Oracle Application Server TopLink API Reference
10g Release 2 (10.1.2)

B15903-01


oracle.toplink.mappings
Class DirectToFieldMapping

java.lang.Object
  extended byoracle.toplink.mappings.DatabaseMapping
      extended byoracle.toplink.mappings.DirectToFieldMapping

All Implemented Interfaces:
java.lang.Cloneable, java.io.Serializable
Direct Known Subclasses:
ObjectTypeMapping, SerializedObjectMapping, TypeConversionMapping

public class DirectToFieldMapping
extends DatabaseMapping

Purpose: Maps an attribute to the corresponding database field type. The list of field types that are supported by TopLink's direct to field mapping is dependent on the relational databae being used.

Since:
TOPLink/Java 1.0
See Also:
Serialized Form

Constructor Summary
DirectToFieldMapping()
Default constructor.

Method Summary
java.lang.Class getAttributeClassification()
PUBLIC: Some databases do not properly support all of the base data types.
java.lang.String getFieldName()
PUBLIC: Name of the field this mapping represents.
java.lang.Object getNullValue()
PUBLIC: Allow for the value used for null to be specified.
void setAttributeClassification(java.lang.Class aClass)
PUBLIC: Some databases do not properly support all of the base data types.
void setFieldName(java.lang.String FieldName)
PUBLIC: Set the field name in the mapping.
void setNullValue(java.lang.Object nullValue)
PUBLIC: Allow for the value used for null to be specified.

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

DirectToFieldMapping

public DirectToFieldMapping()
Default constructor.

Method Detail

getAttributeClassification

public java.lang.Class getAttributeClassification()
PUBLIC: Some databases do not properly support all of the base data types. For these databases, the base data type must be explicitly specified in the mapping to tell TopLink to force the instance variable value to that data type
Overrides:
getAttributeClassification in class DatabaseMapping

getFieldName

public java.lang.String getFieldName()
PUBLIC: Name of the field this mapping represents.

getNullValue

public java.lang.Object getNullValue()
PUBLIC: Allow for the value used for null to be specified. This can be used to convert database null values to application specific values, when null values are not allowed by the application (such as in primitives). Note: the default value for NULL is used on reads, writes, and query SQL generation

setAttributeClassification

public void setAttributeClassification(java.lang.Class aClass)
PUBLIC: Some databases do not properly support all of the base data types. For these databases, the base data type must be explicitly specified in the mapping to tell TopLink to force the instance variable value to that data type

setFieldName

public void setFieldName(java.lang.String FieldName)
PUBLIC: Set the field name in the mapping.

setNullValue

public void setNullValue(java.lang.Object nullValue)
PUBLIC: Allow for the value used for null to be specified. This can be used to convert database null values to application specific values, when null values are not allowed by the application (such as in primitives). Note: the default value for NULL is used on reads, writes, and query SQL generation

Copyright © 1998, 2005 Oracle Corporation. All Rights Reserved.