org.hibernate.search.engine.search.query.dsl.spi

Class AbstractDelegatingSearchQueryHitTypeStep<R,E,LOS>

java.lang.Object

org.hibernate.search.engine.search.query.dsl.spi.AbstractDelegatingSearchQueryHitTypeStep<R,E,LOS>

All Implemented Interfaces:

SearchQueryHitTypeStep<SearchQueryOptionsStep<?,E,LOS,?,?>,R,E,LOS,SearchProjectionFactory<R,E>,SearchPredicateFactory>, SearchQueryPredicateStep<SearchQueryOptionsStep<?,E,LOS,?,?>,E,SearchPredicateFactory>

public abstract class AbstractDelegatingSearchQueryHitTypeStep<R,E,LOS>
extends Object
implements SearchQueryHitTypeStep<SearchQueryOptionsStep<?,E,LOS,?,?>,R,E,LOS,SearchProjectionFactory<R,E>,SearchPredicateFactory>

Constructor Summary

Constructors

Constructor and Description
AbstractDelegatingSearchQueryHitTypeStep(SearchQueryHitTypeStep<?,R,E,LOS,?,?> delegate)

Method Summary

Modifier and Type	Method and Description
SearchQueryPredicateStep<?,E,?>	asEntity() Define the query results as the entity was originally indexed, loaded from an external source (database, ...).
SearchQueryPredicateStep<?,R,?>	asEntityReference() Define the query results as a reference to the entity that was originally indexed.
<P> SearchQueryPredicateStep<?,P,?>	asProjection(Function<? super SearchProjectionFactory<R,E>,? extends ProjectionFinalStep<P>> projectionContributor) Define the query results as one projection for each matching document.
<P> SearchQueryPredicateStep<?,P,?>	asProjection(SearchProjection<P> projection) Define the query results as one projection for each matching document.
SearchQueryPredicateStep<?,List<?>,?>	asProjections(SearchProjection<?>... projections) Define the query results as a list of projections for each matching document.
<T> T	extension(SearchQueryDslExtension<T,R,E,LOS> extension) Extend the current DSL step with the given extension, resulting in an extended step offering more query options.
SearchQueryOptionsStep<?,E,LOS,?,?>	predicate(Function<? super SearchPredicateFactory,? extends PredicateFinalStep> predicateContributor) Set the predicate for this query.
SearchQueryOptionsStep<?,E,LOS,?,?>	predicate(SearchPredicate predicate) Set the predicate for this query.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractDelegatingSearchQueryHitTypeStep

public AbstractDelegatingSearchQueryHitTypeStep(SearchQueryHitTypeStep<?,R,E,LOS,?,?> delegate)

Method Detail

asEntity

public SearchQueryPredicateStep<?,E,?> asEntity()

Description copied from interface: SearchQueryHitTypeStep

Define the query results as the entity was originally indexed, loaded from an external source (database, ...).

Specified by:

asEntity in interface SearchQueryHitTypeStep<SearchQueryOptionsStep<?,E,LOS,?,?>,R,E,LOS,SearchProjectionFactory<R,E>,SearchPredicateFactory>

Returns:

The next step.

See Also:

SearchQueryPredicateStep

asEntityReference

public SearchQueryPredicateStep<?,R,?> asEntityReference()

Description copied from interface: SearchQueryHitTypeStep

Define the query results as a reference to the entity that was originally indexed.

Specified by:

asEntityReference in interface SearchQueryHitTypeStep<SearchQueryOptionsStep<?,E,LOS,?,?>,R,E,LOS,SearchProjectionFactory<R,E>,SearchPredicateFactory>

Returns:

The next step.

See Also:

SearchQueryPredicateStep

asProjection

public <P> SearchQueryPredicateStep<?,P,?> asProjection(Function<? super SearchProjectionFactory<R,E>,? extends ProjectionFinalStep<P>> projectionContributor)

Description copied from interface: SearchQueryHitTypeStep

Define the query results as one projection for each matching document.

Specified by:

asProjection in interface SearchQueryHitTypeStep<SearchQueryOptionsStep<?,E,LOS,?,?>,R,E,LOS,SearchProjectionFactory<R,E>,SearchPredicateFactory>

Type Parameters:

P - The resulting type of the projection.

Parameters:

projectionContributor - A function that will use the factory passed in parameter to create a projection, returning the final step in the projection DSL. Should generally be a lambda expression.

Returns:

The next step.

See Also:

SearchQueryPredicateStep

asProjection

public <P> SearchQueryPredicateStep<?,P,?> asProjection(SearchProjection<P> projection)

Description copied from interface: SearchQueryHitTypeStep

Define the query results as one projection for each matching document.

Specified by:

asProjection in interface SearchQueryHitTypeStep<SearchQueryOptionsStep<?,E,LOS,?,?>,R,E,LOS,SearchProjectionFactory<R,E>,SearchPredicateFactory>

Type Parameters:

P - The resulting type of the projection.

Parameters:

projection - A previously-created SearchProjection object.

Returns:

The next step.

See Also:

SearchQueryPredicateStep

asProjections

public SearchQueryPredicateStep<?,List<?>,?> asProjections(SearchProjection<?>... projections)

Description copied from interface: SearchQueryHitTypeStep

Define the query results as a list of projections for each matching document.

Note that using this method will force you to use casts when consuming the results, since the returned lists are not typed (List<?> instead of List<T>). You can replace calls to this method advantageously with calls to SearchQueryHitTypeStep.asProjection(Function) defining a composite projection.

Specified by:

asProjections in interface SearchQueryHitTypeStep<SearchQueryOptionsStep<?,E,LOS,?,?>,R,E,LOS,SearchProjectionFactory<R,E>,SearchPredicateFactory>

Parameters:

projections - A list of previously-created SearchProjection objects.

Returns:

The next step.

See Also:

SearchProjectionFactory.composite(SearchProjection[]), SearchQueryPredicateStep

predicate

public SearchQueryOptionsStep<?,E,LOS,?,?> predicate(Function<? super SearchPredicateFactory,? extends PredicateFinalStep> predicateContributor)

Description copied from interface: SearchQueryPredicateStep

Set the predicate for this query.

Specified by:

predicate in interface SearchQueryPredicateStep<SearchQueryOptionsStep<?,E,LOS,?,?>,E,SearchPredicateFactory>

Parameters:

predicateContributor - A function that will use the factory passed in parameter to create a predicate, returning the final step in the predicate DSL. Should generally be a lambda expression.

Returns:

The next step.

predicate

public SearchQueryOptionsStep<?,E,LOS,?,?> predicate(SearchPredicate predicate)

Description copied from interface: SearchQueryPredicateStep

Set the predicate for this query.

Specified by:

predicate in interface SearchQueryPredicateStep<SearchQueryOptionsStep<?,E,LOS,?,?>,E,SearchPredicateFactory>

Parameters:

predicate - A SearchPredicate object obtained from the search scope.

Returns:

The next step.

extension

public <T> T extension(SearchQueryDslExtension<T,R,E,LOS> extension)

Description copied from interface: SearchQueryHitTypeStep

Extend the current DSL step with the given extension, resulting in an extended step offering more query options.

Specified by:

extension in interface SearchQueryHitTypeStep<SearchQueryOptionsStep<?,E,LOS,?,?>,R,E,LOS,SearchProjectionFactory<R,E>,SearchPredicateFactory>

Type Parameters:

T - The type of DSL step provided by the extension.

Parameters:

extension - The extension to the query DSL.

Returns:

The extended DSL step.