Package org.apache.lucene.document
Class BinaryRangeDocValues
- java.lang.Object
-
- org.apache.lucene.search.DocIdSetIterator
-
- org.apache.lucene.index.BinaryDocValues
-
- org.apache.lucene.document.BinaryRangeDocValues
-
public class BinaryRangeDocValues extends BinaryDocValues
A binary representation of a range that wraps a BinaryDocValues field
-
-
Field Summary
-
Fields inherited from class org.apache.lucene.search.DocIdSetIterator
NO_MORE_DOCS
-
-
Constructor Summary
Constructors Constructor Description BinaryRangeDocValues(BinaryDocValues in, int numDims, int numBytesPerDimension)Constructor for BinaryRangeDocValues
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description intadvance(int target)Advances to the first beyond the current whose document number is greater than or equal to target, and returns the document number itself.booleanadvanceExact(int target)Advance the iterator to exactlytargetand return whethertargethas a value.BytesRefbinaryValue()Returns the binary value for the current document ID.longcost()Returns the estimated cost of thisDocIdSetIterator.intdocID()Returns the following:-1ifDocIdSetIterator.nextDoc()orDocIdSetIterator.advance(int)were not called yet.byte[]getPackedValue()Gets the packed value that represents this rangeintnextDoc()Advances to the next document in the set and returns the doc it is currently on, orDocIdSetIterator.NO_MORE_DOCSif there are no more docs in the set.
NOTE: after the iterator has exhausted you should not call this method, as it may result in unpredicted behavior.-
Methods inherited from class org.apache.lucene.search.DocIdSetIterator
all, empty, range, slowAdvance
-
-
-
-
Constructor Detail
-
BinaryRangeDocValues
public BinaryRangeDocValues(BinaryDocValues in, int numDims, int numBytesPerDimension)
Constructor for BinaryRangeDocValues- Parameters:
in- the binary doc values source fieldnumDims- the number of dimensions in each doc values fieldnumBytesPerDimension- size of each dimension (2 * encoded value size)
-
-
Method Detail
-
nextDoc
public int nextDoc() throws IOExceptionDescription copied from class:DocIdSetIteratorAdvances to the next document in the set and returns the doc it is currently on, orDocIdSetIterator.NO_MORE_DOCSif there are no more docs in the set.
NOTE: after the iterator has exhausted you should not call this method, as it may result in unpredicted behavior.- Specified by:
nextDocin classDocIdSetIterator- Throws:
IOException
-
docID
public int docID()
Description copied from class:DocIdSetIteratorReturns the following:-1ifDocIdSetIterator.nextDoc()orDocIdSetIterator.advance(int)were not called yet.DocIdSetIterator.NO_MORE_DOCSif the iterator has exhausted.- Otherwise it should return the doc ID it is currently on.
- Specified by:
docIDin classDocIdSetIterator
-
cost
public long cost()
Description copied from class:DocIdSetIteratorReturns the estimated cost of thisDocIdSetIterator.This is generally an upper bound of the number of documents this iterator might match, but may be a rough heuristic, hardcoded value, or otherwise completely inaccurate.
- Specified by:
costin classDocIdSetIterator
-
advance
public int advance(int target) throws IOExceptionDescription copied from class:DocIdSetIteratorAdvances to the first beyond the current whose document number is greater than or equal to target, and returns the document number itself. Exhausts the iterator and returnsDocIdSetIterator.NO_MORE_DOCSif target is greater than the highest document number in the set.The behavior of this method is undefined when called with
target ≤ current, or after the iterator has exhausted. Both cases may result in unpredicted behavior.When
target > currentit behaves as if written:int advance(int target) { int doc; while ((doc = nextDoc()) < target) { } return doc; }Some implementations are considerably more efficient than that.NOTE: this method may be called with
DocIdSetIterator.NO_MORE_DOCSfor 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.- Specified by:
advancein classDocIdSetIterator- Throws:
IOException
-
advanceExact
public boolean advanceExact(int target) throws IOExceptionAdvance the iterator to exactlytargetand return whethertargethas a value.targetmust be greater than or equal to the currentdoc IDand must be a valid doc ID, ie. ≥ 0 and <maxDoc. After this method returns,DocIdSetIterator.docID()returnstarget.- Throws:
IOException
-
binaryValue
public BytesRef binaryValue() throws IOException
Description copied from class:BinaryDocValuesReturns the binary value for the current document ID. It is illegal to call this method afteradvanceExact(int)returnedfalse.- Specified by:
binaryValuein classBinaryDocValues- Returns:
- binary value
- Throws:
IOException
-
getPackedValue
public byte[] getPackedValue()
Gets the packed value that represents this range- Returns:
- the packed value that represents this range
-
-