Uses of Interface
org.hibernate.search.engine.search.predicate.dsl.PredicateFinalStep

Packages that use PredicateFinalStep

Package	Description
org.hibernate.search.backend.elasticsearch.search.predicate.dsl
org.hibernate.search.backend.lucene.search.predicate.dsl
org.hibernate.search.engine.search.aggregation.dsl
org.hibernate.search.engine.search.predicate.dsl
org.hibernate.search.engine.search.predicate.dsl.spi
org.hibernate.search.engine.search.predicate.spi
org.hibernate.search.engine.search.query.dsl
org.hibernate.search.engine.search.query.dsl.spi
org.hibernate.search.engine.search.sort.dsl

Uses of PredicateFinalStep in org.hibernate.search.backend.elasticsearch.search.predicate.dsl

Methods in org.hibernate.search.backend.elasticsearch.search.predicate.dsl that return PredicateFinalStep

Modifier and Type	Method	Description
PredicateFinalStep	ElasticsearchSearchPredicateFactory.fromJson(com.google.gson.JsonObject jsonObject)	Create a predicate from JSON.
PredicateFinalStep	ElasticsearchSearchPredicateFactory.fromJson(String jsonString)	Create a predicate from JSON.

Uses of PredicateFinalStep in org.hibernate.search.backend.lucene.search.predicate.dsl

Methods in org.hibernate.search.backend.lucene.search.predicate.dsl that return PredicateFinalStep

Modifier and Type	Method	Description
PredicateFinalStep	LuceneSearchPredicateFactory.fromLuceneQuery(Query query)	Create a predicate from a Lucene Query.

Uses of PredicateFinalStep in org.hibernate.search.engine.search.aggregation.dsl

Methods in org.hibernate.search.engine.search.aggregation.dsl with parameters of type PredicateFinalStep

Modifier and Type	Method	Description
default S	AggregationFilterStep.filter(PredicateFinalStep dslFinalStep)	Filter nested objects from which values will be extracted for this aggregation.

Method parameters in org.hibernate.search.engine.search.aggregation.dsl with type arguments of type PredicateFinalStep

Modifier and Type	Method	Description
S	AggregationFilterStep.filter(Function<? super PDF,? extends PredicateFinalStep> clauseContributor)	Filter nested objects from which values will be extracted for this aggregation.

Uses of PredicateFinalStep in org.hibernate.search.engine.search.predicate.dsl

Subinterfaces of PredicateFinalStep in org.hibernate.search.engine.search.predicate.dsl

