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

Class ExistsPredicateFieldStepImpl

java.lang.Object

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

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

All Implemented Interfaces:

ExistsPredicateFieldStep<ExistsPredicateOptionsStep<?>>, ExistsPredicateOptionsStep<ExistsPredicateOptionsStep<?>>, PredicateFinalStep, PredicateScoreStep<ExistsPredicateOptionsStep<?>>

public final class ExistsPredicateFieldStepImpl
extends AbstractPredicateFinalStep
implements ExistsPredicateFieldStep<ExistsPredicateOptionsStep<?>>, ExistsPredicateOptionsStep<ExistsPredicateOptionsStep<?>>

Field Summary

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

dslContext

Constructor Summary

Constructors

Constructor	Description
ExistsPredicateFieldStepImpl(SearchPredicateDslContext<?> dslContext)

Method Summary

Modifier and Type	Method	Description
ExistsPredicateOptionsStep<?>	boost(float boost)	Boost the weight of the predicate in score computation.
protected SearchPredicate	build()
ExistsPredicateOptionsStep<?>	constantScore()	Force the score of the predicate to a single constant, identical for all documents.
ExistsPredicateOptionsStep<?>	field(String fieldPath)	Target the given field in the "exists" predicate.

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.PredicateFinalStep

toPredicate

Constructor Details

ExistsPredicateFieldStepImpl

public ExistsPredicateFieldStepImpl(SearchPredicateDslContext<?> dslContext)

Method Details

field

public ExistsPredicateOptionsStep<?> field(String fieldPath)

Description copied from interface: ExistsPredicateFieldStep

Target the given field in the "exists" predicate.

Specified by:

field in interface ExistsPredicateFieldStep<ExistsPredicateOptionsStep<?>>

Parameters:

fieldPath - The path to the index field to apply the predicate on.

Returns:

The next step.

boost

public ExistsPredicateOptionsStep<?> boost(float boost)

Description copied from interface: PredicateScoreStep

Boost the weight of the predicate in score computation.

Specified by:

boost in interface PredicateScoreStep<ExistsPredicateOptionsStep<?>>

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 ExistsPredicateOptionsStep<?> 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<ExistsPredicateOptionsStep<?>>

Returns:

this, for method chaining.

build

protected SearchPredicate build()

Specified by:

build in class AbstractPredicateFinalStep