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

Class ProjectionBindingContextImpl<P>

java.lang.Object

org.hibernate.search.mapper.pojo.search.definition.binding.impl.ProjectionBindingContextImpl<P>

All Implemented Interfaces:

ProjectionBindingContext

public class ProjectionBindingContextImpl<P>
extends Object
implements ProjectionBindingContext

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	ProjectionBindingContextImpl.MultiContextImpl<PV>

Constructor Summary

Constructors

Constructor	Description
ProjectionBindingContextImpl(org.hibernate.search.mapper.pojo.search.definition.binding.impl.ProjectionConstructorParameterBinder<P> parameterBinder, Map<String,Object> params)

Method Summary

Modifier and Type	Method	Description
BeanHolder<? extends ProjectionDefinition<? extends P>>	applyBinder(ProjectionBinder binder)
BeanHolder<? extends ProjectionDefinition<?>>	applyDefaultProjection()
BeanResolver	beanResolver()
PojoModelConstructorParameter	constructorParameter()
<T> BeanHolder<? extends ProjectionDefinition<T>>	createCompositeDefinition(Class<T> projectedType)
<T> BeanHolder<? extends ProjectionDefinition<T>>	createObjectDefinition(String fieldPath, Class<T> projectedType, TreeFilterDefinition filter)
<T> BeanHolder<? extends ProjectionDefinition<List<T>>>	createObjectDefinitionMulti(String fieldPath, Class<T> projectedType, TreeFilterDefinition filter)
<P2> void	definition(Class<P2> expectedValueType, BeanHolder<? extends ProjectionDefinition<? extends P2>> definitionHolder)	Binds the ProjectionBindingContext.constructorParameter() to the given projection definition.
<P2> void	definition(Class<P2> expectedValueType, ProjectionDefinition<? extends P2> definition)	Binds the ProjectionBindingContext.constructorParameter() to the given projection definition.
boolean	isIncluded(String fieldPath)
Optional<ProjectionBindingContextImpl.MultiContextImpl<?>>	multi()	Inspects the type of the ProjectionBindingContext.constructorParameter() to determine if it may be bound to a multi-valued projection.
Object	param(String name)
Optional<Object>	paramOptional(String name)

Methods inherited from class java.lang.Object

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

Constructor Detail

ProjectionBindingContextImpl

public ProjectionBindingContextImpl(org.hibernate.search.mapper.pojo.search.definition.binding.impl.ProjectionConstructorParameterBinder<P> parameterBinder,
                                    Map<String,Object> params)

Method Detail

beanResolver

public BeanResolver beanResolver()

Specified by:

beanResolver in interface ProjectionBindingContext

Returns:

A bean provider, allowing the retrieval of beans, including CDI/Spring DI beans when in the appropriate environment.

param

public Object param(String name)

Specified by:

param in interface ProjectionBindingContext

Parameters:

name - The name of the parameter.

Returns:

The value provided for this parameter.

See Also:

PropertyBinderRef.params(), MethodParameterMappingStep.projection(BeanReference, Map)

paramOptional

public Optional<Object> paramOptional(String name)

Specified by:

paramOptional in interface ProjectionBindingContext

Parameters:

name - The name of the parameter.

Returns:

An optional containing the value provided for this parameter, or Optional.empty() if no value was provided for this parameter.

See Also:

PropertyBinderRef.params(), MethodParameterMappingStep.projection(BeanReference, Map)

definition

public <P2> void definition(Class<P2> expectedValueType,
                            ProjectionDefinition<? extends P2> definition)

Description copied from interface: ProjectionBindingContext

Binds the ProjectionBindingContext.constructorParameter() to the given projection definition.

Specified by:

definition in interface ProjectionBindingContext

Type Parameters:

P2 - The type of values returned by the projection.

Parameters:

expectedValueType - The expected type of the ProjectionBindingContext.constructorParameter(), which must be compatible with the given projection definition. Hibernate Search will check that these expectations are met, and throw an exception if they are not.

definition - A definition of the projection to bind to the ProjectionBindingContext.constructorParameter().

definition

