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

Class AbstractSearchPredicateFactory<S extends ExtendedSearchPredicateFactory<S>,SC extends SearchPredicateIndexScope<?>>

java.lang.Object

org.hibernate.search.engine.search.predicate.dsl.spi.AbstractSearchPredicateFactory<S,SC>

All Implemented Interfaces:

ExtendedSearchPredicateFactory<S>, SearchPredicateFactory

public abstract class AbstractSearchPredicateFactory<S extends ExtendedSearchPredicateFactory<S>,SC extends SearchPredicateIndexScope<?>>
extends Object
implements ExtendedSearchPredicateFactory<S>

Field Summary

Fields

Modifier and Type	Field	Description
protected final SearchPredicateDslContext<SC>	dslContext

Constructor Summary

Constructors

Constructor	Description
AbstractSearchPredicateFactory(SearchPredicateDslContext<SC> dslContext)

Method Summary

Modifier and Type	Method	Description
SimpleBooleanPredicateClausesStep<?>	and()	Match documents if they match all inner clauses.
SimpleBooleanPredicateOptionsStep<?>	and(PredicateFinalStep firstSearchPredicate, PredicateFinalStep... otherSearchPredicate)	Match documents if they match all clauses.
SimpleBooleanPredicateOptionsStep<?>	and(SearchPredicate firstSearchPredicate, SearchPredicate... otherSearchPredicates)	Match documents if they match all previously-built SearchPredicate.
BooleanPredicateClausesStep<?>	bool()	Match documents if they match a combination of boolean clauses.
PredicateFinalStep	bool(Consumer<? super BooleanPredicateClausesStep<?>> clauseContributor)	Match documents if they match a combination of boolean clauses, which will be defined by the given consumer.
ExistsPredicateFieldStep<?>	exists()	Match documents where a given field exists.
SearchPredicateFactoryExtensionIfSupportedStep	extension()	Create a DSL step allowing multiple attempts to apply extensions one after the other, failing only if none of the extensions is supported.
<T> T	extension(SearchPredicateFactoryExtension<T> extension)	Extend the current factory with the given extension, resulting in an extended factory offering different types of predicates.
MatchIdPredicateMatchingStep<?>	id()	Match documents where the identifier is among the given values.
KnnPredicateFieldStep	knn(int k)	Match k documents whose vector field value is nearest to the given vector.
MatchPredicateFieldStep<?>	match()	Match documents where targeted fields have a value that "matches" a given single value.
MatchAllPredicateOptionsStep<?>	matchAll()	Match all documents.
MatchNonePredicateFinalStep	matchNone()	Match none of the documents.
NamedPredicateOptionsStep	named(String path)	Match documents if they match a combination of defined named predicate clauses.
NestedPredicateFieldStep<?>	nested()	Deprecated.
NestedPredicateClausesStep<?>	nested(String objectFieldPath)	Match documents where a nested object matches inner predicates to be defined in the next steps.
NotPredicateFinalStep	not(PredicateFinalStep searchPredicate)	Match documents that do not satisfy the passed in predicate.
NotPredicateFinalStep	not(SearchPredicate searchPredicate)	Match documents that do not satisfy the passed in previously-built SearchPredicate.
SimpleBooleanPredicateClausesStep<?>	or()	Match documents if they match any inner clause.
SimpleBooleanPredicateOptionsStep<?>	or(PredicateFinalStep firstSearchPredicate, PredicateFinalStep... otherSearchPredicate)	Match documents if they match any clause.
SimpleBooleanPredicateOptionsStep<?>	or(SearchPredicate firstSearchPredicate, SearchPredicate... otherSearchPredicate)	Match documents if they match any previously-built SearchPredicate.
PhrasePredicateFieldStep<?>	phrase()	Match documents where targeted fields have a value that contains a given phrase.
PrefixPredicateFieldStep<?>	prefix()	Match documents where targeted fields have a value that starts with a given string.
QueryStringPredicateFieldStep<?>	queryString()	Match documents according to a given query string, using the Lucene's query language.
RangePredicateFieldStep<?>	range()	Match documents where targeted fields have a value within lower and upper bounds.
RegexpPredicateFieldStep<?>	regexp()	Match documents where targeted fields contain a term that matches a given regular expression.
SimpleQueryStringPredicateFieldStep<?>	simpleQueryString()	Match documents according to a given query string, with a simple query language adapted to end users.
SpatialPredicateInitialStep	spatial()	Access the different types of spatial predicates.
TermsPredicateFieldStep<?>	terms()	Match documents where targeted fields contain a term that matches some terms of a given series of terms.
final String	toAbsolutePath(String relativeFieldPath)
WildcardPredicateFieldStep<?>	wildcard()	Match documents where targeted fields contain a term that matches a given pattern, such as inter*on or pa?t.
PredicateFinalStep	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 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.dsl.ExtendedSearchPredicateFactory

