Package org.hibernate.search.engine.search.projection.definition.spi

Class DistanceProjectionDefinition.SingleValued

java.lang.Object

org.hibernate.search.engine.search.projection.definition.spi.AbstractProjectionDefinition<F>

org.hibernate.search.engine.search.projection.definition.spi.DistanceProjectionDefinition<Double>

org.hibernate.search.engine.search.projection.definition.spi.DistanceProjectionDefinition.SingleValued

All Implemented Interfaces:

ProjectionDefinition<Double>, ToStringTreeAppendable

Enclosing class:

DistanceProjectionDefinition<F>

@Incubating
public static final class DistanceProjectionDefinition.SingleValued
extends DistanceProjectionDefinition<Double>

Nested Class Summary

Nested classes/interfaces inherited from class org.hibernate.search.engine.search.projection.definition.spi.DistanceProjectionDefinition

DistanceProjectionDefinition.MultiValued, DistanceProjectionDefinition.SingleValued

Field Summary

Fields inherited from class org.hibernate.search.engine.search.projection.definition.spi.DistanceProjectionDefinition

fieldPath, parameterName, unit

Constructor Summary

Constructors

Constructor	Description
SingleValued(String fieldPath, String parameterName, DistanceUnit unit)

Method Summary

Modifier and Type	Method	Description
SearchProjection<Double>	create(SearchProjectionFactory<?,?> factory, ProjectionDefinitionContext context)	Creates a projection with a specific projected type.
protected boolean	multi()

Methods inherited from class org.hibernate.search.engine.search.projection.definition.spi.DistanceProjectionDefinition

appendTo, type

Methods inherited from class org.hibernate.search.engine.search.projection.definition.spi.AbstractProjectionDefinition

toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hibernate.search.util.common.spi.ToStringTreeAppendable

toStringTree

Constructor Details

SingleValued

public SingleValued(String fieldPath,
 String parameterName,
 DistanceUnit unit)

Method Details

multi

protected boolean multi()

Specified by:

multi in class DistanceProjectionDefinition<Double>

create

public SearchProjection<Double> create(SearchProjectionFactory<?,?> factory,
 ProjectionDefinitionContext context)

Description copied from interface: ProjectionDefinition

Creates a projection with a specific projected type.

Parameters:

factory - A projection factory. If the projection is used in the context of an object field, this factory expects field paths to be provided relative to that same object field. This factory is only valid in the present context and must not be used after ProjectionDefinition.create(SearchProjectionFactory, ProjectionDefinitionContext) returns.

context - The context in which the definition is applied.

Returns:

The created SearchPredicate.

See Also:

• SearchPredicateFactory
• ProjectionDefinitionContext