Module org.elasticsearch.server

Package org.elasticsearch.script.field.vectors

Class DenseVectorDocValuesField

java.lang.Object

org.elasticsearch.script.field.AbstractScriptFieldFactory<DenseVector>

org.elasticsearch.script.field.vectors.DenseVectorDocValuesField

All Implemented Interfaces:

Iterable<DenseVector>, ScriptDocValues.Supplier<org.apache.lucene.util.BytesRef>, DenseVectorScriptDocValues.DenseVectorSupplier, DocValuesScriptFieldFactory, Field<DenseVector>, ScriptFieldFactory

Direct Known Subclasses:

BinaryDenseVectorDocValuesField, ByteBinaryDenseVectorDocValuesField, ByteKnnDenseVectorDocValuesField, KnnDenseVectorDocValuesField

public abstract class DenseVectorDocValuesField
extends AbstractScriptFieldFactory<DenseVector>
implements Field<DenseVector>, DocValuesScriptFieldFactory, DenseVectorScriptDocValues.DenseVectorSupplier

Field Summary

Fields

Modifier and Type	Field	Description
protected final DenseVectorFieldMapper.ElementType	elementType
protected final String	name

Constructor Summary

Constructors

Constructor	Description
DenseVectorDocValuesField(String name, DenseVectorFieldMapper.ElementType elementType)

Method Summary

Modifier and Type	Method	Description
abstract DenseVector	get()	Get the DenseVector for a document if one exists, DenseVector.EMPTY otherwise
abstract DenseVector	get(DenseVector defaultValue)
DenseVectorFieldMapper.ElementType	getElementType()
String	getName()	Returns the name of this field.
Iterator<DenseVector>	iterator()
int	size()	Returns the number of values this field has.
abstract DenseVectorScriptDocValues	toScriptDocValues()	Returns a ScriptDocValues of the appropriate type for this field.

Methods inherited from class org.elasticsearch.script.field.AbstractScriptFieldFactory

toScriptField

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.index.mapper.vectors.DenseVectorScriptDocValues.DenseVectorSupplier

getInternal, getInternal

Methods inherited from interface org.elasticsearch.script.field.DocValuesScriptFieldFactory

setNextDocId

Methods inherited from interface org.elasticsearch.script.field.Field

isEmpty

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.elasticsearch.index.fielddata.ScriptDocValues.Supplier

setNextDocId

Methods inherited from interface org.elasticsearch.script.field.ScriptFieldFactory

toScriptField

Field Details

name

protected final String name

elementType

protected final DenseVectorFieldMapper.ElementType elementType

Constructor Details

DenseVectorDocValuesField

public DenseVectorDocValuesField(String name,
 DenseVectorFieldMapper.ElementType elementType)

Method Details

getName

public String getName()

Description copied from interface: Field

Returns the name of this field.

Specified by:

getName in interface Field<DenseVector>

getElementType

public DenseVectorFieldMapper.ElementType getElementType()

size

public int size()

Description copied from interface: Field

Returns the number of values this field has.

Specified by:

size in interface Field<DenseVector>

Specified by:

size in interface ScriptDocValues.Supplier<org.apache.lucene.util.BytesRef>

get

public abstract DenseVector get()

Get the DenseVector for a document if one exists, DenseVector.EMPTY otherwise

get

public abstract DenseVector get(DenseVector defaultValue)

toScriptDocValues

public abstract DenseVectorScriptDocValues toScriptDocValues()

Description copied from interface: DocValuesScriptFieldFactory

Returns a ScriptDocValues of the appropriate type for this field. This is used to support backwards compatibility for accessing field values through the doc variable.

Specified by:

toScriptDocValues in interface DocValuesScriptFieldFactory

iterator

public Iterator<DenseVector> iterator()

Specified by:

iterator in interface Iterable<DenseVector>