Type Parameters:: SR - Scope root type.

All Superinterfaces:: SearchPredicateFactory

All Known Subinterfaces:: ElasticsearchSearchPredicateFactory<SR>, ExtendedSearchPredicateFactory<SR,S>, LuceneSearchPredicateFactory<SR>

All Known Implementing Classes:: AbstractSearchPredicateFactory

public interface TypedSearchPredicateFactory<SR> extends SearchPredicateFactory

A factory for search predicates.

This is the main entry point to the predicate DSL.

Field paths

By default, field paths passed to this DSL are interpreted as absolute, i.e. relative to the index root.

However, a new, "relative" factory can be created with withRoot(String): the new factory interprets paths as relative to the object field passed as argument to the method.

This can be useful when calling reusable methods that can apply the same predicate on different object fields that have same structure (same sub-fields).

Such a factory can also transform relative paths into absolute paths using toAbsolutePath(String); this can be useful for native predicates in particular.

Field references

A field reference is always represented by the absolute field path and, if applicable, i.e. when a field reference is typed, a combination of the ValueModel and the type.

Field references are usually accessed from the generated Hibernate Search's static metamodel classes that describe the index structure. Such reference provides the information on which search capabilities the particular index field possesses, and allows switching between different value model representations.

Method Summary

Modifier and Type

Method

Description

SimpleBooleanPredicateClausesStep<SR,?>

and()

Match documents if they match all inner clauses.

BooleanPredicateClausesStep<SR,?>

bool()

Match documents if they match a combination of boolean clauses.

ExistsPredicateFieldStep<SR,?>

exists()

Match documents where a given field exists.

SearchPredicateFactoryExtensionIfSupportedStep<SR>

extension()

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

KnnPredicateFieldStep<SR>

knn(int k)

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

MatchPredicateFieldStep<SR,?>

match()

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

MatchAllPredicateOptionsStep<SR,?>

matchAll()

Match all documents.

NestedPredicateFieldStep<SR,?>

nested()

Deprecated.
Use nested(String) instead.

NestedPredicateClausesStep<SR,?>

nested(String objectFieldPath)

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

default NestedPredicateClausesStep<SR,?>

nested(NestedPredicateFieldReference<? super SR> fieldReference)

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

SimpleBooleanPredicateClausesStep<SR,?>

or()

Match documents if they match any inner clause.

PhrasePredicateFieldStep<SR,?>

phrase()

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

PrefixPredicateFieldStep<SR,?>

prefix()

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

QueryStringPredicateFieldStep<SR,?>

queryString()

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

RangePredicateFieldStep<SR,?>

range()

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

RegexpPredicateFieldStep<SR,?>

regexp()

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

SimpleQueryStringPredicateFieldStep<SR,?>

simpleQueryString()

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

SpatialPredicateInitialStep<SR>

spatial()

Access the different types of spatial predicates.

TermsPredicateFieldStep<SR,?>

terms()

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

String

toAbsolutePath(String relativeFieldPath)

WildcardPredicateFieldStep<SR,?>

wildcard()

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

TypedSearchPredicateFactory<SR>

withRoot(String objectFieldPath)

Create a new predicate factory whose root for all paths passed to the DSL will be the given object field.

Methods inherited from interface org.hibernate.search.engine.search.predicate.dsl.SearchPredicateFactory
and, and, bool, extension, id, matchNone, named, not, not, or, or, withParameters

Method Details
- matchAll
  
  MatchAllPredicateOptionsStep<SR,?> matchAll()
  
  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
- bool
  
  BooleanPredicateClausesStep<SR,?> bool()
  
  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
  
  SimpleBooleanPredicateClausesStep<SR,?> and()
  
  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
- or
  
  SimpleBooleanPredicateClausesStep<SR,?> or()
  
  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
- match
  
  MatchPredicateFieldStep<SR,?> match()
  
  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
  
  RangePredicateFieldStep<SR,?> range()
  
  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
  
  PhrasePredicateFieldStep<SR,?> phrase()
  
  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
  
  WildcardPredicateFieldStep<SR,?> wildcard()
  
  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
  
  PrefixPredicateFieldStep<SR,?> prefix()
  
  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
  
  RegexpPredicateFieldStep<SR,?> regexp()
  
  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
  
  TermsPredicateFieldStep<SR,?> terms()
  
  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(since="6.2") NestedPredicateFieldStep<SR,?> nested()
  
  Deprecated.
  Use nested(String) instead.
  
  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
  
  NestedPredicateClausesStep<SR,?> nested(String objectFieldPath)
  
  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
- nested
  
  default NestedPredicateClausesStep<SR,?> nested(NestedPredicateFieldReference<? super SR> fieldReference)
  
  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.
  Parameters:
  
  fieldReference - The field reference representing a definition of the object field to apply the predicate on.
  
  Returns:
  
  The initial step of a DSL where the "nested" predicate can be defined.
  
  See Also:
  
  NestedPredicateFieldStep
- simpleQueryString
  
  SimpleQueryStringPredicateFieldStep<SR,?> simpleQueryString()
  
  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
  
  QueryStringPredicateFieldStep<SR,?> queryString()
  
  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
  
  ExistsPredicateFieldStep<SR,?> exists()
  
  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
  
  SpatialPredicateInitialStep<SR> spatial()
  
  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
- knn
  
  KnnPredicateFieldStep<SR> knn(int k)
  
  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
- extension
  
  SearchPredicateFactoryExtensionIfSupportedStep<SR> extension()
  
  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(TypedSearchPredicateFactoryExtension) method instead.
  
  Specified by:
  
  extension in interface SearchPredicateFactory
  
  Returns:
  
  A DSL step.
- withRoot
  
  @Incubating TypedSearchPredicateFactory<SR> withRoot(String objectFieldPath)
  
  Create a new predicate factory whose root for all paths passed to the DSL will be the given object field.
  This is used to call reusable methods that apply the same predicate on different object fields that have same structure (same sub-fields).
  
  Specified by:
  
  withRoot in interface SearchPredicateFactory
  
  Parameters:
  
  objectFieldPath - The path from the current root to an object field that will become the new root.
  
  Returns:
  
  A new predicate factory using the given object field as root.
- toAbsolutePath
  
  @Incubating 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.

Interface TypedSearchPredicateFactory<SR>

Field paths

Field references

Method Summary

Methods inherited from interface org.hibernate.search.engine.search.predicate.dsl.SearchPredicateFactory

Method Details

matchAll

bool

and

or

match

range

phrase

wildcard

prefix

regexp

terms

nested

nested

nested

simpleQueryString

queryString

exists

spatial

knn

extension

withRoot

toAbsolutePath