- java.lang.Object
-
- org.apache.lucene.index.StoredFields
-
- org.apache.lucene.codecs.StoredFieldsReader
-
- All Implemented Interfaces:
java.io.Closeable
,java.lang.AutoCloseable
,java.lang.Cloneable
- Direct Known Subclasses:
Lucene50CompressingStoredFieldsReader
,Lucene90CompressingStoredFieldsReader
,SimpleTextStoredFieldsReader
,SlowCompositeCodecReaderWrapper.SlowCompositeStoredFieldsReaderWrapper
public abstract class StoredFieldsReader extends StoredFields implements java.lang.Cloneable, java.io.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()
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
StoredFieldsReader()
Sole constructor.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract void
checkIntegrity()
Checks consistency of this reader.abstract StoredFieldsReader
clone()
StoredFieldsReader
getMergeInstance()
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()
- Overrides:
clone
in classjava.lang.Object
-
checkIntegrity
public abstract void checkIntegrity() throws java.io.IOException
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.
- Throws:
java.io.IOException
-
getMergeInstance
public StoredFieldsReader getMergeInstance()
Returns an instance optimized for merging. This instance may not be cloned.The default implementation returns
this
-
-