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

Interface SimpleQueryStringPredicateOptionsStep<S extends SimpleQueryStringPredicateOptionsStep<?>>

Type Parameters:

S - The "self" type (the actual exposed type of this step).

All Superinterfaces:

PredicateBoostStep<S>, PredicateFinalStep, PredicateScoreStep<S>

public interface SimpleQueryStringPredicateOptionsStep<S extends SimpleQueryStringPredicateOptionsStep<?>>
extends PredicateFinalStep, PredicateScoreStep<S>

The final step in an "simple query string" predicate definition, where optional parameters can be set.

Method Summary

Modifier and Type	Method	Description
S	analyzer(String analyzerName)	Define an analyzer to use at query time to interpret the value to match.
S	defaultOperator(BooleanOperator operator)	Define the default operator.
S	flags(Set<SimpleQueryFlag> flags)	Enable operation in the given flags.
default S	flags(SimpleQueryFlag... flags)	Enable operation in the given flags.
S	skipAnalysis()	Any analyzer or normalizer defined on any field will be ignored to interpret the value to match.

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

toPredicate

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

boost, constantScore

Method Detail

defaultOperator

S defaultOperator(BooleanOperator operator)

Define the default operator.

By default, unless the query string contains explicit operators, documents will match if any term mentioned in the query string is present in the document (OR operator). This can be used to change the default behavior to AND, making document match if all terms mentioned in the query string are present in the document.

Parameters:

operator - The default operator (OR or AND).

Returns:

this, for method chaining.

analyzer

S analyzer(String analyzerName)

Define an analyzer to use at query time to interpret the value to match.

If this method is not called, the analyzer defined on the field will be used.

Parameters:

analyzerName - The name of the analyzer to use in the query for this predicate.

Returns:

this, for method chaining.

skipAnalysis

S skipAnalysis()

Any analyzer or normalizer defined on any field will be ignored to interpret the value to match.

Returns:

this, for method chaining.

flags

default S flags(SimpleQueryFlag... flags)

Enable operation in the given flags.

Parameters:

flags - The operation flags.

Returns:

this, for method chaining.

flags

S flags(Set<SimpleQueryFlag> flags)

Enable operation in the given flags.

Parameters:

flags - The operation flags.

Returns:

this, for method chaining.