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

Class LuceneSearchProjectionBuilderFactory

java.lang.Object

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

All Implemented Interfaces:

SearchProjectionBuilderFactory

public class LuceneSearchProjectionBuilderFactory
extends Object
implements SearchProjectionBuilderFactory

Constructor Summary

Constructors

Constructor	Description
LuceneSearchProjectionBuilderFactory(LuceneSearchIndexScopeImpl scope)

Method Summary

Modifier and Type	Method	Description
<T> SearchProjection<T>	byTypeName(Map<String,? extends SearchProjection<? extends T>> inners)
CompositeProjectionBuilder	composite()
<T> SearchProjection<T>	constant(T value)
SearchProjection<org.apache.lucene.document.Document>	document()
SearchProjection<DocumentReference>	documentReference()
SearchProjection<DocumentTree>	documentTree()
<T> SearchProjection<T>	entityComposite(SearchProjection<T> delegate)
<E> SearchProjection<E>	entityLoading()
<R> SearchProjection<R>	entityReference()
SearchProjection<org.apache.lucene.search.Explanation>	explanation()
<I> SearchProjection<I>	id(Class<I> requestedIdentifierType)
SearchProjection<Float>	score()
<T> SearchProjection<T>	throwing(Supplier<SearchException> exceptionSupplier)
<T> SearchProjection<T>	withParameters(Function<? super NamedValues,? extends ProjectionFinalStep<T>> projectionCreator)

Methods inherited from class java.lang.Object

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

Constructor Details

LuceneSearchProjectionBuilderFactory

public LuceneSearchProjectionBuilderFactory(LuceneSearchIndexScopeImpl scope)

Method Details

documentReference

public SearchProjection<DocumentReference> documentReference()

Specified by:

documentReference in interface SearchProjectionBuilderFactory

entityLoading

public <E> SearchProjection<E> entityLoading()

Specified by:

entityLoading in interface SearchProjectionBuilderFactory

entityReference

public <R> SearchProjection<R> entityReference()

Specified by:

entityReference in interface SearchProjectionBuilderFactory

id

public <I> SearchProjection<I> id(Class<I> requestedIdentifierType)

Specified by:

id in interface SearchProjectionBuilderFactory

score

public SearchProjection<Float> score()

Specified by:

score in interface SearchProjectionBuilderFactory

composite

public CompositeProjectionBuilder composite()

Specified by:

composite in interface SearchProjectionBuilderFactory

constant

public <T> SearchProjection<T> constant(T value)

Specified by:

constant in interface SearchProjectionBuilderFactory

entityComposite

public <T> SearchProjection<T> entityComposite(SearchProjection<T> delegate)

Specified by:

entityComposite in interface SearchProjectionBuilderFactory

throwing

public <T> SearchProjection<T> throwing(Supplier<SearchException> exceptionSupplier)

Specified by:

throwing in interface SearchProjectionBuilderFactory

Type Parameters:

T - The type of projected values.

Parameters:

exceptionSupplier - A supplier of the exception to throw.

Returns:

A projection that throws an exception as soon as it's applied to at least one document.

byTypeName

public <T> SearchProjection<T> byTypeName(Map<String,? extends SearchProjection<? extends T>> inners)

Specified by:

byTypeName in interface SearchProjectionBuilderFactory

Type Parameters:

T - The type of projected values.

Parameters:

inners - A map from type name to projection.

Returns:

A projection that delegates to the given projections, picking the delegate based on the document's type name.

withParameters

public <T> SearchProjection<T> withParameters(Function<? super NamedValues,? extends ProjectionFinalStep<T>> projectionCreator)

Specified by:

withParameters in interface SearchProjectionBuilderFactory

document

public SearchProjection<org.apache.lucene.document.Document> document()

explanation

public SearchProjection<org.apache.lucene.search.Explanation> explanation()

documentTree

public SearchProjection<DocumentTree> documentTree()