withRoot

Field Details

dslContext

protected final SearchPredicateDslContext<SC extends SearchPredicateIndexScope<?>> dslContext

Constructor Details

AbstractSearchPredicateFactory

public AbstractSearchPredicateFactory(SearchPredicateDslContext<SC> dslContext)

Method Details

matchAll

public MatchAllPredicateOptionsStep<?> matchAll()

Description copied from interface: SearchPredicateFactory

Match all documents.

Specified by:

matchAll in interface SearchPredicateFactory

Returns:

The initial step of a DSL where the "match all" predicate can be defined.

See Also:

• MatchAllPredicateOptionsStep

matchNone

public MatchNonePredicateFinalStep matchNone()

Description copied from interface: SearchPredicateFactory

Match none of the documents.

Specified by:

matchNone in interface SearchPredicateFactory

Returns:

The initial step of a DSL where the "match none" predicate can be defined.

See Also:

• MatchNonePredicateFinalStep

id

public MatchIdPredicateMatchingStep<?> id()

Description copied from interface: SearchPredicateFactory

Match documents where the identifier is among the given values.

Specified by:

id in interface SearchPredicateFactory

Returns:

The initial step of a DSL allowing the definition of an "id" predicate.

See Also:

• MatchIdPredicateMatchingStep

bool

public BooleanPredicateClausesStep<?> bool()

Description copied from interface: SearchPredicateFactory

Match documents if they match a combination of boolean clauses.

Specified by:

bool in interface SearchPredicateFactory

Returns:

The initial step of a DSL where the "boolean" predicate can be defined.

See Also:

• BooleanPredicateClausesStep

and

public SimpleBooleanPredicateClausesStep<?> and()

Description copied from interface: SearchPredicateFactory

Match documents if they match all inner clauses.

Specified by:

and in interface SearchPredicateFactory

Returns:

The initial step of a DSL where predicates that must match can be added and options can be set.

See Also:

• GenericSimpleBooleanPredicateClausesStep

and

public SimpleBooleanPredicateOptionsStep<?> and(SearchPredicate firstSearchPredicate,
 SearchPredicate... otherSearchPredicates)

Description copied from interface: SearchPredicateFactory

Match documents if they match all previously-built SearchPredicate.

Specified by:

and in interface SearchPredicateFactory

Returns:

The step of a DSL where options can be set.

and

public SimpleBooleanPredicateOptionsStep<?> and(PredicateFinalStep firstSearchPredicate,
 PredicateFinalStep... otherSearchPredicate)

Description copied from interface: SearchPredicateFactory

Match documents if they match all clauses.

Specified by:

and in interface SearchPredicateFactory

Returns:

The step of a DSL where options can be set.

or

public SimpleBooleanPredicateClausesStep<?> or()

Description copied from interface: SearchPredicateFactory

Match documents if they match any inner clause.

Specified by:

or in interface SearchPredicateFactory

Returns:

The initial step of a DSL where predicates that should match can be added and options can be set.

See Also:

• GenericSimpleBooleanPredicateClausesStep

or

public SimpleBooleanPredicateOptionsStep<?> or(SearchPredicate firstSearchPredicate,
 SearchPredicate... otherSearchPredicate)

Description copied from interface: SearchPredicateFactory

Match documents if they match any previously-built SearchPredicate.

Specified by:

or in interface SearchPredicateFactory

Returns:

The step of a DSL where options can be set.

or

public SimpleBooleanPredicateOptionsStep<?> or(PredicateFinalStep firstSearchPredicate,
 PredicateFinalStep... otherSearchPredicate)

Description copied from interface: SearchPredicateFactory

Match documents if they match any clause.

Specified by:

or in interface SearchPredicateFactory

Returns:

The step of a DSL where options can be set.

not

public NotPredicateFinalStep not(SearchPredicate searchPredicate)

Description copied from interface: SearchPredicateFactory

Match documents that do not satisfy the passed in previously-built SearchPredicate.

Can be used to negate a predicate.

Specified by:

not in interface SearchPredicateFactory

Returns:

The initial and final step of a DSL where the "not" predicate can be defined.

See Also:

• NotPredicateFinalStep

not

public NotPredicateFinalStep not(PredicateFinalStep searchPredicate)

Description copied from interface: SearchPredicateFactory

Match documents that do not satisfy the passed in predicate.

