Package org.hibernate.search.backend.lucene.search.query.dsl

Interface LuceneSearchQuerySelectStep<R,E,LOS>

All Superinterfaces:

LuceneSearchQueryWhereStep<E,LOS>, SearchQuerySelectStep<LuceneSearchQueryOptionsStep<E,LOS>,R,E,LOS,LuceneSearchProjectionFactory<R,E>,LuceneSearchPredicateFactory>, SearchQueryWhereStep<LuceneSearchQueryOptionsStep<E,LOS>,E,LOS,LuceneSearchPredicateFactory>

All Known Implementing Classes:

LuceneSearchQuerySelectStepImpl

public interface LuceneSearchQuerySelectStep<R,E,LOS>
extends SearchQuerySelectStep<LuceneSearchQueryOptionsStep<E,LOS>,R,E,LOS,LuceneSearchProjectionFactory<R,E>,LuceneSearchPredicateFactory>, LuceneSearchQueryWhereStep<E,LOS>

Method Summary

Modifier and Type	Method	Description
<P> LuceneSearchQueryWhereStep<P,LOS>	select(Class<P> objectClass)	Select an object projection as a representation of the search hit for each matching document.
<P> LuceneSearchQueryWhereStep<P,LOS>	select(Function<? super LuceneSearchProjectionFactory<R,E>,? extends ProjectionFinalStep<P>> projectionContributor)	Select a given projection as a representation of the search hit for each matching document.
LuceneSearchQueryWhereStep<List<?>,LOS>	select(SearchProjection<?>... projections)	Select a list of projections as a representation of the search hit for each matching document.
<P> LuceneSearchQueryWhereStep<P,LOS>	select(SearchProjection<P> projection)	Select a projection as a representation of the search hit for each matching document.
LuceneSearchQueryWhereStep<E,LOS>	selectEntity()	Select the entity was originally indexed as a representation of the search hit for each matching document.
LuceneSearchQueryWhereStep<R,LOS>	selectEntityReference()	Select a reference to the entity that was originally indexed as a representation of the search hit for each matching document.

Methods inherited from interface org.hibernate.search.engine.search.query.dsl.SearchQuerySelectStep

extension

Methods inherited from interface org.hibernate.search.engine.search.query.dsl.SearchQueryWhereStep

where, where, where

Method Details

selectEntity

LuceneSearchQueryWhereStep<E,LOS> selectEntity()

Description copied from interface: SearchQuerySelectStep

Select the entity was originally indexed as a representation of the search hit for each matching document.

The entity will be loaded directly from its original source (relational database, ...).

Specified by:

selectEntity in interface SearchQuerySelectStep<LuceneSearchQueryOptionsStep<E,LOS>,R,E,LOS,LuceneSearchProjectionFactory<R,E>,LuceneSearchPredicateFactory>

Returns:

The next step.

See Also:

• SearchQueryWhereStep

selectEntityReference

LuceneSearchQueryWhereStep<R,LOS> selectEntityReference()

Description copied from interface: SearchQuerySelectStep

Select a reference to the entity that was originally indexed as a representation of the search hit for each matching document.

Entity references are instances of type EntityReference, but some mappers may expose a different type for backwards compatibility reasons. EntityReference should be favored wherever possible as mapper-specific types will eventually be removed.

Specified by:

selectEntityReference in interface SearchQuerySelectStep<LuceneSearchQueryOptionsStep<E,LOS>,R,E,LOS,LuceneSearchProjectionFactory<R,E>,LuceneSearchPredicateFactory>

Returns:

The next step.

See Also:

• SearchQueryWhereStep

select

<P> LuceneSearchQueryWhereStep<P,LOS> select(Class<P> objectClass)

Description copied from interface: SearchQuerySelectStep

Select an object projection as a representation of the search hit for each matching document.

Specified by:

select in interface SearchQuerySelectStep<LuceneSearchQueryOptionsStep<E,LOS>,R,E,LOS,LuceneSearchProjectionFactory<R,E>,LuceneSearchPredicateFactory>

Type Parameters:

P - The resulting type of the projection.

Parameters:

objectClass - The type of objects returned by the projection. The class is expected to be mapped (generally through annotations) in such a way that it defines the inner projections.

Returns:

The next step.

See Also:

• SearchQueryWhereStep

select

<P> LuceneSearchQueryWhereStep<P,LOS> select(Function<? super LuceneSearchProjectionFactory<R,E>,? extends ProjectionFinalStep<P>> projectionContributor)

Description copied from interface: SearchQuerySelectStep

Select a given projection as a representation of the search hit for each matching document.

Specified by:

select in interface SearchQuerySelectStep<LuceneSearchQueryOptionsStep<E,LOS>,R,E,LOS,LuceneSearchProjectionFactory<R,E>,LuceneSearchPredicateFactory>

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:

• SearchQueryWhereStep

select

<P> LuceneSearchQueryWhereStep<P,LOS> select(SearchProjection<P> projection)

Description copied from interface: SearchQuerySelectStep

Select a projection as a representation of the search hit for each matching document.

Specified by:

select in interface SearchQuerySelectStep<LuceneSearchQueryOptionsStep<E,LOS>,R,E,LOS,LuceneSearchProjectionFactory<R,E>,LuceneSearchPredicateFactory>

Type Parameters:

P - The resulting type of the projection.

Parameters:

projection - A previously-created SearchProjection object.

Returns:

The next step.

See Also:

• SearchQueryWhereStep

select

LuceneSearchQueryWhereStep<List<?>,LOS> select(SearchProjection<?>... projections)

Description copied from interface: SearchQuerySelectStep

Select a list of projections as a representation of the search hit 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 SearchQuerySelectStep.select(Function) defining a composite projection.

Specified by:

select in interface SearchQuerySelectStep<LuceneSearchQueryOptionsStep<E,LOS>,R,E,LOS,LuceneSearchProjectionFactory<R,E>,LuceneSearchPredicateFactory>

Parameters:

projections - A list of previously-created SearchProjection objects.

Returns:

The next step.

See Also:

• SearchProjectionFactory.composite(SearchProjection[])
• SearchQueryWhereStep