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

Class LuceneObjectProjection<E,V,P>

java.lang.Object

org.hibernate.search.backend.lucene.search.projection.impl.LuceneObjectProjection<E,V,P>

Type Parameters:

E - The type of the temporary storage for component values.

V - The type of a single composed value.

P - The type of the final projection result representing an accumulation of composed values of type V.

All Implemented Interfaces:

LuceneSearchProjection<P>, SearchProjection<P>

public class LuceneObjectProjection<E,V,P>
extends Object

A projection that yields one composite value per object in a given object field.

Not to be confused with LuceneCompositeProjection.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LuceneObjectProjection.Factory

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

Constructor Summary

Constructors

Constructor	Description
LuceneObjectProjection(org.hibernate.search.backend.lucene.search.projection.impl.LuceneObjectProjection.Builder builder, LuceneSearchProjection<?>[] inners, ProjectionCompositor<E,V> compositor, ProjectionAccumulator.Provider<V,P> accumulatorProvider)

Method Summary

Modifier and Type	Method	Description
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.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

LuceneObjectProjection

public LuceneObjectProjection(org.hibernate.search.backend.lucene.search.projection.impl.LuceneObjectProjection.Builder builder,
                              LuceneSearchProjection<?>[] inners,
                              ProjectionCompositor<E,V> compositor,
                              ProjectionAccumulator.Provider<V,P> accumulatorProvider)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

request

public LuceneSearchProjection.Extractor<?,P> 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.

Parameters:

context - An execution context for the request.

Returns:

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

indexNames

public final Set<String> indexNames()

Specified by:

indexNames in interface LuceneSearchProjection<P>