Module org.apache.lucene.core

Package org.apache.lucene.codecs.lucene99

Class Lucene99FlatVectorsWriter.FieldWriter<T>

java.lang.Object

org.apache.lucene.codecs.KnnFieldVectorsWriter<T>

org.apache.lucene.codecs.hnsw.FlatFieldVectorsWriter<T>

org.apache.lucene.codecs.lucene99.Lucene99FlatVectorsWriter.FieldWriter<T>

All Implemented Interfaces:

Accountable

Enclosing class:

Lucene99FlatVectorsWriter

private abstract static class Lucene99FlatVectorsWriter.FieldWriter<T>
extends FlatFieldVectorsWriter<T>

Field Summary

Fields

Modifier and Type	Field	Description
private final int	dim
private final DocsWithFieldSet	docsWithField
private final FieldInfo	fieldInfo
private boolean	finished
private int	lastDocID
private static final long	SHALLOW_RAM_BYTES_USED
private final List<T>	vectors

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

NULL_ACCOUNTABLE

Constructor Summary

Constructors

Constructor	Description
FieldWriter(FieldInfo fieldInfo)

Method Summary

Modifier and Type	Method	Description
void	addValue(int docID, T vectorValue)	Add new docID with its vector value to the given field for indexing.
(package private) static Lucene99FlatVectorsWriter.FieldWriter<?>	create(FieldInfo fieldInfo)
void	finish()	indicates that this writer is done and no new vectors are allowed to be added
DocsWithFieldSet	getDocsWithFieldSet()
List<T>	getVectors()
boolean	isFinished()
long	ramBytesUsed()	Return the memory usage of this object in bytes.

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

copyValue

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

SHALLOW_RAM_BYTES_USED

private static final long SHALLOW_RAM_BYTES_USED

fieldInfo

private final FieldInfo fieldInfo

dim

private final int dim

docsWithField

private final DocsWithFieldSet docsWithField

vectors

private final List<T> vectors

finished

private boolean finished

lastDocID

private int lastDocID

Constructor Details

FieldWriter

FieldWriter(FieldInfo fieldInfo)

Method Details

create

static Lucene99FlatVectorsWriter.FieldWriter<?> create(FieldInfo fieldInfo)

addValue

public void addValue(int docID,
 T vectorValue)
              throws IOException

Description copied from class: KnnFieldVectorsWriter

Add new docID with its vector value to the given field for indexing. Doc IDs must be added in increasing order.

Specified by:

addValue in class KnnFieldVectorsWriter<T>

Throws:

IOException

ramBytesUsed

public long ramBytesUsed()

Description copied from interface: Accountable

Return the memory usage of this object in bytes. Negative values are illegal.

getVectors

public List<T> getVectors()

Specified by:

getVectors in class FlatFieldVectorsWriter<T>

Returns:

a list of vectors to be written

getDocsWithFieldSet

public DocsWithFieldSet getDocsWithFieldSet()

Specified by:

getDocsWithFieldSet in class FlatFieldVectorsWriter<T>

Returns:

the docsWithFieldSet for the field writer

finish

public void finish()
            throws IOException

Description copied from class: FlatFieldVectorsWriter

indicates that this writer is done and no new vectors are allowed to be added

Specified by:

finish in class FlatFieldVectorsWriter<T>

Throws:

IOException - if an I/O error occurs

isFinished

public boolean isFinished()

Specified by:

isFinished in class FlatFieldVectorsWriter<T>

Returns:

true if the writer is done and no new vectors are allowed to be added