Modifier and Type	Interface	Description
interface	BooleanPredicateClausesStep<SR,S extends BooleanPredicateClausesStep<SR,?>>	The initial and final step in a boolean predicate definition, where clauses can be added.
interface	CommonQueryStringPredicateOptionsStep<S extends CommonQueryStringPredicateOptionsStep<?>>	The final step in a query string predicate definition, where optional parameters can be set.
interface	ExistsPredicateOptionsStep<S extends ExistsPredicateOptionsStep<?>>	The final step in an "exists" predicate definition, where optional parameters can be set.
interface	GenericBooleanPredicateClausesStep<SR,S extends C,C extends BooleanPredicateOptionsCollector<SR,?>>	A generic superinterface for Predicate DSL steps that involve collecting clauses and options of a boolean predicate.
interface	GenericSimpleBooleanPredicateClausesStep<SR,S extends C,C extends SimpleBooleanPredicateClausesCollector<SR,?>>	A generic superinterface for "simple boolean predicate" DSL steps that involve collecting clauses.
interface	KnnPredicateOptionsStep<SR>	The final step in a "knn" predicate definition, where optional parameters can be set.
interface	MatchAllPredicateOptionsStep<SR,S extends MatchAllPredicateOptionsStep<SR,?>>	The initial and final step in "match all" predicate definition, where optional parameters can be set.
interface	MatchIdPredicateMatchingMoreStep<S extends MatchIdPredicateMatchingMoreStep<?,N>,N extends MatchIdPredicateOptionsStep<?>>	The final step in a "match id" predicate definition, where more IDs to match can be set.
interface	MatchIdPredicateOptionsStep<S extends MatchIdPredicateOptionsStep<?>>	The final step in a "match id" predicate definition, where optional parameters can be set.
interface	MatchNonePredicateFinalStep	The initial and final step in "match none" predicate definition.
interface	MatchPredicateOptionsStep<S extends MatchPredicateOptionsStep<?>>	The final step in a "match" predicate definition, where optional parameters can be set.
interface	NamedPredicateOptionsStep	The initial and final step in named predicate definition.
interface	NestedPredicateClausesStep<SR,S extends NestedPredicateClausesStep<SR,?>>	The step in a nested predicate definition where clauses can be added.
interface	NestedPredicateOptionsStep<S extends NestedPredicateOptionsStep<?>>	Deprecated. Use SearchPredicateFactory.nested(String) instead.
interface	NotPredicateFinalStep	The initial and final step in "not" predicate definition.
interface	PhrasePredicateOptionsStep<S extends PhrasePredicateOptionsStep<?>>	The final step in a "phrase" predicate definition, where optional parameters can be set.
interface	PrefixPredicateOptionsStep<S extends PrefixPredicateOptionsStep<?>>	The final step in a "prefix" predicate definition, where optional parameters can be set.
interface	QueryStringPredicateOptionsStep<S extends QueryStringPredicateOptionsStep<?>>	The final step in a "query string" predicate definition, where optional parameters can be set.
interface	RangePredicateOptionsStep<S extends RangePredicateOptionsStep<?>>	The final step in a "range" predicate definition, where optional parameters can be set.
interface	RegexpPredicateOptionsStep<S extends RegexpPredicateOptionsStep<?>>	The final step in a "regexp" predicate definition, where optional parameters can be set.
interface	SimpleBooleanPredicateClausesStep<SR,S extends SimpleBooleanPredicateClausesStep<SR,?>>	The initial and final step in a "simple boolean predicate" definition, where clauses can be added and options can be set.
interface	SimpleBooleanPredicateOptionsStep<S extends SimpleBooleanPredicateOptionsStep<?>>	The initial and final step in a "simple boolean predicate" definition, where options can be set.
interface	SimpleQueryStringPredicateOptionsStep<S extends SimpleQueryStringPredicateOptionsStep<?>>	The final step in a "simple query string" predicate definition, where optional parameters can be set.
interface	SpatialWithinPredicateOptionsStep<S extends SpatialWithinPredicateOptionsStep<?>>	The final step in a "within" predicate definition, where optional parameters can be set.
interface	TermsPredicateOptionsStep<S extends TermsPredicateOptionsStep<?>>	The final step in a "terms" predicate definition, where optional parameters can be set.
interface	WildcardPredicateOptionsStep<S extends WildcardPredicateOptionsStep<?>>	The final step in a "wildcard" predicate definition, where optional parameters can be set.

Methods in org.hibernate.search.engine.search.predicate.dsl that return PredicateFinalStep

Modifier and Type	Method	Description
PredicateFinalStep	SearchPredicateFactory.bool(Consumer<? super BooleanPredicateClausesStep<SR,?>> clauseContributor)	Deprecated. Use .bool().with(...) instead.
PredicateFinalStep	SearchPredicateFactoryExtensionIfSupportedMoreStep.orElse(Function<SearchPredicateFactory<SR>,? extends PredicateFinalStep> predicateContributor)	If no extension passed to SearchPredicateFactoryExtensionIfSupportedStep.ifSupported(SearchPredicateFactoryExtension, Function) was supported so far, apply the given consumer to the current (non-extended) SearchPredicateFactory; otherwise return the predicate created in the first succeeding ifSupported call.
PredicateFinalStep	SearchPredicateFactoryExtensionIfSupportedMoreStep.orElseFail()	If no extension passed to SearchPredicateFactoryExtensionIfSupportedStep.ifSupported(SearchPredicateFactoryExtension, Function) was supported so far, throw an exception; otherwise return the predicate created in the first succeeding ifSupported call.
PredicateFinalStep	SearchPredicateFactory.withParameters(Function<? super NamedValues,? extends PredicateFinalStep> predicateCreator)	Delegating predicate that creates the actual predicate at query create time and provides access to query parameters.

Methods in org.hibernate.search.engine.search.predicate.dsl with parameters of type PredicateFinalStep

