Module org.apache.lucene.codecs

Package org.apache.lucene.codecs.simpletext

Class SimpleTextStoredFieldsWriter

java.lang.Object

org.apache.lucene.codecs.StoredFieldsWriter

org.apache.lucene.codecs.simpletext.SimpleTextStoredFieldsWriter

All Implemented Interfaces:

Closeable, AutoCloseable, Accountable

public class SimpleTextStoredFieldsWriter
extends StoredFieldsWriter

Writes plain-text stored fields.

FOR RECREATIONAL USE ONLY

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.codecs.StoredFieldsWriter

StoredFieldsWriter.MergeVisitor

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final BytesRef	DOC
(package private) static final BytesRef	END
(package private) static final BytesRef	FIELD
(package private) static final String	FIELDS_EXTENSION
(package private) static final BytesRef	NAME
private int	numDocsWritten
private IndexOutput	out
private final BytesRefBuilder	scratch
(package private) static final BytesRef	TYPE
(package private) static final BytesRef	TYPE_BINARY
(package private) static final BytesRef	TYPE_DOUBLE
(package private) static final BytesRef	TYPE_FLOAT
(package private) static final BytesRef	TYPE_INT
(package private) static final BytesRef	TYPE_LONG
(package private) static final BytesRef	TYPE_STRING
(package private) static final BytesRef	VALUE

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

NULL_ACCOUNTABLE

Constructor Summary

Constructors

Constructor	Description
SimpleTextStoredFieldsWriter(Directory directory, String segment, IOContext context)

Method Summary

Modifier and Type	Method	Description
void	close()
void	finish(int numDocs)	Called before StoredFieldsWriter.close(), passing in the number of documents that were written.
private void	newLine()
long	ramBytesUsed()	Return the memory usage of this object in bytes.
void	startDocument()	Called before writing the stored fields of the document.
private void	write(String s)
private void	write(BytesRef bytes)
void	writeField(FieldInfo info, IndexableField field)	Writes a single stored field.

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

finishDocument, merge

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

Field Details

numDocsWritten

private int numDocsWritten

out

private IndexOutput out

FIELDS_EXTENSION

static final String FIELDS_EXTENSION

See Also:

• Constant Field Values

TYPE_STRING

static final BytesRef TYPE_STRING

TYPE_BINARY

static final BytesRef TYPE_BINARY

TYPE_INT

static final BytesRef TYPE_INT

TYPE_LONG

static final BytesRef TYPE_LONG

TYPE_FLOAT

static final BytesRef TYPE_FLOAT

TYPE_DOUBLE

static final BytesRef TYPE_DOUBLE

END

static final BytesRef END

DOC

static final BytesRef DOC

FIELD

static final BytesRef FIELD

NAME

static final BytesRef NAME

TYPE

static final BytesRef TYPE

VALUE

static final BytesRef VALUE

scratch

private final BytesRefBuilder scratch

Constructor Details

SimpleTextStoredFieldsWriter

public SimpleTextStoredFieldsWriter(Directory directory,
 String segment,
 IOContext context)
                             throws IOException

Throws:

IOException

Method Details

startDocument

public void startDocument()
                   throws IOException

Description copied from class: StoredFieldsWriter

Called before writing the stored fields of the document. StoredFieldsWriter.writeField(FieldInfo, IndexableField) will be called for each stored field. Note that this is called even if the document has no stored fields.

Specified by:

startDocument in class StoredFieldsWriter

Throws:

IOException

writeField

public void writeField(FieldInfo info,
 IndexableField field)
                throws IOException

Description copied from class: StoredFieldsWriter

Writes a single stored field.

Specified by:

writeField in class StoredFieldsWriter

Throws:

IOException

finish

public void finish(int numDocs)
            throws IOException

Description copied from class: StoredFieldsWriter

Called before StoredFieldsWriter.close(), passing in the number of documents that were written. Note that this is intentionally redundant (equivalent to the number of calls to StoredFieldsWriter.startDocument(), but a Codec should check that this is the case to detect the JRE bug described in LUCENE-1282.

Specified by:

finish in class StoredFieldsWriter

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in class StoredFieldsWriter

Throws:

IOException

write

private void write(String s)
            throws IOException

Throws:

IOException

write

private void write(BytesRef bytes)
            throws IOException

Throws:

IOException

newLine

private void newLine()
              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.