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

Class AbstractElasticsearchJavaTimeFieldCodec<T extends TemporalAccessor>

java.lang.Object

org.hibernate.search.backend.elasticsearch.types.codec.impl.AbstractElasticsearchJavaTimeFieldCodec<T>

All Implemented Interfaces:

ElasticsearchFieldCodec<T>

Direct Known Subclasses:

ElasticsearchInstantFieldCodec, ElasticsearchLocalDateFieldCodec, ElasticsearchLocalDateTimeFieldCodec, ElasticsearchLocalTimeFieldCodec, ElasticsearchMonthDayFieldCodec, ElasticsearchOffsetDateTimeFieldCodec, ElasticsearchOffsetTimeFieldCodec, ElasticsearchYearFieldCodec, ElasticsearchYearMonthFieldCodec, ElasticsearchZonedDateTimeFieldCodec

public abstract class AbstractElasticsearchJavaTimeFieldCodec<T extends TemporalAccessor>
extends Object
implements ElasticsearchFieldCodec<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected DateTimeFormatter	formatter

Constructor Summary

Constructors

Constructor	Description
AbstractElasticsearchJavaTimeFieldCodec(DateTimeFormatter delegate)

Method Summary

Modifier and Type	Method	Description
T	decode(com.google.gson.JsonElement element)
T	decodeAggregationKey(com.google.gson.JsonElement key, com.google.gson.JsonElement keyAsString)	Decodes the key returned by a term aggregation.
com.google.gson.JsonElement	encode(T value)
com.google.gson.JsonElement	encodeForMissing(T value)	A different encoding is required for provided missing Java time values.
boolean	isCompatibleWith(ElasticsearchFieldCodec<?> obj)	Determine whether another codec is compatible with this one, i.e.
protected String	nullUnsafeFormat(T value)
protected abstract T	nullUnsafeParse(String stringValue)
protected abstract Long	nullUnsafeScalar(T value)

Methods inherited from class java.lang.Object

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

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

encodeForAggregation

Field Detail

formatter

protected final DateTimeFormatter formatter

Constructor Detail

AbstractElasticsearchJavaTimeFieldCodec

public AbstractElasticsearchJavaTimeFieldCodec(DateTimeFormatter delegate)

Method Detail

encode

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

Specified by:

encode in interface ElasticsearchFieldCodec<T extends TemporalAccessor>

encodeForMissing

public com.google.gson.JsonElement encodeForMissing(T value)

A different encoding is required for provided missing Java time values. See HSEARCH-3255.

Specified by:

encodeForMissing in interface ElasticsearchFieldCodec<T extends TemporalAccessor>

Parameters:

value - to encode

Returns:

a JsonElement containing the long scalar value, if value is not null.

decode

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

Specified by:

decode in interface ElasticsearchFieldCodec<T extends TemporalAccessor>

decodeAggregationKey

public T decodeAggregationKey(com.google.gson.JsonElement key,
                              com.google.gson.JsonElement keyAsString)

Description copied from interface: ElasticsearchFieldCodec

Decodes the key returned by a term aggregation.

Specified by:

decodeAggregationKey in interface ElasticsearchFieldCodec<T extends TemporalAccessor>

Parameters:

key - The "key" property returned by the aggregation. May be a number, a string, ... depending on the field type.

keyAsString - The "key_as_string" property returned by the term aggregation. Either null or a JsonPrimitive containing a string.

Returns:

The decoded term.

isCompatibleWith

public boolean isCompatibleWith(ElasticsearchFieldCodec<?> obj)

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<T extends TemporalAccessor>

Parameters:

obj - Another ElasticsearchFieldCodec, never null.

Returns:

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

nullUnsafeFormat

protected String nullUnsafeFormat(T value)

nullUnsafeParse

protected abstract T nullUnsafeParse(String stringValue)

nullUnsafeScalar

protected abstract Long nullUnsafeScalar(T value)