Modifier and Type	Method	Description
default S	GenericSimpleBooleanPredicateClausesStep.add(PredicateFinalStep searchPredicate)
S	SimpleBooleanPredicateClausesCollector.add(PredicateFinalStep searchPredicate)	Adds the specified predicate to the list of clauses.
SimpleBooleanPredicateOptionsStep<?>	SearchPredicateFactory.and(PredicateFinalStep firstSearchPredicate, PredicateFinalStep... otherSearchPredicates)	Match documents if they match all clauses.
default S	MatchAllPredicateOptionsStep.except(PredicateFinalStep dslFinalStep)	Add a "must not" clause based on an almost-built SearchPredicate.
default S	BooleanPredicateOptionsCollector.filter(PredicateFinalStep dslFinalStep)	Add a "filter" clause based on an almost-built SearchPredicate.
default S	GenericBooleanPredicateClausesStep.filter(PredicateFinalStep dslFinalStep)
default KnnPredicateOptionsStep<SR>	KnnPredicateOptionsStep.filter(PredicateFinalStep searchPredicate)
default S	BooleanPredicateOptionsCollector.must(PredicateFinalStep dslFinalStep)	Add a "must" clause based on an almost-built SearchPredicate.
default S	GenericBooleanPredicateClausesStep.must(PredicateFinalStep dslFinalStep)
default S	BooleanPredicateOptionsCollector.mustNot(PredicateFinalStep dslFinalStep)	Add a "must not" clause based on an almost-built SearchPredicate.
default S	GenericBooleanPredicateClausesStep.mustNot(PredicateFinalStep dslFinalStep)
default N	NestedPredicateNestStep.nest(PredicateFinalStep dslFinalStep)	Deprecated. Set the inner predicate to an almost-built SearchPredicate.
NotPredicateFinalStep	SearchPredicateFactory.not(PredicateFinalStep searchPredicate)	Match documents that do not satisfy the passed in predicate.
SimpleBooleanPredicateOptionsStep<?>	SearchPredicateFactory.or(PredicateFinalStep firstSearchPredicate, PredicateFinalStep... otherSearchPredicates)	Match documents if they match any clause.
default S	BooleanPredicateOptionsCollector.should(PredicateFinalStep dslFinalStep)	Add a "should" clause based on an almost-built SearchPredicate.
default S	GenericBooleanPredicateClausesStep.should(PredicateFinalStep dslFinalStep)

Method parameters in org.hibernate.search.engine.search.predicate.dsl with type arguments of type PredicateFinalStep

Modifier and Type	Method	Description
S	GenericSimpleBooleanPredicateClausesStep.add(Function<? super SearchPredicateFactory<SR>,? extends PredicateFinalStep> clauseContributor)
S	SimpleBooleanPredicateClausesCollector.add(Function<? super SearchPredicateFactory<SR>,? extends PredicateFinalStep> clauseContributor)	Adds a clause to be defined by the given function.
S	MatchAllPredicateOptionsStep.except(Function<? super SearchPredicateFactory<SR>,? extends PredicateFinalStep> clauseContributor)	Add a "must not" clause to be defined by the given function.
S	BooleanPredicateOptionsCollector.filter(Function<? super SearchPredicateFactory<SR>,? extends PredicateFinalStep> clauseContributor)	Add a "filter" clause to be defined by the given function.
S	GenericBooleanPredicateClausesStep.filter(Function<? super SearchPredicateFactory<SR>,? extends PredicateFinalStep> clauseContributor)
KnnPredicateOptionsStep<SR>	KnnPredicateOptionsStep.filter(Function<? super SearchPredicateFactory<SR>,? extends PredicateFinalStep> clauseContributor)
<T> SearchPredicateFactoryExtensionIfSupportedMoreStep<SR>	SearchPredicateFactoryExtensionIfSupportedStep.ifSupported(SearchPredicateFactoryExtension<SR,T> extension, Function<T,? extends PredicateFinalStep> predicateContributor)	If the given extension is supported, and none of the previous extensions passed to SearchPredicateFactoryExtensionIfSupportedStep.ifSupported(SearchPredicateFactoryExtension, Function) was supported, extend the current factory with this extension, apply the given function to the extended factory, and store the resulting predicate for later retrieval.
S	BooleanPredicateOptionsCollector.must(Function<? super SearchPredicateFactory<SR>,? extends PredicateFinalStep> clauseContributor)	Add a "must" clause to be defined by the given function.
S	GenericBooleanPredicateClausesStep.must(Function<? super SearchPredicateFactory<SR>,? extends PredicateFinalStep> clauseContributor)
S	BooleanPredicateOptionsCollector.mustNot(Function<? super SearchPredicateFactory<SR>,? extends PredicateFinalStep> clauseContributor)	Add a "must not" clause to be defined by the given function.
S	GenericBooleanPredicateClausesStep.mustNot(Function<? super SearchPredicateFactory<SR>,? extends PredicateFinalStep> clauseContributor)
N	NestedPredicateNestStep.nest(Function<? super SearchPredicateFactory<SR>,? extends PredicateFinalStep> predicateContributor)	Deprecated. Set the inner predicate defined by the given function.
PredicateFinalStep	SearchPredicateFactoryExtensionIfSupportedMoreStep.orElse(Function<SearchPredicateFactory<SR>,? extends PredicateFinalStep> predicateContributor)	If no extension passed to SearchPredicateFactoryExtensionIfSupportedStep.ifSupported(SearchPredicateFactoryExtension, Function) was supported so far, apply the given consumer to the current (non-extended) SearchPredicateFactory; otherwise return the predicate created in the first succeeding ifSupported call.
S	BooleanPredicateOptionsCollector.should(Function<? super SearchPredicateFactory<SR>,? extends PredicateFinalStep> clauseContributor)	Add a "should" clause to be defined by the given function.
S	GenericBooleanPredicateClausesStep.should(Function<? super SearchPredicateFactory<SR>,? extends PredicateFinalStep> clauseContributor)
PredicateFinalStep	SearchPredicateFactory.withParameters(Function<? super NamedValues,? extends PredicateFinalStep> predicateCreator)	Delegating predicate that creates the actual predicate at query create time and provides access to query parameters.

