Module org.apache.lucene.codecs

Package org.apache.lucene.codecs.simpletext

Class SimpleTextKnnVectorsFormat

java.lang.Object

org.apache.lucene.codecs.KnnVectorsFormat

org.apache.lucene.codecs.simpletext.SimpleTextKnnVectorsFormat

All Implemented Interfaces:

NamedSPILoader.NamedSPI

public final class SimpleTextKnnVectorsFormat
extends KnnVectorsFormat

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

This codec stores all data in a single human-readable text file (_N.vec). 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	META_EXTENSION	Extension of vectors index file
(package private) static final String	VECTOR_EXTENSION	Extension of vectors data file

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

DEFAULT_MAX_DIMENSIONS, EMPTY

Constructor Summary

Constructors

Constructor	Description
SimpleTextKnnVectorsFormat()

Method Summary

Modifier and Type	Method	Description
KnnVectorsReader	fieldsReader(SegmentReadState state)	Returns a KnnVectorsReader to read the vectors from the index.
KnnVectorsWriter	fieldsWriter(SegmentWriteState state)	Returns a KnnVectorsWriter to write the vectors to the index.

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

availableKnnVectorsFormats, forName, getMaxDimensions, getName, reloadKnnVectorsFormat

Methods inherited from class java.lang.Object

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

Field Details

VECTOR_EXTENSION

static final String VECTOR_EXTENSION

Extension of vectors data file

See Also:

• Constant Field Values

META_EXTENSION

static final String META_EXTENSION

Extension of vectors index file

See Also:

• Constant Field Values

Constructor Details

SimpleTextKnnVectorsFormat

public SimpleTextKnnVectorsFormat()

Method Details

fieldsWriter

public KnnVectorsWriter fieldsWriter(SegmentWriteState state)
                              throws IOException

Description copied from class: KnnVectorsFormat

Returns a KnnVectorsWriter to write the vectors to the index.

Specified by:

fieldsWriter in class KnnVectorsFormat

Throws:

IOException

fieldsReader

public KnnVectorsReader fieldsReader(SegmentReadState state)
                              throws IOException

Description copied from class: KnnVectorsFormat

Returns a KnnVectorsReader to read the vectors from the index.

Specified by:

fieldsReader in class KnnVectorsFormat

Throws:

IOException