org.hibernate.search.engine.search.dsl.predicate

Interface SimpleQueryStringPredicateFieldStep

public interface SimpleQueryStringPredicateFieldStep

The initial step in a "simple query string" predicate definition, where the target field can be set.

Method Summary

Modifier and Type	Method and Description
default SimpleQueryStringPredicateFieldMoreStep	onField(String absoluteFieldPath) Target the given field in the simple query string predicate.
SimpleQueryStringPredicateFieldMoreStep	onFields(String... absoluteFieldPaths) Target the given fields in the simple query string predicate.

Method Detail

onField

default SimpleQueryStringPredicateFieldMoreStep onField(String absoluteFieldPath)

Target the given field in the simple query string predicate.

Only text fields are supported.

Multiple fields may be targeted by the same predicate: the predicate will match if any targeted field matches.

When targeting multiple fields, those fields must have compatible types. Please refer to the reference documentation for more information.

Parameters:

absoluteFieldPath - The absolute path (from the document root) of the targeted field.

Returns:

The next step.

onFields

SimpleQueryStringPredicateFieldMoreStep onFields(String... absoluteFieldPaths)

Target the given fields in the simple query string predicate.

Only text fields are supported.

Equivalent to onField(String) followed by multiple calls to SimpleQueryStringPredicateFieldMoreStep.orField(String), the only difference being that calls to MultiFieldPredicateFieldBoostStep.boostedTo(float) and other field-specific settings on the returned step will only need to be done once and will apply to all the fields passed to this method.

Parameters:

absoluteFieldPaths - The absolute paths (from the document root) of the targeted fields.

Returns:

The next step.

See Also:

onField(String)