LUCENE-8378: add DocIdSetIterator.range method

This commit is contained in:
Mike McCandless 2018-07-05 10:01:53 -04:00
parent 98768d9825
commit 4dc2008dc1
3 changed files with 99 additions and 0 deletions

View File

@ -127,6 +127,9 @@ API Changes:
StopAnalyzer is also deprecated, and a stop word set should be explicitly StopAnalyzer is also deprecated, and a stop word set should be explicitly
passed to the constructor. (Alan Woodward) passed to the constructor. (Alan Woodward)
* LUCENE-8378: Add DocIdSetIterator.range static method to return an iterator
matching a range of docids (Mike McCandless)
Bug Fixes: Bug Fixes:
* LUCENE-8380: UTF8TaxonomyWriterCache inconsistency. (Ruslan Torobaev, Dawid Weiss) * LUCENE-8380: UTF8TaxonomyWriterCache inconsistency. (Ruslan Torobaev, Dawid Weiss)

View File

@ -91,6 +91,47 @@ public abstract class DocIdSetIterator {
}; };
} }
/** A {@link DocIdSetIterator} that matches a range documents from
* minDocID (inclusive) to maxDocID (exclusive). */
public static final DocIdSetIterator range(int minDoc, int maxDoc) {
if (minDoc >= maxDoc) {
throw new IllegalArgumentException("minDoc must be < maxDoc but got minDoc=" + minDoc + " maxDoc=" + maxDoc);
}
if (minDoc < 0) {
throw new IllegalArgumentException("minDoc must be >= 0 but got minDoc=" + minDoc);
}
return new DocIdSetIterator() {
private int doc = -1;
@Override
public int docID() {
return doc;
}
@Override
public int nextDoc() throws IOException {
return advance(doc + 1);
}
@Override
public int advance(int target) throws IOException {
if (target < minDoc) {
doc = minDoc;
} else if (target >= maxDoc) {
doc = NO_MORE_DOCS;
} else {
doc = target;
}
return doc;
}
@Override
public long cost() {
return maxDoc - minDoc;
}
};
}
/** /**
* When returned by {@link #nextDoc()}, {@link #advance(int)} and * When returned by {@link #nextDoc()}, {@link #advance(int)} and
* {@link #docID()} it means there are no more docs in the iterator. * {@link #docID()} it means there are no more docs in the iterator.

View File

@ -0,0 +1,55 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.lucene.search;
import org.apache.lucene.util.LuceneTestCase;
import static org.apache.lucene.search.DocIdSetIterator.NO_MORE_DOCS;
public class TestDocIdSetIterator extends LuceneTestCase {
public void testRangeBasic() throws Exception {
DocIdSetIterator disi = DocIdSetIterator.range(5, 8);
assertEquals(-1, disi.docID());
assertEquals(5, disi.nextDoc());
assertEquals(6, disi.nextDoc());
assertEquals(7, disi.nextDoc());
assertEquals(NO_MORE_DOCS, disi.nextDoc());
}
public void testInvalidRange() throws Exception {
expectThrows(IllegalArgumentException.class, () -> {DocIdSetIterator.range(5, 4);});
}
public void testInvalidMin() throws Exception {
expectThrows(IllegalArgumentException.class, () -> {DocIdSetIterator.range(-1, 4);});
}
public void testEmpty() throws Exception {
expectThrows(IllegalArgumentException.class, () -> {DocIdSetIterator.range(7, 7);});
}
public void testAdvance() throws Exception {
DocIdSetIterator disi = DocIdSetIterator.range(5, 20);
assertEquals(-1, disi.docID());
assertEquals(5, disi.nextDoc());
assertEquals(17, disi.advance(17));
assertEquals(18, disi.nextDoc());
assertEquals(19, disi.nextDoc());
assertEquals(NO_MORE_DOCS, disi.nextDoc());
}
}