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

Class ElasticsearchSearchProjectionFactoryImpl<R,E>

java.lang.Object

org.hibernate.search.engine.search.projection.dsl.spi.AbstractSearchProjectionFactory<ElasticsearchSearchProjectionFactory<R,E>,ElasticsearchSearchProjectionIndexScope<?>,R,E>

org.hibernate.search.backend.elasticsearch.search.projection.dsl.impl.ElasticsearchSearchProjectionFactoryImpl<R,E>

All Implemented Interfaces:

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

public class ElasticsearchSearchProjectionFactoryImpl<R,E>
extends AbstractSearchProjectionFactory<ElasticsearchSearchProjectionFactory<R,E>,ElasticsearchSearchProjectionIndexScope<?>,R,E>
implements ElasticsearchSearchProjectionFactory<R,E>

Field Summary

Fields inherited from class org.hibernate.search.engine.search.projection.dsl.spi.AbstractSearchProjectionFactory

dslContext

Constructor Summary

Constructors

Constructor	Description
ElasticsearchSearchProjectionFactoryImpl(SearchProjectionDslContext<ElasticsearchSearchProjectionIndexScope<?>> dslContext)

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.
ElasticsearchSearchProjectionFactory<R,E>	withRoot(String objectFieldPath)	Create a new projection factory whose root for all paths passed to the DSL will be the given object field.

Methods inherited from class org.hibernate.search.engine.search.projection.dsl.spi.AbstractSearchProjectionFactory

composite, composite, constant, distance, documentReference, entity, entity, entityReference, extension, extension, field, field, highlight, id, object, score, toAbsolutePath

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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, highlight, id, id, object, score, toAbsolutePath

Constructor Detail

ElasticsearchSearchProjectionFactoryImpl

public ElasticsearchSearchProjectionFactoryImpl(SearchProjectionDslContext<ElasticsearchSearchProjectionIndexScope<?>> dslContext)

Method Detail

withRoot

public ElasticsearchSearchProjectionFactory<R,E> withRoot(String objectFieldPath)

Description copied from interface: SearchProjectionFactory

Create a new projection factory whose root for all paths passed to the DSL will be the given object field.

This is used to call reusable methods that can apply the same projection on different object fields that have same structure (same sub-fields).

Specified by:

withRoot in interface ExtendedSearchProjectionFactory<ElasticsearchSearchProjectionFactory<R,E>,R,E>

Specified by:

withRoot in interface SearchProjectionFactory<R,E>

Parameters:

objectFieldPath - The path from the current root to an object field that will become the new root.

Returns:

A new projection factory using the given object field as root.

source

public ProjectionFinalStep<com.google.gson.JsonObject> source()

Description copied from interface: ElasticsearchSearchProjectionFactory

Project to a JsonObject representing the document as stored in Elasticsearch.

Specified by:

source in interface ElasticsearchSearchProjectionFactory<R,E>

Returns:

The final step of the projection DSL.

explanation

public ProjectionFinalStep<com.google.gson.JsonObject> explanation()

Description copied from interface: ElasticsearchSearchProjectionFactory

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).

Specified by:

explanation in interface ElasticsearchSearchProjectionFactory<R,E>

Returns:

The final step of the projection DSL.

jsonHit

public ProjectionFinalStep<com.google.gson.JsonObject> jsonHit()

Description copied from interface: ElasticsearchSearchProjectionFactory

Project to a JsonObject representing the hit as returned by Elasticsearch.

Specified by:

jsonHit in interface ElasticsearchSearchProjectionFactory<R,E>

Returns:

The final step of the projection DSL.