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

Interface ElasticsearchSearchProjectionFactory<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<ElasticsearchSearchProjectionFactory<R,E>,R,E>, org.hibernate.search.engine.search.projection.dsl.SearchProjectionFactory<R,E>
public interface ElasticsearchSearchProjectionFactory<R,E> extends org.hibernate.search.engine.search.projection.dsl.ExtendedSearchProjectionFactory<ElasticsearchSearchProjectionFactory<R,E>,R,E>
A factory for search projections with some Elasticsearch-specific methods.
See Also:
  • SearchProjectionFactory

  • Method Summary

    Modifier and Type
    Method
    Description
    org.hibernate.search.engine.search.projection.dsl.ProjectionFinalStep<com.google.gson.JsonObject>
    explanation()
    Project to a JsonObject describing the score computation for the hit.
    org.hibernate.search.engine.search.projection.dsl.ProjectionFinalStep<com.google.gson.JsonObject>
    jsonHit()
    Project to a JsonObject representing the hit as returned by Elasticsearch.
    org.hibernate.search.engine.search.projection.dsl.ProjectionFinalStep<com.google.gson.JsonObject>
    source()
    Project to a JsonObject representing the document as stored in Elasticsearch.

    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

    • source

      org.hibernate.search.engine.search.projection.dsl.ProjectionFinalStep<com.google.gson.JsonObject> source()
      Project to a JsonObject representing the document as stored in Elasticsearch.
      Returns:
      The final step of the projection DSL.

    • explanation

      org.hibernate.search.engine.search.projection.dsl.ProjectionFinalStep<com.google.gson.JsonObject> explanation()
      Project to a JsonObject describing the score computation for the hit.

      This feature is relatively expensive, do not use unless you return a limited amount of hits (using pagination).

      Returns:
      The final step of the projection DSL.

    • jsonHit

      org.hibernate.search.engine.search.projection.dsl.ProjectionFinalStep<com.google.gson.JsonObject> jsonHit()
      Project to a JsonObject representing the hit as returned by Elasticsearch.
      Returns:
      The final step of the projection DSL.