Package org.apache.lucene.codecs

Class StoredFieldsReader

java.lang.Object
org.apache.lucene.codecs.StoredFieldsReader
All Implemented Interfaces:
Closeable, AutoCloseable, Cloneable, Accountable
Direct Known Subclasses:
CompressingStoredFieldsReader, SimpleTextStoredFieldsReader
public abstract class StoredFieldsReader extends Object implements Cloneable, Closeable, Accountable
Codec API for reading stored fields.

You need to implement visitDocument(int, StoredFieldVisitor) to read the stored fields for a document, implement clone() (creating clones of any IndexInputs used, etc), and Closeable.close()

  • Constructor Details

    • StoredFieldsReader

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

  • Method Details

    • visitDocument

      public abstract void visitDocument(int docID, StoredFieldVisitor visitor) throws IOException
      Visit the stored fields for document docID
      Throws:
      IOException

    • clone

      public abstract StoredFieldsReader clone()
      Overrides:
      clone in class Object

    • checkIntegrity

      public abstract void checkIntegrity() throws 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:
      IOException

    • getMergeInstance

      public StoredFieldsReader getMergeInstance()
      Returns an instance optimized for merging. This instance may not be cloned.

      The default implementation returns this