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

Interface PhrasePredicateContext

public interface PhrasePredicateContext

The context used when starting to define a phrase predicate.

Method Summary

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

Method Detail

onField

default PhrasePredicateFieldSetContext onField(String absoluteFieldPath)

Target the given field in the phrase 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:

A PhrasePredicateFieldSetContext allowing to define field-specific settings (such as the boost), or simply to continue the definition of the phrase predicate (phrase to match, ...).

onFields

PhrasePredicateFieldSetContext onFields(String... absoluteFieldPaths)

Target the given fields in the phrase predicate.

Only text fields are supported.

Equivalent to onField(String) followed by multiple calls to PhrasePredicateFieldSetContext.orField(String), the only difference being that calls to MultiFieldPredicateFieldSetContext.boostedTo(float) and other field-specific settings on the returned context 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:

A PhrasePredicateFieldSetContext (see onField(String) for details).

See Also:

onField(String)