When this method is used the {@link #explain(int)} method should not be used.
- *
- * @param target The target document number.
- * @return true iff there is such a match.
- */
+ /** @deprecated use {@link #advance(int)} instead. */
public boolean skipTo(int target) throws IOException {
+ return advance(target) != NO_MORE_DOCS;
+ }
+
+ public int advance(int target) throws IOException {
if (countingSumScorer == null) {
initCountingSumScorer();
}
- return countingSumScorer.skipTo(target);
+ return doc = countingSumScorer.advance(target);
}
-
+
/** Throws an UnsupportedOperationException.
* TODO: Implement an explanation of the coordination factor.
* @param doc The document number for the explanation.
diff --git a/src/java/org/apache/lucene/search/ConjunctionScorer.java b/src/java/org/apache/lucene/search/ConjunctionScorer.java
index fc86029cc06..57f3cd85d7a 100644
--- a/src/java/org/apache/lucene/search/ConjunctionScorer.java
+++ b/src/java/org/apache/lucene/search/ConjunctionScorer.java
@@ -24,76 +24,54 @@ import java.util.Comparator;
/** Scorer for conjunctions, sets of queries, all of which are required. */
class ConjunctionScorer extends Scorer {
+
private final Scorer[] scorers;
-
- private boolean firstTime=true;
- private boolean more;
private final float coord;
- private int lastDoc=-1;
+ private int lastDoc = -1;
public ConjunctionScorer(Similarity similarity, Collection scorers) throws IOException {
- this(similarity, (Scorer[])scorers.toArray(new Scorer[scorers.size()]));
+ this(similarity, (Scorer[]) scorers.toArray(new Scorer[scorers.size()]));
}
public ConjunctionScorer(Similarity similarity, Scorer[] scorers) throws IOException {
super(similarity);
this.scorers = scorers;
- coord = getSimilarity().coord(this.scorers.length, this.scorers.length);
- }
-
- public int doc() { return lastDoc; }
-
- public boolean next() throws IOException {
- if (firstTime)
- return init(0);
- else if (more)
- more = scorers[(scorers.length-1)].next();
- return doNext();
- }
-
- private boolean doNext() throws IOException {
- int first=0;
- Scorer lastScorer = scorers[scorers.length-1];
- Scorer firstScorer;
- while (more && (firstScorer=scorers[first]).doc() < (lastDoc=lastScorer.doc())) {
- more = firstScorer.skipTo(lastDoc);
- lastScorer = firstScorer;
- first = (first == (scorers.length-1)) ? 0 : first+1;
- }
- return more;
- }
-
- public boolean skipTo(int target) throws IOException {
- if (firstTime)
- return init(target);
- else if (more)
- more = scorers[(scorers.length-1)].skipTo(target);
- return doNext();
- }
-
- // Note... most of this could be done in the constructor
- // thus skipping a check for firstTime per call to next() and skipTo()
- private boolean init(int target) throws IOException {
- firstTime=false;
- more = scorers.length>1;
- for (int i=0; i This is invalid until {@link
- #next()} is called for the first time.*/
- public abstract int doc();
-
- /** Moves to the next docId in the set. Returns true, iff
- * there is such a docId. */
- public abstract boolean next() throws IOException;
-
- /** Skips entries to the first beyond the current whose document number is
- * greater than or equal to target. Returns true iff there is such
- * an entry. Behaves as if written:
+ * NOTE: in 3.0, this method will become abstract.
+ *
+ * @since 2.9
+ */
+ public int docID() {
+ return doc;
+ }
+
+ /**
+ * Unsupported anymore. Call {@link #nextDoc()} instead. This method throws
+ * {@link UnsupportedOperationException} if called.
+ *
+ * @deprecated use {@link #nextDoc()} instead. This will be removed in 3.0
+ */
+ public boolean next() throws IOException {
+ throw new UnsupportedOperationException("Call nextDoc() instead.");
+ }
+
+ /**
+ * Unsupported anymore. Call {@link #advance(int)} instead. This method throws
+ * {@link UnsupportedOperationException} if called.
+ *
+ * @deprecated use {@link #advance(int)} instead. This will be removed in 3.0
+ */
+ public boolean skipTo(int target) throws IOException {
+ throw new UnsupportedOperationException("Call advance() instead.");
+ }
+
+ /**
+ * Advances to the next document in the set and returns the doc it is
+ * currently on, or {@link #NO_MORE_DOCS} if there are no more docs in the
+ * set.
+ * Behaves as if written:
+ *
+ *
+ * NOTE: certain implemenations may return a different value (each
+ * time) if called several times in a row with the same target.
+ *
+ * NOTE: this method may be called with {@value #NO_MORE_DOCS} for
+ * efficiency by some Scorers. If your implementation cannot efficiently
+ * determine that it should exhaust, it is recommended that you check for that
+ * value in each call to this method.
+ *
+ * NOTE: after the iterator has exhausted you should not call this
+ * method, as it may result in unpredicted behavior.
+ *
+ * NOTE: in 3.0 this method will become abstract, following the removal
+ * of {@link #skipTo(int)}.
+ *
+ * @since 2.9
+ */
+ public int advance(int target) throws IOException {
+ while (nextDoc() < target) {}
+ return doc;
+ }
+
}
diff --git a/src/java/org/apache/lucene/search/FieldCacheRangeFilter.java b/src/java/org/apache/lucene/search/FieldCacheRangeFilter.java
index c377eaed540..28b6b7ae1ae 100644
--- a/src/java/org/apache/lucene/search/FieldCacheRangeFilter.java
+++ b/src/java/org/apache/lucene/search/FieldCacheRangeFilter.java
@@ -158,37 +158,51 @@ public class FieldCacheRangeFilter extends Filter {
protected class RangeMultiFilterIterator extends DocIdSetIterator {
private int doc = -1;
-
+
+ /** @deprecated use {@link #docID()} instead. */
public int doc() {
return doc;
}
+ public int docID() {
+ return doc;
+ }
+
+ /** @deprecated use {@link #nextDoc()} instead. */
public boolean next() {
+ return nextDoc() != NO_MORE_DOCS;
+ }
+
+ public int nextDoc() {
try {
do {
doc++;
} while (fcsi.order[doc] > inclusiveUpperPoint
|| fcsi.order[doc] < inclusiveLowerPoint);
- return true;
} catch (ArrayIndexOutOfBoundsException e) {
- doc = Integer.MAX_VALUE;
- return false;
+ doc = NO_MORE_DOCS;
}
+ return doc;
}
-
+
+ /** @deprecated use {@link #advance(int)} instead. */
public boolean skipTo(int target) {
+ return advance(target) != NO_MORE_DOCS;
+ }
+
+ public int advance(int target) {
try {
doc = target;
while (fcsi.order[doc] > inclusiveUpperPoint
|| fcsi.order[doc] < inclusiveLowerPoint) {
doc++;
}
- return true;
} catch (ArrayIndexOutOfBoundsException e) {
- doc = Integer.MAX_VALUE;
- return false;
+ doc = NO_MORE_DOCS;
}
+ return doc;
}
+
}
}
}
diff --git a/src/java/org/apache/lucene/search/FieldCacheTermsFilter.java b/src/java/org/apache/lucene/search/FieldCacheTermsFilter.java
index bdfe36b0c94..17332779a25 100644
--- a/src/java/org/apache/lucene/search/FieldCacheTermsFilter.java
+++ b/src/java/org/apache/lucene/search/FieldCacheTermsFilter.java
@@ -17,12 +17,11 @@ package org.apache.lucene.search;
* limitations under the License.
*/
-import org.apache.lucene.index.IndexReader;
-import org.apache.lucene.index.TermDocs; // for javadoc
-import org.apache.lucene.util.OpenBitSet;
-
import java.io.IOException;
+import org.apache.lucene.index.IndexReader;
+import org.apache.lucene.util.OpenBitSet;
+
/**
* A {@link Filter} that only accepts documents whose single
* term value in the specified field is contained in the
@@ -133,33 +132,44 @@ public class FieldCacheTermsFilter extends Filter {
protected class FieldCacheTermsFilterDocIdSetIterator extends DocIdSetIterator {
private int doc = -1;
+ /** @deprecated use {@link #docID()} instead. */
public int doc() {
return doc;
}
-
- public boolean next() {
- try {
- do {
- doc++;
- } while (!openBitSet.fastGet(fcsi.order[doc]));
- return true;
- } catch (ArrayIndexOutOfBoundsException e) {
- doc = Integer.MAX_VALUE;
- return false;
- }
+
+ public int docID() {
+ return doc;
}
+ /** @deprecated use {@link #nextDoc()} instead. */
+ public boolean next() {
+ return nextDoc() != NO_MORE_DOCS;
+ }
+
+ public int nextDoc() {
+ try {
+ while (!openBitSet.fastGet(fcsi.order[++doc])) {}
+ } catch (ArrayIndexOutOfBoundsException e) {
+ doc = NO_MORE_DOCS;
+ }
+ return doc;
+ }
+
+ /** @deprecated use {@link #advance(int)} instead. */
public boolean skipTo(int target) {
+ return advance(target) != NO_MORE_DOCS;
+ }
+
+ public int advance(int target) {
try {
doc = target;
while (!openBitSet.fastGet(fcsi.order[doc])) {
doc++;
}
- return true;
} catch (ArrayIndexOutOfBoundsException e) {
- doc = Integer.MAX_VALUE;
- return false;
+ doc = NO_MORE_DOCS;
}
+ return doc;
}
}
}
diff --git a/src/java/org/apache/lucene/search/FilteredDocIdSetIterator.java b/src/java/org/apache/lucene/search/FilteredDocIdSetIterator.java
index cf45e7e12df..32960b21c87 100644
--- a/src/java/org/apache/lucene/search/FilteredDocIdSetIterator.java
+++ b/src/java/org/apache/lucene/search/FilteredDocIdSetIterator.java
@@ -25,10 +25,9 @@ import java.io.IOException;
* mechanism on an underlying DocIdSetIterator. See {@link
* FilteredDocIdSet}.
*/
-
public abstract class FilteredDocIdSetIterator extends DocIdSetIterator {
protected DocIdSetIterator _innerIter;
- private int _currentDoc;
+ private int doc;
/**
* Constructor.
@@ -39,7 +38,7 @@ public abstract class FilteredDocIdSetIterator extends DocIdSetIterator {
throw new IllegalArgumentException("null iterator");
}
_innerIter = innerIter;
- _currentDoc = -1;
+ doc = -1;
}
/**
@@ -50,42 +49,49 @@ public abstract class FilteredDocIdSetIterator extends DocIdSetIterator {
*/
abstract protected boolean match(int doc);
- // @Override
+ /** @deprecated use {@link #docID()} instead. */
public final int doc() {
- return _currentDoc;
+ return doc;
}
- // @Override
+ public int docID() {
+ return doc;
+ }
+
+ /** @deprecated use {@link #nextDoc()} instead. */
public final boolean next() throws IOException{
- while (_innerIter.next()) {
- int doc = _innerIter.doc();
+ return nextDoc() != NO_MORE_DOCS;
+ }
+
+ public int nextDoc() throws IOException {
+ while ((doc = _innerIter.nextDoc()) != NO_MORE_DOCS) {
if (match(doc)) {
- _currentDoc = doc;
- return true;
+ return doc;
}
}
- return false;
+ return doc;
}
-
- // @Override
+
+ /** @deprecated use {@link #advance(int)} instead. */
public final boolean skipTo(int n) throws IOException{
- boolean flag = _innerIter.skipTo(n);
- if (flag) {
- int doc = _innerIter.doc();
+ return advance(n) != NO_MORE_DOCS;
+ }
+
+ public int advance(int target) throws IOException {
+ doc = _innerIter.advance(target);
+ if (doc != NO_MORE_DOCS) {
if (match(doc)) {
- _currentDoc = doc;
- return true;
+ return doc;
} else {
- while (_innerIter.next()) {
- int docid = _innerIter.doc();
- if (match(docid)) {
- _currentDoc = docid;
- return true;
+ while ((doc = _innerIter.nextDoc()) != NO_MORE_DOCS) {
+ if (match(doc)) {
+ return doc;
}
}
- return false;
+ return doc;
}
}
- return flag;
+ return doc;
}
+
}
diff --git a/src/java/org/apache/lucene/search/FilteredQuery.java b/src/java/org/apache/lucene/search/FilteredQuery.java
index f79d9391b6a..9a11ee126a8 100644
--- a/src/java/org/apache/lucene/search/FilteredQuery.java
+++ b/src/java/org/apache/lucene/search/FilteredQuery.java
@@ -85,7 +85,7 @@ extends Query {
}
Filter f = FilteredQuery.this.filter;
DocIdSetIterator docIdSetIterator = f.getDocIdSet(ir).iterator();
- if (docIdSetIterator.skipTo(i) && (docIdSetIterator.doc() == i)) {
+ if (docIdSetIterator.advance(i) == i) {
return inner;
} else {
Explanation result = new Explanation
@@ -99,35 +99,51 @@ extends Query {
public Query getQuery() { return FilteredQuery.this; }
// return a filtering scorer
- public Scorer scorer (IndexReader indexReader) throws IOException {
+ public Scorer scorer (IndexReader indexReader) throws IOException {
final Scorer scorer = weight.scorer(indexReader);
final DocIdSetIterator docIdSetIterator = filter.getDocIdSet(indexReader).iterator();
return new Scorer(similarity) {
- private boolean advanceToCommon() throws IOException {
- while (scorer.doc() != docIdSetIterator.doc()) {
- if (scorer.doc() < docIdSetIterator.doc()) {
- if (!scorer.skipTo(docIdSetIterator.doc())) {
- return false;
- }
- } else if (!docIdSetIterator.skipTo(scorer.doc())) {
- return false;
+ private int doc = -1;
+
+ private int advanceToCommon(int scorerDoc, int disiDoc) throws IOException {
+ while (scorerDoc != disiDoc) {
+ if (scorerDoc < disiDoc) {
+ scorerDoc = scorer.advance(disiDoc);
+ } else {
+ disiDoc = docIdSetIterator.advance(scorerDoc);
}
}
- return true;
+ return scorerDoc;
}
+ /** @deprecated use {@link #nextDoc()} instead. */
public boolean next() throws IOException {
- return docIdSetIterator.next() && scorer.next() && advanceToCommon();
+ return nextDoc() != NO_MORE_DOCS;
}
+ public int nextDoc() throws IOException {
+ int scorerDoc, disiDoc;
+ return doc = (disiDoc = docIdSetIterator.nextDoc()) != NO_MORE_DOCS
+ && (scorerDoc = scorer.nextDoc()) != NO_MORE_DOCS
+ && advanceToCommon(scorerDoc, disiDoc) != NO_MORE_DOCS ? scorer.docID() : NO_MORE_DOCS;
+ }
+
+ /** @deprecated use {@link #docID()} instead. */
public int doc() { return scorer.doc(); }
-
+ public int docID() { return doc; }
+
+ /** @deprecated use {@link #advance(int)} instead. */
public boolean skipTo(int i) throws IOException {
- return docIdSetIterator.skipTo(i)
- && scorer.skipTo(docIdSetIterator.doc())
- && advanceToCommon();
+ return advance(i) != NO_MORE_DOCS;
+ }
+
+ public int advance(int target) throws IOException {
+ int disiDoc, scorerDoc;
+ return doc = (disiDoc = docIdSetIterator.advance(target)) != NO_MORE_DOCS
+ && (scorerDoc = scorer.advance(disiDoc)) != NO_MORE_DOCS
+ && advanceToCommon(scorerDoc, disiDoc) != NO_MORE_DOCS ? scorer.docID() : NO_MORE_DOCS;
}
public float score() throws IOException { return getBoost() * scorer.score(); }
@@ -136,7 +152,7 @@ extends Query {
public Explanation explain (int i) throws IOException {
Explanation exp = scorer.explain(i);
- if (docIdSetIterator.skipTo(i) && (docIdSetIterator.doc() == i)) {
+ if (docIdSetIterator.advance(i) == i) {
exp.setDescription ("allowed by filter: "+exp.getDescription());
exp.setValue(getBoost() * exp.getValue());
} else {
diff --git a/src/java/org/apache/lucene/search/IndexSearcher.java b/src/java/org/apache/lucene/search/IndexSearcher.java
index e028161c22f..60e7306effb 100644
--- a/src/java/org/apache/lucene/search/IndexSearcher.java
+++ b/src/java/org/apache/lucene/search/IndexSearcher.java
@@ -258,28 +258,34 @@ public class IndexSearcher extends Searcher {
if (scorer == null)
return;
+ int docID = scorer.docID();
+ assert docID == -1 || docID == DocIdSetIterator.NO_MORE_DOCS;
+
if (filter == null) {
scorer.score(collector);
return;
}
- DocIdSetIterator filterDocIdIterator = filter.getDocIdSet(reader).iterator(); // CHECKME: use ConjunctionScorer here?
+ // CHECKME: use ConjunctionScorer here?
+ DocIdSetIterator filterIter = filter.getDocIdSet(reader).iterator();
+
+ int filterDoc = filterIter.nextDoc();
+ int scorerDoc = scorer.advance(filterDoc);
- boolean more = filterDocIdIterator.next() && scorer.skipTo(filterDocIdIterator.doc());
-
collector.setScorer(scorer);
- while (more) {
- int filterDocId = filterDocIdIterator.doc();
- if (filterDocId > scorer.doc() && !scorer.skipTo(filterDocId)) {
- more = false;
- } else {
- int scorerDocId = scorer.doc();
- if (scorerDocId == filterDocId) { // permitted by filter
- collector.collect(scorerDocId);
- more = filterDocIdIterator.next();
- } else {
- more = filterDocIdIterator.skipTo(scorerDocId);
+ while (true) {
+ if (scorerDoc == filterDoc) {
+ // Check if scorer has exhausted, only before collecting.
+ if (scorerDoc == DocIdSetIterator.NO_MORE_DOCS) {
+ break;
}
+ collector.collect(scorerDoc);
+ filterDoc = filterIter.nextDoc();
+ scorerDoc = scorer.advance(filterDoc);
+ } else if (scorerDoc > filterDoc) {
+ filterDoc = filterIter.advance(scorerDoc);
+ } else {
+ scorerDoc = scorer.advance(filterDoc);
}
}
}
diff --git a/src/java/org/apache/lucene/search/MatchAllDocsQuery.java b/src/java/org/apache/lucene/search/MatchAllDocsQuery.java
index 685e6d68235..35ca11622b0 100644
--- a/src/java/org/apache/lucene/search/MatchAllDocsQuery.java
+++ b/src/java/org/apache/lucene/search/MatchAllDocsQuery.java
@@ -47,9 +47,10 @@ public class MatchAllDocsQuery extends Query {
final TermDocs termDocs;
final float score;
final byte[] norms;
-
- MatchAllScorer(IndexReader reader, Similarity similarity, Weight w, byte[] norms) throws IOException
- {
+ private int doc = -1;
+
+ MatchAllScorer(IndexReader reader, Similarity similarity, Weight w,
+ byte[] norms) throws IOException {
super(similarity);
this.termDocs = reader.termDocs(null);
score = w.getValue();
@@ -60,26 +61,36 @@ public class MatchAllDocsQuery extends Query {
return null; // not called... see MatchAllDocsWeight.explain()
}
+ /** @deprecated use {@link #docID()} instead. */
public int doc() {
return termDocs.doc();
}
+
+ public int docID() {
+ return doc;
+ }
+ /** @deprecated use {@link #nextDoc()} instead. */
public boolean next() throws IOException {
- return termDocs.next();
+ return nextDoc() != NO_MORE_DOCS;
}
+ public int nextDoc() throws IOException {
+ return doc = termDocs.next() ? termDocs.doc() : NO_MORE_DOCS;
+ }
+
public float score() {
- if (norms == null) {
- return score;
- } else {
- return score * Similarity.decodeNorm(norms[doc()]); // normalize for field
- }
+ return norms == null ? score : score * Similarity.decodeNorm(norms[docID()]);
}
+ /** @deprecated use {@link #advance(int)} instead. */
public boolean skipTo(int target) throws IOException {
- return termDocs.skipTo(target);
+ return advance(target) != NO_MORE_DOCS;
}
+ public int advance(int target) throws IOException {
+ return doc = termDocs.skipTo(target) ? termDocs.doc() : NO_MORE_DOCS;
+ }
}
private class MatchAllDocsWeight implements Weight {
diff --git a/src/java/org/apache/lucene/search/NonMatchingScorer.java b/src/java/org/apache/lucene/search/NonMatchingScorer.java
index 3455d4728c0..0260b036516 100644
--- a/src/java/org/apache/lucene/search/NonMatchingScorer.java
+++ b/src/java/org/apache/lucene/search/NonMatchingScorer.java
@@ -23,13 +23,22 @@ import java.io.IOException;
class NonMatchingScorer extends Scorer {
public NonMatchingScorer() { super(null); } // no similarity used
+ /** @deprecated use {@link #docID()} instead. */
public int doc() { throw new UnsupportedOperationException(); }
+
+ public int docID() { return NO_MORE_DOCS; }
+ /** @deprecated use {@link #nextDoc()} instead. */
public boolean next() throws IOException { return false; }
+
+ public int nextDoc() throws IOException { return NO_MORE_DOCS; }
public float score() { throw new UnsupportedOperationException(); }
+ /** @deprecated use {@link #advance(int)} instead. */
public boolean skipTo(int target) { return false; }
+
+ public int advance(int target) { return NO_MORE_DOCS; }
public Explanation explain(int doc) {
Explanation e = new Explanation();
diff --git a/src/java/org/apache/lucene/search/PhraseScorer.java b/src/java/org/apache/lucene/search/PhraseScorer.java
index 7e5e720ad28..1d4942e65ab 100644
--- a/src/java/org/apache/lucene/search/PhraseScorer.java
+++ b/src/java/org/apache/lucene/search/PhraseScorer.java
@@ -43,9 +43,8 @@ abstract class PhraseScorer extends Scorer {
private float freq; //prhase frequency in current doc as computed by phraseFreq().
-
- PhraseScorer(Weight weight, TermPositions[] tps, int[] offsets, Similarity similarity,
- byte[] norms) {
+ PhraseScorer(Weight weight, TermPositions[] tps, int[] offsets,
+ Similarity similarity, byte[] norms) {
super(similarity);
this.norms = norms;
this.weight = weight;
@@ -60,25 +59,37 @@ abstract class PhraseScorer extends Scorer {
PhrasePositions pp = new PhrasePositions(tps[i], offsets[i]);
if (last != null) { // add next to end of list
last.next = pp;
- } else
+ } else {
first = pp;
+ }
last = pp;
}
pq = new PhraseQueue(tps.length); // construct empty pq
-
+ first.doc = -1;
}
+ /** @deprecated use {@link #docID()} instead. */
public int doc() { return first.doc; }
+
+ public int docID() { return first.doc; }
+ /** @deprecated use {@link #nextDoc()} instead. */
public boolean next() throws IOException {
+ return nextDoc() != NO_MORE_DOCS;
+ }
+
+ public int nextDoc() throws IOException {
if (firstTime) {
init();
firstTime = false;
} else if (more) {
more = last.next(); // trigger further scanning
}
- return doNext();
+ if (!doNext()) {
+ first.doc = NO_MORE_DOCS;
+ }
+ return first.doc;
}
// next without initial increment
@@ -107,16 +118,25 @@ abstract class PhraseScorer extends Scorer {
return norms == null ? raw : raw * Similarity.decodeNorm(norms[first.doc]); // normalize
}
+ /** @deprecated use {@link #advance(int)} instead. */
public boolean skipTo(int target) throws IOException {
+ return advance(target) != NO_MORE_DOCS;
+ }
+
+ public int advance(int target) throws IOException {
firstTime = false;
for (PhrasePositions pp = first; more && pp != null; pp = pp.next) {
more = pp.skipTo(target);
}
- if (more)
+ if (more) {
sort(); // re-sort
- return doNext();
+ }
+ if (!doNext()) {
+ first.doc = NO_MORE_DOCS;
+ }
+ return first.doc;
}
-
+
/**
* For a document containing all the phrase query terms, compute the
* frequency of the phrase in that document.
@@ -127,16 +147,19 @@ abstract class PhraseScorer extends Scorer {
protected abstract float phraseFreq() throws IOException;
private void init() throws IOException {
- for (PhrasePositions pp = first; more && pp != null; pp = pp.next)
+ for (PhrasePositions pp = first; more && pp != null; pp = pp.next) {
more = pp.next();
- if(more)
+ }
+ if (more) {
sort();
+ }
}
private void sort() {
pq.clear();
- for (PhrasePositions pp = first; pp != null; pp = pp.next)
- pq.put(pp);
+ for (PhrasePositions pp = first; pp != null; pp = pp.next) {
+ pq.add(pp);
+ }
pqToList();
}
@@ -163,9 +186,8 @@ abstract class PhraseScorer extends Scorer {
public Explanation explain(final int doc) throws IOException {
Explanation tfExplanation = new Explanation();
- while (next() && doc() < doc) {}
-
- float phraseFreq = (doc() == doc) ? freq : 0.0f;
+ int d = advance(doc);
+ float phraseFreq = (d == doc) ? freq : 0.0f;
tfExplanation.setValue(getSimilarity().tf(phraseFreq));
tfExplanation.setDescription("tf(phraseFreq=" + phraseFreq + ")");
diff --git a/src/java/org/apache/lucene/search/ReqExclScorer.java b/src/java/org/apache/lucene/search/ReqExclScorer.java
index 9cc664c5537..6fa6e597585 100644
--- a/src/java/org/apache/lucene/search/ReqExclScorer.java
+++ b/src/java/org/apache/lucene/search/ReqExclScorer.java
@@ -29,76 +29,78 @@ import java.io.IOException;
class ReqExclScorer extends Scorer {
private Scorer reqScorer;
private DocIdSetIterator exclDisi;
+ private int doc = -1;
/** Construct a
+ * NOTE: this class assumes the stored integers are doc Ids (hence why it
+ * extends {@link DocIdSet}). Therefore its {@link #iterator()} assumes {@value
+ * DocIdSetIterator#NO_MORE_DOCS} can be used as sentinel. If you intent to use
+ * this value, then make sure it's not used during search flow.
*/
public class SortedVIntList extends DocIdSet {
/** When a BitSet has fewer than 1 in BITS2VINTLIST_SIZE bits set,
@@ -99,8 +104,9 @@ public class SortedVIntList extends DocIdSet {
*/
public SortedVIntList(DocIdSetIterator docIdSetIterator) throws IOException {
SortedVIntListBuilder builder = new SortedVIntListBuilder();
- while (docIdSetIterator.next()) {
- builder.addInt(docIdSetIterator.doc());
+ int doc;
+ while ((doc = docIdSetIterator.nextDoc()) != DocIdSetIterator.NO_MORE_DOCS) {
+ builder.addInt(doc);
}
builder.done();
}
@@ -181,6 +187,7 @@ public class SortedVIntList extends DocIdSet {
return new DocIdSetIterator() {
int bytePos = 0;
int lastInt = 0;
+ int doc = -1;
private void advance() {
// See org.apache.lucene.store.IndexInput.readVInt()
@@ -192,26 +199,43 @@ public class SortedVIntList extends DocIdSet {
}
}
+ /** @deprecated use {@link #docID()} instead. */
public int doc() {return lastInt;}
+ public int docID() {
+ return doc;
+ }
+
+ /** @deprecated use {@link #nextDoc()} instead. */
public boolean next() {
- if (bytePos >= lastBytePos) {
- return false;
- } else {
- advance();
- return true;
- }
+ return nextDoc() != NO_MORE_DOCS;
}
+ public int nextDoc() {
+ if (bytePos >= lastBytePos) {
+ doc = NO_MORE_DOCS;
+ } else {
+ advance();
+ doc = lastInt;
+ }
+ return doc;
+ }
+
+ /** @deprecated use {@link #advance(int)} instead. */
public boolean skipTo(int docNr) {
+ return advance(docNr) != NO_MORE_DOCS;
+ }
+
+ public int advance(int target) {
while (bytePos < lastBytePos) {
advance();
- if (lastInt >= docNr) { // No skipping to docNr available.
- return true;
+ if (lastInt >= target) {
+ return doc = lastInt;
}
}
- return false;
+ return doc = NO_MORE_DOCS;
}
+
};
}
}
diff --git a/src/test/org/apache/lucene/search/JustCompileSearch.java b/src/test/org/apache/lucene/search/JustCompileSearch.java
index ce96955d104..6e8f4cd0b8b 100644
--- a/src/test/org/apache/lucene/search/JustCompileSearch.java
+++ b/src/test/org/apache/lucene/search/JustCompileSearch.java
@@ -175,18 +175,32 @@ final class JustCompileSearch {
static final class JustCompileDocIdSetIterator extends DocIdSetIterator {
+ /** @deprecated delete in 3.0 */
public int doc() {
throw new UnsupportedOperationException(UNSUPPORTED_MSG);
}
+
+ public int docID() {
+ throw new UnsupportedOperationException(UNSUPPORTED_MSG);
+ }
+ /** @deprecated delete in 3.0 */
public boolean next() throws IOException {
throw new UnsupportedOperationException(UNSUPPORTED_MSG);
}
+ /** @deprecated delete in 3.0 */
public boolean skipTo(int target) throws IOException {
throw new UnsupportedOperationException(UNSUPPORTED_MSG);
}
+ public int nextDoc() throws IOException {
+ throw new UnsupportedOperationException(UNSUPPORTED_MSG);
+ }
+
+ public int advance(int target) throws IOException {
+ throw new UnsupportedOperationException(UNSUPPORTED_MSG);
+ }
}
static final class JustCompileFieldCache implements FieldCache {
@@ -470,6 +484,11 @@ final class JustCompileSearch {
super(similarity);
}
+ protected boolean score(Collector collector, int max, int firstDocID)
+ throws IOException {
+ throw new UnsupportedOperationException(UNSUPPORTED_MSG);
+ }
+
public Explanation explain(int doc) throws IOException {
throw new UnsupportedOperationException(UNSUPPORTED_MSG);
}
@@ -478,18 +497,32 @@ final class JustCompileSearch {
throw new UnsupportedOperationException(UNSUPPORTED_MSG);
}
+ /** @deprecated delete in 3.0 */
public int doc() {
throw new UnsupportedOperationException(UNSUPPORTED_MSG);
}
+
+ public int docID() {
+ throw new UnsupportedOperationException(UNSUPPORTED_MSG);
+ }
+ /** @deprecated delete in 3.0. */
public boolean next() throws IOException {
throw new UnsupportedOperationException(UNSUPPORTED_MSG);
}
+ /** @deprecated delete in 3.0. */
public boolean skipTo(int target) throws IOException {
throw new UnsupportedOperationException(UNSUPPORTED_MSG);
}
+
+ public int nextDoc() throws IOException {
+ throw new UnsupportedOperationException(UNSUPPORTED_MSG);
+ }
+ public int advance(int target) throws IOException {
+ throw new UnsupportedOperationException(UNSUPPORTED_MSG);
+ }
}
static final class JustCompileSimilarity extends Similarity {
diff --git a/src/test/org/apache/lucene/search/QueryUtils.java b/src/test/org/apache/lucene/search/QueryUtils.java
index 136fa350abb..47a352eef97 100644
--- a/src/test/org/apache/lucene/search/QueryUtils.java
+++ b/src/test/org/apache/lucene/search/QueryUtils.java
@@ -1,13 +1,13 @@
package org.apache.lucene.search;
-import junit.framework.TestCase;
-
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
+import junit.framework.Assert;
+
import org.apache.lucene.index.IndexReader;
/**
@@ -56,17 +56,17 @@ public class QueryUtils {
}
public static void checkEqual(Query q1, Query q2) {
- TestCase.assertEquals(q1, q2);
- TestCase.assertEquals(q1.hashCode(), q2.hashCode());
+ Assert.assertEquals(q1, q2);
+ Assert.assertEquals(q1.hashCode(), q2.hashCode());
}
public static void checkUnequal(Query q1, Query q2) {
- TestCase.assertTrue(!q1.equals(q2));
- TestCase.assertTrue(!q2.equals(q1));
+ Assert.assertTrue(!q1.equals(q2));
+ Assert.assertTrue(!q2.equals(q1));
// possible this test can fail on a hash collision... if that
// happens, please change test to use a different example.
- TestCase.assertTrue(q1.hashCode() != q2.hashCode());
+ Assert.assertTrue(q1.hashCode() != q2.hashCode());
}
/** deep check that explanations of a query 'score' correctly */
@@ -169,8 +169,9 @@ public class QueryUtils {
try {
int op = order[(opidx[0]++)%order.length];
//System.out.println(op==skip_op ? "skip("+(sdoc[0]+1)+")":"next()");
- boolean more = op==skip_op ? scorer.skipTo(sdoc[0]+1) : scorer.next();
- sdoc[0] = scorer.doc();
+ boolean more = op == skip_op ? scorer.advance(sdoc[0] + 1) != DocIdSetIterator.NO_MORE_DOCS
+ : scorer.nextDoc() != DocIdSetIterator.NO_MORE_DOCS;
+ sdoc[0] = scorer.docID();
float scorerScore = scorer.score();
float scorerScore2 = scorer.score();
float scoreDiff = Math.abs(score-scorerScore);
@@ -204,8 +205,9 @@ public class QueryUtils {
// make sure next call to scorer is false.
int op = order[(opidx[0]++)%order.length];
//System.out.println(op==skip_op ? "last: skip()":"last: next()");
- boolean more = op==skip_op ? scorer.skipTo(sdoc[0]+1) : scorer.next();
- TestCase.assertFalse(more);
+ boolean more = (op == skip_op ? scorer.advance(sdoc[0] + 1) : scorer
+ .nextDoc()) != DocIdSetIterator.NO_MORE_DOCS;
+ Assert.assertFalse(more);
}
}
@@ -228,11 +230,11 @@ public class QueryUtils {
for (int i=lastDoc[0]+1; i<=doc; i++) {
Weight w = q.weight(s);
Scorer scorer = w.scorer(s.getIndexReader());
- TestCase.assertTrue("query collected "+doc+" but skipTo("+i+") says no more docs!",scorer.skipTo(i));
- TestCase.assertEquals("query collected "+doc+" but skipTo("+i+") got to "+scorer.doc(),doc,scorer.doc());
+ Assert.assertTrue("query collected "+doc+" but skipTo("+i+") says no more docs!",scorer.advance(i) != DocIdSetIterator.NO_MORE_DOCS);
+ Assert.assertEquals("query collected "+doc+" but skipTo("+i+") got to "+scorer.docID(),doc,scorer.docID());
float skipToScore = scorer.score();
- TestCase.assertEquals("unstable skipTo("+i+") score!",skipToScore,scorer.score(),maxDiff);
- TestCase.assertEquals("query assigned doc "+doc+" a score of <"+score+"> but skipTo("+i+") has <"+skipToScore+">!",score,skipToScore,maxDiff);
+ Assert.assertEquals("unstable skipTo("+i+") score!",skipToScore,scorer.score(),maxDiff);
+ Assert.assertEquals("query assigned doc "+doc+" a score of <"+score+"> but skipTo("+i+") has <"+skipToScore+">!",score,skipToScore,maxDiff);
}
lastDoc[0] = doc;
} catch (IOException e) {
@@ -245,8 +247,8 @@ public class QueryUtils {
});
Weight w = q.weight(s);
Scorer scorer = w.scorer(s.getIndexReader());
- boolean more = scorer.skipTo(lastDoc[0]+1);
+ boolean more = scorer.advance(lastDoc[0] + 1) != DocIdSetIterator.NO_MORE_DOCS;
if (more)
- TestCase.assertFalse("query's last doc was "+lastDoc[0]+" but skipTo("+(lastDoc[0]+1)+") got to "+scorer.doc(),more);
+ Assert.assertFalse("query's last doc was "+lastDoc[0]+" but skipTo("+(lastDoc[0]+1)+") got to "+scorer.docID(),more);
}
}
diff --git a/src/test/org/apache/lucene/search/TestBoolean2.java b/src/test/org/apache/lucene/search/TestBoolean2.java
index bd8282b9407..a538cdb9d31 100644
--- a/src/test/org/apache/lucene/search/TestBoolean2.java
+++ b/src/test/org/apache/lucene/search/TestBoolean2.java
@@ -18,23 +18,18 @@ package org.apache.lucene.search;
*/
-import org.apache.lucene.store.RAMDirectory;
-
-import org.apache.lucene.index.IndexWriter;
-import org.apache.lucene.index.Term;
+import java.util.Random;
import org.apache.lucene.analysis.WhitespaceAnalyzer;
-
import org.apache.lucene.document.Document;
import org.apache.lucene.document.Field;
-
-import org.apache.lucene.queryParser.QueryParser;
+import org.apache.lucene.index.IndexWriter;
+import org.apache.lucene.index.Term;
import org.apache.lucene.queryParser.ParseException;
-
+import org.apache.lucene.queryParser.QueryParser;
+import org.apache.lucene.store.RAMDirectory;
import org.apache.lucene.util.LuceneTestCase;
-import java.util.Random;
-
/** Test BooleanQuery2 against BooleanQuery by overriding the standard query parser.
* This also tests the scoring order of BooleanQuery.
*/
@@ -158,13 +153,14 @@ public class TestBoolean2 extends LuceneTestCase {
int tot=0;
+ BooleanQuery q1 = null;
try {
// increase number of iterations for more complete testing
for (int i=0; i<1000; i++) {
int level = rnd.nextInt(3);
- BooleanQuery q1 = randBoolQuery(new Random(rnd.nextLong()), level, field, vals, null);
-
+ q1 = randBoolQuery(new Random(rnd.nextLong()), level, field, vals, null);
+
// Can't sort by relevance since floating point numbers may not quite
// match up.
Sort sort = Sort.INDEXORDER;
@@ -181,6 +177,10 @@ public class TestBoolean2 extends LuceneTestCase {
CheckHits.checkEqual(q1, hits1, hits2);
}
+ } catch (Exception e) {
+ // For easier debugging
+ System.out.println("failed query: " + q1);
+ throw e;
} finally { // even when a test fails.
BooleanQuery.setAllowDocsOutOfOrder(false);
}
diff --git a/src/test/org/apache/lucene/search/TestBooleanScorer.java b/src/test/org/apache/lucene/search/TestBooleanScorer.java
index e5eaeb24f61..1ef2a133880 100644
--- a/src/test/org/apache/lucene/search/TestBooleanScorer.java
+++ b/src/test/org/apache/lucene/search/TestBooleanScorer.java
@@ -18,6 +18,7 @@ package org.apache.lucene.search;
*/
import java.io.IOException;
+import java.util.Arrays;
import org.apache.lucene.analysis.WhitespaceAnalyzer;
import org.apache.lucene.document.Document;
@@ -74,5 +75,41 @@ public class TestBooleanScorer extends LuceneTestCase
}
+ public void testEmptyBucketWithMoreDocs() throws Exception {
+ // This test checks the logic of nextDoc() when all sub scorers have docs
+ // beyond the first bucket (for example). Currently, the code relies on the
+ // 'more' variable to work properly, and this test ensures that if the logic
+ // changes, we have a test to back it up.
+
+ Similarity sim = Similarity.getDefault();
+ Scorer[] scorers = new Scorer[] {new Scorer(sim) {
+ private int doc = -1;
+ public Explanation explain(int doc) throws IOException { return null; }
+ public float score() throws IOException { return 0; }
+ /** @deprecated delete in 3.0. */
+ public int doc() { return 3000; }
+ public int docID() { return doc; }
+ /** @deprecated delete in 3.0 */
+ public boolean next() throws IOException { return nextDoc() != NO_MORE_DOCS; }
+
+ public int nextDoc() throws IOException {
+ return doc = doc == -1 ? 3000 : NO_MORE_DOCS;
+ }
+
+ /** @deprecated delete in 3.0 */
+ public boolean skipTo(int target) throws IOException {
+ return advance(target) != NO_MORE_DOCS;
+ }
+
+ public int advance(int target) throws IOException {
+ return doc = target <= 3000 ? 3000 : NO_MORE_DOCS;
+ }
+
+ }};
+ BooleanScorer bs = new BooleanScorer(sim, 1, Arrays.asList(scorers), null);
+
+ assertEquals("should have received 3000", 3000, bs.nextDoc());
+ assertEquals("should have received NO_MORE_DOCS", DocIdSetIterator.NO_MORE_DOCS, bs.nextDoc());
+ }
}
diff --git a/src/test/org/apache/lucene/search/TestDisjunctionMaxQuery.java b/src/test/org/apache/lucene/search/TestDisjunctionMaxQuery.java
index a770d753cf7..3b19c00c1dc 100644
--- a/src/test/org/apache/lucene/search/TestDisjunctionMaxQuery.java
+++ b/src/test/org/apache/lucene/search/TestDisjunctionMaxQuery.java
@@ -136,10 +136,9 @@ public class TestDisjunctionMaxQuery extends LuceneTestCase{
final Weight dw = dq.weight(s);
final Scorer ds = dw.scorer(r);
- final boolean skipOk = ds.skipTo(3);
+ final boolean skipOk = ds.advance(3) != DocIdSetIterator.NO_MORE_DOCS;
if (skipOk) {
- fail("firsttime skipTo found a match? ... " +
- r.document(ds.doc()).get("id"));
+ fail("firsttime skipTo found a match? ... " + r.document(ds.docID()).get("id"));
}
}
@@ -152,8 +151,8 @@ public class TestDisjunctionMaxQuery extends LuceneTestCase{
final Weight dw = dq.weight(s);
final Scorer ds = dw.scorer(r);
- assertTrue("firsttime skipTo found no match", ds.skipTo(3));
- assertEquals("found wrong docid", "d4", r.document(ds.doc()).get("id"));
+ assertTrue("firsttime skipTo found no match", ds.advance(3) != DocIdSetIterator.NO_MORE_DOCS);
+ assertEquals("found wrong docid", "d4", r.document(ds.docID()).get("id"));
}
diff --git a/src/test/org/apache/lucene/search/TestDocIdSet.java b/src/test/org/apache/lucene/search/TestDocIdSet.java
index ef2348c9743..3627cab2594 100644
--- a/src/test/org/apache/lucene/search/TestDocIdSet.java
+++ b/src/test/org/apache/lucene/search/TestDocIdSet.java
@@ -34,27 +34,37 @@ public class TestDocIdSet extends LuceneTestCase {
public DocIdSetIterator iterator() {
return new DocIdSetIterator() {
- int docid=-1;
- //@Override
+ int docid = -1;
+
+ /** @deprecated use {@link #docID()} instead. */
public int doc() {
return docid;
}
- //@Override
+ public int docID() {
+ return docid;
+ }
+
+ /** @deprecated use {@link #nextDoc()} instead. */
public boolean next() throws IOException {
- docid++;
- return (docidscorerDocQueue.
@@ -176,7 +183,7 @@ class DisjunctionSumScorer extends Scorer {
*
In case there is a match, currentDoc, currentSumScore,
* and nrMatchers describe the match.
*
- * @todo Investigate whether it is possible to use skipTo() when
+ * TODO: Investigate whether it is possible to use skipTo() when
* the minimum number of matchers is bigger than one, ie. try and use the
* character of ConjunctionScorer for the minimum number of matchers.
* Also delay calling score() on the sub scorers until the minimum number of
@@ -190,7 +197,7 @@ class DisjunctionSumScorer extends Scorer {
currentScore = scorerDocQueue.topScore();
nrMatchers = 1;
do { // Until all subscorers are after currentDoc
- if (! scorerDocQueue.topNextAndAdjustElsePop()) {
+ if (!scorerDocQueue.topNextAndAdjustElsePop()) {
if (scorerDocQueue.size() == 0) {
break; // nothing more to advance, check for last match.
}
@@ -215,8 +222,13 @@ class DisjunctionSumScorer extends Scorer {
*/
public float score() throws IOException { return currentScore; }
+ /** @deprecated use {@link #docID()} instead. */
public int doc() { return currentDoc; }
+ public int docID() {
+ return currentDoc;
+ }
+
/** Returns the number of subscorers matching the current document.
* Initially invalid, until {@link #next()} is called the first time.
*/
@@ -224,31 +236,52 @@ class DisjunctionSumScorer extends Scorer {
return nrMatchers;
}
- /** Skips to the first match beyond the current whose document number is
- * greater than or equal to a given target.
- *
When this method is used the {@link #explain(int)} method should not be used.
- *
The implementation uses the skipTo() method on the subscorers.
- * @param target The target document number.
+ /**
+ * Skips to the first match beyond the current whose document number is
+ * greater than or equal to a given target.
+ * When this method is used the {@link #explain(int)} method should not be
+ * used.
+ * The implementation uses the skipTo() method on the subscorers.
+ *
+ * @param target
+ * The target document number.
* @return true iff there is such a match.
+ * @deprecated use {@link #advance(int)} instead.
*/
public boolean skipTo(int target) throws IOException {
+ return advance(target) != NO_MORE_DOCS;
+ }
+
+ /**
+ * Advances to the first match beyond the current whose document number is
+ * greater than or equal to a given target.
+ * When this method is used the {@link #explain(int)} method should not be
+ * used.
+ * The implementation uses the skipTo() method on the subscorers.
+ *
+ * @param target
+ * The target document number.
+ * @return the document whose number is greater than or equal to the given
+ * target, or -1 if none exist.
+ */
+ public int advance(int target) throws IOException {
if (scorerDocQueue.size() < minimumNrMatchers) {
- return false;
+ return currentDoc = NO_MORE_DOCS;
}
if (target <= currentDoc) {
- return true;
+ return currentDoc;
}
do {
if (scorerDocQueue.topDoc() >= target) {
- return advanceAfterCurrent();
- } else if (! scorerDocQueue.topSkipToAndAdjustElsePop(target)) {
+ return advanceAfterCurrent() ? currentDoc : (currentDoc = NO_MORE_DOCS);
+ } else if (!scorerDocQueue.topSkipToAndAdjustElsePop(target)) {
if (scorerDocQueue.size() < minimumNrMatchers) {
- return false;
+ return currentDoc = NO_MORE_DOCS;
}
}
} while (true);
}
-
+
/** @return An explanation for the score of a given document. */
public Explanation explain(int doc) throws IOException {
Explanation res = new Explanation();
diff --git a/src/java/org/apache/lucene/search/DocIdSetIterator.java b/src/java/org/apache/lucene/search/DocIdSetIterator.java
index 5f22ebf85f4..5da274e28a9 100644
--- a/src/java/org/apache/lucene/search/DocIdSetIterator.java
+++ b/src/java/org/apache/lucene/search/DocIdSetIterator.java
@@ -20,30 +20,130 @@ package org.apache.lucene.search;
import java.io.IOException;
/**
- * This abstract class defines methods to iterate over a set of
- * non-decreasing doc ids.
+ * This abstract class defines methods to iterate over a set of non-decreasing
+ * doc ids. Note that this class assumes it iterates on doc Ids, and therefore
+ * {@link #NO_MORE_DOCS} is set to {@value #NO_MORE_DOCS} in order to be used as
+ * a sentinel object. Implementations of this class are expected to consider
+ * {@link Integer#MAX_VALUE} as an invalid value.
*/
public abstract class DocIdSetIterator {
- /** Returns the current document number.
- * boolean skipTo(int target) {
- * do {
- * if (!next())
- * return false;
- * } while (target > doc());
- * return true;
- * }
- *
- * Some implementations are considerably more efficient than that.
- */
- public abstract boolean skipTo(int target) throws IOException;
+
+ // TODO (3.0): review the javadocs and remove any references to '3.0'.
+ private int doc = -1;
+
+ /**
+ * When returned by {@link #nextDoc()}, {@link #advance(int)} and
+ * {@link #doc()} it means there are no more docs in the iterator.
+ */
+ public static final int NO_MORE_DOCS = Integer.MAX_VALUE;
+
+ /**
+ * Unsupported anymore. Call {@link #docID()} instead. This method throws
+ * {@link UnsupportedOperationException} if called.
+ *
+ * @deprecated use {@link #docID()} instead.
+ */
+ public int doc() {
+ throw new UnsupportedOperationException("Call docID() instead.");
+ }
+
+ /**
+ * Returns the following:
+ *
+ *
+ *
+ *
+ * NOTE: in 3.0 this method will become abstract, following the removal
+ * of {@link #next()}. For backward compatibility it is implemented as:
+ *
+ *
+ * public int nextDoc() throws IOException {
+ * return next() ? doc() : NO_MORE_DOCS;
+ * }
+ *
+ *
+ * NOTE: after the iterator has exhausted you should not call this
+ * method, as it may result in unpredicted behavior.
+ *
+ * @since 2.9
+ */
+ public int nextDoc() throws IOException {
+ return doc = next() ? doc() : NO_MORE_DOCS;
+ }
+
+ /**
+ * Advances to the first beyond the current whose document number is greater
+ * than or equal to target. Returns the current document number or
+ * {@link #NO_MORE_DOCS} if there are no more docs in the set.
+ *
+ * int advance(int target) {
+ * int doc;
+ * while ((doc = nextDoc()) < target) {
+ * }
+ * return doc;
+ * }
+ *
+ *
+ * Some implementations are considerably more efficient than that.
+ * ReqExclScorer.
* @param reqScorer The scorer that must match, except where
* @param exclDisi indicates exclusion.
*/
- public ReqExclScorer(
- Scorer reqScorer,
- DocIdSetIterator exclDisi) {
+ public ReqExclScorer(Scorer reqScorer, DocIdSetIterator exclDisi) {
super(null); // No similarity used.
this.reqScorer = reqScorer;
this.exclDisi = exclDisi;
}
- private boolean firstTime = true;
-
+ /** @deprecated use {@link #nextDoc()} instead. */
public boolean next() throws IOException {
- if (firstTime) {
- if (! exclDisi.next()) {
- exclDisi = null; // exhausted at start
- }
- firstTime = false;
- }
+ return nextDoc() != NO_MORE_DOCS;
+ }
+
+ public int nextDoc() throws IOException {
if (reqScorer == null) {
- return false;
+ return doc;
}
- if (! reqScorer.next()) {
+ doc = reqScorer.nextDoc();
+ if (doc == NO_MORE_DOCS) {
reqScorer = null; // exhausted, nothing left
- return false;
+ return doc;
}
if (exclDisi == null) {
- return true; // reqScorer.next() already returned true
+ return doc;
}
- return toNonExcluded();
+ return doc = toNonExcluded();
}
/** Advance to non excluded doc.
*
On entry:
*
*
* Advances reqScorer a non excluded required doc, if any.
* @return true iff there is a non excluded required doc.
*/
- private boolean toNonExcluded() throws IOException {
- int exclDoc = exclDisi.doc();
+ private int toNonExcluded() throws IOException {
+ int exclDoc = exclDisi.docID();
+ int reqDoc = reqScorer.docID(); // may be excluded
do {
- int reqDoc = reqScorer.doc(); // may be excluded
if (reqDoc < exclDoc) {
- return true; // reqScorer advanced to before exclScorer, ie. not excluded
+ return reqDoc; // reqScorer advanced to before exclScorer, ie. not excluded
} else if (reqDoc > exclDoc) {
- if (! exclDisi.skipTo(reqDoc)) {
+ exclDoc = exclDisi.advance(reqDoc);
+ if (exclDoc == NO_MORE_DOCS) {
exclDisi = null; // exhausted, no more exclusions
- return true;
+ return reqDoc;
}
- exclDoc = exclDisi.doc();
if (exclDoc > reqDoc) {
- return true; // not excluded
+ return reqDoc; // not excluded
}
}
- } while (reqScorer.next());
+ } while ((reqDoc = reqScorer.nextDoc()) != NO_MORE_DOCS);
reqScorer = null; // exhausted, nothing left
- return false;
+ return NO_MORE_DOCS;
}
+ /** @deprecated use {@link #docID()} instead. */
public int doc() {
return reqScorer.doc(); // reqScorer may be null when next() or skipTo() already return false
}
+
+ public int docID() {
+ return doc;
+ }
/** Returns the score of the current document matching the query.
* Initially invalid, until {@link #next()} is called the first time.
@@ -108,35 +110,28 @@ class ReqExclScorer extends Scorer {
return reqScorer.score(); // reqScorer may be null when next() or skipTo() already return false
}
- /** Skips to the first match beyond the current whose document number is
- * greater than or equal to a given target.
- *
When this method is used the {@link #explain(int)} method should not be used.
- * @param target The target document number.
- * @return true iff there is such a match.
- */
+ /** @deprecated use {@link #advance(int)} instead. */
public boolean skipTo(int target) throws IOException {
- if (firstTime) {
- firstTime = false;
- if (! exclDisi.skipTo(target)) {
- exclDisi = null; // exhausted
- }
- }
- if (reqScorer == null) {
- return false;
- }
- if (exclDisi == null) {
- return reqScorer.skipTo(target);
- }
- if (! reqScorer.skipTo(target)) {
- reqScorer = null;
- return false;
- }
- return toNonExcluded();
+ return advance(target) != NO_MORE_DOCS;
}
+ public int advance(int target) throws IOException {
+ if (reqScorer == null) {
+ return doc = NO_MORE_DOCS;
+ }
+ if (exclDisi == null) {
+ return doc = reqScorer.advance(target);
+ }
+ if (reqScorer.advance(target) == NO_MORE_DOCS) {
+ reqScorer = null;
+ return doc = NO_MORE_DOCS;
+ }
+ return doc = toNonExcluded();
+ }
+
public Explanation explain(int doc) throws IOException {
Explanation res = new Explanation();
- if (exclDisi.skipTo(doc) && (exclDisi.doc() == doc)) {
+ if (exclDisi.advance(doc) == doc) {
res.setDescription("excluded");
} else {
res.setDescription("not excluded");
diff --git a/src/java/org/apache/lucene/search/ReqOptSumScorer.java b/src/java/org/apache/lucene/search/ReqOptSumScorer.java
index 1284e070efd..19ec8cc037f 100644
--- a/src/java/org/apache/lucene/search/ReqOptSumScorer.java
+++ b/src/java/org/apache/lucene/search/ReqOptSumScorer.java
@@ -43,44 +43,52 @@ class ReqOptSumScorer extends Scorer {
this.optScorer = optScorer;
}
- private boolean firstTimeOptScorer = true;
-
+ /** @deprecated use {@link #nextDoc()} instead. */
public boolean next() throws IOException {
return reqScorer.next();
}
+ public int nextDoc() throws IOException {
+ return reqScorer.nextDoc();
+ }
+
+ /** @deprecated use {@link #advance(int)} instead. */
public boolean skipTo(int target) throws IOException {
return reqScorer.skipTo(target);
}
+ public int advance(int target) throws IOException {
+ return reqScorer.advance(target);
+ }
+
+ /** @deprecated use {@link #docID()} instead. */
public int doc() {
return reqScorer.doc();
}
+ public int docID() {
+ return reqScorer.docID();
+ }
+
/** Returns the score of the current document matching the query.
* Initially invalid, until {@link #next()} is called the first time.
* @return The score of the required scorer, eventually increased by the score
* of the optional scorer when it also matches the current document.
*/
public float score() throws IOException {
- int curDoc = reqScorer.doc();
+ int curDoc = reqScorer.docID();
float reqScore = reqScorer.score();
- if (firstTimeOptScorer) {
- firstTimeOptScorer = false;
- if (! optScorer.skipTo(curDoc)) {
- optScorer = null;
- return reqScore;
- }
- } else if (optScorer == null) {
+ if (optScorer == null) {
return reqScore;
- } else if ((optScorer.doc() < curDoc) && (! optScorer.skipTo(curDoc))) {
+ }
+
+ int optScorerDoc = optScorer.docID();
+ if (optScorerDoc < curDoc && (optScorerDoc = optScorer.advance(curDoc)) == NO_MORE_DOCS) {
optScorer = null;
return reqScore;
}
- // assert (optScorer != null) && (optScorer.doc() >= curDoc);
- return (optScorer.doc() == curDoc)
- ? reqScore + optScorer.score()
- : reqScore;
+
+ return optScorerDoc == curDoc ? reqScore + optScorer.score() : reqScore;
}
/** Explain the score of a document.
diff --git a/src/java/org/apache/lucene/search/ScoreCachingWrappingScorer.java b/src/java/org/apache/lucene/search/ScoreCachingWrappingScorer.java
index 6dcd9c8b5d3..265f7cd808e 100644
--- a/src/java/org/apache/lucene/search/ScoreCachingWrappingScorer.java
+++ b/src/java/org/apache/lucene/search/ScoreCachingWrappingScorer.java
@@ -42,8 +42,8 @@ public class ScoreCachingWrappingScorer extends Scorer {
this.scorer = scorer;
}
- protected boolean score(Collector collector, int max) throws IOException {
- return scorer.score(collector, max);
+ protected boolean score(Collector collector, int max, int firstDocID) throws IOException {
+ return scorer.score(collector, max, firstDocID);
}
public Similarity getSimilarity() {
@@ -55,7 +55,7 @@ public class ScoreCachingWrappingScorer extends Scorer {
}
public float score() throws IOException {
- int doc = scorer.doc();
+ int doc = scorer.docID();
if (doc != curDoc) {
curScore = scorer.score();
curDoc = doc;
@@ -64,20 +64,35 @@ public class ScoreCachingWrappingScorer extends Scorer {
return curScore;
}
+ /** @deprecated use {@link #docID()} instead. */
public int doc() {
return scorer.doc();
}
+
+ public int docID() {
+ return scorer.docID();
+ }
+ /** @deprecated use {@link #nextDoc()} instead. */
public boolean next() throws IOException {
return scorer.next();
}
+ public int nextDoc() throws IOException {
+ return scorer.nextDoc();
+ }
+
public void score(Collector collector) throws IOException {
scorer.score(collector);
}
+ /** @deprecated use {@link #advance(int)} instead. */
public boolean skipTo(int target) throws IOException {
return scorer.skipTo(target);
}
+ public int advance(int target) throws IOException {
+ return scorer.advance(target);
+ }
+
}
diff --git a/src/java/org/apache/lucene/search/Scorer.java b/src/java/org/apache/lucene/search/Scorer.java
index 0d5c0c8c9e3..2388473bdb2 100644
--- a/src/java/org/apache/lucene/search/Scorer.java
+++ b/src/java/org/apache/lucene/search/Scorer.java
@@ -71,8 +71,9 @@ public abstract class Scorer extends DocIdSetIterator {
*/
public void score(Collector collector) throws IOException {
collector.setScorer(this);
- while (next()) {
- collector.collect(doc());
+ int doc;
+ while ((doc = nextDoc()) != NO_MORE_DOCS) {
+ collector.collect(doc);
}
}
@@ -86,26 +87,33 @@ public abstract class Scorer extends DocIdSetIterator {
* @deprecated use {@link #score(Collector, int)} instead.
*/
protected boolean score(HitCollector hc, int max) throws IOException {
- return score(new HitCollectorWrapper(hc), max);
+ return score(new HitCollectorWrapper(hc), max, docID());
}
- /** Expert: Collects matching documents in a range. Hook for optimization.
- * Note that {@link #next()} must be called once before this method is called
- * for the first time.
- * @param collector The collector to which all matching documents are passed.
- * @param max Do not score documents past this.
+ /**
+ * Expert: Collects matching documents in a range. Hook for optimization.
+ * Note, firstDocID is added to ensure that {@link #nextDoc()}
+ * was called before this method.
+ *
+ * @param collector
+ * The collector to which all matching documents are passed.
+ * @param max
+ * Do not score documents past this.
+ * @param firstDocID
+ * The first document ID (ensures {@link #nextDoc()} is called before
+ * this method.
* @return true if more matching documents may remain.
*/
- protected boolean score(Collector collector, int max) throws IOException {
+ protected boolean score(Collector collector, int max, int firstDocID) throws IOException {
collector.setScorer(this);
- while (doc() < max) {
- collector.collect(doc());
- if (!next())
- return false;
+ int doc = firstDocID;
+ while (doc < max) {
+ collector.collect(doc);
+ doc = nextDoc();
}
- return true;
+ return doc == NO_MORE_DOCS;
}
-
+
/** Returns the score of the current document matching the query.
* Initially invalid, until {@link #next()} or {@link #skipTo(int)}
* is called the first time, or when called from within
diff --git a/src/java/org/apache/lucene/search/TermScorer.java b/src/java/org/apache/lucene/search/TermScorer.java
index 35928a1fcc3..b343df7d8ad 100644
--- a/src/java/org/apache/lucene/search/TermScorer.java
+++ b/src/java/org/apache/lucene/search/TermScorer.java
@@ -31,7 +31,7 @@ final class TermScorer extends Scorer {
private TermDocs termDocs;
private byte[] norms;
private float weightValue;
- private int doc;
+ private int doc = -1;
private final int[] docs = new int[32]; // buffered doc numbers
private final int[] freqs = new int[32]; // buffered term freqs
@@ -65,16 +65,16 @@ final class TermScorer extends Scorer {
}
public void score(Collector c) throws IOException {
- next();
- score(c, Integer.MAX_VALUE);
+ score(c, Integer.MAX_VALUE, nextDoc());
}
/** @deprecated use {@link #score(Collector, int)} instead. */
protected boolean score(HitCollector c, int end) throws IOException {
- return score(new HitCollectorWrapper(c), end);
+ return score(new HitCollectorWrapper(c), end, doc);
}
- protected boolean score(Collector c, int end) throws IOException {
+ // firstDocID is ignored since nextDoc() sets 'doc'
+ protected boolean score(Collector c, int end, int firstDocID) throws IOException {
c.setScorer(this);
while (doc < end) { // for docs in window
c.collect(doc); // collect score
@@ -94,17 +94,31 @@ final class TermScorer extends Scorer {
return true;
}
- /** Returns the current document number matching the query.
- * Initially invalid, until {@link #next()} is called the first time.
- */
+ /** @deprecated use {@link #docID()} instead. */
public int doc() { return doc; }
+
+ public int docID() { return doc; }
- /** Advances to the next document matching the query.
- *
The iterator over the matching documents is buffered using
+ /**
+ * Advances to the next document matching the query.
+ * The iterator over the matching documents is buffered using
* {@link TermDocs#read(int[],int[])}.
+ *
* @return true iff there is another document matching the query.
+ * @deprecated use {@link #nextDoc()} instead.
*/
public boolean next() throws IOException {
+ return nextDoc() != NO_MORE_DOCS;
+ }
+
+ /**
+ * Advances to the next document matching the query.
+ * The iterator over the matching documents is buffered using
+ * {@link TermDocs#read(int[],int[])}.
+ *
+ * @return the document matching the query or -1 if there are no more documents.
+ */
+ public int nextDoc() throws IOException {
pointer++;
if (pointer >= pointerMax) {
pointerMax = termDocs.read(docs, freqs); // refill buffer
@@ -112,15 +126,15 @@ final class TermScorer extends Scorer {
pointer = 0;
} else {
termDocs.close(); // close stream
- doc = Integer.MAX_VALUE; // set to sentinel value
- return false;
+ return doc = NO_MORE_DOCS;
}
}
doc = docs[pointer];
- return true;
+ return doc;
}
-
+
public float score() {
+ assert doc != -1;
int f = freqs[pointer];
float raw = // compute tf(f)*weight
f < SCORE_CACHE_SIZE // check cache
@@ -130,18 +144,34 @@ final class TermScorer extends Scorer {
return norms == null ? raw : raw * SIM_NORM_DECODER[norms[doc] & 0xFF]; // normalize for field
}
- /** Skips to the first match beyond the current whose document number is
- * greater than or equal to a given target.
- *
The implementation uses {@link TermDocs#skipTo(int)}.
- * @param target The target document number.
+ /**
+ * Skips to the first match beyond the current whose document number is
+ * greater than or equal to a given target.
+ * The implementation uses {@link TermDocs#skipTo(int)}.
+ *
+ * @param target
+ * The target document number.
* @return true iff there is such a match.
+ * @deprecated use {@link #advance(int)} instead.
*/
public boolean skipTo(int target) throws IOException {
+ return advance(target) != NO_MORE_DOCS;
+ }
+
+ /**
+ * Advances to the first match beyond the current whose document number is
+ * greater than or equal to a given target.
+ * The implementation uses {@link TermDocs#skipTo(int)}.
+ *
+ * @param target
+ * The target document number.
+ * @return the matching document or -1 if none exist.
+ */
+ public int advance(int target) throws IOException {
// first scan in cache
for (pointer++; pointer < pointerMax; pointer++) {
if (docs[pointer] >= target) {
- doc = docs[pointer];
- return true;
+ return doc = docs[pointer];
}
}
@@ -153,11 +183,11 @@ final class TermScorer extends Scorer {
docs[pointer] = doc = termDocs.doc();
freqs[pointer] = termDocs.freq();
} else {
- doc = Integer.MAX_VALUE;
+ doc = NO_MORE_DOCS;
}
- return result;
+ return doc;
}
-
+
/** Returns an explanation of the score for a document.
*
When this method is used, the {@link #next()} method
* and the {@link #score(HitCollector)} method should not be used.
diff --git a/src/java/org/apache/lucene/search/function/CustomScoreQuery.java b/src/java/org/apache/lucene/search/function/CustomScoreQuery.java
index 1a28370e474..b02f04572d5 100755
--- a/src/java/org/apache/lucene/search/function/CustomScoreQuery.java
+++ b/src/java/org/apache/lucene/search/function/CustomScoreQuery.java
@@ -367,41 +367,53 @@ public class CustomScoreQuery extends Query {
this.vScores = new float[valSrcScorers.length];
}
- /*(non-Javadoc) @see org.apache.lucene.search.Scorer#next() */
+ /** @deprecated use {@link #nextDoc()} instead. */
public boolean next() throws IOException {
- boolean hasNext = subQueryScorer.next();
- if (hasNext) {
- for(int i = 0; i < valSrcScorers.length; i++) {
- valSrcScorers[i].skipTo(subQueryScorer.doc());
- }
- }
- return hasNext;
+ return nextDoc() != NO_MORE_DOCS;
}
- /*(non-Javadoc) @see org.apache.lucene.search.Scorer#doc() */
+ public int nextDoc() throws IOException {
+ int doc = subQueryScorer.nextDoc();
+ if (doc != NO_MORE_DOCS) {
+ for (int i = 0; i < valSrcScorers.length; i++) {
+ valSrcScorers[i].advance(doc);
+ }
+ }
+ return doc;
+ }
+
+ /** @deprecated use {@link #docID()} instead. */
public int doc() {
return subQueryScorer.doc();
}
+ public int docID() {
+ return subQueryScorer.docID();
+ }
+
/*(non-Javadoc) @see org.apache.lucene.search.Scorer#score() */
public float score() throws IOException {
- for(int i = 0; i < valSrcScorers.length; i++) {
+ for (int i = 0; i < valSrcScorers.length; i++) {
vScores[i] = valSrcScorers[i].score();
}
- return qWeight * customScore(subQueryScorer.doc(), subQueryScorer.score(), vScores);
+ return qWeight * customScore(subQueryScorer.docID(), subQueryScorer.score(), vScores);
}
- /*(non-Javadoc) @see org.apache.lucene.search.Scorer#skipTo(int) */
+ /** @deprecated use {@link #advance(int)} instead. */
public boolean skipTo(int target) throws IOException {
- boolean hasNext = subQueryScorer.skipTo(target);
- if (hasNext) {
- for (int i = 0; i < valSrcScorers.length; i++) {
- valSrcScorers[i].skipTo(subQueryScorer.doc());
+ return advance(target) != NO_MORE_DOCS;
+ }
+
+ public int advance(int target) throws IOException {
+ int doc = subQueryScorer.advance(target);
+ if (doc != NO_MORE_DOCS) {
+ for (int i = 0; i < valSrcScorers.length; i++) {
+ valSrcScorers[i].advance(doc);
}
}
- return hasNext;
+ return doc;
}
-
+
/*(non-Javadoc) @see org.apache.lucene.search.Scorer#explain(int) */
public Explanation explain(int doc) throws IOException {
Explanation subQueryExpl = weight.subQueryWeight.explain(reader,doc);
diff --git a/src/java/org/apache/lucene/search/function/ValueSourceQuery.java b/src/java/org/apache/lucene/search/function/ValueSourceQuery.java
index 0b331c0a485..bc39d608218 100644
--- a/src/java/org/apache/lucene/search/function/ValueSourceQuery.java
+++ b/src/java/org/apache/lucene/search/function/ValueSourceQuery.java
@@ -115,6 +115,7 @@ public class ValueSourceQuery extends Query {
private final float qWeight;
private final DocValues vals;
private final TermDocs termDocs;
+ private int doc = -1;
// constructor
private ValueSourceScorer(Similarity similarity, IndexReader reader, ValueSourceWeight w) throws IOException {
@@ -126,26 +127,37 @@ public class ValueSourceQuery extends Query {
termDocs = reader.termDocs(null);
}
- /*(non-Javadoc) @see org.apache.lucene.search.Scorer#next() */
+ /** @deprecated use {@link #nextDoc()} instead. */
public boolean next() throws IOException {
return termDocs.next();
}
- /*(non-Javadoc) @see org.apache.lucene.search.Scorer#doc()
- */
+ public int nextDoc() throws IOException {
+ return doc = termDocs.next() ? termDocs.doc() : NO_MORE_DOCS;
+ }
+
+ /** @deprecated use {@link #docID()} instead. */
public int doc() {
return termDocs.doc();
}
+ public int docID() {
+ return doc;
+ }
+
/*(non-Javadoc) @see org.apache.lucene.search.Scorer#score() */
public float score() throws IOException {
return qWeight * vals.floatVal(termDocs.doc());
}
- /*(non-Javadoc) @see org.apache.lucene.search.Scorer#skipTo(int) */
+ /** @deprecated use {@link #advance(int)} instead. */
public boolean skipTo(int target) throws IOException {
return termDocs.skipTo(target);
}
+
+ public int advance(int target) throws IOException {
+ return doc = termDocs.skipTo(target) ? termDocs.doc() : NO_MORE_DOCS;
+ }
/*(non-Javadoc) @see org.apache.lucene.search.Scorer#explain(int) */
public Explanation explain(int doc) throws IOException {
diff --git a/src/java/org/apache/lucene/search/spans/SpanScorer.java b/src/java/org/apache/lucene/search/spans/SpanScorer.java
index 2432be83ee8..23f1f79e599 100644
--- a/src/java/org/apache/lucene/search/spans/SpanScorer.java
+++ b/src/java/org/apache/lucene/search/spans/SpanScorer.java
@@ -33,6 +33,7 @@ public class SpanScorer extends Scorer {
protected byte[] norms;
protected float value;
+ /** @deprecated not needed anymore */
protected boolean firstTime = true;
protected boolean more = true;
@@ -46,33 +47,46 @@ public class SpanScorer extends Scorer {
this.norms = norms;
this.weight = weight;
this.value = weight.getValue();
- doc = -1;
+ if (this.spans.next()) {
+ doc = -1;
+ } else {
+ doc = NO_MORE_DOCS;
+ more = false;
+ }
}
+ /** @deprecated use {@link #nextDoc()} instead. */
public boolean next() throws IOException {
- if (firstTime) {
- more = spans.next();
- firstTime = false;
- }
- return setFreqCurrentDoc();
+ return nextDoc() != NO_MORE_DOCS;
}
- public boolean skipTo(int target) throws IOException {
- if (firstTime) {
- more = spans.skipTo(target);
- firstTime = false;
+ public int nextDoc() throws IOException {
+ if (!setFreqCurrentDoc()) {
+ doc = NO_MORE_DOCS;
}
- if (! more) {
- return false;
+ return doc;
+ }
+
+ /** @deprecated use {@link #advance(int)} instead. */
+ public boolean skipTo(int target) throws IOException {
+ return advance(target) != NO_MORE_DOCS;
+ }
+
+ public int advance(int target) throws IOException {
+ if (!more) {
+ return doc = NO_MORE_DOCS;
}
if (spans.doc() < target) { // setFreqCurrentDoc() leaves spans.doc() ahead
more = spans.skipTo(target);
}
- return setFreqCurrentDoc();
+ if (!setFreqCurrentDoc()) {
+ doc = NO_MORE_DOCS;
+ }
+ return doc;
}
-
+
protected boolean setFreqCurrentDoc() throws IOException {
- if (! more) {
+ if (!more) {
return false;
}
doc = spans.doc();
@@ -85,7 +99,10 @@ public class SpanScorer extends Scorer {
return true;
}
+ /** @deprecated use {@link #docID()} instead. */
public int doc() { return doc; }
+
+ public int docID() { return doc; }
public float score() throws IOException {
float raw = getSimilarity().tf(freq) * value; // raw score
@@ -95,9 +112,9 @@ public class SpanScorer extends Scorer {
public Explanation explain(final int doc) throws IOException {
Explanation tfExplanation = new Explanation();
- skipTo(doc);
+ int expDoc = advance(doc);
- float phraseFreq = (doc() == doc) ? freq : 0.0f;
+ float phraseFreq = (expDoc == doc) ? freq : 0.0f;
tfExplanation.setValue(getSimilarity().tf(phraseFreq));
tfExplanation.setDescription("tf(phraseFreq=" + phraseFreq + ")");
diff --git a/src/java/org/apache/lucene/util/DocIdBitSet.java b/src/java/org/apache/lucene/util/DocIdBitSet.java
index 0bea485fb75..334300271b3 100644
--- a/src/java/org/apache/lucene/util/DocIdBitSet.java
+++ b/src/java/org/apache/lucene/util/DocIdBitSet.java
@@ -18,6 +18,7 @@ package org.apache.lucene.util;
*/
import java.util.BitSet;
+
import org.apache.lucene.search.DocIdSet;
import org.apache.lucene.search.DocIdSetIterator;
@@ -50,28 +51,40 @@ public class DocIdBitSet extends DocIdSet {
this.docId = -1;
}
+ /** @deprecated use {@link #docID()} instead. */
public int doc() {
assert docId != -1;
return docId;
}
+ public int docID() {
+ return docId;
+ }
+
+ /** @deprecated use {@link #nextDoc()} instead. */
public boolean next() {
// (docId + 1) on next line requires -1 initial value for docNr:
- return checkNextDocId(bitSet.nextSetBit(docId + 1));
+ return nextDoc() != NO_MORE_DOCS;
+ }
+
+ public int nextDoc() {
+ // (docId + 1) on next line requires -1 initial value for docNr:
+ int d = bitSet.nextSetBit(docId + 1);
+ // -1 returned by BitSet.nextSetBit() when exhausted
+ docId = d == -1 ? NO_MORE_DOCS : d;
+ return docId;
}
+ /** @deprecated use {@link #advance(int)} instead. */
public boolean skipTo(int skipDocNr) {
- return checkNextDocId( bitSet.nextSetBit(skipDocNr));
+ return advance(skipDocNr) != NO_MORE_DOCS;
}
- private boolean checkNextDocId(int d) {
- if (d == -1) { // -1 returned by BitSet.nextSetBit() when exhausted
- docId = Integer.MAX_VALUE;
- return false;
- } else {
- docId = d;
- return true;
- }
+ public int advance(int target) {
+ int d = bitSet.nextSetBit(target);
+ // -1 returned by BitSet.nextSetBit() when exhausted
+ docId = d == -1 ? NO_MORE_DOCS : d;
+ return docId;
}
}
}
diff --git a/src/java/org/apache/lucene/util/OpenBitSetDISI.java b/src/java/org/apache/lucene/util/OpenBitSetDISI.java
index 83471ac5c0f..3e3c77ea823 100644
--- a/src/java/org/apache/lucene/util/OpenBitSetDISI.java
+++ b/src/java/org/apache/lucene/util/OpenBitSetDISI.java
@@ -47,8 +47,10 @@ public class OpenBitSetDISI extends OpenBitSet {
* constructor.
*/
public void inPlaceOr(DocIdSetIterator disi) throws IOException {
- while (disi.next() && (disi.doc() < size())) {
- fastSet(disi.doc());
+ int doc;
+ long size = size();
+ while ((doc = disi.nextDoc()) < size) {
+ fastSet(doc);
}
}
@@ -60,8 +62,8 @@ public class OpenBitSetDISI extends OpenBitSet {
*/
public void inPlaceAnd(DocIdSetIterator disi) throws IOException {
int bitSetDoc = nextSetBit(0);
- while ((bitSetDoc != -1) && disi.skipTo(bitSetDoc)) {
- int disiDoc = disi.doc();
+ int disiDoc;
+ while (bitSetDoc != -1 && (disiDoc = disi.advance(bitSetDoc)) != DocIdSetIterator.NO_MORE_DOCS) {
clear(bitSetDoc, disiDoc);
bitSetDoc = nextSetBit(disiDoc + 1);
}
@@ -77,8 +79,10 @@ public class OpenBitSetDISI extends OpenBitSet {
* constructor.
*/
public void inPlaceNot(DocIdSetIterator disi) throws IOException {
- while (disi.next() && (disi.doc() < size())) {
- fastClear(disi.doc());
+ int doc;
+ long size = size();
+ while ((doc = disi.nextDoc()) < size) {
+ fastClear(doc);
}
}
@@ -89,8 +93,10 @@ public class OpenBitSetDISI extends OpenBitSet {
* constructor.
*/
public void inPlaceXor(DocIdSetIterator disi) throws IOException {
- while (disi.next() && (disi.doc() < size())) {
- fastFlip(disi.doc());
+ int doc;
+ long size = size();
+ while ((doc = disi.nextDoc()) < size) {
+ fastFlip(doc);
}
}
}
diff --git a/src/java/org/apache/lucene/util/OpenBitSetIterator.java b/src/java/org/apache/lucene/util/OpenBitSetIterator.java
index 10b2daed952..f7ad0fb0edc 100644
--- a/src/java/org/apache/lucene/util/OpenBitSetIterator.java
+++ b/src/java/org/apache/lucene/util/OpenBitSetIterator.java
@@ -17,8 +17,6 @@
package org.apache.lucene.util;
-import java.io.IOException;
-
import org.apache.lucene.search.DocIdSetIterator;
/** An iterator to iterate over set bits in an OpenBitSet.
@@ -35,7 +33,34 @@ public class OpenBitSetIterator extends DocIdSetIterator {
// should be faster than accessing an array for each index, and
// the total array size is kept smaller (256*sizeof(int))=1K
protected final static int[] bitlist={
- 0x0,0x1,0x2,0x21,0x3,0x31,0x32,0x321,0x4,0x41,0x42,0x421,0x43,0x431,0x432,0x4321,0x5,0x51,0x52,0x521,0x53,0x531,0x532,0x5321,0x54,0x541,0x542,0x5421,0x543,0x5431,0x5432,0x54321,0x6,0x61,0x62,0x621,0x63,0x631,0x632,0x6321,0x64,0x641,0x642,0x6421,0x643,0x6431,0x6432,0x64321,0x65,0x651,0x652,0x6521,0x653,0x6531,0x6532,0x65321,0x654,0x6541,0x6542,0x65421,0x6543,0x65431,0x65432,0x654321,0x7,0x71,0x72,0x721,0x73,0x731,0x732,0x7321,0x74,0x741,0x742,0x7421,0x743,0x7431,0x7432,0x74321,0x75,0x751,0x752,0x7521,0x753,0x7531,0x7532,0x75321,0x754,0x7541,0x7542,0x75421,0x7543,0x75431,0x75432,0x754321,0x76,0x761,0x762,0x7621,0x763,0x7631,0x7632,0x76321,0x764,0x7641,0x7642,0x76421,0x7643,0x76431,0x76432,0x764321,0x765,0x7651,0x7652,0x76521,0x7653,0x76531,0x76532,0x765321,0x7654,0x76541,0x76542,0x765421,0x76543,0x765431,0x765432,0x7654321,0x8,0x81,0x82,0x821,0x83,0x831,0x832,0x8321,0x84,0x841,0x842,0x8421,0x843,0x8431,0x8432,0x84321,0x85,0x851,0x852,0x8521,0x853,0x8531,0x8532,0x85321,0x854,0x8541,0x8542,0x85421,0x8543,0x85431,0x85432,0x854321,0x86,0x861,0x862,0x8621,0x863,0x8631,0x8632,0x86321,0x864,0x8641,0x8642,0x86421,0x8643,0x86431,0x86432,0x864321,0x865,0x8651,0x8652,0x86521,0x8653,0x86531,0x86532,0x865321,0x8654,0x86541,0x86542,0x865421,0x86543,0x865431,0x865432,0x8654321,0x87,0x871,0x872,0x8721,0x873,0x8731,0x8732,0x87321,0x874,0x8741,0x8742,0x87421,0x8743,0x87431,0x87432,0x874321,0x875,0x8751,0x8752,0x87521,0x8753,0x87531,0x87532,0x875321,0x8754,0x87541,0x87542,0x875421,0x87543,0x875431,0x875432,0x8754321,0x876,0x8761,0x8762,0x87621,0x8763,0x87631,0x87632,0x876321,0x8764,0x87641,0x87642,0x876421,0x87643,0x876431,0x876432,0x8764321,0x8765,0x87651,0x87652,0x876521,0x87653,0x876531,0x876532,0x8765321,0x87654,0x876541,0x876542,0x8765421,0x876543,0x8765431,0x8765432,0x87654321
+ 0x0, 0x1, 0x2, 0x21, 0x3, 0x31, 0x32, 0x321, 0x4, 0x41, 0x42, 0x421, 0x43,
+ 0x431, 0x432, 0x4321, 0x5, 0x51, 0x52, 0x521, 0x53, 0x531, 0x532, 0x5321,
+ 0x54, 0x541, 0x542, 0x5421, 0x543, 0x5431, 0x5432, 0x54321, 0x6, 0x61, 0x62,
+ 0x621, 0x63, 0x631, 0x632, 0x6321, 0x64, 0x641, 0x642, 0x6421, 0x643,
+ 0x6431, 0x6432, 0x64321, 0x65, 0x651, 0x652, 0x6521, 0x653, 0x6531, 0x6532,
+ 0x65321, 0x654, 0x6541, 0x6542, 0x65421, 0x6543, 0x65431, 0x65432, 0x654321,
+ 0x7, 0x71, 0x72, 0x721, 0x73, 0x731, 0x732, 0x7321, 0x74, 0x741, 0x742,
+ 0x7421, 0x743, 0x7431, 0x7432, 0x74321, 0x75, 0x751, 0x752, 0x7521, 0x753,
+ 0x7531, 0x7532, 0x75321, 0x754, 0x7541, 0x7542, 0x75421, 0x7543, 0x75431,
+ 0x75432, 0x754321, 0x76, 0x761, 0x762, 0x7621, 0x763, 0x7631, 0x7632,
+ 0x76321, 0x764, 0x7641, 0x7642, 0x76421, 0x7643, 0x76431, 0x76432, 0x764321,
+ 0x765, 0x7651, 0x7652, 0x76521, 0x7653, 0x76531, 0x76532, 0x765321, 0x7654,
+ 0x76541, 0x76542, 0x765421, 0x76543, 0x765431, 0x765432, 0x7654321, 0x8,
+ 0x81, 0x82, 0x821, 0x83, 0x831, 0x832, 0x8321, 0x84, 0x841, 0x842, 0x8421,
+ 0x843, 0x8431, 0x8432, 0x84321, 0x85, 0x851, 0x852, 0x8521, 0x853, 0x8531,
+ 0x8532, 0x85321, 0x854, 0x8541, 0x8542, 0x85421, 0x8543, 0x85431, 0x85432,
+ 0x854321, 0x86, 0x861, 0x862, 0x8621, 0x863, 0x8631, 0x8632, 0x86321, 0x864,
+ 0x8641, 0x8642, 0x86421, 0x8643, 0x86431, 0x86432, 0x864321, 0x865, 0x8651,
+ 0x8652, 0x86521, 0x8653, 0x86531, 0x86532, 0x865321, 0x8654, 0x86541,
+ 0x86542, 0x865421, 0x86543, 0x865431, 0x865432, 0x8654321, 0x87, 0x871,
+ 0x872, 0x8721, 0x873, 0x8731, 0x8732, 0x87321, 0x874, 0x8741, 0x8742,
+ 0x87421, 0x8743, 0x87431, 0x87432, 0x874321, 0x875, 0x8751, 0x8752, 0x87521,
+ 0x8753, 0x87531, 0x87532, 0x875321, 0x8754, 0x87541, 0x87542, 0x875421,
+ 0x87543, 0x875431, 0x875432, 0x8754321, 0x876, 0x8761, 0x8762, 0x87621,
+ 0x8763, 0x87631, 0x87632, 0x876321, 0x8764, 0x87641, 0x87642, 0x876421,
+ 0x87643, 0x876431, 0x876432, 0x8764321, 0x8765, 0x87651, 0x87652, 0x876521,
+ 0x87653, 0x876531, 0x876532, 0x8765321, 0x87654, 0x876541, 0x876542,
+ 0x8765421, 0x876543, 0x8765431, 0x8765432, 0x87654321
};
/***** the python code that generated bitlist
def bits2int(val):
@@ -56,14 +81,13 @@ public class OpenBitSetIterator extends DocIdSetIterator {
// for efficiency, or have a common root interface? (or
// maybe both? could ask for a SetBitsIterator, etc...
-
private final long[] arr;
private final int words;
private int i=-1;
private long word;
private int wordShift;
private int indexArray;
- private int curDocId;
+ private int curDocId = -1;
public OpenBitSetIterator(OpenBitSet obs) {
this(obs.getBits(), obs.getNumWords());
@@ -104,50 +128,24 @@ public class OpenBitSetIterator extends DocIdSetIterator {
}
******/
+ /** @deprecated use {@link #nextDoc()} instead. */
public boolean next() {
- if (indexArray==0) {
- if (word!=0) {
- word >>>= 8;
- wordShift += 8;
- }
-
- while (word==0) {
- if (++i >= words) {
- curDocId = -1;
- return false;
- }
- word = arr[i];
- wordShift =-1; // loop invariant code motion should move this
- }
-
- // after the first time, should I go with a linear search, or
- // stick with the binary search in shift?
- shift();
- }
-
- int bitIndex = (indexArray & 0x0f) + wordShift;
- indexArray >>>= 4;
- // should i<<6 be cached as a separate variable?
- // it would only save one cycle in the best circumstances.
- curDocId = (i<<6) + bitIndex;
- return true;
+ return nextDoc() != NO_MORE_DOCS;
}
- /** Moves iterator to the next doc and returns its id;
- returns -1 when this iterator is exhausted. */
public int nextDoc() {
- if (indexArray==0) {
- if (word!=0) {
+ if (indexArray == 0) {
+ if (word != 0) {
word >>>= 8;
wordShift += 8;
}
- while (word==0) {
+ while (word == 0) {
if (++i >= words) {
- return curDocId = -1;
+ return curDocId = NO_MORE_DOCS;
}
word = arr[i];
- wordShift =-1; // loop invariant code motion should move this
+ wordShift = -1; // loop invariant code motion should move this
}
// after the first time, should I go with a linear search, or
@@ -162,60 +160,30 @@ public class OpenBitSetIterator extends DocIdSetIterator {
return curDocId = (i<<6) + bitIndex;
}
+ /** @deprecated use {@link #advance(int)} instead. */
public boolean skipTo(int target) {
- indexArray=0;
+ return advance(target) != NO_MORE_DOCS;
+ }
+
+ public int advance(int target) {
+ indexArray = 0;
i = target >> 6;
- if (i>=words) {
- word =0; // setup so next() will also return -1
- curDocId = -1;
- return false;
+ if (i >= words) {
+ word = 0; // setup so next() will also return -1
+ return curDocId = NO_MORE_DOCS;
}
wordShift = target & 0x3f;
word = arr[i] >>> wordShift;
- if (word !=0) {
+ if (word != 0) {
wordShift--; // compensate for 1 based arrIndex
} else {
- while (word ==0) {
+ while (word == 0) {
if (++i >= words) {
- curDocId = -1;
- return false;
+ return curDocId = NO_MORE_DOCS;
}
word = arr[i];
}
- wordShift =-1;
- }
-
- shift();
-
- int bitIndex = (indexArray & 0x0f) + wordShift;
- indexArray >>>= 4;
- // should i<<6 be cached as a separate variable?
- // it would only save one cycle in the best circumstances.
- curDocId = (i<<6) + bitIndex;
- return true;
- }
-
- /** Behaves like {@link #skipTo(int)} and returns the docId the iterator
- * skipped to; returns -1 if no valid document could be skipped to. */
- public int next(int fromIndex) {
- indexArray=0;
- i = fromIndex >> 6;
- if (i>=words) {
- word =0; // setup so next() will also return -1
- return curDocId = -1;
- }
- wordShift = fromIndex & 0x3f;
- word = arr[i] >>> wordShift;
- if (word !=0) {
- wordShift--; // compensate for 1 based arrIndex
- } else {
- while (word ==0) {
- if (++i >= words) {
- return curDocId = -1;
- }
- word = arr[i];
- }
- wordShift =-1;
+ wordShift = -1;
}
shift();
@@ -226,9 +194,14 @@ public class OpenBitSetIterator extends DocIdSetIterator {
// it would only save one cycle in the best circumstances.
return curDocId = (i<<6) + bitIndex;
}
-
+
+ /** @deprecated use {@link #docID()} instead. */
public int doc() {
- return this.curDocId;
+ return curDocId;
}
+ public int docID() {
+ return curDocId;
+ }
+
}
diff --git a/src/java/org/apache/lucene/util/ScorerDocQueue.java b/src/java/org/apache/lucene/util/ScorerDocQueue.java
index 2e42e7ac37b..7c04a9bc091 100755
--- a/src/java/org/apache/lucene/util/ScorerDocQueue.java
+++ b/src/java/org/apache/lucene/util/ScorerDocQueue.java
@@ -20,6 +20,8 @@ package org.apache.lucene.util;
/* Derived from org.apache.lucene.util.PriorityQueue of March 2005 */
import java.io.IOException;
+
+import org.apache.lucene.search.DocIdSetIterator;
import org.apache.lucene.search.Scorer;
/** A ScorerDocQueue maintains a partial ordering of its Scorers such that the
@@ -35,14 +37,14 @@ public class ScorerDocQueue { // later: SpansQueue for spans with doc and term
Scorer scorer;
int doc;
- HeapedScorerDoc(Scorer s) { this(s, s.doc()); }
+ HeapedScorerDoc(Scorer s) { this(s, s.docID()); }
HeapedScorerDoc(Scorer scorer, int doc) {
this.scorer = scorer;
this.doc = doc;
}
- void adjust() { doc = scorer.doc(); }
+ void adjust() { doc = scorer.docID(); }
}
private HeapedScorerDoc topHSD; // same as heap[1], only for speed
@@ -79,7 +81,7 @@ public class ScorerDocQueue { // later: SpansQueue for spans with doc and term
put(scorer);
return true;
} else {
- int docNr = scorer.doc();
+ int docNr = scorer.docID();
if ((size > 0) && (! (docNr < topHSD.doc))) { // heap[1] is top()
heap[1] = new HeapedScorerDoc(scorer, docNr);
downHeap();
@@ -113,16 +115,16 @@ public class ScorerDocQueue { // later: SpansQueue for spans with doc and term
}
public final boolean topNextAndAdjustElsePop() throws IOException {
- return checkAdjustElsePop( topHSD.scorer.next());
+ return checkAdjustElsePop(topHSD.scorer.nextDoc() != DocIdSetIterator.NO_MORE_DOCS);
}
public final boolean topSkipToAndAdjustElsePop(int target) throws IOException {
- return checkAdjustElsePop( topHSD.scorer.skipTo(target));
+ return checkAdjustElsePop(topHSD.scorer.advance(target) != DocIdSetIterator.NO_MORE_DOCS);
}
private boolean checkAdjustElsePop(boolean cond) {
if (cond) { // see also adjustTop
- topHSD.doc = topHSD.scorer.doc();
+ topHSD.doc = topHSD.scorer.docID();
} else { // see also popNoResult
heap[1] = heap[size]; // move last to first
heap[size] = null;
diff --git a/src/java/org/apache/lucene/util/SortedVIntList.java b/src/java/org/apache/lucene/util/SortedVIntList.java
index 54dcc0ee41a..eb875ca22a3 100644
--- a/src/java/org/apache/lucene/util/SortedVIntList.java
+++ b/src/java/org/apache/lucene/util/SortedVIntList.java
@@ -24,10 +24,15 @@ import org.apache.lucene.search.DocIdSet;
import org.apache.lucene.search.DocIdSetIterator;
/**
- * Store and iterate sorted integers in compressed form in RAM.
- *
The code for compressing the differences between ascending integers was
- * borrowed from {@link org.apache.lucene.store.IndexInput} and
- * {@link org.apache.lucene.store.IndexOutput}.
+ * Stores and iterate on sorted integers in compressed form in RAM.
+ * The code for compressing the differences between ascending integers was
+ * borrowed from {@link org.apache.lucene.store.IndexInput} and
+ * {@link org.apache.lucene.store.IndexOutput}.
+ *