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

Class ElasticsearchDistanceToFieldProjection<A,P>

java.lang.Object

org.hibernate.search.backend.elasticsearch.search.projection.impl.AbstractElasticsearchProjection<P>

org.hibernate.search.backend.elasticsearch.search.projection.impl.ElasticsearchDistanceToFieldProjection<A,P>

Type Parameters:

A - The type of the temporary storage for accumulated values, before and after being transformed.

P - The type of the final projection result representing accumulated distance values.

All Implemented Interfaces:

ElasticsearchSearchProjection<P>, ElasticsearchSearchProjection.Extractor<A,P>, SearchProjection<P>

public class ElasticsearchDistanceToFieldProjection<A,P>
extends AbstractElasticsearchProjection<P>
implements ElasticsearchSearchProjection.Extractor<A,P>

A projection on the distance from a given center to the GeoPoint defined in an index field.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ElasticsearchDistanceToFieldProjection.Builder
static class	ElasticsearchDistanceToFieldProjection.Factory

Nested classes/interfaces inherited from class org.hibernate.search.backend.elasticsearch.search.projection.impl.AbstractElasticsearchProjection

AbstractElasticsearchProjection.AbstractBuilder<P>

Nested classes/interfaces inherited from interface org.hibernate.search.backend.elasticsearch.search.projection.impl.ElasticsearchSearchProjection

ElasticsearchSearchProjection.Extractor<E,P>

Field Summary

Fields inherited from class org.hibernate.search.backend.elasticsearch.search.projection.impl.AbstractElasticsearchProjection

indexNames

Fields inherited from interface org.hibernate.search.backend.elasticsearch.search.projection.impl.ElasticsearchSearchProjection

log

Method Summary

Modifier and Type	Method	Description
A	extract(ProjectionHitMapper<?> projectionHitMapper, com.google.gson.JsonObject hit, com.google.gson.JsonObject source, ProjectionExtractContext context)	Performs hit extraction.
ElasticsearchSearchProjection.Extractor<?,P>	request(com.google.gson.JsonObject requestBody, ProjectionRequestContext context)	Contributes to the request, making sure that the requirements for this projection are met, and creating an ElasticsearchSearchProjection.Extractor that will be able to extract the result of the projection from the Elasticsearch response.
String	toString()
P	transform(LoadingResult<?> loadingResult, A extractedData, ProjectionTransformContext context)	Transforms the extracted data to the actual projection result.

Methods inherited from class org.hibernate.search.backend.elasticsearch.search.projection.impl.AbstractElasticsearchProjection

indexNames

Methods inherited from class java.lang.Object

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

Method Detail

toString

public String toString()

Overrides:

toString in class Object

request

public ElasticsearchSearchProjection.Extractor<?,P> request(com.google.gson.JsonObject requestBody,
                                                                  ProjectionRequestContext context)

Description copied from interface: ElasticsearchSearchProjection

Contributes to the request, making sure that the requirements for this projection are met, and creating an ElasticsearchSearchProjection.Extractor that will be able to extract the result of the projection from the Elasticsearch response.

Specified by:

request in interface ElasticsearchSearchProjection<A>

Parameters:

requestBody - The request body.

context - An execution context for the request.

Returns:

An ElasticsearchSearchProjection.Extractor, to extract the result of the projection from the Elasticsearch response.

extract

public A extract(ProjectionHitMapper<?> projectionHitMapper,
                 com.google.gson.JsonObject hit,
                 com.google.gson.JsonObject source,
                 ProjectionExtractContext context)

Description copied from interface: ElasticsearchSearchProjection.Extractor

Performs hit extraction.

Implementations should only perform operations relative to extracting content from the index, delaying operations that rely on the mapper until ElasticsearchSearchProjection.Extractor.transform(LoadingResult, Object, ProjectionTransformContext) is called, so that blocking mapper operations (if any) do not pollute backend threads.

Specified by:

extract in interface ElasticsearchSearchProjection.Extractor<A,P>

Parameters:

projectionHitMapper - The projection hit mapper used to transform hits to entities.

hit - The part of the response body relevant to the hit to extract.

source - The part of the source that this extractor should extract from (if relevant).

context - An execution context for the extraction.

Returns:

The element extracted from the hit. Might be a key referring to an object that will be loaded by the ProjectionHitMapper. This returned object will be passed to ElasticsearchSearchProjection.Extractor.transform(LoadingResult, Object, ProjectionTransformContext).

transform

public P transform(LoadingResult<?> loadingResult,
                   A extractedData,
                   ProjectionTransformContext context)

Description copied from interface: ElasticsearchSearchProjection.Extractor

Transforms the extracted data to the actual projection result.

Specified by:

transform in interface ElasticsearchSearchProjection.Extractor<A,P>

Parameters:

loadingResult - Container containing all the entities that have been loaded by the ProjectionHitMapper.

extractedData - The extracted data to transform, coming from the ElasticsearchSearchProjection.Extractor.extract(ProjectionHitMapper, JsonObject, JsonObject, ProjectionExtractContext) method.

context - An execution context for the transforming.

Returns:

The final result considered as a hit.