Class FieldsProducer

java.lang.Object
org.apache.lucene.index.Fields
org.apache.lucene.codecs.FieldsProducer
All Implemented Interfaces:
Closeable, AutoCloseable, Iterable<String>
Direct Known Subclasses:
BlockTermsReader, BloomFilteringPostingsFormat.BloomFilteredFieldsProducer, CompletionFieldsProducer, DirectPostingsFormat.DirectFields, FSTTermsReader, Lucene40BlockTreeTermsReader, Lucene90BlockTreeTermsReader, OrdsBlockTreeTermsReader, PerFieldMergeState.FilterFieldsProducer, PerFieldPostingsFormat.FieldsReader, SimpleTextFieldsReader, UniformSplitTermsReader, VersionBlockTreeTermsReader

public abstract class FieldsProducer extends Fields implements Closeable
Abstract API that produces terms, doc, freq, prox, offset and payloads postings.
  • Constructor Details

    • FieldsProducer

      protected FieldsProducer()
      Sole constructor. (For invocation by subclass constructors, typically implicit.)
  • Method Details

    • close

      public abstract void close() throws IOException
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Closeable
      Throws:
      IOException
    • 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 FieldsProducer getMergeInstance()
      Returns an instance optimized for merging. This instance may only be consumed in the thread that called getMergeInstance().

      The default implementation returns this