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

Class LuceneFieldFieldCodec<F>

java.lang.Object

org.hibernate.search.backend.lucene.types.codec.impl.LuceneFieldFieldCodec<F>

All Implemented Interfaces:

LuceneFieldCodec<F,F>

public final class LuceneFieldFieldCodec<F>
extends Object
implements LuceneFieldCodec<F,F>

Constructor Summary

Constructors

Constructor	Description
LuceneFieldFieldCodec(Class<F> valueClass, LuceneFieldContributor<F> fieldContributor, LuceneFieldValueExtractor<F> fieldValueExtractor)

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.
F	decode(F field)
F	decode(org.apache.lucene.index.IndexableField field)	Extract the value from the given stored field.
F	encode(F value)	Encode the given value.
Class<F>	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.
F	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

LuceneFieldFieldCodec

public LuceneFieldFieldCodec(Class<F> valueClass,
 LuceneFieldContributor<F> fieldContributor,
 LuceneFieldValueExtractor<F> fieldValueExtractor)

Method Details

addToDocument

public 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,F>

Parameters:

documentBuilder - The document builder.

absoluteFieldPath - The absolute path of the field.

value - The value to encode.

decode

public F 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<F,F>

Parameters:

field - The document field. Never null.

Returns:

The decoded value.

raw

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

Specified by:

raw in interface LuceneFieldCodec<F,F>

decode

public F decode(F field)

Specified by:

decode in interface LuceneFieldCodec<F,F>

encode

public F encode(F value)

Description copied from interface: LuceneFieldCodec

Encode the given value.

Useful for predicates and sorts in particular.

Specified by:

encode in interface LuceneFieldCodec<F,F>

Parameters:

value - The value to encode.

encodedType

public Class<F> encodedType()

Specified by:

encodedType in interface LuceneFieldCodec<F,F>

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<F,F>

Parameters:

obj - Another LuceneFieldCodec, never null.

Returns:

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