com.avaje.ebeaninternal.server.type

Class EnumToDbValueMap<T>

java.lang.Object

com.avaje.ebeaninternal.server.type.EnumToDbValueMap<T>

Direct Known Subclasses:

EnumToDbIntegerMap, EnumToDbStringMap

public abstract class EnumToDbValueMap<T>
extends Object

Used to map Bean values to DB values.

Useful for building Enum converters where you want to map the DB values an Enum gets converter to.

Constructor Summary

Constructors

Constructor and Description
EnumToDbValueMap() Construct with allowNulls defaulting to false.
EnumToDbValueMap(boolean allowNulls, boolean isIntegerType) Construct with allowNulls setting.

Method Summary

Methods

Modifier and Type	Method and Description
abstract EnumToDbValueMap<T>	add(Object beanValue, String dbValue) Add name value pair where the dbValue is the raw string and may need to be converted (to an Integer for example).
protected void	addInternal(Object beanValue, T dbValue) Add a bean value and DB value pair.
Iterator<Object>	beanValues() Return the bean 'key' value.
abstract void	bind(DataBind b, Object value) Bind using the correct database type.
static EnumToDbValueMap<?>	create(boolean integerType)
Iterator<T>	dbValues() Return the DB values.
Object	getBeanValue(T dbValue) Return the Bean value given the DB value.
abstract int	getDbType() Return the database type.
T	getDbValue(Object beanValue) Return the DB value given the bean value.
boolean	isIntegerType() Return true if this is mapping to integers, false if mapping to Strings.
abstract Object	read(DataReader dataReader) Read using the correct database type.

Methods inherited from class java.lang.Object

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

Constructor Detail

EnumToDbValueMap

public EnumToDbValueMap()

Construct with allowNulls defaulting to false.

EnumToDbValueMap

public EnumToDbValueMap(boolean allowNulls,
                boolean isIntegerType)

Construct with allowNulls setting.

If allowNulls is false then an IllegalArgumentException is thrown by either the getDBValue or getBeanValue methods if not matching Bean or DB value is found.

Method Detail

create

public static EnumToDbValueMap<?> create(boolean integerType)

isIntegerType

public boolean isIntegerType()

Return true if this is mapping to integers, false if mapping to Strings.

dbValues

public Iterator<T> dbValues()

Return the DB values.

beanValues

public Iterator<Object> beanValues()

Return the bean 'key' value.

bind

public abstract void bind(DataBind b,
        Object value)
                   throws SQLException

Bind using the correct database type.

Throws:

SQLException

read

public abstract Object read(DataReader dataReader)
                     throws SQLException

Read using the correct database type.

Throws:

SQLException

getDbType

public abstract int getDbType()

Return the database type.

add

public abstract EnumToDbValueMap<T> add(Object beanValue,
                      String dbValue)

Add name value pair where the dbValue is the raw string and may need to be converted (to an Integer for example).

addInternal

protected void addInternal(Object beanValue,
               T dbValue)

Add a bean value and DB value pair.

The dbValue will be converted to an Integer if isIntegerType is true;

getDbValue

public T getDbValue(Object beanValue)

Return the DB value given the bean value.

getBeanValue

public Object getBeanValue(T dbValue)

Return the Bean value given the DB value.