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

Class LuceneBigIntegerFieldCodec

java.lang.Object

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

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

All Implemented Interfaces:

LuceneFieldCodec<BigInteger,Long>

public final class LuceneBigIntegerFieldCodec
extends AbstractLuceneNumericFieldCodec<BigInteger,Long>

Constructor Summary

Constructors

Constructor	Description
LuceneBigIntegerFieldCodec(Indexing indexing, DocValues docValues, Storage storage, BigInteger indexNullAsValue, int decimalScale)

Method Summary

Modifier and Type	Method	Description
BigInteger	decode(Long encoded)
BigInteger	decode(org.apache.lucene.index.IndexableField field)	Extract the value from the given stored field.
Long	encode(BigInteger value)	Encode the given value.
Class<Long>	encodedType()
LuceneNumericDomain<Long>	getDomain()
boolean	isCompatibleWith(LuceneFieldCodec<?,?> obj)	Determine whether the given codec provides an encoding that is compatible with this codec, i.e. whether its LuceneFieldCodec.decode(IndexableField) and LuceneFieldCodec.encode(Object) methods behave the same way.
Long	raw(org.apache.lucene.index.IndexableField field)
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 Details

LuceneBigIntegerFieldCodec

public LuceneBigIntegerFieldCodec(Indexing indexing,
 DocValues docValues,
 Storage storage,
 BigInteger indexNullAsValue,
 int decimalScale)

Method Details

toString

public String toString()

Overrides:

toString in class Object

decode

public BigInteger 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.

raw

public Long raw(org.apache.lucene.index.IndexableField field)

encode

public Long encode(BigInteger value)

Description copied from interface: LuceneFieldCodec

Encode the given value.

Useful for predicates and sorts in particular.

Parameters:

value - The value to encode.

decode

public BigInteger decode(Long encoded)

getDomain

public LuceneNumericDomain<Long> getDomain()

Specified by:

getDomain in class AbstractLuceneNumericFieldCodec<BigInteger,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 LuceneFieldCodec.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<BigInteger,Long>

Overrides:

isCompatibleWith in class AbstractLuceneNumericFieldCodec<BigInteger,Long>

Parameters:

obj - Another LuceneFieldCodec, never null.

Returns:

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

encodedType

public Class<Long> encodedType()

Returns:

The type of the encoded value.