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

Interface PredicateScoreStep<S>

Type Parameters:

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

All Known Subinterfaces:

BooleanPredicateClausesStep<S>, CommonQueryStringPredicateOptionsStep<S>, ExistsPredicateOptionsStep<S>, GenericBooleanPredicateClausesStep<S,C>, KnnPredicateOptionsStep, MatchAllPredicateOptionsStep<S>, MatchIdPredicateMatchingMoreStep<S,N>, MatchIdPredicateOptionsStep<S>, MatchPredicateOptionsStep<S>, NotPredicateFinalStep, PhrasePredicateOptionsStep<S>, QueryStringPredicateOptionsStep<S>, RangePredicateOptionsStep<S>, RegexpPredicateOptionsStep<S>, SimpleBooleanPredicateClausesStep<S>, SimpleBooleanPredicateOptionsStep<S>, SimpleQueryStringPredicateOptionsStep<S>, SpatialWithinPredicateOptionsStep<S>, TermsPredicateOptionsStep<S>, WildcardPredicateOptionsStep<S>

All Known Implementing Classes:

KnnPredicateFieldStepImpl

public interface PredicateScoreStep<S>

The step in a predicate definition where score-related options can be set.

Method Summary

Modifier and Type	Method	Description
S	boost(float boost)	Boost the weight of the predicate in score computation.
S	constantScore()	Force the score of the predicate to a single constant, identical for all documents.

Method Details

boost

S boost(float boost)

Boost the weight of the predicate in score computation.

Parameters:

boost - The boost factor. Higher than 1 increases the weight in score computation, between 0 and 1 lowers the weight. Lower than 0 is for experts only.

Returns:

this, for method chaining.

constantScore

S constantScore()

Force the score of the predicate to a single constant, identical for all documents.

By default, the score will be 1.0f, but boosts, if any, will still be applied to the predicate.

Returns:

this, for method chaining.