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>, Accountable

Direct Known Subclasses:

BlockTermsReader, BlockTreeTermsReader, FSTOrdTermsReader, FSTTermsReader, OrdsBlockTreeTermsReader, VersionBlockTreeTermsReader

public abstract class FieldsProducer
extends Fields
implements java.io.Closeable, Accountable

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 and Description
protected	FieldsProducer() Sole constructor.

Method Summary

Modifier and Type	Method and Description
abstract void	checkIntegrity() Checks consistency of this reader.
abstract void	close()
FieldsProducer	getMergeInstance() Returns an instance optimized for merging.

Methods inherited from class org.apache.lucene.index.Fields

iterator, size, terms

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.lucene.util.Accountable

getChildResources, ramBytesUsed

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

FieldsProducer

protected FieldsProducer()

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

Method Detail

close

public abstract void close()
                    throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

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()
                                throws java.io.IOException

Returns an instance optimized for merging.

The default implementation returns this

Throws:

java.io.IOException