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

Class LuceneStringFieldCodec

java.lang.Object

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

All Implemented Interfaces:

LuceneFieldCodec<String>, LuceneStandardFieldCodec<String,String>

public final class LuceneStringFieldCodec
extends Object
implements LuceneStandardFieldCodec<String,String>

Constructor Summary

Constructors

Constructor	Description
LuceneStringFieldCodec(org.apache.lucene.document.FieldType mainFieldType, DocValues docValues, String indexNullAsValue, org.apache.lucene.analysis.Analyzer analyzerOrNormalizer)

Method Summary

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

Constructor Detail

LuceneStringFieldCodec

public LuceneStringFieldCodec(org.apache.lucene.document.FieldType mainFieldType,
                              DocValues docValues,
                              String indexNullAsValue,
                              org.apache.lucene.analysis.Analyzer analyzerOrNormalizer)

Method Detail

addToDocument

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

Parameters:

documentBuilder - The document builder.

absoluteFieldPath - The absolute path of the field.

value - The value to encode.

decode

public String 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<String>

Parameters:

field - The document field. Never null.

Returns:

The decoded 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 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<String>

Parameters:

obj - Another LuceneFieldCodec, never null.

Returns:

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

encode

public String encode(String value)

Description copied from interface: LuceneStandardFieldCodec

Encode the given value.

Useful for predicates and sorts in particular.

Specified by:

encode in interface LuceneStandardFieldCodec<String,String>

Parameters:

value - The value to encode.