oracle.toplink.mappings
Class ObjectTypeMapping

java.lang.Object
oracle.toplink.mappings.DatabaseMapping
oracle.toplink.mappings.DirectToFieldMapping
oracle.toplink.mappings.ObjectTypeMapping

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public class ObjectTypeMapping

extends DirectToFieldMapping

Purpose: Object type mappings are used to match a fixed number of database primitives to Java objects. They are used when the values on the databae and in the java differ. To create an object type mapping, simply specify the instance variable and field names involved, together with a conversion value.

Since:

TOPLink/Java 1.0

See Also:

Serialized Form

Constructor Summary

ObjectTypeMapping()
PUBLIC: Default constructor.

Method Summary

void	addConversionValue(java.lang.Object fieldValue, java.lang.Object attributeValue) PUBLIC: A type conversion value is a two-way mapping from the database to the object.
void	addToAttributeOnlyConversionValue(java.lang.Object fieldValue, java.lang.Object attributeValue) PUBLIC: An attribute only conversion value is a one-way mapping from the database to the object.
java.lang.Object	getDefaultAttributeValue() PUBLIC: The default value can be used if the database can possibly store additional values then those that have been mapped.
java.util.Vector	getFieldToAttributeValueAssociations() PUBLIC: Return a collection of the field to attribute value associations.
java.util.Vector	getFieldToAttributeValueAssociationsForXML() PUBLIC: Return a collection of the field to attribute value associations for XML.
void	mapBooleans() PUBLIC: This is a very specific protocol which maps fieldValues "T" and "F" to true and false respectively.
void	mapGenders() PUBLIC: This is a very specific protocol which maps fieldValues "F" and "M" to "Female" and "Male" respectively.
void	mapResponses() PUBLIC: This is a very specific protocol which maps fieldValues "Y" and "N" to "Yes" and "No" respectively.
void	setDefaultAttributeValue(java.lang.Object defaultAttributeValue) PUBLIC: The default value can be used if the database can possibly store additional values then those that have been mapped.
void	setFieldToAttributeValueAssociations(java.util.Vector fieldToAttributeValueAssociations) PUBLIC: Set a collection of the field to attribute value associations.

Methods inherited from class oracle.toplink.mappings.DirectToFieldMapping

getAttributeClassification, getFieldName, getNullValue, setAttributeClassification, setFieldName, setNullValue

Methods inherited from class oracle.toplink.mappings.DatabaseMapping

getAttributeName, getGetMethodName, getSetMethodName, readOnly, readWrite, setAttributeName, setGetMethodName, setIsReadOnly, setSetMethodName, setWeight, simpleAddToCollectionChangeRecord, simpleRemoveFromCollectionChangeRecord

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ObjectTypeMapping

public ObjectTypeMapping()

PUBLIC: Default constructor.

Method Detail

addConversionValue

public void addConversionValue(java.lang.Object fieldValue,
                               java.lang.Object attributeValue)

PUBLIC: A type conversion value is a two-way mapping from the database to the object. The database value will be substituted for the object value when read, and the object value will be substituted for database value when written. Note that each field/attribute value must have one and only one attribute/field value to maintain a two-way mapping.

addToAttributeOnlyConversionValue

public void addToAttributeOnlyConversionValue(java.lang.Object fieldValue,
                                              java.lang.Object attributeValue)

PUBLIC: An attribute only conversion value is a one-way mapping from the database to the object. This can be used if multiple database values are desired to be mapped to the same object value. Note that when written only the default value will be used for the attribute, not this value.

getDefaultAttributeValue

public java.lang.Object getDefaultAttributeValue()

PUBLIC: The default value can be used if the database can possibly store additional values then those that have been mapped. Any value retreived from the database that is not mapped will be substitued for the default value.

getFieldToAttributeValueAssociations

public java.util.Vector getFieldToAttributeValueAssociations()

PUBLIC: Return a collection of the field to attribute value associations.

getFieldToAttributeValueAssociationsForXML

public java.util.Vector getFieldToAttributeValueAssociationsForXML()

PUBLIC: Return a collection of the field to attribute value associations for XML.

mapBooleans

public void mapBooleans()

PUBLIC: This is a very specific protocol which maps fieldValues "T" and "F" to true and false respectively.

mapGenders

public void mapGenders()

PUBLIC: This is a very specific protocol which maps fieldValues "F" and "M" to "Female" and "Male" respectively.

mapResponses

public void mapResponses()

PUBLIC: This is a very specific protocol which maps fieldValues "Y" and "N" to "Yes" and "No" respectively.

setDefaultAttributeValue

public void setDefaultAttributeValue(java.lang.Object defaultAttributeValue)

PUBLIC: The default value can be used if the database can possibly store additional values then those that have been mapped. Any value retreived from the database that is not mapped will be substitued for the default value.

setFieldToAttributeValueAssociations

public void setFieldToAttributeValueAssociations(java.util.Vector fieldToAttributeValueAssociations)

PUBLIC: Set a collection of the field to attribute value associations.