com.speedment.runtime.typemapper

Interface TypeMapper<DB_TYPE,JAVA_TYPE>

Type Parameters:

DB_TYPE - the type as it is represented in the JDBC driver

JAVA_TYPE - the type as it should be represented in generated code

All Known Implementing Classes:

BigDecimalToDouble, BinaryToUuidMapper, BlobToByteArrayMapper, ClobToStringMapper, DateToIntMapper, DateToLocalDateMapper, DateToLongMapper, DoubleToFloatMapper, IntegerToByteMapper, IntegerToShortMapper, IntegerZeroOneToBooleanMapper, LongToByteMapper, LongToIntegerMapper, LongToShortMapper, PrimitiveDoubleToFloatMapper, PrimitiveIntegerToByteMapper, PrimitiveIntegerToShortMapper, PrimitiveIntegerZeroOneToBooleanMapper, PrimitiveLongToByteMapper, PrimitiveLongToIntegerMapper, PrimitiveLongToShortMapper, PrimitiveShortToByteMapper, PrimitiveTypeMapper, ShortToByteMapper, StringToLocaleMapper, TimestampToIntMapper, TimestampToLocalDateTimeMapper, TimestampToLongMapper, TimeToIntMapper, TimeToLocalTimeMapper, TimeToLongMapper, TrueFalseStringToBooleanMapper, YesNoStringToBooleanMapper

public interface TypeMapper<DB_TYPE,JAVA_TYPE>

A type mapper contains logic for converting between the database and the java type for a field. Implementations of this class should be installed in the TypeMapperComponent.

Since:

2.2.0

Author:

Emil Forslund

Field Summary

Fields

Modifier and Type	Field and Description
static Comparator<TypeMapper<?,?>>	COMPARATOR The standard comparator to use for instances of the TypeMapper interface.

Method Summary

Modifier and Type	Method and Description
Type	getJavaType(Column column) Returns a type describing the resulting java type when this mapper is applied to a database result.
String	getLabel() Returns the label for this mapper that should appear to the end user.
static <T> TypeMapper<T,T>	identity() Returns an identity type mapper.
static <T> TypeMapper<T,T>	primitive() Returns an primitive type mapper.
DB_TYPE	toDatabaseType(JAVA_TYPE value) Converts a value from the java domain to the database domain.
JAVA_TYPE	toJavaType(Column column, Class<?> entityType, DB_TYPE value) Converts a value from the database domain to the java domain.

Field Detail

COMPARATOR

static final Comparator<TypeMapper<?,?>> COMPARATOR

The standard comparator to use for instances of the TypeMapper interface. This comparator will use the name of the database type as comparison index and if two mappers share the same database type, it will use the label in alphabetical order.

Method Detail

getLabel

String getLabel()

Returns the label for this mapper that should appear to the end user.

Returns:

the label

getJavaType

Type getJavaType(Column column)

Returns a type describing the resulting java type when this mapper is applied to a database result.

Parameters:

column - the column that is being mapped

Returns:

the resulting java type

toJavaType

JAVA_TYPE toJavaType(Column column,
                     Class<?> entityType,
                     DB_TYPE value)

Converts a value from the database domain to the java domain.

Parameters:

column - the column that is being mapped

entityType - the entity type that the mapping is for

value - the value to convert

Returns:

the converted value

toDatabaseType

DB_TYPE toDatabaseType(JAVA_TYPE value)

Converts a value from the java domain to the database domain.

Parameters:

value - the value to convert

Returns:

the converted value

identity

static <T> TypeMapper<T,T> identity()

Returns an identity type mapper.

Type Parameters:

T - the type of the identity type mapper

Returns:

an identity type mapper

primitive

static <T> TypeMapper<T,T> primitive()

Returns an primitive type mapper.

Type Parameters:

T - the wrapper type of the primitive type mapper

Returns:

an primitive type mapper