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

Interface MatchPredicateTerminalContext

All Superinterfaces:

SearchPredicateBoostContext<MatchPredicateTerminalContext>, SearchPredicateScoreContext<MatchPredicateTerminalContext>, SearchPredicateTerminalContext

public interface MatchPredicateTerminalContext
extends SearchPredicateTerminalContext, SearchPredicateScoreContext<MatchPredicateTerminalContext>

The context used when a match predicate is fully defined.

Allows to set options or to retrieve the predicate.

Method Summary

Modifier and Type	Method and Description
default MatchPredicateTerminalContext	fuzzy() Enable fuzziness for this match predicate; only works for text fields.
default MatchPredicateTerminalContext	fuzzy(int maxEditDistance) Enable fuzziness for this match predicate; only works for text fields.
MatchPredicateTerminalContext	fuzzy(int maxEditDistance, int exactPrefixLength) Enable fuzziness for this match predicate; only works for text fields.

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

toPredicate

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

withConstantScore

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

boostedTo

Method Detail

fuzzy

default MatchPredicateTerminalContext fuzzy()

Enable fuzziness for this match predicate; only works for text fields.

Fuzziness allows to match documents that do not contain the value to match, but a close value, for example with one letter that differs.

Returns:

this, for method chaining.

See Also:

fuzzy(int, int)

fuzzy

default MatchPredicateTerminalContext fuzzy(int maxEditDistance)

Enable fuzziness for this match predicate; only works for text fields.

Fuzziness allows to match documents that do not contain the value to match, but a close value, for example with one letter that differs.

Parameters:

maxEditDistance - The maximum value of the edit distance, which defines how permissive the fuzzy predicate will be.

Returns:

this, for method chaining.

See Also:

fuzzy(int, int)

fuzzy

MatchPredicateTerminalContext fuzzy(int maxEditDistance,
                                    int exactPrefixLength)

Enable fuzziness for this match predicate; only works for text fields.

Fuzziness allows to match documents that do not contain the value to match, but a close value, for example with one letter that differs.

Parameters:

maxEditDistance - The maximum value of the edit distance, which defines how permissive the fuzzy predicate will be.

Roughly speaking, the edit distance is the number of changes between two terms: switching characters, removing them, ...

If zero, then fuzziness is completely disabled. The other accepted values, 1 and 2, are increasingly fuzzy.

exactPrefixLength - Length of the prefix that has to match exactly, i.e. for which fuzziness will not be allowed.

A non-zero value is recommended if the index contains a large amount of distinct terms.

Returns:

this, for method chaining.