Class EnumValueHandler
java.lang.Object
org.apache.openjpa.jdbc.meta.strats.AbstractValueHandler
org.apache.openjpa.jdbc.meta.strats.EnumValueHandler
- All Implemented Interfaces:
Serializable, ValueHandler
Value handler for JDK1.5 enum field types.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanWhether to store the enum value as its ordinal.booleanWhether to use the @EnumeratedValue annotated field for DB mapping.static booleanhasEnumeratedValue(Class<?> enumType) Check if the given enum type has a field annotated with @EnumeratedValue.booleanReturn whether the values managed by this handler can be used in state image versioning.Column[]map(ValueMapping vm, String name, ColumnIO io, boolean adapt) Deprecated.Column[]map(ValueMapping vm, DBIdentifier name, ColumnIO io, boolean adapt) voidsetStoreOrdinal(boolean ordinal) Whether to store the enum value as its ordinal.voidsetUseEnumeratedValue(boolean useEnumeratedValue) Whether to use the @EnumeratedValue annotated field for DB mapping.static StringReturn the value handler strategy to use for the given enum type.toDataStoreValue(ValueMapping vm, Object val, JDBCStore store) Translate the given value to its datastore equivalent.toObjectValue(ValueMapping vm, Object val) Translate the given datastore value into its Java equivalent.Methods inherited from class AbstractValueHandler
getResultArgument, objectValueRequiresLoad, toObjectValue
-
Constructor Details
-
EnumValueHandler
public EnumValueHandler()
-
-
Method Details
-
getStoreOrdinal
public boolean getStoreOrdinal()Whether to store the enum value as its ordinal. -
setStoreOrdinal
public void setStoreOrdinal(boolean ordinal) Whether to store the enum value as its ordinal. -
getUseEnumeratedValue
public boolean getUseEnumeratedValue()Whether to use the @EnumeratedValue annotated field for DB mapping. -
setUseEnumeratedValue
public void setUseEnumeratedValue(boolean useEnumeratedValue) Whether to use the @EnumeratedValue annotated field for DB mapping. -
map
Deprecated.Description copied from interface:ValueHandlerMap the given value and return all mapped columns, or simply return an array of unmapped default columns. The columns should have at least theirNameandJavaTypeproperties set.- Parameters:
name- use as a base to form column name(s); the column names of unmapped columns will automatically be made to fit database limitationsio- I/O information about mapped columns; you do not have to set this information if returning templatesadapt- whether to adapt the mapping or schema
-
map
-
strategy
Return the value handler strategy to use for the given enum type. An enum type with an @EnumeratedValue field is always mapped by that value, as the JPA 3.2 specification gives it precedence over the ordinal/name choice; every place that configures this handler from metadata has to go through here, so that one enum type is encoded the same way no matter which kind of metadata declared it. -
hasEnumeratedValue
Check if the given enum type has a field annotated with @EnumeratedValue. -
isVersionable
Description copied from interface:ValueHandlerReturn whether the values managed by this handler can be used in state image versioning.- Specified by:
isVersionablein interfaceValueHandler- Overrides:
isVersionablein classAbstractValueHandler
-
toDataStoreValue
Description copied from interface:ValueHandlerTranslate the given value to its datastore equivalent. If this value occupies multiple columns, return an object array with one element per column. For relation id columns, return the state manager the column depends on.- Specified by:
toDataStoreValuein interfaceValueHandler- Overrides:
toDataStoreValuein classAbstractValueHandler
-
toObjectValue
Description copied from interface:ValueHandlerTranslate the given datastore value into its Java equivalent. If the value occupies multiple columns, the given object will be an object array with one entry per column. This method is only called ifValueHandler.objectValueRequiresLoad(ValueMapping)returns false.- Specified by:
toObjectValuein interfaceValueHandler- Overrides:
toObjectValuein classAbstractValueHandler
-