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
,PerFieldKnnVectorsFormat
,SimpleTextKnnVectorsFormat
public abstract class KnnVectorsFormat extends java.lang.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 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 KnnVectorsFormat
EMPTY
EMPTY throws an exception when written.private java.lang.String
name
-
Constructor Summary
Constructors Modifier Constructor Description protected
KnnVectorsFormat(java.lang.String name)
Sole constructor
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract KnnVectorsReader
fieldsReader(SegmentReadState state)
Returns aKnnVectorsReader
to read the vectors from the index.abstract KnnVectorsWriter
fieldsWriter(SegmentWriteState state)
Returns aKnnVectorsWriter
to write the vectors to the index.static KnnVectorsFormat
forName(java.lang.String name)
looks up a format by namejava.lang.String
getName()
-
-
-
Field Detail
-
name
private final java.lang.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.
-
-
Method Detail
-
getName
public java.lang.String getName()
- Specified by:
getName
in interfaceNamedSPILoader.NamedSPI
-
forName
public static KnnVectorsFormat forName(java.lang.String name)
looks up a format by name
-
fieldsWriter
public abstract KnnVectorsWriter fieldsWriter(SegmentWriteState state) throws java.io.IOException
Returns aKnnVectorsWriter
to write the vectors to the index.- Throws:
java.io.IOException
-
fieldsReader
public abstract KnnVectorsReader fieldsReader(SegmentReadState state) throws java.io.IOException
Returns aKnnVectorsReader
to read the vectors from the index.- Throws:
java.io.IOException
-
-