Package org.apache.lucene.index
Class FilterCodecReader
- java.lang.Object
-
- org.apache.lucene.index.IndexReader
-
- org.apache.lucene.index.LeafReader
-
- org.apache.lucene.index.CodecReader
-
- org.apache.lucene.index.FilterCodecReader
-
- All Implemented Interfaces:
Closeable,AutoCloseable
- Direct Known Subclasses:
SortingCodecReader
public abstract class FilterCodecReader extends CodecReader
AFilterCodecReadercontains another CodecReader, which it uses as its basic source of data, possibly transforming the data along the way or providing additional functionality.NOTE: If this
FilterCodecReaderdoes not change the content the contained reader, you could consider delegating calls toLeafReader.getCoreCacheHelper()andIndexReader.getReaderCacheHelper().
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.lucene.index.IndexReader
IndexReader.CacheHelper, IndexReader.CacheKey, IndexReader.ClosedListener
-
-
Field Summary
Fields Modifier and Type Field Description protected CodecReaderinThe underlying CodecReader instance.
-
Constructor Summary
Constructors Constructor Description FilterCodecReader(CodecReader in)Creates a new FilterCodecReader.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description voidcheckIntegrity()Checks consistency of this reader.protected voiddoClose()Implements close.voiddocument(int docID, StoredFieldVisitor visitor)Deprecated.CodecReadergetDelegate()Returns the wrappedCodecReader.DocValuesProducergetDocValuesReader()Expert: retrieve underlying DocValuesProducerFieldInfosgetFieldInfos()Get theFieldInfosdescribing all fields in this reader.StoredFieldsReadergetFieldsReader()Expert: retrieve underlying StoredFieldsReaderBitsgetLiveDocs()Returns theBitsrepresenting live (not deleted) docs.LeafMetaDatagetMetaData()Return metadata about this leaf.NormsProducergetNormsReader()Expert: retrieve underlying NormsProducerPointsReadergetPointsReader()Expert: retrieve underlying PointsReaderFieldsProducergetPostingsReader()Expert: retrieve underlying FieldsProducerFieldsgetTermVectors(int docID)Deprecated.TermVectorsReadergetTermVectorsReader()Expert: retrieve underlying TermVectorsReaderKnnVectorsReadergetVectorReader()Expert: retrieve underlying VectorReaderintmaxDoc()Returns one greater than the largest possible document number.intnumDocs()Returns the number of documents in this index.static CodecReaderunwrap(CodecReader reader)Get the wrapped instance byreaderas long as this reader is an instance ofFilterCodecReader.-
Methods inherited from class org.apache.lucene.index.CodecReader
getBinaryDocValues, getByteVectorValues, getFloatVectorValues, getNormValues, getNumericDocValues, getPointValues, getSortedDocValues, getSortedNumericDocValues, getSortedSetDocValues, searchNearestVectors, searchNearestVectors, storedFields, terms, termVectors
-
Methods inherited from class org.apache.lucene.index.LeafReader
docFreq, getContext, getCoreCacheHelper, getDocCount, getSumDocFreq, getSumTotalTermFreq, postings, postings, searchNearestVectors, searchNearestVectors, totalTermFreq
-
Methods inherited from class org.apache.lucene.index.IndexReader
close, decRef, document, document, ensureOpen, equals, getReaderCacheHelper, getRefCount, getTermVector, hasDeletions, hashCode, incRef, leaves, notifyReaderClosedListeners, numDeletedDocs, registerParentReader, tryIncRef
-
-
-
-
Field Detail
-
in
protected final CodecReader in
The underlying CodecReader instance.
-
-
Constructor Detail
-
FilterCodecReader
public FilterCodecReader(CodecReader in)
Creates a new FilterCodecReader.- Parameters:
in- the underlying CodecReader instance.
-
-
Method Detail
-
unwrap
public static CodecReader unwrap(CodecReader reader)
Get the wrapped instance byreaderas long as this reader is an instance ofFilterCodecReader.
-
getFieldsReader
public StoredFieldsReader getFieldsReader()
Description copied from class:CodecReaderExpert: retrieve underlying StoredFieldsReader- Specified by:
getFieldsReaderin classCodecReader
-
getTermVectorsReader
public TermVectorsReader getTermVectorsReader()
Description copied from class:CodecReaderExpert: retrieve underlying TermVectorsReader- Specified by:
getTermVectorsReaderin classCodecReader
-
getNormsReader
public NormsProducer getNormsReader()
Description copied from class:CodecReaderExpert: retrieve underlying NormsProducer- Specified by:
getNormsReaderin classCodecReader
-
getDocValuesReader
public DocValuesProducer getDocValuesReader()
Description copied from class:CodecReaderExpert: retrieve underlying DocValuesProducer- Specified by:
getDocValuesReaderin classCodecReader
-
getPostingsReader
public FieldsProducer getPostingsReader()
Description copied from class:CodecReaderExpert: retrieve underlying FieldsProducer- Specified by:
getPostingsReaderin classCodecReader
-
document
@Deprecated public void document(int docID, StoredFieldVisitor visitor) throws IOException
Deprecated.Description copied from class:IndexReaderExpert: 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.- Overrides:
documentin classCodecReader- Throws:
IOException
-
getTermVectors
@Deprecated public Fields getTermVectors(int docID) throws IOException
Deprecated.Description copied from class:IndexReaderRetrieve 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).- Overrides:
getTermVectorsin classCodecReader- Throws:
IOException
-
getLiveDocs
public Bits getLiveDocs()
Description copied from class:LeafReaderReturns theBitsrepresenting live (not deleted) docs. A set bit indicates the doc ID has not been deleted. If this method returns null it means there are no deleted documents (all documents are live).The returned instance has been safely published for use by multiple threads without additional synchronization.
- Specified by:
getLiveDocsin classLeafReader
-
getFieldInfos
public FieldInfos getFieldInfos()
Description copied from class:LeafReaderGet theFieldInfosdescribing all fields in this reader.Note: Implementations should cache the FieldInfos instance returned by this method such that subsequent calls to this method return the same instance.
- Specified by:
getFieldInfosin classLeafReader
-
getPointsReader
public PointsReader getPointsReader()
Description copied from class:CodecReaderExpert: retrieve underlying PointsReader- Specified by:
getPointsReaderin classCodecReader
-
getVectorReader
public KnnVectorsReader getVectorReader()
Description copied from class:CodecReaderExpert: retrieve underlying VectorReader- Specified by:
getVectorReaderin classCodecReader
-
numDocs
public int numDocs()
Description copied from class:IndexReaderReturns the number of documents in this index.NOTE: This operation may run in O(maxDoc). Implementations that can't return this number in constant-time should cache it.
- Specified by:
numDocsin classIndexReader
-
maxDoc
public int maxDoc()
Description copied from class:IndexReaderReturns one greater than the largest possible document number. This may be used to, e.g., determine how big to allocate an array which will have an element for every document number in an index.- Specified by:
maxDocin classIndexReader
-
getMetaData
public LeafMetaData getMetaData()
Description copied from class:LeafReaderReturn metadata about this leaf.- Specified by:
getMetaDatain classLeafReader
-
doClose
protected void doClose() throws IOExceptionDescription copied from class:IndexReaderImplements close.- Overrides:
doClosein classCodecReader- Throws:
IOException
-
checkIntegrity
public void checkIntegrity() throws IOExceptionDescription copied from class:LeafReaderChecks 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.
- Overrides:
checkIntegrityin classCodecReader- Throws:
IOException
-
getDelegate
public CodecReader getDelegate()
Returns the wrappedCodecReader.
-
-