|
Oracle Fusion Middleware Java API Reference for Oracle TopLink (Deprecated) 11g Release 1 (11.1.1) B32476-04 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.toplink.mappings.DatabaseMapping
public abstract class DatabaseMapping
Purpose: Defines how an attribute of an object maps to and from the database
Responsibilities:
Constructor Summary | |
---|---|
DatabaseMapping()
Default constructor. |
Method Summary | |
---|---|
AttributeAccessor |
getAttributeAccessor()
ADVANCED: Return the attributeAccessor. |
java.lang.Class |
getAttributeClassification()
The classification type for the attribute this mapping represents |
java.lang.String |
getAttributeName()
Return the name of the attribute set in the mapping. |
java.lang.String |
getGetMethodName()
This method is invoked reflectively on the reference object to return the value of the attribute in the object. |
java.lang.Object |
getProperty(java.lang.Object property)
ADVANCED: Allow user defined properties. |
ClassDescriptor |
getReferenceDescriptor()
Return the referenceDescriptor. |
java.lang.String |
getSetMethodName()
This method is invoked reflectively on the reference object to set the value of the attribute in the object. |
boolean |
isLazy()
Return if this mapping is lazy. |
boolean |
isOptional()
Return whether the value of this mapping is optional (that is, can be null). |
boolean |
isUsingMethodAccess()
Return if method access is used. |
void |
readOnly()
To make mapping read only. |
void |
readWrite()
The mapping can be dynamically made either readOnly or readWriteOnly. |
void |
setAttributeAccessor(AttributeAccessor anAttributeAccessor)
ADVANCED: Set the attributeAccessor. |
void |
setAttributeName(java.lang.String attributeName)
Sets the name of the attribute in the mapping. |
void |
setGetMethodName(java.lang.String methodName)
This method is invoked reflectively on the reference object to return the value of the attribute in the object. |
void |
setIsLazy(boolean isLazy)
Set if this mapping is lazy. |
void |
setIsOptional(boolean isOptional)
Used to specify whether the value of this mapping may be null. |
void |
setIsReadOnly(boolean aBoolean)
Set this mapping to be read only. |
void |
setProperty(java.lang.Object property,
java.lang.Object value)
ADVANCED: Allow user defined properties. |
void |
setSetMethodName(java.lang.String methodName)
Set the methodName used to set the value for the mapping's attribute into the object. |
void |
setWeight(java.lang.Integer newWeight)
ADVANCED: Set the weight of the mapping, used to sort mappings DirectToField Mappings have a default weight of 1 while all other Mappings have a default weight of MAXINT. |
void |
simpleAddToCollectionChangeRecord(java.lang.Object referenceKey,
java.lang.Object changeSetToAdd,
oracle.toplink.internal.sessions.ObjectChangeSet changeSet,
oracle.toplink.internal.sessions.AbstractSession session)
ADVANCED: This method is used to add an object to a collection once the changeSet is applied. |
void |
simpleRemoveFromCollectionChangeRecord(java.lang.Object referenceKey,
java.lang.Object changeSetToAdd,
oracle.toplink.internal.sessions.ObjectChangeSet changeSet,
oracle.toplink.internal.sessions.AbstractSession session)
ADVANCED: This method is used to remove an object from a collection once the changeSet is applied. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public DatabaseMapping()
Method Detail |
---|
public AttributeAccessor getAttributeAccessor()
public java.lang.Class getAttributeClassification()
public java.lang.String getAttributeName()
public java.lang.String getGetMethodName()
public java.lang.Object getProperty(java.lang.Object property)
public ClassDescriptor getReferenceDescriptor()
public java.lang.String getSetMethodName()
public boolean isUsingMethodAccess()
public boolean isOptional()
public boolean isLazy()
public void setIsLazy(boolean isLazy)
public void readOnly()
public void readWrite()
public void setAttributeAccessor(AttributeAccessor anAttributeAccessor)
public void setAttributeName(java.lang.String attributeName)
public void setGetMethodName(java.lang.String methodName)
public void setIsOptional(boolean isOptional)
public void setIsReadOnly(boolean aBoolean)
public void setProperty(java.lang.Object property, java.lang.Object value)
public void setSetMethodName(java.lang.String methodName)
public void setWeight(java.lang.Integer newWeight)
public void simpleAddToCollectionChangeRecord(java.lang.Object referenceKey, java.lang.Object changeSetToAdd, oracle.toplink.internal.sessions.ObjectChangeSet changeSet, oracle.toplink.internal.sessions.AbstractSession session) throws DescriptorException
DescriptorException
public void simpleRemoveFromCollectionChangeRecord(java.lang.Object referenceKey, java.lang.Object changeSetToAdd, oracle.toplink.internal.sessions.ObjectChangeSet changeSet, oracle.toplink.internal.sessions.AbstractSession session) throws DescriptorException
DescriptorException
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |