Module org.apache.lucene.core

Package org.apache.lucene.codecs

Class KnnVectorsFormat

java.lang.Object

org.apache.lucene.codecs.KnnVectorsFormat

All Implemented Interfaces:

NamedSPILoader.NamedSPI

Direct Known Subclasses:

Lucene90HnswVectorsFormat, Lucene91HnswVectorsFormat, Lucene92HnswVectorsFormat, Lucene94HnswVectorsFormat, Lucene95HnswVectorsFormat, PerFieldKnnVectorsFormat, SimpleTextKnnVectorsFormat

public abstract class KnnVectorsFormat
extends Object
implements NamedSPILoader.NamedSPI

Encodes/decodes per-document vector and any associated indexing structures required to support nearest-neighbor search

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	KnnVectorsFormat.Holder	This static holder class prevents classloading deadlock by delaying init of doc values formats until needed.

Field Summary

Fields

Modifier and Type	Field	Description
static final KnnVectorsFormat	EMPTY	EMPTY throws an exception when written.
private final String	name

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	KnnVectorsFormat(String name)	Sole constructor

Method Summary

Modifier and Type	Method	Description
abstract KnnVectorsReader	fieldsReader(SegmentReadState state)	Returns a KnnVectorsReader to read the vectors from the index.
abstract KnnVectorsWriter	fieldsWriter(SegmentWriteState state)	Returns a KnnVectorsWriter to write the vectors to the index.
static KnnVectorsFormat	forName(String name)	looks up a format by name
String	getName()

Methods inherited from class java.lang.Object

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

Field Details

name

private final String name

EMPTY

public static final KnnVectorsFormat EMPTY

EMPTY throws an exception when written. It acts as a sentinel indicating a Codec that does not support vectors.

Constructor Details

KnnVectorsFormat

protected KnnVectorsFormat(String name)

Sole constructor

Method Details

getName

public String getName()

Specified by:

getName in interface NamedSPILoader.NamedSPI

forName

public static KnnVectorsFormat forName(String name)

looks up a format by name

fieldsWriter

public abstract KnnVectorsWriter fieldsWriter(SegmentWriteState state)
                                       throws IOException

Returns a KnnVectorsWriter to write the vectors to the index.

Throws:

IOException

fieldsReader

public abstract KnnVectorsReader fieldsReader(SegmentReadState state)
                                       throws IOException

Returns a KnnVectorsReader to read the vectors from the index.

Throws:

IOException