LuceneSearchProjectionFactory (Hibernate Search 6.1.8.Final)

Type Parameters:

R - The type of entity references.

E - The type of entities.

All Superinterfaces:

ExtendedSearchProjectionFactory<LuceneSearchProjectionFactory<R,E>,R,E>, SearchProjectionFactory<R,E>
```
public interface LuceneSearchProjectionFactory<R,E>
extends ExtendedSearchProjectionFactory<LuceneSearchProjectionFactory<R,E>,R,E>
```
A factory for search projections with some Lucene-specific methods.

See Also:

SearchProjectionFactory

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`ProjectionFinalStep<Document>`	`document()`	Project to a Lucene `Document` containing all the stored fields.
`ProjectionFinalStep<Explanation>`	`explanation()`	Project to a Lucene `Explanation` describing the score computation for the hit.

Methods inherited from interface org.hibernate.search.engine.search.projection.dsl.ExtendedSearchProjectionFactory
withRoot

Methods inherited from interface org.hibernate.search.engine.search.projection.dsl.SearchProjectionFactory
composite, composite, composite, composite, composite, composite, composite, composite, composite, composite, distance, documentReference, entity, entityReference, extension, extension, field, field, field, field, id, id, score, toAbsolutePath

- Method Detail
  - document
```
ProjectionFinalStep<Document> document()
```
    Project to a Lucene Document containing all the stored fields.
    Note that only stored fields are returned: fields that are not marked as projectable may be missing.
    
    Returns:
    
    The final step of the projection DSL.
  - explanation
```
ProjectionFinalStep<Explanation> explanation()
```
    Project to a Lucene Explanation describing the score computation for the hit.
    This feature is relatively expensive, do not use unless you return a limited amount of objects (using pagination).
    
    Returns:
    
    The final step of the projection DSL.