Uses of PredicateFinalStep in org.hibernate.search.engine.search.predicate.dsl.spi

Classes in org.hibernate.search.engine.search.predicate.dsl.spi that implement PredicateFinalStep

Modifier and Type	Class	Description
class	AbstractPredicateFinalStep	An abstract base for PredicateFinalStep implementations.
final class	StaticPredicateFinalStep

Methods in org.hibernate.search.engine.search.predicate.dsl.spi that return PredicateFinalStep

Modifier and Type	Method	Description
PredicateFinalStep	AbstractSearchPredicateFactory.bool(Consumer<? super BooleanPredicateClausesStep<SR,?>> clauseContributor)
PredicateFinalStep	AbstractSearchPredicateFactory.withParameters(Function<? super NamedValues,? extends PredicateFinalStep> predicateCreator)

Methods in org.hibernate.search.engine.search.predicate.dsl.spi with parameters of type PredicateFinalStep

Modifier and Type	Method	Description
SimpleBooleanPredicateOptionsStep<?>	AbstractSearchPredicateFactory.and(PredicateFinalStep firstSearchPredicate, PredicateFinalStep... otherSearchPredicate)
NotPredicateFinalStep	AbstractSearchPredicateFactory.not(PredicateFinalStep searchPredicate)
SimpleBooleanPredicateOptionsStep<?>	AbstractSearchPredicateFactory.or(PredicateFinalStep firstSearchPredicate, PredicateFinalStep... otherSearchPredicate)

Method parameters in org.hibernate.search.engine.search.predicate.dsl.spi with type arguments of type PredicateFinalStep

Modifier and Type	Method	Description
PredicateFinalStep	AbstractSearchPredicateFactory.withParameters(Function<? super NamedValues,? extends PredicateFinalStep> predicateCreator)

Uses of PredicateFinalStep in org.hibernate.search.engine.search.predicate.spi

Method parameters in org.hibernate.search.engine.search.predicate.spi with type arguments of type PredicateFinalStep

Modifier and Type	Method	Description
void	WithParametersPredicateBuilder.creator(Function<? super NamedValues,? extends PredicateFinalStep> predicateDefinition)

Uses of PredicateFinalStep in org.hibernate.search.engine.search.query.dsl

Method parameters in org.hibernate.search.engine.search.query.dsl with type arguments of type PredicateFinalStep

Modifier and Type	Method	Description
N	SearchQueryWhereStep.where(Function<? super PDF,? extends PredicateFinalStep> predicateContributor)	Set the predicate for this query.

Uses of PredicateFinalStep in org.hibernate.search.engine.search.query.dsl.spi

Method parameters in org.hibernate.search.engine.search.query.dsl.spi with type arguments of type PredicateFinalStep

Modifier and Type	Method	Description
SearchQueryOptionsStep<SR,?,E,LOS,?,?>	AbstractDelegatingSearchQuerySelectStep.where(Function<? super SearchPredicateFactory<SR>,? extends PredicateFinalStep> predicateContributor)
S	AbstractSearchQueryOptionsStep.where(Function<? super PDF,? extends PredicateFinalStep> predicateContributor)

Uses of PredicateFinalStep in org.hibernate.search.engine.search.sort.dsl

Methods in org.hibernate.search.engine.search.sort.dsl with parameters of type PredicateFinalStep

Modifier and Type	Method	Description
default S	SortFilterStep.filter(PredicateFinalStep dslFinalStep)	Filter nested objects from which values will be extracted for this sort.

Method parameters in org.hibernate.search.engine.search.sort.dsl with type arguments of type PredicateFinalStep

Modifier and Type	Method	Description
S	SortFilterStep.filter(Function<? super PDF,? extends PredicateFinalStep> clauseContributor)	Filter nested objects from which values will be extracted for this sort.