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

Packages that use SearchPredicateFactory

Package	Description
org.hibernate.search.backend.elasticsearch
org.hibernate.search.backend.elasticsearch.search.predicate.dsl
org.hibernate.search.backend.lucene
org.hibernate.search.backend.lucene.search.predicate.dsl
org.hibernate.search.engine.mapper.scope.spi
org.hibernate.search.engine.search.aggregation.dsl
org.hibernate.search.engine.search.aggregation.dsl.spi
org.hibernate.search.engine.search.predicate.definition
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.query.spi
org.hibernate.search.engine.search.sort.dsl
org.hibernate.search.engine.search.sort.dsl.spi
org.hibernate.search.mapper.orm.scope
org.hibernate.search.mapper.pojo.scope.spi
org.hibernate.search.mapper.pojo.standalone.scope

Uses of SearchPredicateFactory in org.hibernate.search.backend.elasticsearch

Methods in org.hibernate.search.backend.elasticsearch with parameters of type SearchPredicateFactory

Modifier and Type	Method	Description
Optional<ElasticsearchSearchPredicateFactory>	ElasticsearchExtension.extendOptional(SearchPredicateFactory original)	Attempt to extend a given factory, returning an empty Optional in case of failure.

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

Subinterfaces of SearchPredicateFactory in org.hibernate.search.backend.elasticsearch.search.predicate.dsl

Modifier and Type	Interface	Description
interface	ElasticsearchSearchPredicateFactory	A factory for search predicates with some Elasticsearch-specific methods.

Uses of SearchPredicateFactory in org.hibernate.search.backend.lucene

Methods in org.hibernate.search.backend.lucene with parameters of type SearchPredicateFactory

Modifier and Type	Method	Description
Optional<LuceneSearchPredicateFactory>	LuceneExtension.extendOptional(SearchPredicateFactory original)	Attempt to extend a given factory, returning an empty Optional in case of failure.

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

Subinterfaces of SearchPredicateFactory in org.hibernate.search.backend.lucene.search.predicate.dsl

Modifier and Type	Interface	Description
interface	LuceneSearchPredicateFactory	A factory for search predicates with some Lucene-specific methods.

Uses of SearchPredicateFactory in org.hibernate.search.engine.mapper.scope.spi

Methods in org.hibernate.search.engine.mapper.scope.spi that return SearchPredicateFactory

Modifier and Type	Method	Description
SearchPredicateFactory	MappedIndexScope.predicate()

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

Classes in org.hibernate.search.engine.search.aggregation.dsl with type parameters of type SearchPredicateFactory

