* WARNING: The status of the search.function package is experimental.
@@ -81,7 +81,6 @@
* This parameter is optional - it can be null or even an empty array.
*/
public CustomScoreQuery(Query subQuery, ValueSourceQuery valSrcQueries[]) {
- super();
this.subQuery = subQuery;
this.valSrcQueries = valSrcQueries!=null?
valSrcQueries : new ValueSourceQuery[0];
@@ -90,11 +89,23 @@
/*(non-Javadoc) @see org.apache.lucene.search.Query#rewrite(org.apache.lucene.index.IndexReader) */
public Query rewrite(IndexReader reader) throws IOException {
- subQuery = subQuery.rewrite(reader);
+ CustomScoreQuery clone = null;
+
+ final Query sq = subQuery.rewrite(reader);
+ if (sq != subQuery) {
+ clone = (CustomScoreQuery) clone();
+ clone.subQuery = sq;
+ }
+
for(int i = 0; i < valSrcQueries.length; i++) {
- valSrcQueries[i] = (ValueSourceQuery) valSrcQueries[i].rewrite(reader);
+ final ValueSourceQuery v = (ValueSourceQuery) valSrcQueries[i].rewrite(reader);
+ if (v != valSrcQueries[i]) {
+ if (clone == null) clone = (CustomScoreQuery) clone();
+ clone.valSrcQueries[i] = v;
+ }
}
- return this;
+
+ return (clone == null) ? this : clone;
}
/*(non-Javadoc) @see org.apache.lucene.search.Query#extractTerms(java.util.Set) */
@@ -135,7 +146,8 @@
}
CustomScoreQuery other = (CustomScoreQuery)o;
if (this.getBoost() != other.getBoost() ||
- !this.subQuery.equals(other.subQuery)||
+ !this.subQuery.equals(other.subQuery) ||
+ this.strict != other.strict ||
this.valSrcQueries.length != other.valSrcQueries.length) {
return false;
}
@@ -153,31 +165,48 @@
for (int i=0; i
- * If your custom scoring is different than the default herein you
- * should override at least one of the two customScore() methods.
- * If the number of ValueSourceQueries is always < 2 it is
- * sufficient to override the other
- * {@link #customScore(int, float, float) customScore()}
- * method, which is simpler.
- *
- * The default computation herein is a multiplication of given scores:
- *
- * Subclasses can override this method to modify the custom score.
- *
- * If your custom scoring is different than the default herein you
- * should override at least one of the two customScore() methods.
- * If the number of ValueSourceQueries is always < 2 it is
- * sufficient to override this customScore() method, which is simpler.
- *
- * The default computation herein is a multiplication of the two scores:
- * NOTE: The doc is relative to the current
- * reader, last passed to {@link #setNextReader}.
- *
- * @param doc id of scored doc.
- * @param subQueryScore score of that doc by the subQuery.
- * @param valSrcScore score of that doc by the ValueSourceQuery.
- * @return custom score.
+ * @deprecated Will be removed in Lucene 3.1.
+ * The doc is relative to the current reader, which is
+ * unknown to CustomScoreQuery when using per-segment search (since Lucene 2.9).
+ * Please override {@link #getCustomScoreProvider} and return a subclass
+ * of {@link CustomScoreProvider} for the given {@link IndexReader}.
+ * @see CustomScoreProvider#customScore(int,float,float)
*/
public float customScore(int doc, float subQueryScore, float valSrcScore) {
return subQueryScore * valSrcScore;
}
/**
- * Called when the scoring switches to another reader.
- *
- * @param reader
- * next IndexReader
- */
- public void setNextReader(IndexReader reader) throws IOException {
- }
-
- /**
* Explain the custom score.
- * Whenever overriding {@link #customScore(int, float, float[])},
- * this method should also be overridden to provide the correct explanation
- * for the part of the custom scoring.
- *
- * @param doc doc being explained.
- * @param subQueryExpl explanation for the sub-query part.
- * @param valSrcExpls explanation for the value source part.
- * @return an explanation for the custom score
+ * @deprecated Will be removed in Lucene 3.1.
+ * The doc is relative to the current reader, which is
+ * unknown to CustomScoreQuery when using per-segment search (since Lucene 2.9).
+ * Please override {@link #getCustomScoreProvider} and return a subclass
+ * of {@link CustomScoreProvider} for the given {@link IndexReader}.
+ * @see CustomScoreProvider#customExplain(int,Explanation,Explanation[])
*/
public Explanation customExplain(int doc, Explanation subQueryExpl, Explanation valSrcExpls[]) {
if (valSrcExpls.length == 1) {
@@ -261,14 +265,12 @@
/**
* Explain the custom score.
- * Whenever overriding {@link #customScore(int, float, float)},
- * this method should also be overridden to provide the correct explanation
- * for the part of the custom scoring.
- *
- * @param doc doc being explained.
- * @param subQueryExpl explanation for the sub-query part.
- * @param valSrcExpl explanation for the value source part.
- * @return an explanation for the custom score
+ * @deprecated Will be removed in Lucene 3.1.
+ * The doc is relative to the current reader, which is
+ * unknown to CustomScoreQuery when using per-segment search (since Lucene 2.9).
+ * Please override {@link #getCustomScoreProvider} and return a subclass
+ * of {@link CustomScoreProvider} for the given {@link IndexReader}.
+ * @see CustomScoreProvider#customExplain(int,Explanation,Explanation[])
*/
public Explanation customExplain(int doc, Explanation subQueryExpl, Explanation valSrcExpl) {
float valSrcScore = 1;
@@ -372,7 +374,7 @@
for(int i = 0; i < valSrcScorers.length; i++) {
valSrcExpls[i] = valSrcScorers[i].explain(doc);
}
- Explanation customExp = customExplain(doc,subQueryExpl,valSrcExpls);
+ Explanation customExp = CustomScoreQuery.this.getCustomScoreProvider(reader).customExplain(doc,subQueryExpl,valSrcExpls);
float sc = getValue() * customExp.getValue();
Explanation res = new ComplexExplanation(
true, sc, CustomScoreQuery.this.toString() + ", product of:");
@@ -399,6 +401,7 @@
private Scorer subQueryScorer;
private Scorer[] valSrcScorers;
private IndexReader reader;
+ private final CustomScoreProvider provider;
private float vScores[]; // reused in score() to avoid allocating this array for each doc
// constructor
@@ -411,7 +414,7 @@
this.valSrcScorers = valSrcScorers;
this.reader = reader;
this.vScores = new float[valSrcScorers.length];
- setNextReader(reader);
+ this.provider = CustomScoreQuery.this.getCustomScoreProvider(reader);
}
/** @deprecated use {@link #nextDoc()} instead. */
@@ -443,7 +446,7 @@
for (int i = 0; i < valSrcScorers.length; i++) {
vScores[i] = valSrcScorers[i].score();
}
- return qWeight * customScore(subQueryScorer.docID(), subQueryScorer.score(), vScores);
+ return qWeight * provider.customScore(subQueryScorer.docID(), subQueryScorer.score(), vScores);
}
/** @deprecated use {@link #advance(int)} instead. */
Property changes on: src\java\org\apache\lucene\search\MultiTermQueryWrapperFilter.java
___________________________________________________________________
Modified: svn:mergeinfo
Merged /lucene/java/branches/lucene_3_0/src/java/org/apache/lucene/search/MultiTermQueryWrapperFilter.java:r912383
Property changes on: src\java\org\apache\lucene\util\AttributeSource.java
___________________________________________________________________
Modified: svn:mergeinfo
Merged /lucene/java/branches/lucene_3_0/src/java/org/apache/lucene/util/AttributeSource.java:r912383
Property changes on: src\test\org\apache\lucene\analysis\BaseTokenStreamTestCase.java
___________________________________________________________________
Modified: svn:mergeinfo
Merged /lucene/java/branches/lucene_3_0/src/test/org/apache/lucene/analysis/BaseTokenStreamTestCase.java:r912383
Property changes on: src\test\org\apache\lucene\analysis\TestISOLatin1AccentFilter.java
___________________________________________________________________
Modified: svn:mergeinfo
Merged /lucene/java/branches/lucene_3_0/src/test/org/apache/lucene/analysis/TestISOLatin1AccentFilter.java:r912383
Property changes on: src\test\org\apache\lucene\document\TestDateTools.java
___________________________________________________________________
Modified: svn:mergeinfo
Merged /lucene/java/branches/lucene_3_0/src/test/org/apache/lucene/document/TestDateTools.java:r912383
Property changes on: src\test\org\apache\lucene\document\TestNumberTools.java
___________________________________________________________________
Modified: svn:mergeinfo
Merged /lucene/java/branches/lucene_3_0/src/test/org/apache/lucene/document/TestNumberTools.java:r912383
Property changes on: src\test\org\apache\lucene\index\TestBackwardsCompatibility.java
___________________________________________________________________
Modified: svn:mergeinfo
Merged /lucene/java/branches/lucene_3_0/src/test/org/apache/lucene/index/TestBackwardsCompatibility.java:r912383
Index: src/test/org/apache/lucene/search/function/TestCustomScoreQuery.java
===================================================================
--- src/test/org/apache/lucene/search/function/TestCustomScoreQuery.java (revision 912370)
+++ src/test/org/apache/lucene/search/function/TestCustomScoreQuery.java (working copy)
@@ -74,29 +74,34 @@
// must have static class otherwise serialization tests fail
private static class CustomAddQuery extends CustomScoreQuery {
// constructor
- CustomAddQuery (Query q, ValueSourceQuery qValSrc) {
- super(q,qValSrc);
+ CustomAddQuery(Query q, ValueSourceQuery qValSrc) {
+ super(q, qValSrc);
}
+
/*(non-Javadoc) @see org.apache.lucene.search.function.CustomScoreQuery#name() */
public String name() {
return "customAdd";
}
- /*(non-Javadoc) @see org.apache.lucene.search.function.CustomScoreQuery#customScore(int, float, float) */
- public float customScore(int doc, float subQueryScore, float valSrcScore) {
- return subQueryScore + valSrcScore;
+
+ protected CustomScoreProvider getCustomScoreProvider(IndexReader reader) {
+ return new CustomScoreProvider(reader) {
+ public float customScore(int doc, float subQueryScore, float valSrcScore) {
+ return subQueryScore + valSrcScore;
+ }
+
+ public Explanation customExplain(int doc, Explanation subQueryExpl, Explanation valSrcExpl) {
+ float valSrcScore = valSrcExpl == null ? 0 : valSrcExpl.getValue();
+ Explanation exp = new Explanation(valSrcScore + subQueryExpl.getValue(), "custom score: sum of:");
+ exp.addDetail(subQueryExpl);
+ if (valSrcExpl != null) {
+ exp.addDetail(valSrcExpl);
+ }
+ return exp;
+ }
+ };
}
- /* (non-Javadoc)@see org.apache.lucene.search.function.CustomScoreQuery#customExplain(int, org.apache.lucene.search.Explanation, org.apache.lucene.search.Explanation)*/
- public Explanation customExplain(int doc, Explanation subQueryExpl, Explanation valSrcExpl) {
- float valSrcScore = valSrcExpl==null ? 0 : valSrcExpl.getValue();
- Explanation exp = new Explanation( valSrcScore + subQueryExpl.getValue(), "custom score: sum of:");
- exp.addDetail(subQueryExpl);
- if (valSrcExpl != null) {
- exp.addDetail(valSrcExpl);
- }
- return exp;
- }
}
-
+
// must have static class otherwise serialization tests fail
private static class CustomMulAddQuery extends CustomScoreQuery {
// constructor
@@ -108,50 +113,52 @@
return "customMulAdd";
}
/*(non-Javadoc) @see org.apache.lucene.search.function.CustomScoreQuery#customScore(int, float, float) */
- public float customScore(int doc, float subQueryScore, float valSrcScores[]) {
- if (valSrcScores.length == 0) {
- return subQueryScore;
- }
- if (valSrcScores.length == 1) {
- return subQueryScore + valSrcScores[0];
- // confirm that skipping beyond the last doc, on the
- // previous reader, hits NO_MORE_DOCS
- }
- return (subQueryScore + valSrcScores[0]) * valSrcScores[1]; // we know there are two
- }
- /* (non-Javadoc)@see org.apache.lucene.search.function.CustomScoreQuery#customExplain(int, org.apache.lucene.search.Explanation, org.apache.lucene.search.Explanation)*/
- public Explanation customExplain(int doc, Explanation subQueryExpl, Explanation valSrcExpls[]) {
- if (valSrcExpls.length == 0) {
- return subQueryExpl;
- }
- Explanation exp = new Explanation(valSrcExpls[0].getValue() + subQueryExpl.getValue(), "sum of:");
- exp.addDetail(subQueryExpl);
- exp.addDetail(valSrcExpls[0]);
- if (valSrcExpls.length == 1) {
- exp.setDescription("CustomMulAdd, sum of:");
- return exp;
- }
- Explanation exp2 = new Explanation(valSrcExpls[1].getValue() * exp.getValue(), "custom score: product of:");
- exp2.addDetail(valSrcExpls[1]);
- exp2.addDetail(exp);
- return exp2;
- }
+ protected CustomScoreProvider getCustomScoreProvider(IndexReader reader) {
+ return new CustomScoreProvider(reader) {
+ public float customScore(int doc, float subQueryScore, float valSrcScores[]) {
+ if (valSrcScores.length == 0) {
+ return subQueryScore;
+ }
+ if (valSrcScores.length == 1) {
+ return subQueryScore + valSrcScores[0];
+ // confirm that skipping beyond the last doc, on the
+ // previous reader, hits NO_MORE_DOCS
+ }
+ return (subQueryScore + valSrcScores[0]) * valSrcScores[1]; // we know there are two
+ }
+
+ public Explanation customExplain(int doc, Explanation subQueryExpl, Explanation valSrcExpls[]) {
+ if (valSrcExpls.length == 0) {
+ return subQueryExpl;
+ }
+ Explanation exp = new Explanation(valSrcExpls[0].getValue() + subQueryExpl.getValue(), "sum of:");
+ exp.addDetail(subQueryExpl);
+ exp.addDetail(valSrcExpls[0]);
+ if (valSrcExpls.length == 1) {
+ exp.setDescription("CustomMulAdd, sum of:");
+ return exp;
+ }
+ Explanation exp2 = new Explanation(valSrcExpls[1].getValue() * exp.getValue(), "custom score: product of:");
+ exp2.addDetail(valSrcExpls[1]);
+ exp2.addDetail(exp);
+ return exp2;
+ }
+ };
+ }
}
private final class CustomExternalQuery extends CustomScoreQuery {
- private IndexReader reader;
- private int[] values;
- public float customScore(int doc, float subScore, float valSrcScore) {
- assertTrue(doc <= reader.maxDoc());
- return (float) values[doc];
+ protected CustomScoreProvider getCustomScoreProvider(IndexReader reader) throws IOException {
+ final int[] values = FieldCache.DEFAULT.getInts(reader, INT_FIELD);
+ return new CustomScoreProvider(reader) {
+ public float customScore(int doc, float subScore, float valSrcScore) throws IOException {
+ assertTrue(doc <= reader.maxDoc());
+ return (float) values[doc];
+ }
+ };
}
- public void setNextReader(IndexReader r) throws IOException {
- reader = r;
- values = FieldCache.DEFAULT.getInts(r, INT_FIELD);
- }
-
public CustomExternalQuery(Query q) {
super(q);
}
Property changes on: src\test\org\apache\lucene\util\TestAttributeSource.java
___________________________________________________________________
Modified: svn:mergeinfo
Merged /lucene/java/branches/lucene_3_0/src/test/org/apache/lucene/util/TestAttributeSource.java:r912383
- * ModifiedScore = valSrcScore * valSrcScores[0] * valSrcScores[1] * ...
- *
- *
- * @param doc id of scored doc.
- * @param subQueryScore score of that doc by the subQuery.
- * @param valSrcScores scores of that doc by the ValueSourceQuery.
- * @return custom score.
+ * @deprecated Will be removed in Lucene 3.1.
+ * The doc is relative to the current reader, which is
+ * unknown to CustomScoreQuery when using per-segment search (since Lucene 2.9).
+ * Please override {@link #getCustomScoreProvider} and return a subclass
+ * of {@link CustomScoreProvider} for the given {@link IndexReader}.
+ * @see CustomScoreProvider#customScore(int,float,float[])
*/
public float customScore(int doc, float subQueryScore, float valSrcScores[]) {
if (valSrcScores.length == 1) {
@@ -195,50 +224,25 @@
/**
* Compute a custom score by the subQuery score and the ValueSourceQuery score.
- *
- * ModifiedScore = subQueryScore * valSrcScore
- *
- *
- *