Can be used to negate a predicate.

Specified by:

not in interface SearchPredicateFactory

Returns:

The initial and final step of a DSL where the "not" predicate can be defined.

See Also:

• NotPredicateFinalStep

bool

public PredicateFinalStep bool(Consumer<? super BooleanPredicateClausesStep<?>> clauseContributor)

Description copied from interface: SearchPredicateFactory

Match documents if they match a combination of boolean clauses, which will be defined by the given consumer.

Best used with lambda expressions.

Specified by:

bool in interface SearchPredicateFactory

Parameters:

clauseContributor - A consumer that will add clauses to the step passed in parameter. Should generally be a lambda expression.

Returns:

The final step of the boolean predicate definition.

See Also:

• GenericBooleanPredicateClausesStep.with(Consumer)

match

public MatchPredicateFieldStep<?> match()

Description copied from interface: SearchPredicateFactory

Match documents where targeted fields have a value that "matches" a given single value.

Note that "value matching" may be exact or approximate depending on the type of the targeted fields: numeric fields in particular imply exact matches, while analyzed, full-text fields imply approximate matches depending on how they are analyzed.

Specified by:

match in interface SearchPredicateFactory

Returns:

The initial step of a DSL where the "match" predicate can be defined.

See Also:

• MatchPredicateFieldStep

range

public RangePredicateFieldStep<?> range()

Description copied from interface: SearchPredicateFactory

Match documents where targeted fields have a value within lower and upper bounds.

Specified by:

range in interface SearchPredicateFactory

Returns:

The initial step of a DSL where the "range" predicate can be defined.

See Also:

• RangePredicateFieldStep

phrase

public PhrasePredicateFieldStep<?> phrase()

Description copied from interface: SearchPredicateFactory

Match documents where targeted fields have a value that contains a given phrase.

Specified by:

phrase in interface SearchPredicateFactory

Returns:

The initial step of a DSL where the "phrase" predicate can be defined.

See Also:

• PhrasePredicateFieldStep

wildcard

public WildcardPredicateFieldStep<?> wildcard()

Description copied from interface: SearchPredicateFactory

Match documents where targeted fields contain a term that matches a given pattern, such as inter*on or pa?t.

Note that such patterns are not analyzed, thus any character that is not a wildcard must match exactly the content of the index (including uppercase letters, diacritics, ...).

Specified by:

wildcard in interface SearchPredicateFactory

Returns:

The initial step of a DSL where the "wildcard" predicate can be defined.

See Also:

• WildcardPredicateFieldStep

prefix

public PrefixPredicateFieldStep<?> prefix()

Description copied from interface: SearchPredicateFactory

Match documents where targeted fields have a value that starts with a given string.

Specified by:

prefix in interface SearchPredicateFactory

Returns:

The initial step of a DSL where the "prefix" predicate can be defined.

See Also:

• PrefixPredicateFieldStep

regexp

public RegexpPredicateFieldStep<?> regexp()

Description copied from interface: SearchPredicateFactory

Match documents where targeted fields contain a term that matches a given regular expression.

Specified by:

regexp in interface SearchPredicateFactory

Returns:

The initial step of a DSL where the "regexp" predicate can be defined.

See Also:

• RegexpPredicateFieldStep

terms

public TermsPredicateFieldStep<?> terms()

Description copied from interface: SearchPredicateFactory

Match documents where targeted fields contain a term that matches some terms of a given series of terms.

Specified by:

terms in interface SearchPredicateFactory

Returns:

The initial step of a DSL where the "terms" predicate can be defined.

See Also:

• TermsPredicateFieldStep

nested

@Deprecated
public NestedPredicateFieldStep<?> nested()

Deprecated.

Description copied from interface: SearchPredicateFactory

Match documents where a nested object matches a given predicate.

Specified by:

nested in interface SearchPredicateFactory

Returns:

The initial step of a DSL where the "nested" predicate can be defined.

See Also:

• NestedPredicateFieldStep

nested

public NestedPredicateClausesStep<?> nested(String objectFieldPath)

Description copied from interface: SearchPredicateFactory

Match documents where a nested object matches inner predicates to be defined in the next steps.

The resulting nested predicate must match all inner clauses, similarly to an "and" predicate.

Specified by:

nested in interface SearchPredicateFactory

Parameters:

objectFieldPath - The path to the (nested) object field that must match.

Returns:

The initial step of a DSL where the "nested" predicate can be defined.

See Also:

• NestedPredicateFieldStep

simpleQueryString

public SimpleQueryStringPredicateFieldStep<?> simpleQueryString()

Description copied from interface: SearchPredicateFactory

