Apache Solr open-source search software
Payload Score Parser: expand documentation's pointing to Lucene javadocs (#2693)
Christine Poerschke6beaf5088b2a
diff --git a/gradle/documentation/pull-lucene-javadocs.gradle b/gradle/documentation/pull-lucene-javadocs.gradleindex 17985d88f1b..e3fcaecef25 100644--- a/gradle/documentation/pull-lucene-javadocs.gradle+++ b/gradle/documentation/pull-lucene-javadocs.gradle@@ -49,6 +49,7 @@ configure(project(":solr:documentation")) {javadocs variantOf(libs.apache.lucene.analysis.common) { classifier 'javadoc' }javadocs variantOf(libs.apache.lucene.analysis.stempel) { classifier 'javadoc' }javadocs variantOf(libs.apache.lucene.queryparser) { classifier 'javadoc' }+ javadocs variantOf(libs.apache.lucene.queries) { classifier 'javadoc' }javadocs variantOf(libs.apache.lucene.spatialextras) { classifier 'javadoc' }}diff --git a/solr/core/src/java/org/apache/solr/search/PayloadScoreQParserPlugin.java b/solr/core/src/java/org/apache/solr/search/PayloadScoreQParserPlugin.javaindex 7039878ec86..c26853933cb 100644--- a/solr/core/src/java/org/apache/solr/search/PayloadScoreQParserPlugin.java+++ b/solr/core/src/java/org/apache/solr/search/PayloadScoreQParserPlugin.java@@ -31,8 +31,8 @@ import org.apache.solr.schema.FieldType;import org.apache.solr.util.PayloadUtils;/**- * Creates a PayloadScoreQuery wrapping a SpanQuery created from the input value, applying text- * analysis and constructing SpanTermQuery or SpanNearQuery based on number of terms. <br>+ * Creates a {@link PayloadScoreQuery} wrapping a SpanQuery created from the input value, applying+ * text analysis and constructing SpanTermQuery or SpanNearQuery based on number of terms. <br>* Other parameters: <br>* <code>f</code>, the field (required) <br>* <code>func</code>, payload function (min, max, or average; required) <br>diff --git a/solr/documentation/gradle.lockfile b/solr/documentation/gradle.lockfileindex 8dea621a16a..45fbc16d3be 100644--- a/solr/documentation/gradle.lockfile+++ b/solr/documentation/gradle.lockfile@@ -5,5 +5,6 @@ org.apache.lucene:lucene-analysis-common:9.12.1=javadocsorg.apache.lucene:lucene-analysis-stempel:9.12.1=javadocsorg.apache.lucene:lucene-core:9.12.1=javadocsorg.apache.lucene:lucene-queryparser:9.12.1=javadocs+org.apache.lucene:lucene-queries:9.12.1=javadocsorg.apache.lucene:lucene-spatial-extras:9.12.1=javadocsempty=changesHtml,jarValidation,minimalSite,sitediff --git a/solr/solr-ref-guide/gradle.lockfile b/solr/solr-ref-guide/gradle.lockfileindex 0a3e108d6e2..e425da75b2f 100644--- a/solr/solr-ref-guide/gradle.lockfile+++ b/solr/solr-ref-guide/gradle.lockfile@@ -94,7 +94,7 @@ org.apache.lucene:lucene-highlighter:9.12.1=testRuntimeClasspathorg.apache.lucene:lucene-join:9.12.1=testRuntimeClasspathorg.apache.lucene:lucene-memory:9.12.1=testRuntimeClasspathorg.apache.lucene:lucene-misc:9.12.1=testRuntimeClasspath-org.apache.lucene:lucene-queries:9.12.1=testCompileClasspath,testRuntimeClasspath+org.apache.lucene:lucene-queries:9.12.1=localJavadocs,testCompileClasspath,testRuntimeClasspathorg.apache.lucene:lucene-queryparser:9.12.1=localJavadocs,testRuntimeClasspathorg.apache.lucene:lucene-sandbox:9.12.1=testRuntimeClasspathorg.apache.lucene:lucene-spatial-extras:9.12.1=localJavadocs,testRuntimeClasspathdiff --git a/solr/solr-ref-guide/modules/query-guide/pages/other-parsers.adoc b/solr/solr-ref-guide/modules/query-guide/pages/other-parsers.adocindex 68a4c92b1c5..abc99fbcf1b 100644--- a/solr/solr-ref-guide/modules/query-guide/pages/other-parsers.adoc+++ b/solr/solr-ref-guide/modules/query-guide/pages/other-parsers.adoc@@ -951,8 +951,8 @@ Payloads can be encoded on terms using either the `DelimitedPayloadTokenFilter`=== Payload Score Parser-`PayloadScoreQParser` incorporates each matching term's numeric (integer or float) payloads into the scores.-The main query is parsed from the field type's query analysis into a `SpanQuery` based on the value of the `operator` parameter below.+`PayloadScoreQParser` incorporates each matching term's numeric (integer or float) payloads into the scores via a {lucene-javadocs}/queries/org/apache/lucene/queries/payloads/PayloadScoreQuery.html[PayloadScoreQuery] that is wrapping a {lucene-javadocs}/queries/org/apache/lucene/queries/spans/SpanQuery.html[SpanQuery].+The main query is parsed from the field type's query analysis into the `SpanQuery` based on the value of the `operator` parameter below.This parser accepts the following parameters: