Class LuceneFieldFieldCodec<F>
- java.lang.Object
-
- org.hibernate.search.backend.lucene.types.codec.impl.LuceneFieldFieldCodec<F>
-
- All Implemented Interfaces:
LuceneFieldCodec<F>
public final class LuceneFieldFieldCodec<F> extends Object implements LuceneFieldCodec<F>
-
-
Constructor Summary
Constructors Constructor Description LuceneFieldFieldCodec(LuceneFieldContributor<F> fieldContributor, LuceneFieldValueExtractor<F> fieldValueExtractor)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddToDocument(LuceneDocumentContent documentBuilder, String absoluteFieldPath, F value)Encode the given value in the document by adding new fields to the Lucene document.Fdecode(org.apache.lucene.index.IndexableField field)Extract the value from the given stored field.booleanisCompatibleWith(LuceneFieldCodec<?> obj)Determine whether the given codec provides an encoding that is compatible with this codec, i.e.
-
-
-
Constructor Detail
-
LuceneFieldFieldCodec
public LuceneFieldFieldCodec(LuceneFieldContributor<F> fieldContributor, LuceneFieldValueExtractor<F> fieldValueExtractor)
-
-
Method Detail
-
addToDocument
public void addToDocument(LuceneDocumentContent documentBuilder, String absoluteFieldPath, F value)
Description copied from interface:LuceneFieldCodecEncode the given value in the document by adding new fields to the Lucene document.- Specified by:
addToDocumentin interfaceLuceneFieldCodec<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:LuceneFieldCodecExtract the value from the given stored field.Typically used in projections.
- Specified by:
decodein interfaceLuceneFieldCodec<F>- Parameters:
field- The document field. Nevernull.- Returns:
- The decoded value.
-
isCompatibleWith
public boolean isCompatibleWith(LuceneFieldCodec<?> obj)
Description copied from interface:LuceneFieldCodecDetermine whether the given codec provides an encoding that is compatible with this codec, i.e. whether itsLuceneFieldCodec.decode(IndexableField)andLuceneStandardFieldCodec.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 ofLuceneFieldCodec.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:
isCompatibleWithin interfaceLuceneFieldCodec<F>- Parameters:
obj- AnotherLuceneFieldCodec, nevernull.- Returns:
trueif the given codec is compatible.falseotherwise, or when in doubt.
-
-