Package org.apache.lucene.index
Class BinaryDocValues
java.lang.Object
org.apache.lucene.search.DocIdSetIterator
org.apache.lucene.index.BinaryDocValues
- Direct Known Subclasses:
BinaryRangeDocValues,FilterBinaryDocValues
A per-document numeric value.
-
Field Summary
Fields inherited from class org.apache.lucene.search.DocIdSetIterator
NO_MORE_DOCS -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionabstract booleanadvanceExact(int target) Advance the iterator to exactlytargetand return whethertargethas a value.abstract BytesRefReturns the binary value for the current document ID.Methods inherited from class org.apache.lucene.search.DocIdSetIterator
advance, all, cost, docID, docIDRunEnd, empty, intoBitSet, nextDoc, range, slowAdvance
-
Constructor Details
-
BinaryDocValues
protected BinaryDocValues()Sole constructor. (For invocation by subclass constructors, typically implicit.)
-
-
Method Details
-
binaryValue
Returns the binary value for the current document ID. It is illegal to call this method afteradvanceExact(int)returnedfalse.- Returns:
- binary value
- Throws:
IOException
-
advanceExact
Advance 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
-