com.marklogic.client.type

Interface PlanSearchOptions

public interface PlanSearchOptions

An option controlling the scoring and weighting of fromSearch() for a row pipeline.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PlanSearchOptions.ScoreMethod

Method Summary

Modifier and Type	Method and Description
XsDoubleVal	getBm25LengthWeight()
XsFloatVal	getQualityWeight() Changed in release 7.0.0 to return a float, as the server requires a float and throws an error on a double.
PlanSearchOptions.ScoreMethod	getScoreMethod()
PlanSearchOptions	withBm25LengthWeight(double bm25LengthWeight)
PlanSearchOptions	withQualityWeight(float qualityWeight) Changed in release 7.0.0 to return a float, as the server requires a float and throws an error on a double.
PlanSearchOptions	withQualityWeight(XsFloatVal qualityWeight) Changed in release 7.0.0 to return a float, as the server requires a float and throws an error on a double.
PlanSearchOptions	withScoreMethod(PlanSearchOptions.ScoreMethod scoreMethod)

Method Detail

getQualityWeight

XsFloatVal getQualityWeight()

Changed in release 7.0.0 to return a float, as the server requires a float and throws an error on a double.

getScoreMethod

PlanSearchOptions.ScoreMethod getScoreMethod()

getBm25LengthWeight

XsDoubleVal getBm25LengthWeight()

Since:

7.0.0; requires MarkLogic 12 or higher.

withQualityWeight

PlanSearchOptions withQualityWeight(float qualityWeight)

Changed in release 7.0.0 to return a float, as the server requires a float and throws an error on a double.

withQualityWeight

PlanSearchOptions withQualityWeight(XsFloatVal qualityWeight)

Changed in release 7.0.0 to return a float, as the server requires a float and throws an error on a double.

withScoreMethod

PlanSearchOptions withScoreMethod(PlanSearchOptions.ScoreMethod scoreMethod)

withBm25LengthWeight

PlanSearchOptions withBm25LengthWeight(double bm25LengthWeight)

Since:

7.0.0; requires MarkLogic 12 or higher.