com.speedment.runtime.core.db

Interface JavaTypeMap

public interface JavaTypeMap

A convenience class for mapping between column types using a database specific rule set.

Since:

3.0.0

Author:

Emil Forslund

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	JavaTypeMap.Rule A rule that helps defining how the metadata for a column should apply to the java mapping.

Method Summary

Modifier and Type	Method and Description
void	addRule(JavaTypeMap.Rule rule) Adds the specified rule to the rule engine.
static JavaTypeMap	create() Creates a new JavaTypeMap using the default implementation.
Class<?>	findJdbcType(Map<String,Class<?>> sqlTypeMapping, ColumnMetaData metadata) Looks through all the rules that has been installed into this rule engine to try and find one that returns something other than an empty Optional.
Class<?>	get(String key) Returns the mapped type for the particular key.
void	put(String key, Class<?> clazz) Adds a new mapping to this type map.

Method Detail

addRule

void addRule(JavaTypeMap.Rule rule)

Adds the specified rule to the rule engine.

Parameters:

rule - the rule to add

findJdbcType

Class<?> findJdbcType(Map<String,Class<?>> sqlTypeMapping,
                      ColumnMetaData metadata)

Looks through all the rules that has been installed into this rule engine to try and find one that returns something other than an empty Optional. If none is found, the default mapping is returned.

Parameters:

sqlTypeMapping - read-only map of existing mappings

metadata - metadata about the particular column

Returns:

the mapped type to be used

put

void put(String key,
         Class<?> clazz)

Adds a new mapping to this type map. If a previous mapping with the same key exists, it will be overwritten.

A read-only view of the map with installed mappings will be available to the rules upon execution.

Parameters:

key - the key for the particular mapping

clazz - the mapped type

get

Class<?> get(String key)

Returns the mapped type for the particular key.

Parameters:

key - the key to look for

Returns:

the type associated with it or null

create

static JavaTypeMap create()

Creates a new JavaTypeMap using the default implementation.

Returns:

the created JavaTypeMap