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

Class AbstractLuceneNumericFieldCodec<F,E extends Number>

java.lang.Object

org.hibernate.search.backend.lucene.types.codec.impl.AbstractLuceneNumericFieldCodec<F,E>

All Implemented Interfaces:

LuceneFieldCodec<F>, LuceneStandardFieldCodec<F,E>

Direct Known Subclasses:

LuceneBigDecimalFieldCodec, LuceneBigIntegerFieldCodec, LuceneBooleanFieldCodec, LuceneByteFieldCodec, LuceneDoubleFieldCodec, LuceneFloatFieldCodec, LuceneInstantFieldCodec, LuceneIntegerFieldCodec, LuceneLocalDateFieldCodec, LuceneLocalDateTimeFieldCodec, LuceneLocalTimeFieldCodec, LuceneLongFieldCodec, LuceneMonthDayFieldCodec, LuceneOffsetDateTimeFieldCodec, LuceneOffsetTimeFieldCodec, LuceneShortFieldCodec, LuceneYearFieldCodec, LuceneYearMonthFieldCodec, LuceneZonedDateTimeFieldCodec

public abstract class AbstractLuceneNumericFieldCodec<F,E extends Number>
extends Object
implements LuceneStandardFieldCodec<F,E>

Constructor Summary

Constructors

Constructor	Description
AbstractLuceneNumericFieldCodec(Indexing indexing, DocValues docValues, Storage storage, F indexNullAsValue)

Method Summary

Modifier and Type	Method	Description
void	addToDocument(LuceneDocumentContent documentBuilder, String absoluteFieldPath, F value)	Encode the given value in the document by adding new fields to the Lucene document.
abstract F	decode(E encoded)
abstract LuceneNumericDomain<E>	getDomain()
boolean	isCompatibleWith(LuceneFieldCodec<?> obj)	Determine whether the given codec provides an encoding that is compatible with this codec, i.e.

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.lucene.types.codec.impl.LuceneFieldCodec

decode

Methods inherited from interface org.hibernate.search.backend.lucene.types.codec.impl.LuceneStandardFieldCodec

encode

Constructor Detail

AbstractLuceneNumericFieldCodec

public AbstractLuceneNumericFieldCodec(Indexing indexing,
                                       DocValues docValues,
                                       Storage storage,
                                       F indexNullAsValue)

Method Detail

addToDocument

public final void addToDocument(LuceneDocumentContent documentBuilder,
                                String absoluteFieldPath,
                                F value)

Description copied from interface: LuceneFieldCodec

Encode the given value in the document by adding new fields to the Lucene document.

Specified by:

addToDocument in interface LuceneFieldCodec<F>

Parameters:

documentBuilder - The document builder.

absoluteFieldPath - The absolute path of the field.

value - The value to encode.

isCompatibleWith

public boolean isCompatibleWith(LuceneFieldCodec<?> obj)

Description copied from interface: LuceneFieldCodec

Determine whether the given codec provides an encoding that is compatible with this codec, i.e. whether its LuceneFieldCodec.decode(IndexableField) and LuceneStandardFieldCodec.encode(Object) methods behave the same way.

NOTE: LuceneFieldCodec.addToDocument(LuceneDocumentContent, String, Object) may behave differently, e.g. it may add docvalues while this codec does not. The behavior of LuceneFieldCodec.addToDocument(LuceneDocumentContent, String, Object) is considered irrelevant when checking the equivalence of encoding, because such differences should be accounted for through other ways (fields being assigned incompatible predicate factories, etc.).

Specified by:

isCompatibleWith in interface LuceneFieldCodec<F>

Parameters:

obj - Another LuceneFieldCodec, never null.

Returns:

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

decode

public abstract F decode(E encoded)

getDomain

public abstract LuceneNumericDomain<E> getDomain()