Can now use search options in ML12 for BM25, Zero, and Random.

Also adds a setting for BM25 Length Weight.

Added a couple of tests. These tests are of limited use here, but they do verify that "bm25" and "zero" are acceptable scoring options.

Author: BillFarber

marklogic-client-api/src/main/java/com/marklogic/client/impl/PlanBuilderBaseImpl.java

@@ -63,14 +63,20 @@ static class PlanSearchOptionsImpl implements PlanSearchOptions {
     private PlanBuilderBaseImpl pb;
     private XsDoubleVal qualityWeight;
     private ScoreMethod scoreMethod;
+	private XsDoubleVal lengthWeight;
     PlanSearchOptionsImpl(PlanBuilderBaseImpl pb) {
       this.pb = pb;
     }
     PlanSearchOptionsImpl(PlanBuilderBaseImpl pb, XsDoubleVal qualityWeight, ScoreMethod scoreMethod) {
-      this(pb);
-      this.qualityWeight = qualityWeight;
-      this.scoreMethod   = scoreMethod;
+		new PlanSearchOptionsImpl(pb, qualityWeight, scoreMethod, null);
     }
+	PlanSearchOptionsImpl(PlanBuilderBaseImpl pb, XsDoubleVal qualityWeight,
+						  ScoreMethod scoreMethod, XsDoubleVal lengthWeight) {
+		  this(pb);
+		  this.qualityWeight = qualityWeight;
+		  this.scoreMethod   = scoreMethod;
+		  this.lengthWeight = lengthWeight;
+	}
 
     @Override
     public XsDoubleVal getQualityWeight() {
@@ -80,19 +86,28 @@ public XsDoubleVal getQualityWeight() {
     public ScoreMethod getScoreMethod() {
       return scoreMethod;
     }
+	public XsDoubleVal getLengthWeight() {
+		  return lengthWeight;
+	  }
     @Override
     public PlanSearchOptions withQualityWeight(double qualityWeight) {
       return withQualityWeight(pb.xs.doubleVal(qualityWeight));
     }
     @Override
     public PlanSearchOptions withQualityWeight(XsDoubleVal qualityWeight) {
-      return new PlanSearchOptionsImpl(pb, qualityWeight, getScoreMethod());
+      return new PlanSearchOptionsImpl(pb, qualityWeight, getScoreMethod(), getLengthWeight());
     }
     @Override
     public PlanSearchOptions withScoreMethod(ScoreMethod scoreMethod) {
-      return new PlanSearchOptionsImpl(pb, getQualityWeight(), scoreMethod);
+      return new PlanSearchOptionsImpl(pb, getQualityWeight(), scoreMethod, getLengthWeight());
     }
-    Map<String,String> makeMap() {
+
+	  @Override
+	  public PlanSearchOptions withBm25LengthWeight(double lengthWeight) {
+		  return new PlanSearchOptionsImpl(pb, getQualityWeight(), getScoreMethod(), pb.xs.doubleVal(lengthWeight));
+	  }
+
+	  Map<String,String> makeMap() {
       if (qualityWeight == null && scoreMethod == null) return null;
 
       Map<String, String> map = new HashMap<String, String>();
@@ -102,6 +117,9 @@ Map<String,String> makeMap() {
       if (scoreMethod != null) {
         map.put("scoreMethod", scoreMethod.name().toLowerCase());
       }
+	  if (lengthWeight != null) {
+		  map.put("lengthWeight", String.valueOf(lengthWeight));
+	  }
       return map;
     }
   }

marklogic-client-api/src/main/java/com/marklogic/client/type/PlanSearchOptions.java

@@ -15,8 +15,6 @@
  */
 package com.marklogic.client.type;
 
-// IMPORTANT: Do not edit. This file is generated.
-
 /**
  * An option controlling the scoring and weighting of fromSearch()
  * for a row pipeline.
@@ -27,7 +25,8 @@ public interface PlanSearchOptions {
     PlanSearchOptions withQualityWeight(double qualityWeight);
     PlanSearchOptions withQualityWeight(XsDoubleVal qualityWeight);
     PlanSearchOptions withScoreMethod(ScoreMethod scoreMethod);
+	PlanSearchOptions withBm25LengthWeight(double lengthWeight);
     enum ScoreMethod {
-        LOGTFIDF, LOGTF, SIMPLE;
+        LOGTFIDF, LOGTF, SIMPLE, BM25, ZERO, RANDOM;
     }
 }

marklogic-client-api/src/test/java/com/marklogic/client/test/junit5/RequiresML12.java

@@ -0,0 +1,22 @@
+package com.marklogic.client.test.junit5;
+
+import com.marklogic.client.test.Common;
+import com.marklogic.client.test.MarkLogicVersion;
+import org.junit.jupiter.api.extension.ConditionEvaluationResult;
+import org.junit.jupiter.api.extension.ExecutionCondition;
+import org.junit.jupiter.api.extension.ExtensionContext;
+
+public class RequiresML12 implements ExecutionCondition {
+
+	private static MarkLogicVersion markLogicVersion;
+
+	@Override
+	public ConditionEvaluationResult evaluateExecutionCondition(ExtensionContext context) {
+		if (markLogicVersion == null) {
+			markLogicVersion = Common.getMarkLogicVersion();
+		}
+		return markLogicVersion.getMajor() >= 12 ?
+			ConditionEvaluationResult.enabled("MarkLogic is version 12 or higher") :
+			ConditionEvaluationResult.disabled("MarkLogic is version 11 or lower");
+	}
+}

marklogic-client-api/src/test/java/com/marklogic/client/test/rows/OpticPlanSearchOptionsTest.java

@@ -0,0 +1,40 @@
+package com.marklogic.client.test.rows;
+
+import com.marklogic.client.row.RowRecord;
+import com.marklogic.client.test.junit5.RequiresML12;
+import com.marklogic.client.type.PlanSearchOptions;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+
+import java.util.List;
+
+import static org.junit.jupiter.api.Assertions.*;
+
+@ExtendWith(RequiresML12.class)
+class OpticPlanSearchOptionsTest extends AbstractOpticUpdateTest {
+
+	@Test
+	void bm25() {
+		PlanSearchOptions options = op.searchOptions()
+			.withScoreMethod(PlanSearchOptions.ScoreMethod.BM25)
+			.withBm25LengthWeight(20.5);
+		List<RowRecord> rows = resultRows(
+			op.fromSearch(op.cts.wordQuery("contents"), null, null, options)
+				.offsetLimit(0, 5)
+		);
+		assertEquals(5, rows.size());
+	}
+
+	@Test
+	void zero() {
+		PlanSearchOptions options = op.searchOptions().withScoreMethod(PlanSearchOptions.ScoreMethod.ZERO);
+		List<RowRecord> rows = resultRows(
+			op.fromSearch(op.cts.wordQuery("contents"), null, null, options)
+				.offsetLimit(0, 5)
+		);
+		assertEquals(5, rows.size());
+		rows.forEach(row -> {
+			assertEquals(0, row.getInt("score"), "The score for every row should be 0.");
+		});
+	}
+}