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

Interface MatchPredicateFieldStep

public interface MatchPredicateFieldStep

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

Method Summary

Modifier and Type	Method and Description
default MatchPredicateFieldMoreStep	onField(String absoluteFieldPath) Target the given field in the match predicate.
MatchPredicateFieldMoreStep	onFields(String... absoluteFieldPaths) Target the given fields in the match predicate.

Method Detail

onField

default MatchPredicateFieldMoreStep onField(String absoluteFieldPath)

Target the given field in the match predicate.

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

MatchPredicateFieldMoreStep onFields(String... absoluteFieldPaths)

Target the given fields in the match predicate.

Equivalent to onField(String) followed by multiple calls to MatchPredicateFieldMoreStep.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)