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

Class LuceneGeoPointFieldCodec

java.lang.Object

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

All Implemented Interfaces:

LuceneFieldCodec<GeoPoint,byte[]>

public final class LuceneGeoPointFieldCodec
extends Object
implements LuceneFieldCodec<GeoPoint,byte[]>

Constructor Summary

Constructors

Constructor	Description
LuceneGeoPointFieldCodec(Indexing indexing, DocValues docValues, Storage storage, GeoPoint indexNullAsValue)

Method Summary

Modifier and Type	Method	Description
void	addToDocument(LuceneDocumentContent documentBuilder, String absoluteFieldPath, GeoPoint value)	Encode the given value in the document by adding new fields to the Lucene document.
GeoPoint	decode(byte[] field)
GeoPoint	decode(org.apache.lucene.index.IndexableField field)	Extract the value from the given stored field.
byte[]	encode(GeoPoint value)	Encode the given value.
Class<byte[]>	encodedType()
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.
byte[]	raw(org.apache.lucene.index.IndexableField field)

Methods inherited from class java.lang.Object

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

Constructor Details

LuceneGeoPointFieldCodec

public LuceneGeoPointFieldCodec(Indexing indexing,
 DocValues docValues,
 Storage storage,
 GeoPoint indexNullAsValue)

Method Details

addToDocument

public void addToDocument(LuceneDocumentContent documentBuilder,
 String absoluteFieldPath,
 GeoPoint 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<GeoPoint,byte[]>

Parameters:

documentBuilder - The document builder.

absoluteFieldPath - The absolute path of the field.

value - The value to encode.

decode

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

Description copied from interface: LuceneFieldCodec

Extract the value from the given stored field.

Typically used in projections.

Specified by:

decode in interface LuceneFieldCodec<GeoPoint,byte[]>

Parameters:

field - The document field. Never null.

Returns:

The decoded value.

raw

public byte[] raw(org.apache.lucene.index.IndexableField field)

Specified by:

raw in interface LuceneFieldCodec<GeoPoint,byte[]>

decode

public GeoPoint decode(byte[] field)

Specified by:

decode in interface LuceneFieldCodec<GeoPoint,byte[]>

encode

public byte[] encode(GeoPoint value)

Description copied from interface: LuceneFieldCodec

Encode the given value.

Useful for predicates and sorts in particular.

Specified by:

encode in interface LuceneFieldCodec<GeoPoint,byte[]>

Parameters:

value - The value to encode.

encodedType

public Class<byte[]> encodedType()

Specified by:

encodedType in interface LuceneFieldCodec<GeoPoint,byte[]>

Returns:

The type of the encoded value.

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<GeoPoint,byte[]>

Parameters:

obj - Another LuceneFieldCodec, never null.

Returns:

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