Package org.apache.lucene.index
Class CodecReader
- java.lang.Object
-
- org.apache.lucene.index.IndexReader
-
- org.apache.lucene.index.LeafReader
-
- org.apache.lucene.index.CodecReader
-
- All Implemented Interfaces:
java.io.Closeable
,java.lang.AutoCloseable
,Accountable
- Direct Known Subclasses:
FilterCodecReader
,SegmentReader
public abstract class CodecReader extends LeafReader implements Accountable
LeafReader implemented by codec APIs.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.lucene.index.IndexReader
IndexReader.CacheHelper, IndexReader.CacheKey, IndexReader.ClosedListener
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
CodecReader()
Sole constructor.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description private void
checkBounds(int docID)
void
checkIntegrity()
Checks consistency of this reader.protected void
doClose()
Implements close.void
document(int docID, StoredFieldVisitor visitor)
Expert: visits the fields of a stored document, for custom processing/loading of each field.BinaryDocValues
getBinaryDocValues(java.lang.String field)
ReturnsBinaryDocValues
for this field, or null if no binary doc values were indexed for this field.java.util.Collection<Accountable>
getChildResources()
Returns nested resources of this class.abstract DocValuesProducer
getDocValuesReader()
Expert: retrieve underlying DocValuesProducerprivate FieldInfo
getDVField(java.lang.String field, DocValuesType type)
abstract StoredFieldsReader
getFieldsReader()
Expert: retrieve thread-private StoredFieldsReaderabstract NormsProducer
getNormsReader()
Expert: retrieve underlying NormsProducerNumericDocValues
getNormValues(java.lang.String field)
ReturnsNumericDocValues
representing norms for this field, or null if noNumericDocValues
were indexed.NumericDocValues
getNumericDocValues(java.lang.String field)
ReturnsNumericDocValues
for this field, or null if no numeric doc values were indexed for this field.abstract PointsReader
getPointsReader()
Expert: retrieve underlying PointsReaderPointValues
getPointValues(java.lang.String field)
Returns thePointValues
used for numeric or spatial searches for the given field, or null if there are no point fields.abstract FieldsProducer
getPostingsReader()
Expert: retrieve underlying FieldsProducerSortedDocValues
getSortedDocValues(java.lang.String field)
ReturnsSortedDocValues
for this field, or null if noSortedDocValues
were indexed for this field.SortedNumericDocValues
getSortedNumericDocValues(java.lang.String field)
ReturnsSortedNumericDocValues
for this field, or null if noSortedNumericDocValues
were indexed for this field.SortedSetDocValues
getSortedSetDocValues(java.lang.String field)
ReturnsSortedSetDocValues
for this field, or null if noSortedSetDocValues
were indexed for this field.Fields
getTermVectors(int docID)
Retrieve term vectors for this document, or null if term vectors were not indexed.abstract TermVectorsReader
getTermVectorsReader()
Expert: retrieve thread-private TermVectorsReaderlong
ramBytesUsed()
Return the memory usage of this object in bytes.Terms
terms(java.lang.String field)
Returns theTerms
index for this field, or null if it has none.-
Methods inherited from class org.apache.lucene.index.LeafReader
docFreq, getContext, getCoreCacheHelper, getDocCount, getFieldInfos, getLiveDocs, getMetaData, getSumDocFreq, getSumTotalTermFreq, postings, postings, totalTermFreq
-
Methods inherited from class org.apache.lucene.index.IndexReader
close, decRef, document, document, ensureOpen, equals, getReaderCacheHelper, getRefCount, getTermVector, hasDeletions, hashCode, incRef, leaves, maxDoc, notifyReaderClosedListeners, numDeletedDocs, numDocs, registerParentReader, tryIncRef
-
-
-
-
Method Detail
-
getFieldsReader
public abstract StoredFieldsReader getFieldsReader()
Expert: retrieve thread-private StoredFieldsReader
-
getTermVectorsReader
public abstract TermVectorsReader getTermVectorsReader()
Expert: retrieve thread-private TermVectorsReader
-
getNormsReader
public abstract NormsProducer getNormsReader()
Expert: retrieve underlying NormsProducer
-
getDocValuesReader
public abstract DocValuesProducer getDocValuesReader()
Expert: retrieve underlying DocValuesProducer
-
getPostingsReader
public abstract FieldsProducer getPostingsReader()
Expert: retrieve underlying FieldsProducer
-
getPointsReader
public abstract PointsReader getPointsReader()
Expert: retrieve underlying PointsReader
-
document
public final void document(int docID, StoredFieldVisitor visitor) throws java.io.IOException
Description copied from class:IndexReader
Expert: visits the fields of a stored document, for custom processing/loading of each field. If you simply want to load all fields, useIndexReader.document(int)
. If you want to load a subset, useDocumentStoredFieldVisitor
.- Specified by:
document
in classIndexReader
- Throws:
java.io.IOException
-
getTermVectors
public final Fields getTermVectors(int docID) throws java.io.IOException
Description copied from class:IndexReader
Retrieve term vectors for this document, or null if term vectors were not indexed. The returned Fields instance acts like a single-document inverted index (the docID will be 0).- Specified by:
getTermVectors
in classIndexReader
- Throws:
java.io.IOException
-
checkBounds
private void checkBounds(int docID)
-
terms
public final Terms terms(java.lang.String field) throws java.io.IOException
Description copied from class:LeafReader
Returns theTerms
index for this field, or null if it has none.- Specified by:
terms
in classLeafReader
- Throws:
java.io.IOException
-
getDVField
private FieldInfo getDVField(java.lang.String field, DocValuesType type)
-
getNumericDocValues
public final NumericDocValues getNumericDocValues(java.lang.String field) throws java.io.IOException
Description copied from class:LeafReader
ReturnsNumericDocValues
for this field, or null if no numeric doc values were indexed for this field. The returned instance should only be used by a single thread.- Specified by:
getNumericDocValues
in classLeafReader
- Throws:
java.io.IOException
-
getBinaryDocValues
public final BinaryDocValues getBinaryDocValues(java.lang.String field) throws java.io.IOException
Description copied from class:LeafReader
ReturnsBinaryDocValues
for this field, or null if no binary doc values were indexed for this field. The returned instance should only be used by a single thread.- Specified by:
getBinaryDocValues
in classLeafReader
- Throws:
java.io.IOException
-
getSortedDocValues
public final SortedDocValues getSortedDocValues(java.lang.String field) throws java.io.IOException
Description copied from class:LeafReader
ReturnsSortedDocValues
for this field, or null if noSortedDocValues
were indexed for this field. The returned instance should only be used by a single thread.- Specified by:
getSortedDocValues
in classLeafReader
- Throws:
java.io.IOException
-
getSortedNumericDocValues
public final SortedNumericDocValues getSortedNumericDocValues(java.lang.String field) throws java.io.IOException
Description copied from class:LeafReader
ReturnsSortedNumericDocValues
for this field, or null if noSortedNumericDocValues
were indexed for this field. The returned instance should only be used by a single thread.- Specified by:
getSortedNumericDocValues
in classLeafReader
- Throws:
java.io.IOException
-
getSortedSetDocValues
public final SortedSetDocValues getSortedSetDocValues(java.lang.String field) throws java.io.IOException
Description copied from class:LeafReader
ReturnsSortedSetDocValues
for this field, or null if noSortedSetDocValues
were indexed for this field. The returned instance should only be used by a single thread.- Specified by:
getSortedSetDocValues
in classLeafReader
- Throws:
java.io.IOException
-
getNormValues
public final NumericDocValues getNormValues(java.lang.String field) throws java.io.IOException
Description copied from class:LeafReader
ReturnsNumericDocValues
representing norms for this field, or null if noNumericDocValues
were indexed. The returned instance should only be used by a single thread.- Specified by:
getNormValues
in classLeafReader
- Throws:
java.io.IOException
-
getPointValues
public final PointValues getPointValues(java.lang.String field) throws java.io.IOException
Description copied from class:LeafReader
Returns thePointValues
used for numeric or spatial searches for the given field, or null if there are no point fields.- Specified by:
getPointValues
in classLeafReader
- Throws:
java.io.IOException
-
doClose
protected void doClose() throws java.io.IOException
Description copied from class:IndexReader
Implements close.- Specified by:
doClose
in classIndexReader
- Throws:
java.io.IOException
-
ramBytesUsed
public long ramBytesUsed()
Description copied from interface:Accountable
Return the memory usage of this object in bytes. Negative values are illegal.- Specified by:
ramBytesUsed
in interfaceAccountable
-
getChildResources
public java.util.Collection<Accountable> getChildResources()
Description copied from interface:Accountable
Returns nested resources of this class. The result should be a point-in-time snapshot (to avoid race conditions).- Specified by:
getChildResources
in interfaceAccountable
- See Also:
Accountables
-
checkIntegrity
public void checkIntegrity() throws java.io.IOException
Description copied from class:LeafReader
Checks consistency of this reader.Note that this may be costly in terms of I/O, e.g. may involve computing a checksum value against large data files.
- Specified by:
checkIntegrity
in classLeafReader
- Throws:
java.io.IOException
-
-