Package 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	Description
ProjectionConverter(Class<V> valueType, FromDocumentValueConverter<? super F,V> delegate)

Method Summary

Modifier and Type	Method	Description
V	fromDocumentValue(F value, FromDocumentValueConvertContext context)
boolean	isCompatibleWith(ProjectionConverter<?,?> other)
static <F> ProjectionConverter<F,F>	passThrough(Class<F> fieldAndValueType)
String	toString()
Class<V>	valueType()
<T> ProjectionConverter<F,? extends T>	withConvertedType(Class<T> expectedType, EventContextProvider eventContextProvider)	Check whether projected values can be assigned to the given type, and returns the projection converter with an appropriate type.

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,
                           FromDocumentValueConverter<? super F,V> delegate)

Method Detail

passThrough

public static <F> ProjectionConverter<F,F> passThrough(Class<F> fieldAndValueType)

toString

public String toString()

Overrides:

toString in class Object

valueType

public Class<V> valueType()

fromDocumentValue

public V fromDocumentValue(F value,
                           FromDocumentValueConvertContext 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.

withConvertedType

public <T> ProjectionConverter<F,? extends T> withConvertedType(Class<T> expectedType,
                                                                      EventContextProvider eventContextProvider)

Check whether projected values can be assigned to the given type, and returns the projection converter with an appropriate type.

Type Parameters:

T - A candidate type for assignment of converted values.

Parameters:

expectedType - A candidate type for assignment of converted values.

eventContextProvider - A provider for the event context to pass to produced exceptions.

Returns:

The projection converter, guaranteed to convert values to the given type.

Throws:

SearchException - If the projection converter cannot convert values to the given type.

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 withConvertedType(Class, EventContextProvider) and fromDocumentValue(Object, FromDocumentValueConvertContext) methods are guaranteed to always return the same value as this object's when given the same input. false otherwise, or when in doubt.