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

Class LuceneEntityReferenceProjection<R>

java.lang.Object

org.hibernate.search.backend.lucene.search.projection.impl.LuceneEntityReferenceProjection<R>

All Implemented Interfaces:

LuceneSearchProjection<R>, LuceneSearchProjection.Extractor<DocumentReference,R>, SearchProjection<R>

public class LuceneEntityReferenceProjection<R>
extends Object
implements LuceneSearchProjection.Extractor<DocumentReference,R>

Nested Class Summary

Nested classes/interfaces inherited from interface org.hibernate.search.backend.lucene.search.projection.impl.LuceneSearchProjection

LuceneSearchProjection.Extractor<E,P>

Field Summary

Fields inherited from interface org.hibernate.search.backend.lucene.search.projection.impl.LuceneSearchProjection

log

Method Summary

Modifier and Type	Method	Description
Set<String>	indexNames()
LuceneSearchProjection.Extractor<?,R>	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.
String	toString()
R	transform(LoadingResult<?> loadingResult, DocumentReference extractedData, ProjectionTransformContext context)	Transforms the extracted data to the actual projection result.
Values<DocumentReference>	values(ProjectionExtractContext context)	Creates low-level values for use in a TopDocsDataCollector.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

toString

public String toString()

Overrides:

toString in class Object

request

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

Description copied from interface: LuceneSearchProjection

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.

Specified by:

request in interface LuceneSearchProjection<R>

Parameters:

context - An execution context for the request.

Returns:

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

values

public Values<DocumentReference> values(ProjectionExtractContext context)

Description copied from interface: LuceneSearchProjection.Extractor

Creates low-level values for use in a TopDocsDataCollector.

The returned Values should only perform operations relative to extracting content from the index, delaying operations that rely on the mapper until LuceneSearchProjection.Extractor.transform(LoadingResult, Object, ProjectionTransformContext) is called, so that blocking mapper operations (if any) do not pollute backend threads.

Specified by:

values in interface LuceneSearchProjection.Extractor<DocumentReference,R>

Parameters:

context - An execution context for the extraction.

Returns:

The Values to use during Lucene collection of top docs data.

transform

public R transform(LoadingResult<?> loadingResult,
                   DocumentReference extractedData,
                   ProjectionTransformContext context)

Description copied from interface: LuceneSearchProjection.Extractor

Transforms the extracted data to the actual projection result.

Specified by:

transform in interface LuceneSearchProjection.Extractor<DocumentReference,R>

Parameters:

loadingResult - Container containing all the entities that have been loaded by the ProjectionHitMapper.

extractedData - The extracted data to transform, returned by the value source.

context - An execution context for the transforming.

Returns:

The final result considered as a hit.

indexNames

public final Set<String> indexNames()

Specified by:

indexNames in interface LuceneSearchProjection<P>