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

Interface FromDocumentFieldValueConverter<F,V>

Type Parameters:

F - The type of source, index field values.

V - The type of target values.

All Superinterfaces:

FromDocumentValueConverter<F,V>

@Deprecated(since="6.1")
public interface FromDocumentFieldValueConverter<F,V>
extends FromDocumentValueConverter<F,V>

Deprecated.

Implement FromDocumentValueConverter instead.

A converter from a source index field value to a different value.

Method Summary

Modifier and Type	Method	Description
V	convert(F value, FromDocumentFieldValueConvertContext context)	Deprecated.
default V	fromDocumentValue(F value, FromDocumentValueConvertContext context)	Deprecated.
default boolean	isCompatibleWith(FromDocumentFieldValueConverter<?,?> other)	Deprecated.
default boolean	isCompatibleWith(FromDocumentValueConverter<?,?> other)	Deprecated.

Method Details

fromDocumentValue

default V fromDocumentValue(F value,
 FromDocumentValueConvertContext context)

Deprecated.

Specified by:

fromDocumentValue in interface FromDocumentValueConverter<F,V>

Parameters:

value - The value to convert from the document model.

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

Returns:

The converted value.

isCompatibleWith

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

Deprecated.

Specified by:

isCompatibleWith in interface FromDocumentValueConverter<F,V>

Parameters:

other - Another FromDocumentValueConverter, never null.

Returns:

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

convert

V convert(F value,
 FromDocumentFieldValueConvertContext context)

Deprecated.

Parameters:

value - The index field value to convert.

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

Returns:

The converted value.

isCompatibleWith

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

Deprecated.

Parameters:

other - Another ToDocumentFieldValueConverter, never null.

Returns:

true if the given object behaves exactly the same as this object, i.e. its convert(Object, org.hibernate.search.engine.backend.types.converter.runtime.FromDocumentFieldValueConvertContext) method is guaranteed to always return the same value as this object's when given the same input. false otherwise, or when in doubt.