Package org.apache.lucene.index
Class BinaryDocValues
- java.lang.Object
-
- org.apache.lucene.search.DocIdSetIterator
-
- org.apache.lucene.index.DocValuesIterator
-
- org.apache.lucene.index.BinaryDocValues
-
- Direct Known Subclasses:
BinaryDocValuesWriter.BufferedBinaryDocValues
,BinaryDocValuesWriter.SortingBinaryDocValues
,BinaryRangeDocValues
,FilterBinaryDocValues
,LegacyBinaryDocValuesWrapper
,Lucene70DocValuesProducer.DenseBinaryDocValues
,Lucene70DocValuesProducer.SparseBinaryDocValues
,Lucene80DocValuesProducer.DenseBinaryDocValues
,Lucene80DocValuesProducer.SparseBinaryDocValues
,SortedDocValues
public abstract class BinaryDocValues extends DocValuesIterator
A per-document numeric value.
-
-
Field Summary
-
Fields inherited from class org.apache.lucene.search.DocIdSetIterator
NO_MORE_DOCS
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
BinaryDocValues()
Sole constructor.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description abstract BytesRef
binaryValue()
Returns the binary value for the current document ID.-
Methods inherited from class org.apache.lucene.index.DocValuesIterator
advanceExact
-
Methods inherited from class org.apache.lucene.search.DocIdSetIterator
advance, all, cost, docID, empty, nextDoc, range, slowAdvance
-
-
-
-
Method Detail
-
binaryValue
public abstract BytesRef binaryValue() throws java.io.IOException
Returns the binary value for the current document ID. It is illegal to call this method afterDocValuesIterator.advanceExact(int)
returnedfalse
.- Returns:
- binary value
- Throws:
java.io.IOException
-
-