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
A
FilterCodecReader contains 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 FilterCodecReader does not change the content the contained
reader, you could consider delegating calls to LeafReader.getCoreCacheHelper() and IndexReader.getReaderCacheHelper().
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.lucene.index.IndexReader
IndexReader.CacheHelper, IndexReader.CacheKey, IndexReader.ClosedListener -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final CodecReaderThe underlying CodecReader instance. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidChecks consistency of this reader.protected voiddoClose()Implements close.Returns the wrappedCodecReader.Expert: retrieve underlying DocValuesProducerGet theFieldInfosdescribing all fields in this reader.Expert: retrieve underlying StoredFieldsReaderReturns theBitsrepresenting live (not deleted) docs.Return metadata about this leaf.Expert: retrieve underlying NormsProducerExpert: retrieve underlying PointsReaderExpert: retrieve underlying FieldsProducerExpert: retrieve underlying TermVectorsReaderExpert: 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, getDocValuesSkipper, getFloatVectorValues, getNormValues, getNumericDocValues, getPointValues, getSortedDocValues, getSortedNumericDocValues, getSortedSetDocValues, searchNearestVectors, searchNearestVectors, storedFields, terms, termVectorsMethods inherited from class org.apache.lucene.index.LeafReader
docFreq, getContext, getCoreCacheHelper, getDocCount, getSumDocFreq, getSumTotalTermFreq, postings, postings, searchNearestVectors, searchNearestVectors, totalTermFreqMethods inherited from class org.apache.lucene.index.IndexReader
close, decRef, ensureOpen, equals, getReaderCacheHelper, getRefCount, hasDeletions, hashCode, incRef, leaves, notifyReaderClosedListeners, numDeletedDocs, registerParentReader, tryIncRef
-
Field Details
-
in
The underlying CodecReader instance.
-
-
Constructor Details
-
FilterCodecReader
Creates a new FilterCodecReader.- Parameters:
in- the underlying CodecReader instance.
-
-
Method Details
-
unwrap
Get the wrapped instance byreaderas long as this reader is an instance ofFilterCodecReader. -
getFieldsReader
Description copied from class:CodecReaderExpert: retrieve underlying StoredFieldsReader- Specified by:
getFieldsReaderin classCodecReader
-
getTermVectorsReader
Description copied from class:CodecReaderExpert: retrieve underlying TermVectorsReader- Specified by:
getTermVectorsReaderin classCodecReader
-
getNormsReader
Description copied from class:CodecReaderExpert: retrieve underlying NormsProducer- Specified by:
getNormsReaderin classCodecReader
-
getDocValuesReader
Description copied from class:CodecReaderExpert: retrieve underlying DocValuesProducer- Specified by:
getDocValuesReaderin classCodecReader
-
getPostingsReader
Description copied from class:CodecReaderExpert: retrieve underlying FieldsProducer- Specified by:
getPostingsReaderin classCodecReader
-
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
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
Description copied from class:CodecReaderExpert: retrieve underlying PointsReader- Specified by:
getPointsReaderin classCodecReader
-
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
Description copied from class:LeafReaderReturn metadata about this leaf.- Specified by:
getMetaDatain classLeafReader
-
doClose
Description copied from class:IndexReaderImplements close.- Overrides:
doClosein classCodecReader- Throws:
IOException
-
checkIntegrity
Description 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
Returns the wrappedCodecReader.
-