Package org.hibernate.search.engine.search.predicate.definition

Interface PredicateDefinitionContext

All Known Subinterfaces:

TypedPredicateDefinitionContext<SR>

All Known Implementing Classes:

NamedValuesBasedPredicateDefinitionContext, NamedValuesBasedTypedPredicateDefinitionContext

@Incubating
public interface PredicateDefinitionContext

The context passed to PredicateDefinition.create(PredicateDefinitionContext).

See Also:

• PredicateDefinition.create(PredicateDefinitionContext)

Method Summary

Modifier and Type	Method	Description
default Object	param(String name)	Deprecated. Use params() instead.
default <T> T	param(String name, Class<T> paramType)	Deprecated. Use params() instead.
default Optional<Object>	paramOptional(String name)	Deprecated. Use params() instead.
default <T> Optional<T>	paramOptional(String name, Class<T> paramType)	Deprecated. Use params() instead.
NamedValues	params()
SearchPredicateFactory	predicate()

Method Details

predicate

SearchPredicateFactory predicate()

Returns:

A predicate factory. If the named predicate was registered on 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 PredicateDefinition.create(PredicateDefinitionContext) returns.

See Also:

• TypedSearchPredicateFactory

param

@Deprecated(since="7.0")
default Object param(String name)

Deprecated.

Use params() instead.

Parameters:

name - The name of the parameter.

Returns:

The value provided to NamedPredicateOptionsStep.param(String, Object) for this parameter.

Throws:

SearchException - If no value was provided for this parameter.

See Also:

• NamedPredicateOptionsStep.param(String, Object)

param

@Deprecated(since="7.2")
default <T> T param(String name,
 Class<T> paramType)

Deprecated.

Use params() instead.

Type Parameters:

T - The type of the parameter.

Parameters:

name - The name of the parameter.

paramType - The type of the parameter.

Returns:

The value provided to NamedPredicateOptionsStep.param(String, Object) for this parameter.

Throws:

SearchException - If no value was provided for this parameter.

See Also:

• NamedPredicateOptionsStep.param(String, Object)

paramOptional

@Deprecated(since="7.0")
default Optional<Object> paramOptional(String name)

Deprecated.

Use params() instead.

Parameters:

name - The name of the parameter.

Returns:

An optional containing the value provided to NamedPredicateOptionsStep.param(String, Object) for this parameter, or Optional.empty() if no value was provided for this parameter.

See Also:

• NamedPredicateOptionsStep.param(String, Object)

paramOptional

@Deprecated(since="7.2")
default <T> Optional<T> paramOptional(String name,
 Class<T> paramType)

Deprecated.

Use params() instead.

Type Parameters:

T - The type of the parameter.

Parameters:

name - The name of the parameter.

paramType - The type of the parameter.

Returns:

An optional containing the value provided to NamedPredicateOptionsStep.param(String, Object) for this parameter, or Optional.empty() if no value was provided for this parameter.

See Also:

• NamedPredicateOptionsStep.param(String, Object)

params

NamedValues params()

Returns:

Predicate definition context parameters provided through NamedPredicateOptionsStep.param(String, Object).

See Also:

• NamedValues.get(String, Class)
• NamedValues.getOptional(String, Class)