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

Class LuceneBigDecimalFieldCodec

java.lang.Object

org.hibernate.search.backend.lucene.types.codec.impl.AbstractLuceneNumericFieldCodec<BigDecimal,Long>

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

All Implemented Interfaces:

LuceneFieldCodec<BigDecimal>, LuceneStandardFieldCodec<BigDecimal,Long>

public final class LuceneBigDecimalFieldCodec
extends AbstractLuceneNumericFieldCodec<BigDecimal,Long>

Constructor Summary

Constructors

Constructor	Description
LuceneBigDecimalFieldCodec(Indexing indexing, DocValues docValues, Storage storage, BigDecimal indexNullAsValue, int decimalScale)

Method Summary

Modifier and Type	Method	Description
BigDecimal	decode(Long encoded)
BigDecimal	decode(org.apache.lucene.index.IndexableField field)	Extract the value from the given stored field.
Long	encode(BigDecimal value)	Encode the given value.
LuceneNumericDomain<Long>	getDomain()
boolean	isCompatibleWith(LuceneFieldCodec<?> obj)	Determine whether the given codec provides an encoding that is compatible with this codec, i.e.
String	toString()

Methods inherited from class org.hibernate.search.backend.lucene.types.codec.impl.AbstractLuceneNumericFieldCodec

addToDocument

Methods inherited from class java.lang.Object

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

Constructor Detail

LuceneBigDecimalFieldCodec

public LuceneBigDecimalFieldCodec(Indexing indexing,
                                  DocValues docValues,
                                  Storage storage,
                                  BigDecimal indexNullAsValue,
                                  int decimalScale)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

decode

public BigDecimal decode(org.apache.lucene.index.IndexableField field)

Description copied from interface: LuceneFieldCodec

Extract the value from the given stored field.

Typically used in projections.

Parameters:

field - The document field. Never null.

Returns:

The decoded value.

encode

public Long encode(BigDecimal value)

Description copied from interface: LuceneStandardFieldCodec

Encode the given value.

Useful for predicates and sorts in particular.

Parameters:

value - The value to encode.

decode

public BigDecimal decode(Long encoded)

Specified by:

decode in class AbstractLuceneNumericFieldCodec<BigDecimal,Long>

getDomain

public LuceneNumericDomain<Long> getDomain()

Specified by:

getDomain in class AbstractLuceneNumericFieldCodec<BigDecimal,Long>

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<BigDecimal>

Overrides:

isCompatibleWith in class AbstractLuceneNumericFieldCodec<BigDecimal,Long>

Parameters:

obj - Another LuceneFieldCodec, never null.

Returns:

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