Module org.apache.lucene.codecs

Package org.apache.lucene.codecs.simpletext

Class SimpleTextKnnVectorsWriter

java.lang.Object

org.apache.lucene.codecs.KnnVectorsWriter

org.apache.lucene.codecs.BufferingKnnVectorsWriter

org.apache.lucene.codecs.simpletext.SimpleTextKnnVectorsWriter

All Implemented Interfaces:

Closeable, AutoCloseable, Accountable

public class SimpleTextKnnVectorsWriter
extends BufferingKnnVectorsWriter

Writes vector-valued fields in a plain text format

Nested Class Summary

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

KnnVectorsWriter.MergedVectorValues

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final BytesRef	FIELD_NAME
(package private) static final BytesRef	FIELD_NUMBER
private final IndexOutput	meta
private final BytesRefBuilder	scratch
(package private) static final BytesRef	SIZE
(package private) static final BytesRef	VECTOR_DATA_LENGTH
(package private) static final BytesRef	VECTOR_DATA_OFFSET
(package private) static final BytesRef	VECTOR_DIMENSION
private final IndexOutput	vectorData

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

NULL_ACCOUNTABLE

Constructor Summary

Constructors

Constructor	Description
SimpleTextKnnVectorsWriter(SegmentWriteState state)

Method Summary

Modifier and Type	Method	Description
void	close()
void	finish()	Called once at the end before close
private void	newline(IndexOutput out)
private void	write(IndexOutput out, String s)
private void	write(IndexOutput out, BytesRef b)
private void	writeByteVectorValue(ByteVectorValues vectors)
void	writeField(FieldInfo fieldInfo, ByteVectorValues byteVectorValues, int maxDoc)	Write the provided byte vector field
void	writeField(FieldInfo fieldInfo, FloatVectorValues floatVectorValues, int maxDoc)	Write the provided float vector field
private void	writeField(IndexOutput out, BytesRef fieldName, int value)
private void	writeField(IndexOutput out, BytesRef fieldName, long value)
private void	writeField(IndexOutput out, BytesRef fieldName, String value)
private void	writeFloatVectorValue(FloatVectorValues vectors)
private void	writeInt(IndexOutput out, int x)
private void	writeLong(IndexOutput out, long x)
private void	writeMeta(FieldInfo field, long vectorDataOffset, long vectorDataLength, List<Integer> docIds)

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

addField, flush, mergeOneField, ramBytesUsed

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

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

FIELD_NUMBER

static final BytesRef FIELD_NUMBER

FIELD_NAME

static final BytesRef FIELD_NAME

VECTOR_DATA_OFFSET

static final BytesRef VECTOR_DATA_OFFSET

VECTOR_DATA_LENGTH

static final BytesRef VECTOR_DATA_LENGTH

VECTOR_DIMENSION

static final BytesRef VECTOR_DIMENSION

SIZE

static final BytesRef SIZE

meta

private final IndexOutput meta

vectorData

private final IndexOutput vectorData

scratch

private final BytesRefBuilder scratch

Constructor Details

SimpleTextKnnVectorsWriter

SimpleTextKnnVectorsWriter(SegmentWriteState state)
                    throws IOException

Throws:

IOException

Method Details

writeField

public void writeField(FieldInfo fieldInfo,
 FloatVectorValues floatVectorValues,
 int maxDoc)
                throws IOException

Description copied from class: BufferingKnnVectorsWriter

Write the provided float vector field

Specified by:

writeField in class BufferingKnnVectorsWriter

Throws:

IOException

writeFloatVectorValue

private void writeFloatVectorValue(FloatVectorValues vectors)
                            throws IOException

Throws:

IOException

writeField

public void writeField(FieldInfo fieldInfo,
 ByteVectorValues byteVectorValues,
 int maxDoc)
                throws IOException

Description copied from class: BufferingKnnVectorsWriter

Write the provided byte vector field

Specified by:

writeField in class BufferingKnnVectorsWriter

Throws:

IOException

writeByteVectorValue

private void writeByteVectorValue(ByteVectorValues vectors)
                           throws IOException

Throws:

IOException

writeMeta

private void writeMeta(FieldInfo field,
 long vectorDataOffset,
 long vectorDataLength,
 List<Integer> docIds)
                throws IOException

Throws:

IOException

finish

public void finish()
            throws IOException

Description copied from class: KnnVectorsWriter

Called once at the end before close

Specified by:

finish in class KnnVectorsWriter

Throws:

IOException

close

public void close()
           throws IOException

Throws:

IOException

writeField

private void writeField(IndexOutput out,
 BytesRef fieldName,
 int value)
                 throws IOException

Throws:

IOException

writeField

private void writeField(IndexOutput out,
 BytesRef fieldName,
 long value)
                 throws IOException

Throws:

IOException

writeField

private void writeField(IndexOutput out,
 BytesRef fieldName,
 String value)
                 throws IOException

Throws:

IOException

write

private void write(IndexOutput out,
 String s)
            throws IOException

Throws:

IOException

writeInt

private void writeInt(IndexOutput out,
 int x)
               throws IOException

Throws:

IOException

writeLong

private void writeLong(IndexOutput out,
 long x)
                throws IOException

Throws:

IOException

write

private void write(IndexOutput out,
 BytesRef b)
            throws IOException

Throws:

IOException

newline

private void newline(IndexOutput out)
              throws IOException

Throws:

IOException