Module org.apache.lucene.codecs

Package org.apache.lucene.codecs.simpletext

Class SimpleTextPointsFormat

java.lang.Object

org.apache.lucene.codecs.PointsFormat

org.apache.lucene.codecs.simpletext.SimpleTextPointsFormat

public final class SimpleTextPointsFormat
extends PointsFormat

For debugging, curiosity, transparency only!! Do not use this codec in production.

This codec stores all dimensional data in a single human-readable text file (_N.dim). You can view this in any text editor, and even edit it to alter your index.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final String	POINT_EXTENSION	Extension of points data file
(package private) static final String	POINT_INDEX_EXTENSION	Extension of points index file

Fields inherited from class org.apache.lucene.codecs.PointsFormat

EMPTY

Constructor Summary

Constructors

Constructor	Description
SimpleTextPointsFormat()

Method Summary

Modifier and Type	Method	Description
PointsReader	fieldsReader(SegmentReadState state)	Reads a segment.
PointsWriter	fieldsWriter(SegmentWriteState state)	Writes a new segment

Methods inherited from class java.lang.Object

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

Field Details

POINT_EXTENSION

static final String POINT_EXTENSION

Extension of points data file

See Also:

• Constant Field Values

POINT_INDEX_EXTENSION

static final String POINT_INDEX_EXTENSION

Extension of points index file

See Also:

• Constant Field Values

Constructor Details

SimpleTextPointsFormat

public SimpleTextPointsFormat()

Method Details

fieldsWriter

public PointsWriter fieldsWriter(SegmentWriteState state)
                          throws IOException

Description copied from class: PointsFormat

Writes a new segment

Specified by:

fieldsWriter in class PointsFormat

Throws:

IOException

fieldsReader

public PointsReader fieldsReader(SegmentReadState state)
                          throws IOException

Description copied from class: PointsFormat

Reads a segment. NOTE: by the time this call returns, it must hold open any files it will need to use; else, those files may be deleted. Additionally, required files may be deleted during the execution of this call before there is a chance to open them. Under these circumstances an IOException should be thrown by the implementation. IOExceptions are expected and will automatically cause a retry of the segment opening logic with the newly revised segments.

Specified by:

fieldsReader in class PointsFormat

Throws:

IOException