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

Interface MatchPredicateFieldStep<SR,N extends MatchPredicateFieldMoreStep<?,?>>

public interface MatchPredicateFieldStep<SR,N extends MatchPredicateFieldMoreStep<?,?>>

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

Method Summary

Modifier and Type	Method	Description
default N	field(String fieldPath)	Target the given field in the match predicate.
default <T> MatchPredicateFieldMoreGenericStep<?,?,T,MatchPredicateFieldReference<? super SR,T>>	field(MatchPredicateFieldReference<? super SR,T> fieldReference)	Target the given field in the match predicate.
N	fields(String... fieldPaths)	Target the given fields in the match predicate.
<T> MatchPredicateFieldMoreGenericStep<?,?,T,MatchPredicateFieldReference<? super SR,T>>	fields(MatchPredicateFieldReference<? super SR,T>... fieldReferences)	Target the given fields in the match predicate.

Method Details

field

default N field(String fieldPath)

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:

fieldPath - The path to the index field to apply the predicate on.

Returns:

The next step.

fields

N fields(String... fieldPaths)

Target the given fields in the match predicate.

Equivalent to field(String) followed by multiple calls to MatchPredicateFieldMoreGenericStep.field(Object), the only difference being that calls to MultiFieldPredicateFieldBoostStep.boost(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:

fieldPaths - The paths to the index fields to apply the predicate on.

Returns:

The next step.

See Also:

• field(String)

field

default <T>
MatchPredicateFieldMoreGenericStep<?,?,T,MatchPredicateFieldReference<? super SR,T>> field(MatchPredicateFieldReference<? super SR,T> fieldReference)

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:

fieldReference - The field reference representing a definition of the index field to apply the predicate on.

Returns:

The next step.

fields

<T>
MatchPredicateFieldMoreGenericStep<?,?,T,MatchPredicateFieldReference<? super SR,T>> fields(MatchPredicateFieldReference<? super SR,T>... fieldReferences)

Target the given fields in the match predicate.

Equivalent to field(String) followed by multiple calls to MatchPredicateFieldMoreGenericStep.field(Object), the only difference being that calls to MultiFieldPredicateFieldBoostStep.boost(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:

fieldReferences - The field references representing paths to the index fields to apply the predicate on.

Returns:

The next step.

See Also:

• field(MatchPredicateFieldReference)