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

Interface MatchPredicateFieldSetContext

All Superinterfaces:

MultiFieldPredicateFieldSetContext<MatchPredicateFieldSetContext>

public interface MatchPredicateFieldSetContext
extends MultiFieldPredicateFieldSetContext<MatchPredicateFieldSetContext>

The context used when defining a match predicate, after at least one field was mentioned.

Method Summary

Modifier and Type	Method and Description
default MatchPredicateTerminalContext	matching(Object value) Require at least one of the targeted fields to match the given value.
MatchPredicateTerminalContext	matching(Object value, DslConverter dslConverter) Require at least one of the targeted fields to match the given value.
default MatchPredicateFieldSetContext	orField(String absoluteFieldPath) Target the given field in the match predicate, as an alternative to the already-targeted fields.
MatchPredicateFieldSetContext	orFields(String... absoluteFieldPaths) Target the given fields in the match predicate, as an alternative to the already-targeted fields.

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

boostedTo

Method Detail

orField

default MatchPredicateFieldSetContext orField(String absoluteFieldPath)

Target the given field in the match predicate, as an alternative to the already-targeted fields.

See MatchPredicateContext.onField(String) for more information about targeting fields.

Parameters:

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

Returns:

this, for method chaining.

See Also:

MatchPredicateContext.onField(String)

orFields

MatchPredicateFieldSetContext orFields(String... absoluteFieldPaths)

Target the given fields in the match predicate, as an alternative to the already-targeted fields.

See MatchPredicateContext.onFields(String...) for more information about targeting fields.

Parameters:

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

Returns:

this, for method chaining.

See Also:

MatchPredicateContext.onFields(String...)

matching

default MatchPredicateTerminalContext matching(Object value)

Require at least one of the targeted fields to match the given value.

This method will apply DSL converters to value before Hibernate Search attempts to interpret it as a field value. See DslConverter.ENABLED.

Parameters:

value - The value to match. The signature of this method defines this parameter as an Object, but a specific type is expected depending on the targeted field. See DslConverter.ENABLED for more information.

Returns:

A context allowing to set further options or get the resulting predicate.

See Also:

matching(Object, DslConverter)

matching

MatchPredicateTerminalContext matching(Object value,
                                       DslConverter dslConverter)

Require at least one of the targeted fields to match the given value.

Parameters:

value - The value to match. The signature of this method defines this parameter as an Object, but a specific type is expected depending on the targeted field and on the dslConverter parameter. See DslConverter for more information.

dslConverter - Controls how the value should be converted before Hibernate Search attempts to interpret it as a field value. See DslConverter for more information.

Returns:

A context allowing to set further options or get the resulting predicate.

See Also:

DslConverter