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:

ExtendedSearchProjectionFactory<ElasticsearchSearchProjectionFactory<R,E>,R,E>, SearchProjectionFactory<R,E>

All Known Implementing Classes:

ElasticsearchSearchProjectionFactoryImpl

public interface ElasticsearchSearchProjectionFactory<R,E>
extends 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
ProjectionFinalStep<com.google.gson.JsonObject>	explanation()	Project to a JsonObject describing the score computation for the hit.
ProjectionFinalStep<com.google.gson.JsonObject>	jsonHit()	Project to a JsonObject representing the hit as returned by Elasticsearch.
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

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

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

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.