Class ConverterValueHandler
java.lang.Object
org.apache.openjpa.jdbc.meta.strats.AbstractValueHandler
org.apache.openjpa.jdbc.meta.strats.ConverterValueHandler
- All Implemented Interfaces:
Serializable, ValueHandler
ValueHandler for fields using a JPA
AttributeConverter.
This handler is responsible for mapping the correct database column type
based on the converter's database type (the Y in
AttributeConverter<X,Y>). The actual value conversion between
entity attribute type and database column type is handled by the
externalization path in FieldMetaData.getExternalValue() and
FieldMetaData.getFieldValue().
- Since:
- 4.2.0
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanReturn whether the values managed by this handler can be used in state image versioning.Column[]map(ValueMapping vm, String name, ColumnIO io, boolean adapt) Map the given value and return all mapped columns, or simply return an array of unmapped default columns.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
-
ConverterValueHandler
-
-
Method Details
-
map
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
-
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
-
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
-
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
-