Package org.apache.openjpa.jdbc.meta.strats

Class AbstractValueHandler

java.lang.Object

org.apache.openjpa.jdbc.meta.strats.AbstractValueHandler

All Implemented Interfaces:

java.io.Serializable, ValueHandler

Direct Known Subclasses:

BlobValueHandler, ByteArrayValueHandler, CharArrayStreamValueHandler, CharArrayValueHandler, ClobValueHandler, EmbedValueHandler, EnumValueHandler, ImmutableValueHandler, UntypedPCValueHandler, XMLValueHandler

public abstract class AbstractValueHandler
extends java.lang.Object
implements ValueHandler

No-op implementations of ValueHandler interface methods.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
AbstractValueHandler()

Method Summary

Modifier and Type	Method	Description
java.lang.Object	getResultArgument(ValueMapping vm)	Return the argument to pass to the result set when loading data via Result.getObject(java.lang.Object, int, java.lang.Object), or null if none.
boolean	isVersionable(ValueMapping vm)	Return whether the values managed by this handler can be used in state image versioning.
boolean	objectValueRequiresLoad(ValueMapping vm)	Return whether this handler potentially must load extra data to extract the object value from its datastore representation.
java.lang.Object	toDataStoreValue(ValueMapping vm, java.lang.Object val, JDBCStore store)	Translate the given value to its datastore equivalent.
java.lang.Object	toObjectValue(ValueMapping vm, java.lang.Object val)	Translate the given datastore value into its Java equivalent.
java.lang.Object	toObjectValue(ValueMapping vm, java.lang.Object val, OpenJPAStateManager sm, JDBCStore store, JDBCFetchConfiguration fetch)	Translate the given datastore value into its Java equivalent.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.openjpa.jdbc.meta.ValueHandler

map

Constructor Detail

AbstractValueHandler

public AbstractValueHandler()

Method Detail

isVersionable

public boolean isVersionable(ValueMapping vm)

Description copied from interface: ValueHandler

Return whether the values managed by this handler can be used in state image versioning.

Specified by:

isVersionable in interface ValueHandler

objectValueRequiresLoad

public boolean objectValueRequiresLoad(ValueMapping vm)

Description copied from interface: ValueHandler

Return whether this handler potentially must load extra data to extract the object value from its datastore representation.

Specified by:

objectValueRequiresLoad in interface ValueHandler

getResultArgument

public java.lang.Object getResultArgument(ValueMapping vm)

Description copied from interface: ValueHandler

Return the argument to pass to the result set when loading data via Result.getObject(java.lang.Object, int, java.lang.Object), or null if none. If this value occupies multiple columns, return an array with one element per column. You may return null if all array elements would be null.

Specified by:

getResultArgument in interface ValueHandler

toDataStoreValue

public java.lang.Object toDataStoreValue(ValueMapping vm,
                                         java.lang.Object val,
                                         JDBCStore store)

Description copied from interface: ValueHandler

Translate 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:

toDataStoreValue in interface ValueHandler

toObjectValue

public java.lang.Object toObjectValue(ValueMapping vm,
                                      java.lang.Object val)

Description copied from interface: ValueHandler

Translate 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 if ValueHandler.objectValueRequiresLoad(org.apache.openjpa.jdbc.meta.ValueMapping) returns false.

Specified by:

toObjectValue in interface ValueHandler

toObjectValue

public java.lang.Object toObjectValue(ValueMapping vm,
                                      java.lang.Object val,
                                      OpenJPAStateManager sm,
                                      JDBCStore store,
                                      JDBCFetchConfiguration fetch)
                               throws java.sql.SQLException

Description copied from interface: ValueHandler

Translate 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 if ValueHandler.objectValueRequiresLoad(org.apache.openjpa.jdbc.meta.ValueMapping) returns true.

Specified by:

toObjectValue in interface ValueHandler

sm - the state manager that owns the value; may be null if loading a projection

Throws:

java.sql.SQLException