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:

Closeable, 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.LeafReader

LeafReader.CoreClosedListener

Nested classes/interfaces inherited from class org.apache.lucene.index.IndexReader

IndexReader.ReaderClosedListener

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CodecReader() Sole constructor.

Method Summary

Methods

Modifier and Type	Method and Description
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.
Fields	fields() Returns Fields for this reader.
BinaryDocValues	getBinaryDocValues(String field) Returns BinaryDocValues for this field, or null if no BinaryDocValues were indexed for this field.
Collection<Accountable>	getChildResources() Returns nested resources of this class.
Bits	getDocsWithField(String field) Returns a Bits at the size of reader.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.
abstract DocValuesProducer	getDocValuesReader() Expert: retrieve underlying DocValuesProducer
abstract StoredFieldsReader	getFieldsReader() Expert: retrieve thread-private StoredFieldsReader
abstract NormsProducer	getNormsReader() Expert: retrieve underlying NormsProducer
NumericDocValues	getNormValues(String field) Returns NumericDocValues representing norms for this field, or null if no NumericDocValues were indexed.
NumericDocValues	getNumericDocValues(String field) Returns NumericDocValues for this field, or null if no NumericDocValues were indexed for this field.
abstract FieldsProducer	getPostingsReader() Expert: retrieve underlying FieldsProducer
SortedDocValues	getSortedDocValues(String field) Returns SortedDocValues for this field, or null if no SortedDocValues were indexed for this field.
SortedNumericDocValues	getSortedNumericDocValues(String field) Returns SortedNumericDocValues for this field, or null if no SortedNumericDocValues were indexed for this field.
SortedSetDocValues	getSortedSetDocValues(String field) Returns SortedSetDocValues for this field, or null if no SortedSetDocValues 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 TermVectorsReader
long	ramBytesUsed() Return the memory usage of this object in bytes.

Methods inherited from class org.apache.lucene.index.LeafReader

addCoreClosedListener, addCoreClosedListenerAsReaderClosedListener, docFreq, getContext, getDocCount, getFieldInfos, getLiveDocs, getSumDocFreq, getSumTotalTermFreq, postings, postings, removeCoreClosedListener, removeCoreClosedListenerAsReaderClosedListener, termDocsEnum, termPositionsEnum, terms, totalTermFreq

Methods inherited from class org.apache.lucene.index.IndexReader

addReaderClosedListener, close, decRef, document, document, ensureOpen, equals, getCombinedCoreAndDeletesKey, getCoreCacheKey, getRefCount, getTermVector, hasDeletions, hashCode, incRef, leaves, maxDoc, numDeletedDocs, numDocs, registerParentReader, removeReaderClosedListener, tryIncRef

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CodecReader

protected CodecReader()

Sole constructor. (For invocation by subclass constructors, typically implicit.)

Method Detail

getFieldsReader

public abstract StoredFieldsReader getFieldsReader()

Expert: retrieve thread-private StoredFieldsReader

NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.

getTermVectorsReader

public abstract TermVectorsReader getTermVectorsReader()

Expert: retrieve thread-private TermVectorsReader

NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.

getNormsReader

public abstract NormsProducer getNormsReader()

Expert: retrieve underlying NormsProducer

NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.

getDocValuesReader

public abstract DocValuesProducer getDocValuesReader()

Expert: retrieve underlying DocValuesProducer

NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.

getPostingsReader

public abstract FieldsProducer getPostingsReader()

Expert: retrieve underlying FieldsProducer

NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.

document

public final void document(int docID,
            StoredFieldVisitor visitor)
                    throws 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, use IndexReader.document(int). If you want to load a subset, use DocumentStoredFieldVisitor.

Specified by:

document in class IndexReader

Throws:

IOException

getTermVectors

public final Fields getTermVectors(int docID)
                            throws 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 class IndexReader

Throws:

IOException

fields

public final Fields fields()

Description copied from class: LeafReader

Returns Fields for this reader. This method will not return null.

Specified by:

fields in class LeafReader

getNumericDocValues

public final NumericDocValues getNumericDocValues(String field)
                                           throws IOException

Description copied from class: LeafReader

Returns NumericDocValues for this field, or null if no NumericDocValues were indexed for this field. The returned instance should only be used by a single thread.

Specified by:

getNumericDocValues in class LeafReader

Throws:

IOException

getDocsWithField

public final Bits getDocsWithField(String field)
                            throws IOException

Description copied from class: LeafReader

Returns a Bits at the size of reader.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 class LeafReader

Throws:

IOException

getBinaryDocValues

public final BinaryDocValues getBinaryDocValues(String field)
                                         throws IOException

Description copied from class: LeafReader

Returns BinaryDocValues for this field, or null if no BinaryDocValues were indexed for this field. The returned instance should only be used by a single thread.

Specified by:

getBinaryDocValues in class LeafReader

Throws:

IOException

getSortedDocValues

public final SortedDocValues getSortedDocValues(String field)
                                         throws IOException

Description copied from class: LeafReader

Returns SortedDocValues for this field, or null if no SortedDocValues were indexed for this field. The returned instance should only be used by a single thread.

Specified by:

getSortedDocValues in class LeafReader

Throws:

IOException

getSortedNumericDocValues

public final SortedNumericDocValues getSortedNumericDocValues(String field)
                                                       throws IOException

Description copied from class: LeafReader

Returns SortedNumericDocValues for this field, or null if no SortedNumericDocValues were indexed for this field. The returned instance should only be used by a single thread.

Specified by:

getSortedNumericDocValues in class LeafReader

Throws:

IOException

getSortedSetDocValues

public final SortedSetDocValues getSortedSetDocValues(String field)
                                               throws IOException

Description copied from class: LeafReader

Returns SortedSetDocValues for this field, or null if no SortedSetDocValues were indexed for this field. The returned instance should only be used by a single thread.

Specified by:

getSortedSetDocValues in class LeafReader

Throws:

IOException

getNormValues

public final NumericDocValues getNormValues(String field)
                                     throws IOException

Description copied from class: LeafReader

Returns NumericDocValues representing norms for this field, or null if no NumericDocValues were indexed. The returned instance should only be used by a single thread.

Specified by:

getNormValues in class LeafReader

Throws:

IOException

doClose

protected void doClose()
                throws IOException

Description copied from class: IndexReader

Implements close.

Specified by:

doClose in class IndexReader

Throws:

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 interface Accountable

getChildResources

public 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 interface Accountable

See Also:

Accountables

checkIntegrity

public void checkIntegrity()
                    throws 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 class LeafReader

Throws:

IOException