public <P2> void definition(Class<P2> expectedValueType,
                            BeanHolder<? extends ProjectionDefinition<? extends P2>> definitionHolder)

Description copied from interface: ProjectionBindingContext

Binds the ProjectionBindingContext.constructorParameter() to the given projection definition.

Specified by:

definition in interface ProjectionBindingContext

Type Parameters:

P2 - The type of values returned by the projection.

Parameters:

expectedValueType - The expected type of the ProjectionBindingContext.constructorParameter(), which must be compatible with the given projection definition. Hibernate Search will check that these expectations are met, and throw an exception if they are not.

definitionHolder - A BeanHolder containing the definition of the projection to bind to the ProjectionBindingContext.constructorParameter().

multi

public Optional<ProjectionBindingContextImpl.MultiContextImpl<?>> multi()

Description copied from interface: ProjectionBindingContext

Inspects the type of the ProjectionBindingContext.constructorParameter() to determine if it may be bound to a multi-valued projection.

Specified by:

multi in interface ProjectionBindingContext

Returns:

An optional containing a context that can be used to bind a projection if the type of the ProjectionBindingContext.constructorParameter() can be bound to a multi-valued projection; an empty optional otherwise.

constructorParameter

public PojoModelConstructorParameter constructorParameter()

Specified by:

constructorParameter in interface ProjectionBindingContext

Returns:

An entry point allowing to inspect the constructor parameter being bound to a projection.

createObjectDefinition

public <T> BeanHolder<? extends ProjectionDefinition<T>> createObjectDefinition(String fieldPath,
                                                                                Class<T> projectedType,
                                                                                TreeFilterDefinition filter)

Specified by:

createObjectDefinition in interface ProjectionBindingContext

Parameters:

fieldPath - The (relative) path to an object field in the indexed document.

projectedType - A type expected to have a corresponding projection mapping (e.g. using ProjectionConstructor).

filter - The filter to apply to determine which nested index field projections should be included in the projection. See ObjectProjection.includePaths(), ObjectProjection.excludePaths(), ObjectProjection.includeDepth(), ...

Returns:

A single-valued object projection definition for the given type.

See Also:

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

createObjectDefinitionMulti

public <T> BeanHolder<? extends ProjectionDefinition<List<T>>> createObjectDefinitionMulti(String fieldPath,
                                                                                           Class<T> projectedType,
                                                                                           TreeFilterDefinition filter)

Specified by:

createObjectDefinitionMulti in interface ProjectionBindingContext

Parameters:

fieldPath - The (relative) path to an object field in the indexed document.

projectedType - A type expected to have a corresponding projection mapping (e.g. using ProjectionConstructor).

filter - The filter to apply to determine which nested index field projections should be included in the projection. See ObjectProjection.includePaths(), ObjectProjection.excludePaths(), ObjectProjection.includeDepth(), ...

Returns:

A multi-valued object projection definition for the given type.

See Also:

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

createCompositeDefinition

public <T> BeanHolder<? extends ProjectionDefinition<T>> createCompositeDefinition(Class<T> projectedType)

Specified by:

createCompositeDefinition in interface ProjectionBindingContext

Parameters:

projectedType - A type expected to have a corresponding projection mapping (e.g. using ProjectionConstructor)

Returns:

A composite projection definition for the given type.

See Also:

SearchProjectionFactory.composite(), CompositeProjectionInnerStep.as(Class)

isIncluded

public boolean isIncluded(String fieldPath)

Specified by:

isIncluded in interface ProjectionBindingContext

Parameters:

fieldPath - The (relative) path to an object field in the indexed document.

Returns:

true if the field with the given path is included according to surrounding filters (see ObjectProjection.includePaths(), ObjectProjection.excludePaths(), ObjectProjection.includeDepth(), ...). false otherwise. Projections on excluded fields should be replaced with a constant projection returning null or an empty list, as appropriate.

applyBinder

public BeanHolder<? extends ProjectionDefinition<? extends P>> applyBinder(ProjectionBinder binder)

applyDefaultProjection

public BeanHolder<? extends ProjectionDefinition<?>> applyDefaultProjection()