org.hibernate.search.engine.backend.types.converter

Interface ToDocumentFieldValueConverter<V,F>

Type Parameters:

V - The type of source values.

F - The type of target, index field values.

All Known Implementing Classes:

PassThroughToDocumentFieldValueConverter

public interface ToDocumentFieldValueConverter<V,F>

A converter from a source value to a target value that should be indexed.

Method Summary

Modifier and Type	Method and Description
F	convert(V value, ToDocumentFieldValueConvertContext context)
default boolean	isCompatibleWith(ToDocumentFieldValueConverter<?,?> other)

Method Detail

convert

F convert(V value,
          ToDocumentFieldValueConvertContext context)

Parameters:

value - The source value to convert.

context - A context that can be extended to a more useful type, giving access to such things as a Hibernate ORM SessionFactory (if using the Hibernate ORM mapper).

Returns:

The converted index field value.

isCompatibleWith

default boolean isCompatibleWith(ToDocumentFieldValueConverter<?,?> other)

Parameters:

other - Another ToDocumentFieldValueConverter, never null.

Returns:

true if the given object behaves exactly the same as this object, i.e. its convert(Object, ToDocumentFieldValueConvertContext) method is guaranteed to always return the same value as this object's when given the same input. false otherwise, or when in doubt.