Package org.hibernate.search.mapper.pojo.search.definition.binding.builtin

Class ObjectProjectionBinder

java.lang.Object

org.hibernate.search.mapper.pojo.search.definition.binding.builtin.ObjectProjectionBinder

All Implemented Interfaces:

ProjectionBinder

public final class ObjectProjectionBinder
extends Object
implements ProjectionBinder

Binds a constructor parameter to an object projection bound to a specific object field in the indexed document.

The content of the object projection is defined in the constructor parameter type by another ProjectionConstructor.

Compared to the basic composite projection, an object projection is bound to a specific object field, and thus it yields zero, one or many values, as many as there are objects in the targeted object field. Therefore, you must take care of using a List<...> as your constructor parameter type if the object field is multi-valued.

See Also:

SearchProjectionFactory.object(String), CompositeProjectionInnerStep.as(Class), ObjectProjection

Method Summary

Modifier and Type	Method	Description
void	bind(ProjectionBindingContext context)	Binds a constructor parameter to a projection.
static ObjectProjectionBinder	create()	Creates an ObjectProjectionBinder to be passed to MethodParameterMappingStep.projection(ProjectionBinder).
static ObjectProjectionBinder	create(String fieldPath)	Creates an ObjectProjectionBinder to be passed to MethodParameterMappingStep.projection(ProjectionBinder).
ObjectProjectionBinder	filter(TreeFilterDefinition filter)
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

create

public static ObjectProjectionBinder create()

Creates an ObjectProjectionBinder to be passed to MethodParameterMappingStep.projection(ProjectionBinder).

This method requires the projection constructor class to be compiled with the -parameters flag to infer the field path from the name of the constructor parameter being bound. If this compiler flag is not used, use create(String) instead and pass the field path explicitly.

Returns:

The binder.

create

public static ObjectProjectionBinder create(String fieldPath)

Creates an ObjectProjectionBinder to be passed to MethodParameterMappingStep.projection(ProjectionBinder).

Parameters:

fieldPath - The path to the index field whose value will be extracted. When null, defaults to the name of the constructor parameter being bound, if it can be retrieved (requires the class to be compiled with the -parameters flag; otherwise a null fieldPath will lead to a failure).

Returns:

The binder.

toString

public String toString()

Overrides:

toString in class Object

filter

public ObjectProjectionBinder filter(TreeFilterDefinition filter)

Parameters:

filter - The filter to apply to determine which nested index field projections should be included in the projection.

Returns:

this, for method chaining.

See Also:

ObjectProjection.includePaths(), ObjectProjection.excludePaths(), ObjectProjection.includeDepth()

bind

public void bind(ProjectionBindingContext context)

Description copied from interface: ProjectionBinder

Binds a constructor parameter to a projection.

The context passed in parameter provides various information about the constructor parameter being bound. Implementations are expected to take advantage of that information and to call one of the definition*(...) methods on the context to set the projection.

Specified by:

bind in interface ProjectionBinder

Parameters:

context - A context object providing information about the constructor parameter being bound, and expecting a call to one of its definition*(...) methods.