Package org.apache.lucene.codecs
Class FieldsProducer
- java.lang.Object
-
- org.apache.lucene.index.Fields
-
- org.apache.lucene.codecs.FieldsProducer
-
- All Implemented Interfaces:
java.io.Closeable
,java.lang.AutoCloseable
,java.lang.Iterable<java.lang.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 java.io.Closeable
Abstract API that produces terms, doc, freq, prox, offset and payloads postings.
-
-
Field Summary
-
Fields inherited from class org.apache.lucene.index.Fields
EMPTY_ARRAY
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
FieldsProducer()
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 void
close()
FieldsProducer
getMergeInstance()
Returns an instance optimized for merging.
-
-
-
Method Detail
-
close
public abstract void close() throws java.io.IOException
- Specified by:
close
in interfacejava.lang.AutoCloseable
- Specified by:
close
in interfacejava.io.Closeable
- Throws:
java.io.IOException
-
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 FieldsProducer getMergeInstance()
Returns an instance optimized for merging. This instance may only be consumed in the thread that calledgetMergeInstance()
.The default implementation returns
this
-
-