Match documents according to a given query string, with a simple query language adapted to end users.

Note that by default, unless the query string contains explicit operators, documents will match if any term mentioned in the query string is present in the document (OR operator). This makes sense when sorting results by relevance, but is not ideal otherwise. See CommonQueryStringPredicateOptionsStep.defaultOperator(BooleanOperator) to change this behavior.

Specified by:

simpleQueryString in interface SearchPredicateFactory

Returns:

The initial step of a DSL where the "simple query string" predicate can be defined.

See Also:

• SimpleQueryStringPredicateFieldStep

queryString

public QueryStringPredicateFieldStep<?> queryString()

Description copied from interface: SearchPredicateFactory

Match documents according to a given query string, using the Lucene's query language.

Note that by default, unless the query string contains explicit operators, documents will match if any term mentioned in the query string is present in the document (OR operator). This makes sense when sorting results by relevance, but is not ideal otherwise. See CommonQueryStringPredicateOptionsStep.defaultOperator(BooleanOperator) to change this behavior.

Specified by:

queryString in interface SearchPredicateFactory

Returns:

The initial step of a DSL where the "query string" predicate can be defined.

See Also:

• QueryStringPredicateFieldStep

exists

public ExistsPredicateFieldStep<?> exists()

Description copied from interface: SearchPredicateFactory

Match documents where a given field exists.

Fields are considered to exist in a document when they have at least one non-null value in this document.

Specified by:

exists in interface SearchPredicateFactory

Returns:

The initial step of a DSL where the "exists" predicate can be defined.

See Also:

• ExistsPredicateFieldStep

spatial

public SpatialPredicateInitialStep spatial()

Description copied from interface: SearchPredicateFactory

Access the different types of spatial predicates.

Specified by:

spatial in interface SearchPredicateFactory

Returns:

The initial step of a DSL where spatial predicates can be defined.

See Also:

• SpatialPredicateInitialStep

named

public NamedPredicateOptionsStep named(String path)

Description copied from interface: SearchPredicateFactory

Match documents if they match a combination of defined named predicate clauses.

Specified by:

named in interface SearchPredicateFactory

Parameters:

path - The path to the named predicate, formatted as <object field path>.<predicate name>, or just <predicate name> if the predicate was declared at the root.

Returns:

The initial step of a DSL where named predicate predicates can be defined.

See Also:

• NamedPredicateOptionsStep

knn

public KnnPredicateFieldStep knn(int k)

Description copied from interface: SearchPredicateFactory

Match k documents whose vector field value is nearest to the given vector.

"knn" stands for "K-Nearest Neighbors"; it is a form of vector search.

Specified by:

knn in interface SearchPredicateFactory

Parameters:

k - The number of nearest neighbors to look for.

Returns:

The initial step of a DSL where knn predicate options can be defined.

See Also:

• KnnPredicateVectorStep
• KnnPredicateOptionsStep

withParameters

public PredicateFinalStep withParameters(Function<? super NamedValues,? extends PredicateFinalStep> predicateCreator)

Description copied from interface: SearchPredicateFactory

Delegating predicate that creates the actual predicate at query create time and provides access to query parameters.

Which predicate exactly to create is defined by a function passed to the arguments of this predicate.

Specified by:

withParameters in interface SearchPredicateFactory

Parameters:

predicateCreator - The function defining an actual predicate to apply.

Returns:

A final DSL step in a parameterized predicate definition.

extension

public <T> T extension(SearchPredicateFactoryExtension<T> extension)

Description copied from interface: SearchPredicateFactory

Extend the current factory with the given extension, resulting in an extended factory offering different types of predicates.

Specified by:

extension in interface SearchPredicateFactory

Type Parameters:

T - The type of factory provided by the extension.

Parameters:

extension - The extension to the predicate DSL.

Returns:

The extended factory.

extension

public SearchPredicateFactoryExtensionIfSupportedStep extension()

Description copied from interface: SearchPredicateFactory

Create a DSL step allowing multiple attempts to apply extensions one after the other, failing only if none of the extensions is supported.

If you only need to apply a single extension and fail if it is not supported, use the simpler SearchPredicateFactory.extension(SearchPredicateFactoryExtension) method instead.

Specified by:

extension in interface SearchPredicateFactory

Returns:

A DSL step.

toAbsolutePath

public final String toAbsolutePath(String relativeFieldPath)

Specified by:

toAbsolutePath in interface SearchPredicateFactory

Parameters:

relativeFieldPath - The path to a field, relative to the root of this factory.

Returns:

The absolute path of the field, for use in native predicates for example. Note the path is returned even if the field doesn't exist.