com.speedment.config.db.mapper

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:

AbstractIdentityMapper, ArrayIdentityMapper, BigDecimalIdentityMapper, BigDecimalToDouble, BlobIdentityMapper, BooleanIdentityMapper, ByteIdentityMapper, ClobIdentityMapper, ClobToStringMapper, DateIdentityMapper, DateToIntMapper, DateToLongMapper, DoubleIdentityMapper, FloatIdentityMapper, IntegerIdentityMapper, IntegerZeroOneToBooleanMapper, LongIdentityMapper, NClobIdentityMapper, ObjectIdentityMapper, RefIdentityMapper, RowIdIdentityMapper, ShortIdentityMapper, SQLXMLIdentityMapper, StringIdentityMapper, StringToLocaleMapper, TimeIdentityMapper, TimestampIdentityMapper, TimestampToIntMapper, TimestampToLongMapper, TimeToIntMapper, TimeToLongMapper, TrueFalseStringToBooleanMapper, URLIdentityMapper, UUIDIdentityMapper, 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

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
Class<DB_TYPE>	getDatabaseType() Returns the type as it is represented in the JDBC driver.
Class<JAVA_TYPE>	getJavaType() Returns the type as it should be represented in generated code.
default String	getLabel() Returns the label for this mapper that should appear to the end user.
default boolean	isApproximation() Returns if this mapper may use an approximation when converting from one form to the other.
boolean	isIdentityMapper() Returns if this is an identity mapper.
DB_TYPE	toDatabaseType(JAVA_TYPE value) Converts a value from the java domain to the database domain.
JAVA_TYPE	toJavaType(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

default String getLabel()

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

Returns:

the label

getJavaType

Class<JAVA_TYPE> getJavaType()

Returns the type as it should be represented in generated code.

Returns:

the type

getDatabaseType

Class<DB_TYPE> getDatabaseType()

Returns the type as it is represented in the JDBC driver.

Returns:

the type

toJavaType

JAVA_TYPE toJavaType(DB_TYPE value)

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

Parameters:

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

isIdentityMapper

boolean isIdentityMapper()

Returns if this is an identity mapper. An identity mapper is a one-to-one mapper between the JDBC and the generated code type. For example, a String to String is an indentity mapper.

Returns:

true if identity mapper, else false

isApproximation

default boolean isApproximation()

Returns if this mapper may use an approximation when converting from one form to the other.

Returns:

if this mapper may use an approximation when converting from one form to the other