Package org.apache.lucene.index
Class SegmentReader
java.lang.Object
org.apache.lucene.index.IndexReader
org.apache.lucene.index.AtomicReader
org.apache.lucene.index.SegmentReader
- All Implemented Interfaces:
Closeable
,AutoCloseable
IndexReader implementation over a single segment.
Instances pointing to the same segment (but with different deletes, etc) may share the same core data.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interface
Called when the shared core for this SegmentReader is closed.Nested classes/interfaces inherited from class org.apache.lucene.index.IndexReader
IndexReader.ReaderClosedListener
-
Constructor Summary
ConstructorsConstructorDescriptionSegmentReader
(SegmentCommitInfo si, int termInfosIndexDivisor, IOContext context) Constructs a new SegmentReader with a new core. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Expert: adds a CoreClosedListener to this reader's shared coreReturns the directory this index resides in.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.fields()
ReturnsFields
for this reader.getBinaryDocValues
(String field) ReturnsBinaryDocValues
for this field, or null if noBinaryDocValues
were indexed for this field.Expert: Returns a key for this IndexReader that also includes deletions, so FieldCache/CachingWrapperFilter can find it again.Expert: Returns a key for this IndexReader, so FieldCache/CachingWrapperFilter can find it again.getDocsWithField
(String field) Returns aBits
at the size ofreader.maxDoc()
, with turned on bits for each docid that does have a value for this field, or null if no DocValues were indexed for this field.Get theFieldInfos
describing all fields in this reader.Expert: retrieve thread-privateStoredFieldsReader
Returns theBits
representing live (not deleted) docs.getNormValues
(String field) ReturnsNumericDocValues
representing norms for this field, or null if noNumericDocValues
were indexed.getNumericDocValues
(String field) ReturnsNumericDocValues
for this field, or null if noNumericDocValues
were indexed for this field.Return the SegmentInfoPerCommit of the segment this reader is reading.Return the name of the segment this reader is reading.getSortedDocValues
(String field) ReturnsSortedDocValues
for this field, or null if noSortedDocValues
were indexed for this field.getSortedSetDocValues
(String field) ReturnsSortedSetDocValues
for this field, or null if noSortedSetDocValues
were indexed for this field.int
Returns term infos index divisor originally passed toSegmentReader(SegmentCommitInfo, int, IOContext)
.getTermVectors
(int docID) Retrieve term vectors for this document, or null if term vectors were not indexed.Expert: retrieve thread-privateTermVectorsReader
int
maxDoc()
Returns one greater than the largest possible document number.int
numDocs()
Returns the number of documents in this index.long
Returns approximate RAM Bytes usedvoid
Expert: removes a CoreClosedListener from this reader's shared coretoString()
Methods inherited from class org.apache.lucene.index.AtomicReader
docFreq, getContext, getDocCount, getSumDocFreq, getSumTotalTermFreq, hasNorms, termDocsEnum, termPositionsEnum, terms, totalTermFreq
Methods inherited from class org.apache.lucene.index.IndexReader
addReaderClosedListener, close, decRef, document, document, ensureOpen, equals, getRefCount, getTermVector, hasDeletions, hashCode, incRef, leaves, numDeletedDocs, open, open, open, open, open, registerParentReader, removeReaderClosedListener, tryIncRef
-
Constructor Details
-
SegmentReader
public SegmentReader(SegmentCommitInfo si, int termInfosIndexDivisor, IOContext context) throws IOException Constructs a new SegmentReader with a new core.- Throws:
CorruptIndexException
- if the index is corruptIOException
- if there is a low-level IO error
-
-
Method Details
-
getLiveDocs
Description copied from class:AtomicReader
Returns theBits
representing 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:
getLiveDocs
in classAtomicReader
-
doClose
Description copied from class:IndexReader
Implements close.- Specified by:
doClose
in classIndexReader
- Throws:
IOException
-
getFieldInfos
Description copied from class:AtomicReader
Get theFieldInfos
describing all fields in this reader.- Specified by:
getFieldInfos
in classAtomicReader
-
getFieldsReader
Expert: retrieve thread-privateStoredFieldsReader
-
document
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:
IOException
-
fields
Description copied from class:AtomicReader
ReturnsFields
for this reader. This method may return null if the reader has no postings.- Specified by:
fields
in classAtomicReader
-
numDocs
public int numDocs()Description copied from class:IndexReader
Returns the number of documents in this index.- Specified by:
numDocs
in classIndexReader
-
maxDoc
public int maxDoc()Description copied from class:IndexReader
Returns 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:
maxDoc
in classIndexReader
-
getTermVectorsReader
Expert: retrieve thread-privateTermVectorsReader
-
getTermVectors
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:
IOException
-
toString
-
getSegmentName
Return the name of the segment this reader is reading. -
getSegmentInfo
Return the SegmentInfoPerCommit of the segment this reader is reading. -
directory
Returns the directory this index resides in. -
getCoreCacheKey
Description copied from class:IndexReader
Expert: Returns a key for this IndexReader, so FieldCache/CachingWrapperFilter can find it again. This key must not have equals()/hashCode() methods, so "equals" means "identical".- Overrides:
getCoreCacheKey
in classIndexReader
-
getCombinedCoreAndDeletesKey
Description copied from class:IndexReader
Expert: Returns a key for this IndexReader that also includes deletions, so FieldCache/CachingWrapperFilter can find it again. This key must not have equals()/hashCode() methods, so "equals" means "identical".- Overrides:
getCombinedCoreAndDeletesKey
in classIndexReader
-
getTermInfosIndexDivisor
public int getTermInfosIndexDivisor()Returns term infos index divisor originally passed toSegmentReader(SegmentCommitInfo, int, IOContext)
. -
getNumericDocValues
Description copied from class:AtomicReader
ReturnsNumericDocValues
for this field, or null if noNumericDocValues
were indexed for this field. The returned instance should only be used by a single thread.- Specified by:
getNumericDocValues
in classAtomicReader
- Throws:
IOException
-
getDocsWithField
Description copied from class:AtomicReader
Returns aBits
at the size ofreader.maxDoc()
, with turned on bits for each docid that does have a value for this field, or null if no DocValues were indexed for this field. The returned instance should only be used by a single thread- Specified by:
getDocsWithField
in classAtomicReader
- Throws:
IOException
-
getBinaryDocValues
Description copied from class:AtomicReader
ReturnsBinaryDocValues
for this field, or null if noBinaryDocValues
were indexed for this field. The returned instance should only be used by a single thread.- Specified by:
getBinaryDocValues
in classAtomicReader
- Throws:
IOException
-
getSortedDocValues
Description copied from class:AtomicReader
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 classAtomicReader
- Throws:
IOException
-
getSortedSetDocValues
Description copied from class:AtomicReader
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 classAtomicReader
- Throws:
IOException
-
getNormValues
Description copied from class:AtomicReader
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 classAtomicReader
- Throws:
IOException
-
addCoreClosedListener
Expert: adds a CoreClosedListener to this reader's shared core -
removeCoreClosedListener
Expert: removes a CoreClosedListener from this reader's shared core -
ramBytesUsed
public long ramBytesUsed()Returns approximate RAM Bytes used
-