Package org.hibernate.search.backend.elasticsearch.types.codec.impl

Class AbstractElasticsearchVectorFieldCodec<F>

java.lang.Object

org.hibernate.search.backend.elasticsearch.types.codec.impl.AbstractElasticsearchFieldCodec<F>

org.hibernate.search.backend.elasticsearch.types.codec.impl.AbstractElasticsearchVectorFieldCodec<F>

All Implemented Interfaces:

ElasticsearchFieldCodec<F>, ElasticsearchVectorFieldCodec<F>

Direct Known Subclasses:

ElasticsearchByteVectorFieldCodec, ElasticsearchFloatVectorFieldCodec

public abstract class AbstractElasticsearchVectorFieldCodec<F>
extends AbstractElasticsearchFieldCodec<F>
implements ElasticsearchVectorFieldCodec<F>

Field Summary

Fields

Modifier and Type	Field	Description
protected final int	dimension
protected final VectorSimilarity	similarity

Fields inherited from class org.hibernate.search.backend.elasticsearch.types.codec.impl.AbstractElasticsearchFieldCodec

gson

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractElasticsearchVectorFieldCodec(com.google.gson.Gson gson, VectorSimilarity similarity, int dimension, Integer m, Integer efConstruction, F indexNullAs)

Method Summary

Modifier and Type	Method	Description
boolean	canDecodeArrays()	Whether this codec can extract data from JsonArrays when decoding.
F	decode(com.google.gson.JsonElement element)
com.google.gson.JsonElement	encode(F value)
protected abstract F	fromJsonArray(com.google.gson.JsonArray jsonElements)
int	getConfiguredDimensions()
boolean	isCompatibleWith(ElasticsearchFieldCodec<?> other)	Determine whether another codec is compatible with this one, i.e. whether it will encode/decode the information to/from the document in a compatible way.
protected abstract com.google.gson.JsonArray	toJsonArray(F value)
String	toString()

Methods inherited from class org.hibernate.search.backend.elasticsearch.types.codec.impl.AbstractElasticsearchFieldCodec

fromJsonElementToString, fromJsonStringToElement

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hibernate.search.backend.elasticsearch.types.codec.impl.ElasticsearchFieldCodec

decodeAggregationKey, encodeForAggregation, encodeForMissing, fromJsonElementToString, fromJsonStringToElement

Methods inherited from interface org.hibernate.search.backend.elasticsearch.types.codec.impl.ElasticsearchVectorFieldCodec

scoreToSimilarity, vectorElementsType

Field Details

similarity

protected final VectorSimilarity similarity

dimension

protected final int dimension

Constructor Details

AbstractElasticsearchVectorFieldCodec

protected AbstractElasticsearchVectorFieldCodec(com.google.gson.Gson gson,
 VectorSimilarity similarity,
 int dimension,
 Integer m,
 Integer efConstruction,
 F indexNullAs)

Method Details

encode

public com.google.gson.JsonElement encode(F value)

Specified by:

encode in interface ElasticsearchFieldCodec<F>

toJsonArray

protected abstract com.google.gson.JsonArray toJsonArray(F value)

decode

public F decode(com.google.gson.JsonElement element)

Specified by:

decode in interface ElasticsearchFieldCodec<F>

fromJsonArray

protected abstract F fromJsonArray(com.google.gson.JsonArray jsonElements)

getConfiguredDimensions

public int getConfiguredDimensions()

Specified by:

getConfiguredDimensions in interface ElasticsearchVectorFieldCodec<F>

Returns:

The number of dimensions (array length) of vectors to be indexed that this codec can process.

isCompatibleWith

public boolean isCompatibleWith(ElasticsearchFieldCodec<?> other)

Description copied from interface: ElasticsearchFieldCodec

Determine whether another codec is compatible with this one, i.e. whether it will encode/decode the information to/from the document in a compatible way.

Specified by:

isCompatibleWith in interface ElasticsearchFieldCodec<F>

Parameters:

other - Another ElasticsearchFieldCodec, never null.

Returns:

true if the given codec is compatible. false otherwise, or when in doubt.

canDecodeArrays

public boolean canDecodeArrays()

Description copied from interface: ElasticsearchFieldCodec

Whether this codec can extract data from JsonArrays when decoding.

Specified by:

canDecodeArrays in interface ElasticsearchFieldCodec<F>

toString

public String toString()

Overrides:

toString in class Object