Modifier and Type	Interface	Description
interface	AggregationFilterStep<S,PDF extends SearchPredicateFactory>	The step in an aggregation definition where a filter can be set to select nested objects from which values will be extracted for this aggregation.
interface	AvgAggregationFieldStep<PDF extends SearchPredicateFactory>	The initial step in an "avg" aggregation definition, where the target field can be set.
interface	AvgAggregationOptionsStep<S extends AvgAggregationOptionsStep<?,PDF,F>,PDF extends SearchPredicateFactory,F>	The final step in a "avg" aggregation definition, where optional parameters can be set.
interface	CountAggregationFieldStep<PDF extends SearchPredicateFactory>	The initial step in a "count" aggregation definition, where the target field can be set.
interface	CountAggregationOptionsStep<S extends CountAggregationOptionsStep<?,PDF>,PDF extends SearchPredicateFactory>	The final step in a "count" aggregation definition, where optional parameters can be set.
interface	CountDistinctAggregationFieldStep<PDF extends SearchPredicateFactory>	The initial step in a "count distinct" aggregation definition, where the target field can be set.
interface	CountDistinctAggregationOptionsStep<S extends CountDistinctAggregationOptionsStep<?,PDF>,PDF extends SearchPredicateFactory>	The final step in a "count distinct" aggregation definition, where optional parameters can be set.
interface	ExtendedSearchAggregationFactory<S extends ExtendedSearchAggregationFactory<?,PDF>,PDF extends SearchPredicateFactory>	A base interface for subtypes of SearchAggregationFactory allowing to easily override the self type and predicate factory type for all relevant methods.
interface	MaxAggregationFieldStep<PDF extends SearchPredicateFactory>	The initial step in a "min" aggregation definition, where the target field can be set.
interface	MaxAggregationOptionsStep<S extends MaxAggregationOptionsStep<?,PDF,F>,PDF extends SearchPredicateFactory,F>	The final step in a "max" aggregation definition, where optional parameters can be set.
interface	MinAggregationFieldStep<PDF extends SearchPredicateFactory>	The initial step in a "min" aggregation definition, where the target field can be set.
interface	MinAggregationOptionsStep<S extends MinAggregationOptionsStep<?,PDF,F>,PDF extends SearchPredicateFactory,F>	The final step in a "min" aggregation definition, where optional parameters can be set.
interface	RangeAggregationFieldStep<PDF extends SearchPredicateFactory>	The initial step in a "range" aggregation definition, where the target field can be set.
interface	RangeAggregationOptionsStep<S extends RangeAggregationOptionsStep<?,PDF,F,A>,PDF extends SearchPredicateFactory,F,A>	The final step in a "range" aggregation definition, where optional parameters can be set.
interface	RangeAggregationRangeMoreStep<S extends RangeAggregationRangeMoreStep<?,?,PDF,F>,N extends RangeAggregationOptionsStep<?,PDF,F,Map<Range<F>,Long>>,PDF extends SearchPredicateFactory,F>	The step in a "range" aggregation definition where optional parameters can be set, (see the superinterface RangeAggregationOptionsStep), or more ranges can be added.
interface	RangeAggregationRangeStep<N extends RangeAggregationRangeMoreStep<?,?,PDF,F>,PDF extends SearchPredicateFactory,F>	The step in a "range" aggregation definition where the ranges can be set.
interface	SumAggregationFieldStep<PDF extends SearchPredicateFactory>	The initial step in a "sum" aggregation definition, where the target field can be set.
interface	SumAggregationOptionsStep<S extends SumAggregationOptionsStep<?,PDF,F>,PDF extends SearchPredicateFactory,F>	The final step in a "sum" aggregation definition, where optional parameters can be set.
interface	TermsAggregationFieldStep<PDF extends SearchPredicateFactory>	The initial step in a "terms" aggregation definition, where the target field can be set.
interface	TermsAggregationOptionsStep<S extends TermsAggregationOptionsStep<?,PDF,F,A>,PDF extends SearchPredicateFactory,F,A>	The final step in a "terms" aggregation definition, where optional parameters can be set.

Uses of SearchPredicateFactory in org.hibernate.search.engine.search.aggregation.dsl.spi

Classes in org.hibernate.search.engine.search.aggregation.dsl.spi with type parameters of type SearchPredicateFactory

Modifier and Type	Class	Description
class	AbstractSearchAggregationFactory<S extends ExtendedSearchAggregationFactory<S,PDF>,SC extends SearchAggregationIndexScope<?>,PDF extends SearchPredicateFactory>
class	SearchAggregationDslContext<SC extends SearchAggregationIndexScope<?>,PDF extends SearchPredicateFactory>	Represents the current context in the search DSL, including in particular the search scope and the aggregation builder factory.

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

Modifier and Type	Method	Description
static <SC extends SearchAggregationIndexScope<?>, PDF extends SearchPredicateFactory> SearchAggregationDslContext<SC,PDF>	SearchAggregationDslContext.root(SC scope, PDF predicateFactory)

Uses of SearchPredicateFactory in org.hibernate.search.engine.search.predicate.definition

Methods in org.hibernate.search.engine.search.predicate.definition that return SearchPredicateFactory

Modifier and Type	Method	Description
SearchPredicateFactory	PredicateDefinitionContext.predicate()

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

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

Modifier and Type	Interface	Description
interface	ExtendedSearchPredicateFactory<S extends ExtendedSearchPredicateFactory<?>>	A base interface for subtypes of SearchPredicateFactory allowing to easily override the self type for all relevant methods.

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

Modifier and Type	Method	Description
SearchPredicateFactory	SearchPredicateFactory.withRoot(String objectFieldPath)	Create a new predicate factory whose root for all paths passed to the DSL will be the given object field.

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

Modifier and Type	Method	Description
Optional<T>	SearchPredicateFactoryExtension.extendOptional(SearchPredicateFactory original)	Attempt to extend a given factory, returning an empty Optional in case of failure.

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

