File Doc Category Size Date Package
Converter.java API Doc Glassfish v2 API 3938 Tue May 22 16:54:46 BST 2007 oracle.toplink.essentials.mappings.converters

Converter

public interface Converter implements Serializable

Purpose: Conversion interface to allow conversion between object and data types. This can be used in any mapping to convert between the object and data types without requiring code placed in the object model. TopLink provides several common converters, but the application can also define it own.

see: DirectToFieldMapping#setConverter(Converter)
see: DirectCollectionMapping#setConverter(Converter)
see: ObjectTypeConverter
see: TypeConversionConverter
see: SerializedObjectConverter
author: James Sutherland
since: OracleAS TopLink 10g (10.0.3)

Fields Summary
Constructors Summary
Methods Summary
public java.lang.Object convertDataValueToObjectValue(java.lang.Object dataValue, oracle.toplink.essentials.sessions.Session session)
PUBLIC: Convert the databases' data representation of the value to the object's representation. For example this could convert between an sql.Time datatype and the Java Calendar type.
public java.lang.Object convertObjectValueToDataValue(java.lang.Object objectValue, oracle.toplink.essentials.sessions.Session session)
PUBLIC: Convert the object's representation of the value to the databases' data representation. For example this could convert between a Calendar Java type and the sql.Time datatype.
public void initialize(oracle.toplink.essentials.mappings.DatabaseMapping mapping, oracle.toplink.essentials.sessions.Session session)
PUBLIC: Allow for any initialization.
public boolean isMutable()
PUBLIC: If the converter converts the value to a mutable value, i.e. a value that can have its' parts changed without being replaced, then it must return true. If the value is not mutable, cannot be changed without replacing the whole value then false must be returned. This is used within the UnitOfWork to determine how to clone.