Package org.hibernate.search.engine.search.predicate.spi

Class NamedValuesBasedPredicateDefinitionContext<SR>

java.lang.Object

org.hibernate.search.engine.search.predicate.spi.NamedValuesBasedPredicateDefinitionContext<SR>

All Implemented Interfaces:

PredicateDefinitionContext<SR>

@Incubating
public final class NamedValuesBasedPredicateDefinitionContext<SR>
extends Object
implements PredicateDefinitionContext<SR>

Constructor Summary

Constructors

Constructor	Description
NamedValuesBasedPredicateDefinitionContext(SearchPredicateFactory<SR> factory, Map<String,Object> params, Function<String,SearchException> namedValueMissing)

Method Summary

Modifier and Type	Method	Description
NamedValues	params()
SearchPredicateFactory<SR>	predicate()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hibernate.search.engine.search.predicate.definition.PredicateDefinitionContext

param, param, paramOptional, paramOptional

Constructor Details

NamedValuesBasedPredicateDefinitionContext

public NamedValuesBasedPredicateDefinitionContext(SearchPredicateFactory<SR> factory,
 Map<String,Object> params,
 Function<String,SearchException> namedValueMissing)

Method Details

predicate

public SearchPredicateFactory<SR> predicate()

Specified by:

predicate in interface PredicateDefinitionContext<SR>

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<SR>) returns.

See Also:

• SearchPredicateFactory

params

public NamedValues params()

Specified by:

params in interface PredicateDefinitionContext<SR>

Returns:

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

See Also:

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