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

Class FieldProjectionDefinition.SingleValued<F>

java.lang.Object

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

org.hibernate.search.engine.search.projection.definition.spi.FieldProjectionDefinition<F,F>

org.hibernate.search.engine.search.projection.definition.spi.FieldProjectionDefinition.SingleValued<F>

All Implemented Interfaces:

ProjectionDefinition<F>, ToStringTreeAppendable

Enclosing class:

FieldProjectionDefinition<P,F>

@Incubating
public static final class FieldProjectionDefinition.SingleValued<F>
extends FieldProjectionDefinition<F,F>

Nested Class Summary

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

FieldProjectionDefinition.MultiValued<F>, FieldProjectionDefinition.SingleValued<F>

Field Summary

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

fieldPath, fieldType, valueConvert

Constructor Summary

Constructors

Constructor	Description
SingleValued(String fieldPath, Class<F> fieldType, ValueConvert valueConvert)

Method Summary

Modifier and Type	Method	Description
SearchProjection<F>	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.FieldProjectionDefinition

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 Detail

SingleValued

public SingleValued(String fieldPath,
                    Class<F> fieldType,
                    ValueConvert valueConvert)

Method Detail

multi

protected boolean multi()

Specified by:

multi in class FieldProjectionDefinition<F,F>

create

public SearchProjection<F> 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