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

Interface LuceneSearchProjectionFactory<R,E>

Type Parameters:
R - The type of entity references.
E - The type of entities.
All Superinterfaces:
org.hibernate.search.engine.search.projection.dsl.ExtendedSearchProjectionFactory<LuceneSearchProjectionFactory<R,E>,R,E>, org.hibernate.search.engine.search.projection.dsl.SearchProjectionFactory<R,E>
public interface LuceneSearchProjectionFactory<R,E> extends org.hibernate.search.engine.search.projection.dsl.ExtendedSearchProjectionFactory<LuceneSearchProjectionFactory<R,E>,R,E>
A factory for search projections with some Lucene-specific methods.
See Also:
  • SearchProjectionFactory

  • Method Summary

    Modifier and Type
    Method
    Description
    org.hibernate.search.engine.search.projection.dsl.ProjectionFinalStep<Document>
    document()
    Project to a Lucene Document containing all the stored fields.
    org.hibernate.search.engine.search.projection.dsl.ProjectionFinalStep<DocumentTree>
    documentTree()
    Project to a DocumentTree containing all the stored fields and nested documents.
    org.hibernate.search.engine.search.projection.dsl.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, composite, constant, distance, documentReference, entity, entity, entityReference, extension, extension, field, field, field, field, field, field, highlight, id, id, object, score, toAbsolutePath, withParameters

  • Method Details

    • document

      org.hibernate.search.engine.search.projection.dsl.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

      org.hibernate.search.engine.search.projection.dsl.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.

    • documentTree

      @Incubating org.hibernate.search.engine.search.projection.dsl.ProjectionFinalStep<DocumentTree> documentTree()
      Project to a DocumentTree containing all the stored fields and nested documents.

      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.