Package org.apache.lucene.codecs
Class StoredFieldsReader
- java.lang.Object
-
- org.apache.lucene.index.StoredFields
-
- org.apache.lucene.codecs.StoredFieldsReader
-
- All Implemented Interfaces:
Closeable,AutoCloseable,Cloneable
- Direct Known Subclasses:
Lucene90CompressingStoredFieldsReader
public abstract class StoredFieldsReader extends StoredFields implements Cloneable, Closeable
Codec API for reading stored fields.You need to implement
StoredFields.document(int, StoredFieldVisitor)to read the stored fields for a document, implementclone()(creating clones of any IndexInputs used, etc), andCloseable.close()- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedStoredFieldsReader()Sole constructor.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract voidcheckIntegrity()Checks consistency of this reader.abstract StoredFieldsReaderclone()StoredFieldsReadergetMergeInstance()Returns an instance optimized for merging.-
Methods inherited from class org.apache.lucene.index.StoredFields
document, document, document
-
-
-
-
Method Detail
-
clone
public abstract StoredFieldsReader clone()
-
checkIntegrity
public abstract void checkIntegrity() throws IOExceptionChecks 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.
- Throws:
IOException- NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.
-
getMergeInstance
public StoredFieldsReader getMergeInstance()
Returns an instance optimized for merging. This instance may not be cloned.The default implementation returns
this
-
-