Modifier and Type	Method	Description
S	GenericSimpleBooleanPredicateClausesStep.add(Function<? super SearchPredicateFactory,? extends PredicateFinalStep> clauseContributor)
S	SimpleBooleanPredicateClausesCollector.add(Function<? super SearchPredicateFactory,? extends PredicateFinalStep> clauseContributor)	Adds a clause to be defined by the given function.
S	MatchAllPredicateOptionsStep.except(Function<? super SearchPredicateFactory,? extends PredicateFinalStep> clauseContributor)	Add a "must not" clause to be defined by the given function.
S	BooleanPredicateOptionsCollector.filter(Function<? super SearchPredicateFactory,? extends PredicateFinalStep> clauseContributor)	Add a "filter" clause to be defined by the given function.
S	GenericBooleanPredicateClausesStep.filter(Function<? super SearchPredicateFactory,? extends PredicateFinalStep> clauseContributor)
KnnPredicateOptionsStep	KnnPredicateOptionsStep.filter(Function<? super SearchPredicateFactory,? extends PredicateFinalStep> clauseContributor)
S	BooleanPredicateOptionsCollector.must(Function<? super SearchPredicateFactory,? extends PredicateFinalStep> clauseContributor)	Add a "must" clause to be defined by the given function.
S	GenericBooleanPredicateClausesStep.must(Function<? super SearchPredicateFactory,? extends PredicateFinalStep> clauseContributor)
S	BooleanPredicateOptionsCollector.mustNot(Function<? super SearchPredicateFactory,? extends PredicateFinalStep> clauseContributor)	Add a "must not" clause to be defined by the given function.
S	GenericBooleanPredicateClausesStep.mustNot(Function<? super SearchPredicateFactory,? extends PredicateFinalStep> clauseContributor)
N	NestedPredicateNestStep.nest(Function<? super SearchPredicateFactory,? extends PredicateFinalStep> predicateContributor)	Deprecated. Set the inner predicate defined by the given function.
PredicateFinalStep	SearchPredicateFactoryExtensionIfSupportedMoreStep.orElse(Function<SearchPredicateFactory,? 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,? extends PredicateFinalStep> clauseContributor)	Add a "should" clause to be defined by the given function.
S	GenericBooleanPredicateClausesStep.should(Function<? super SearchPredicateFactory,? extends PredicateFinalStep> clauseContributor)

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

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

Modifier and Type	Class	Description
class	AbstractSearchPredicateFactory<S extends ExtendedSearchPredicateFactory<S>,SC extends SearchPredicateIndexScope<?>>

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

Methods in org.hibernate.search.engine.search.predicate.spi that return SearchPredicateFactory

Modifier and Type	Method	Description
SearchPredicateFactory	NamedValuesBasedPredicateDefinitionContext.predicate()

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

Modifier and Type	Method	Description
void	NamedPredicateBuilder.factory(SearchPredicateFactory factory)

Constructors in org.hibernate.search.engine.search.predicate.spi with parameters of type SearchPredicateFactory

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

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

Classes in org.hibernate.search.engine.search.query.dsl with type parameters of type SearchPredicateFactory

Modifier and Type	Interface	Description
interface	SearchQuerySelectStep<N extends SearchQueryOptionsStep<?,E,LOS,?,?>,R,E,LOS,PJF extends SearchProjectionFactory<R,E>,PDF extends SearchPredicateFactory>	The initial step in a query definition, where the element used to represent query hits, i.e. the "SELECT" clause, can be set.
interface	SearchQueryWhereStep<N extends SearchQueryOptionsStep<?,H,LOS,?,?>,H,LOS,PDF extends SearchPredicateFactory>	The step in a query definition where the predicate, i.e. the "WHERE" clause, can be set.

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

Classes in org.hibernate.search.engine.search.query.dsl.spi with type parameters of type SearchPredicateFactory

Modifier and Type	Class	Description
class	AbstractExtendedSearchQueryOptionsStep<S extends SearchQueryOptionsStep<S,H,LOS,SF,AF>,H,R extends SearchResult<H>,SCR extends SearchScroll<H>,LOS,PDF extends SearchPredicateFactory,SF extends SearchSortFactory,AF extends SearchAggregationFactory,SC extends SearchQueryIndexScope<?>>
class	AbstractSearchQueryOptionsStep<S extends SearchQueryOptionsStep<S,H,LOS,SF,AF>,H,LOS,PDF extends SearchPredicateFactory,SF extends SearchSortFactory,AF extends SearchAggregationFactory,SC extends SearchQueryIndexScope<?>>
class	AbstractSearchQuerySelectStep<N extends SearchQueryOptionsStep<?,E,LOS,?,?>,R,E,LOS,PJF extends SearchProjectionFactory<R,E>,PDF extends SearchPredicateFactory>

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

