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

Class MatchIdPredicateMatchingStepImpl

java.lang.Object

org.hibernate.search.engine.search.predicate.dsl.spi.AbstractPredicateFinalStep

org.hibernate.search.engine.search.predicate.dsl.impl.MatchIdPredicateMatchingStepImpl

All Implemented Interfaces:

MatchIdPredicateMatchingMoreStep<MatchIdPredicateMatchingStepImpl,MatchIdPredicateOptionsStep<?>>, MatchIdPredicateMatchingStep<MatchIdPredicateMatchingStepImpl>, MatchIdPredicateOptionsStep<MatchIdPredicateOptionsStep<?>>, PredicateFinalStep, PredicateScoreStep<MatchIdPredicateOptionsStep<?>>

public final class MatchIdPredicateMatchingStepImpl
extends AbstractPredicateFinalStep
implements MatchIdPredicateMatchingStep<MatchIdPredicateMatchingStepImpl>, MatchIdPredicateMatchingMoreStep<MatchIdPredicateMatchingStepImpl,MatchIdPredicateOptionsStep<?>>

Field Summary

Fields inherited from class org.hibernate.search.engine.search.predicate.dsl.spi.AbstractPredicateFinalStep

dslContext

Constructor Summary

Constructors

Constructor	Description
MatchIdPredicateMatchingStepImpl(SearchPredicateDslContext<?> dslContext)

Method Summary

Modifier and Type	Method	Description
MatchIdPredicateMatchingStepImpl	boost(float boost)	Boost the weight of the predicate in score computation.
protected SearchPredicate	build()
MatchIdPredicateMatchingStepImpl	constantScore()	Force the score of the predicate to a single constant, identical for all documents.
MatchIdPredicateMatchingStepImpl	matching(Object value, ValueConvert convert)	Target the identifier with the given id.

Methods inherited from class org.hibernate.search.engine.search.predicate.dsl.spi.AbstractPredicateFinalStep

toPredicate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

matching, matchingAny, matchingAny

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

toPredicate

Constructor Detail

MatchIdPredicateMatchingStepImpl

public MatchIdPredicateMatchingStepImpl(SearchPredicateDslContext<?> dslContext)

Method Detail

matching

public MatchIdPredicateMatchingStepImpl matching(Object value,
                                                 ValueConvert convert)

Description copied from interface: MatchIdPredicateMatchingStep

Target the identifier with the given id.

If used multiple times, it will target any of the specified values.

Specified by:

matching in interface MatchIdPredicateMatchingStep<MatchIdPredicateMatchingStepImpl>

Parameters:

value - the value of the id we want to match.

convert - Controls how the value should be converted before Hibernate Search attempts to interpret it as an identifier value. See ValueConvert for more information.

Returns:

The next step.

See Also:

MatchIdPredicateMatchingStep.matchingAny(Collection)

boost

public MatchIdPredicateMatchingStepImpl boost(float boost)

Description copied from interface: PredicateScoreStep

Boost the weight of the predicate in score computation.

Specified by:

boost in interface PredicateScoreStep<MatchIdPredicateOptionsStep<?>>

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

public MatchIdPredicateMatchingStepImpl constantScore()

Description copied from interface: PredicateScoreStep

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.

Specified by:

constantScore in interface PredicateScoreStep<MatchIdPredicateOptionsStep<?>>

Returns:

this, for method chaining.

build

protected SearchPredicate build()

Specified by:

build in class AbstractPredicateFinalStep