Module org.apache.lucene.codecs

Package org.apache.lucene.codecs.simpletext

Class SimpleTextStoredFieldsReader

java.lang.Object

org.apache.lucene.index.StoredFields

org.apache.lucene.codecs.StoredFieldsReader

org.apache.lucene.codecs.simpletext.SimpleTextStoredFieldsReader

All Implemented Interfaces:

Closeable, AutoCloseable, Cloneable

public class SimpleTextStoredFieldsReader
extends StoredFieldsReader

reads plaintext stored fields

FOR RECREATIONAL USE ONLY

Field Summary

Fields

Modifier and Type	Field	Description
private final FieldInfos	fieldInfos
private IndexInput	in
private long[]	offsets
private BytesRefBuilder	scratch
private CharsRefBuilder	scratchUTF16

Constructor Summary

Constructors

Constructor	Description
SimpleTextStoredFieldsReader(long[] offsets, IndexInput in, FieldInfos fieldInfos)
SimpleTextStoredFieldsReader(Directory directory, SegmentInfo si, FieldInfos fn, IOContext context)

Method Summary

Modifier and Type	Method	Description
void	checkIntegrity()	Checks consistency of this reader.
StoredFieldsReader	clone()
void	close()
void	document(int n, StoredFieldVisitor visitor)	Expert: visits the fields of a stored document, for custom processing/loading of each field.
private boolean	equalsAt(BytesRef a, BytesRef b, int bOffset)
private int	parseIntAt(int offset)
private void	readField(BytesRef type, FieldInfo fieldInfo, StoredFieldVisitor visitor)
private void	readIndex(int size)
private void	readLine()
String	toString()

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

getMergeInstance

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

document, document, prefetch

Methods inherited from class java.lang.Object

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

Field Details

offsets

private long[] offsets

in

private IndexInput in

scratch

private BytesRefBuilder scratch

scratchUTF16

private CharsRefBuilder scratchUTF16

fieldInfos

private final FieldInfos fieldInfos

Constructor Details

SimpleTextStoredFieldsReader

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

Throws:

IOException

SimpleTextStoredFieldsReader

SimpleTextStoredFieldsReader(long[] offsets,
 IndexInput in,
 FieldInfos fieldInfos)

Method Details

readIndex

private void readIndex(int size)
                throws IOException

Throws:

IOException

document

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

Description copied from class: StoredFields

Expert: visits the fields of a stored document, for custom processing/loading of each field. If you simply want to load all fields, use StoredFields.document(int). If you want to load a subset, use DocumentStoredFieldVisitor.

Specified by:

document in class StoredFields

Throws:

IOException

readField

private void readField(BytesRef type,
 FieldInfo fieldInfo,
 StoredFieldVisitor visitor)
                throws IOException

Throws:

IOException

clone

public StoredFieldsReader clone()

Specified by:

clone in class StoredFieldsReader

close

public void close()
           throws IOException

Throws:

IOException

readLine

private void readLine()
               throws IOException

Throws:

IOException

parseIntAt

private int parseIntAt(int offset)

equalsAt

private boolean equalsAt(BytesRef a,
 BytesRef b,
 int bOffset)

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