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

Class ProjectionConverter<F,V>

java.lang.Object

org.hibernate.search.engine.backend.types.converter.spi.ProjectionConverter<F,V>

Type Parameters:

F - The type of source values obtained from the backend.

V - The type of projected values.

public final class ProjectionConverter<F,V>
extends Object

A converter from a value obtained from the backend to a projected value.

Constructor Summary

Constructors

Constructor and Description
ProjectionConverter(Class<V> valueType, FromDocumentFieldValueConverter<F,V> delegate)

Method Summary

Modifier and Type	Method and Description
V	convert(F value, FromDocumentFieldValueConvertContext context)
boolean	isCompatibleWith(ProjectionConverter<?,?> other)
boolean	isConvertedTypeAssignableTo(Class<?> superTypeCandidate) Check whether converted values can be assigned to the given type.
String	toString()
Class<V>	valueType()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ProjectionConverter

public ProjectionConverter(Class<V> valueType,
                           FromDocumentFieldValueConverter<F,V> delegate)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

valueType

public Class<V> valueType()

isConvertedTypeAssignableTo

public boolean isConvertedTypeAssignableTo(Class<?> superTypeCandidate)

Check whether converted values can be assigned to the given type.

Parameters:

superTypeCandidate - A candidate type for assignment of converted values.

Returns:

true if the converted type V is a subtype of superTypeCandidate, false otherwise.

convert

public V convert(F value,
                 FromDocumentFieldValueConvertContext context)

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

public boolean isCompatibleWith(ProjectionConverter<?,?> other)

Parameters:

other - Another DslConverter, never null.

Returns:

true if the given object behaves exactly the same as this object, i.e. its isConvertedTypeAssignableTo(Class) and convert(Object, FromDocumentFieldValueConvertContext) methods are guaranteed to always return the same value as this object's when given the same input. false otherwise, or when in doubt.