Modifier and Type	Method	Description
SearchQueryOptionsStep<?,E,LOS,?,?>	AbstractDelegatingSearchQuerySelectStep.where(BiConsumer<? super SearchPredicateFactory,? super SimpleBooleanPredicateClausesCollector<?>> predicateContributor)
SearchQueryOptionsStep<?,E,LOS,?,?>	AbstractDelegatingSearchQuerySelectStep.where(Function<? super SearchPredicateFactory,? extends PredicateFinalStep> predicateContributor)

Uses of SearchPredicateFactory in org.hibernate.search.engine.search.query.spi

Methods in org.hibernate.search.engine.search.query.spi that return SearchPredicateFactory

Modifier and Type	Method	Description
SearchPredicateFactory	SearchQueryIndexScope.predicateFactory()

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

Classes in org.hibernate.search.engine.search.sort.dsl with type parameters of type SearchPredicateFactory

Modifier and Type	Interface	Description
interface	DistanceSortOptionsStep<S extends DistanceSortOptionsStep<?,PDF>,PDF extends SearchPredicateFactory>	The initial and final step in a "distance" sort definition, where optional parameters can be set.
interface	ExtendedSearchSortFactory<S extends ExtendedSearchSortFactory<?,PDF>,PDF extends SearchPredicateFactory>	A base interface for subtypes of SearchSortFactory allowing to easily override the self type and predicate factory type for all relevant methods.
interface	FieldSortOptionsStep<S extends FieldSortOptionsStep<?,PDF>,PDF extends SearchPredicateFactory>	The initial and final step in a "field" sort definition, where optional parameters can be set.
interface	SortFilterStep<S,PDF extends SearchPredicateFactory>	The step in a sort definition where a filter can be set to select nested objects from which values will be extracted for this sort.

Methods in org.hibernate.search.engine.search.sort.dsl that return types with arguments of type SearchPredicateFactory

Modifier and Type	Method	Description
default DistanceSortOptionsStep<?,? extends SearchPredicateFactory>	SearchSortFactory.distance(String fieldPath, double latitude, double longitude)	Order elements by the distance from the location stored in the specified field to the location specified.
DistanceSortOptionsStep<?,? extends SearchPredicateFactory>	SearchSortFactory.distance(String fieldPath, GeoPoint location)	Order elements by the distance from the location stored in the specified field to the location specified.
FieldSortOptionsStep<?,? extends SearchPredicateFactory>	SearchSortFactory.field(String fieldPath)	Order elements by the value of a specific field.

Uses of SearchPredicateFactory in org.hibernate.search.engine.search.sort.dsl.spi

Classes in org.hibernate.search.engine.search.sort.dsl.spi with type parameters of type SearchPredicateFactory

Modifier and Type	Class	Description
class	AbstractSearchSortFactory<S extends ExtendedSearchSortFactory<S,PDF>,SC extends SearchSortIndexScope<?>,PDF extends SearchPredicateFactory>
final class	SearchSortDslContext<SC extends SearchSortIndexScope<?>,PDF extends SearchPredicateFactory>	Represents the current context in the search DSL, including in particular the search scope, the sort builder factory and the knowledge of previous sorts chained using SortThenStep.then().

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

Modifier and Type	Method	Description
static <SC extends SearchSortIndexScope<?>, PDF extends SearchPredicateFactory> SearchSortDslContext<SC,PDF>	SearchSortDslContext.root(SC scope, Function<SearchSortDslContext<SC,PDF>,SearchSortFactory> factoryProvider, PDF predicateFactory)

Uses of SearchPredicateFactory in org.hibernate.search.mapper.orm.scope

Methods in org.hibernate.search.mapper.orm.scope that return SearchPredicateFactory

Modifier and Type	Method	Description
SearchPredicateFactory	SearchScope.predicate()	Initiate the building of a search predicate.

Uses of SearchPredicateFactory in org.hibernate.search.mapper.pojo.scope.spi

Methods in org.hibernate.search.mapper.pojo.scope.spi that return SearchPredicateFactory

Modifier and Type	Method	Description
SearchPredicateFactory	PojoScopeDelegate.predicate()

Uses of SearchPredicateFactory in org.hibernate.search.mapper.pojo.standalone.scope

Methods in org.hibernate.search.mapper.pojo.standalone.scope that return SearchPredicateFactory

Modifier and Type	Method	Description
SearchPredicateFactory	SearchScope.predicate()	Initiate the building of a search predicate.