org.apache.lucene.codecs.simpletext

Class SimpleTextStoredFieldsReader

java.lang.Object

org.apache.lucene.codecs.StoredFieldsReader

org.apache.lucene.codecs.simpletext.SimpleTextStoredFieldsReader

All Implemented Interfaces:

Closeable, AutoCloseable, Cloneable, Accountable

public class SimpleTextStoredFieldsReader
extends StoredFieldsReader

reads plaintext stored fields

FOR RECREATIONAL USE ONLY

Constructor Summary

Constructors

Constructor and Description
SimpleTextStoredFieldsReader(Directory directory, SegmentInfo si, FieldInfos fn, IOContext context)

Method Summary

Methods

Modifier and Type	Method and Description
void	checkIntegrity() Checks consistency of this reader.
StoredFieldsReader	clone()
void	close()
Collection<Accountable>	getChildResources() Returns nested resources of this class.
long	ramBytesUsed() Return the memory usage of this object in bytes.
String	toString()
void	visitDocument(int n, StoredFieldVisitor visitor) Visit the stored fields for document docID

Methods inherited from class org.apache.lucene.codecs.StoredFieldsReader

getMergeInstance

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleTextStoredFieldsReader

public SimpleTextStoredFieldsReader(Directory directory,
                            SegmentInfo si,
                            FieldInfos fn,
                            IOContext context)
                             throws IOException

Throws:

IOException

Method Detail

visitDocument

public void visitDocument(int n,
                 StoredFieldVisitor visitor)
                   throws IOException

Description copied from class: StoredFieldsReader

Visit the stored fields for document docID

Specified by:

visitDocument in class StoredFieldsReader

Throws:

IOException

clone

public StoredFieldsReader clone()

Specified by:

clone in class StoredFieldsReader

close

public void close()
           throws IOException

Throws:

IOException

ramBytesUsed

public long ramBytesUsed()

Description copied from interface: Accountable

Return the memory usage of this object in bytes. Negative values are illegal.

getChildResources

public Collection<Accountable> getChildResources()

Description copied from interface: Accountable

Returns nested resources of this class. The result should be a point-in-time snapshot (to avoid race conditions).

See Also:

Accountables

toString

public String toString()

Overrides:

toString in class Object

checkIntegrity

public void checkIntegrity()
                    throws IOException

Description copied from class: StoredFieldsReader

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.

Specified by:

checkIntegrity in class StoredFieldsReader

Throws:

IOException