Package org.hibernate.search.backend.lucene.search.projection.impl

Interface LuceneSearchProjection<P>

All Superinterfaces:

SearchProjection<P>

All Known Implementing Classes:

LuceneByMappedTypeProjection, LuceneConstantProjection, LuceneDistanceToFieldProjection, LuceneEntityCompositeProjection, LuceneEntityLoadingProjection, LuceneEntityReferenceProjection, LuceneFieldHighlightProjection, LuceneFieldProjection, LuceneIdProjection, LuceneObjectProjection, LuceneThrowingProjection, LuceneWithParametersProjection

public interface LuceneSearchProjection<P>
extends SearchProjection<P>

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	LuceneSearchProjection.Extractor<E,P>	An object responsible for extracting data from the Lucene Searcher, to implement a projection.

Field Summary

Fields

Modifier and Type	Field	Description
static final Log	log

Method Summary

Modifier and Type	Method	Description
static <P> LuceneSearchProjection<P>	from(LuceneSearchIndexScope<?> scope, SearchProjection<P> projection)
Set<String>	indexNames()
LuceneSearchProjection.Extractor<?,P>	request(ProjectionRequestContext context)	Request the collection of per-document data that will be used in LuceneSearchProjection.Extractor.values(ProjectionExtractContext), making sure that the requirements for this projection are met.

Field Details

log

static final Log log

Method Details

indexNames

Set<String> indexNames()

request

LuceneSearchProjection.Extractor<?,P> request(ProjectionRequestContext context)

Request the collection of per-document data that will be used in LuceneSearchProjection.Extractor.values(ProjectionExtractContext), making sure that the requirements for this projection are met.

Parameters:

context - An execution context for the request.

Returns:

An LuceneSearchProjection.Extractor, to extract the result of the projection from the Elasticsearch response.

from

static <P> LuceneSearchProjection<P> from(LuceneSearchIndexScope<?> scope,
 SearchProjection<P> projection)