org.sormula.translator.standard

Class EnumToStringTranslator<T extends java.lang.Enum<T>>

java.lang.Object

org.sormula.translator.standard.EnumTranslator<T>

org.sormula.translator.standard.EnumToStringTranslator<T>

All Implemented Interfaces:

TypeTranslator<java.lang.Enum<T>>

public class EnumToStringTranslator<T extends java.lang.Enum<T>>
extends EnumTranslator<T>

TypeTranslator to use for Enum fields. Writes Enum (Enum.toString()) to column as a String. Override Enum.toString() to supply a value to store in the database. By default Enum.toString() returns Enum.name().

Column should be a sql type that is compatible with java String (like varchar) and wide enough for the longest value returned by Enum.toString().

This class and subclasses may be used as a TypeTranslator for Enum fields in one of two ways:

• by specifying with ImplicitType.translator() or ExplicitType.translator().
• by specifying in EnumType.translator().

Since:

4.1

Author:

Jeff Miller

Constructor Summary

Constructors

Constructor and Description
EnumToStringTranslator()

Method Summary

Modifier and Type	Method and Description
protected java.lang.Enum<T>	columnToEnum(java.lang.Object columnValue) Converts a table column value to an Enum.
protected java.lang.Object	enumToColumn(java.lang.Enum<T> enumValue) Converts an Enum constant to column value with Enum.toString().
java.util.Map<java.lang.Object,java.lang.Enum<T>>	getColumnEnumMap() Gets the map of Enum's that were built by setEnumClass(Class) for use in converting database values to Enum's in columnToEnum(Object).
void	setEnumClass(java.lang.Class<T> enumClass) Sets the class of Enum to translate.

Methods inherited from class org.sormula.translator.standard.EnumTranslator

getDefaultEnum, getDefaultEnumName, getEnumClass, read, setDefaultEnumName, write

Methods inherited from class java.lang.Object

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

Constructor Detail

EnumToStringTranslator

public EnumToStringTranslator()

Method Detail

setEnumClass

public void setEnumClass(java.lang.Class<T> enumClass)

Sets the class of Enum to translate. This method is typically invoked by RowTranslator to initialize this translator when Table object is initialized that contains an Enum field.

This method also builds a map of Enums where keys are enumToColumn(Enum) for all elements of Class.getEnumConstants(). Map is used by columnToEnum(Object) to convert from column value to Enum.

Overrides:

setEnumClass in class EnumTranslator<T extends java.lang.Enum<T>>

Parameters:

enumClass - Class of Enum to be translated

getColumnEnumMap

public java.util.Map<java.lang.Object,java.lang.Enum<T>> getColumnEnumMap()

Gets the map of Enum's that were built by setEnumClass(Class) for use in converting database values to Enum's in columnToEnum(Object).

Returns:

map of Enum's where key is enumToColumn(Enum)

enumToColumn

protected java.lang.Object enumToColumn(java.lang.Enum<T> enumValue)

Converts an Enum constant to column value with Enum.toString(). Override this method if something other than Enum.toString() should be used for database value of Enum.

Overrides:

enumToColumn in class EnumTranslator<T extends java.lang.Enum<T>>

Parameters:

enumValue - the Enum constant to convert

Returns:

Enum.toString(); null if enumValue is null

columnToEnum

protected java.lang.Enum<T> columnToEnum(java.lang.Object columnValue)

Converts a table column value to an Enum. This method looks up Enum in map that was created by setEnumClass(Class). Key to map is enumToColumn(Enum).

This method may be overridden if desired. It is not likely that you will need to override if you've overridden enumToColumn(Enum).

Overrides:

columnToEnum in class EnumTranslator<T extends java.lang.Enum<T>>

Parameters:

columnValue - value read from table column that stores Enum

Returns:

Enum where enumToColumn(Enum) equals columnValue; null if columnValue is null; EnumTranslator.getDefaultEnum() if columnValue cannot be found in getColumnEnumMap()