|
Oracle Application Server TopLink API Reference 10g Release 2 (10.1.2) B15903-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.toplink.mappings.DatabaseMapping
oracle.toplink.mappings.ForeignReferenceMapping
oracle.toplink.mappings.CollectionMapping
oracle.toplink.mappings.DirectCollectionMapping
Purpose: This mapping is used to store objects into a collection that are non TopLink enabled.
Constructor Summary | |
DirectCollectionMapping() PUBLIC: Default constructor. |
Method Summary | |
void |
addReferenceKeyFieldName(java.lang.String referenceForeignKeyFieldName, java.lang.String sourcePrimaryKeyFieldName) PUBLIC: Add the name of the reference key field. |
java.lang.String |
getDirectFieldName() PUBLIC: Returns the name of the field name in the reference table. |
java.util.Vector |
getReferenceKeyFieldNames() PUBLIC: Return the reference key field names associated with the mapping. |
java.lang.String |
getReferenceTableName() PUBLIC: Returns the name of the reference table |
java.lang.String |
getReferenceTableQualifiedName() PUBLIC: Returns the qualified name of the reference table |
java.util.Vector |
getSourceKeyFieldNames() PUBLIC: Return the source key field names associated with the mapping. |
void |
setContainerPolicy(oracle.toplink.internal.queryframework.ContainerPolicy containerPolicy) ADVANCED: Configure the mapping to use a container policy. |
void |
setCustomInsertQuery(DataModifyQuery query) PUBLIC: The default insert query for mapping can be overridden by specifying the new query. |
void |
setDirectFieldName(java.lang.String fieldName) PUBLIC: Set the direct field name in the reference table. |
void |
setInsertSQLString(java.lang.String sqlString) PUBLIC: Set the receiver's insert SQL string. |
void |
setReferenceKeyFieldName(java.lang.String fieldName) PUBLIC: Set the name of the reference key field. |
void |
setReferenceKeyFieldNames(java.util.Vector fieldNames) PUBLIC: Set the reference key field names associated with the mapping. |
void |
setReferenceTableName(java.lang.String tableName) PUBLIC: Set the reference table name. |
void |
setSessionName(java.lang.String name) PUBLIC: Set the name of the session to execute the mapping's queries under. |
void |
setSourceKeyFieldNames(java.util.Vector fieldNames) PUBLIC: Set the source key field names associated with the mapping. |
void |
simpleAddToCollectionChangeRecord(java.lang.Object referenceKey, java.lang.Object objectToAdd, oracle.toplink.internal.sessions.ObjectChangeSet changeSet, oracle.toplink.publicinterface.Session session) ADVANCED: This method is used to have an object add to a collection once the changeSet is applied The referenceKey parameter should only be used for direct Maps. |
void |
simpleRemoveFromCollectionChangeRecord(java.lang.Object referenceKey, java.lang.Object objectToRemove, oracle.toplink.internal.sessions.ObjectChangeSet changeSet, oracle.toplink.publicinterface.Session session) ADVANCED: This method is used to have an object removed from a collection once the changeSet is applied The referenceKey parameter should only be used for direct Maps. |
void |
useCollectionClass(java.lang.Class concreteClass) PUBLIC: Configure the mapping to use an instance of the specified container class to hold the target objects. |
void |
useMapClass(java.lang.Class concreteClass, java.lang.String methodName) PUBLIC: It is illegal to use a Map as the container of a DirectCollectionMapping. |
Methods inherited from class oracle.toplink.mappings.CollectionMapping |
addAscendingOrdering, addDescendingOrdering, getRealCollectionAttributeValueFromObject, setCustomDeleteAllQuery, setDeleteAllSQLString, useSortedSetClass, useTransparentCollection, useTransparentMap |
Methods inherited from class oracle.toplink.mappings.DatabaseMapping |
getAttributeClassification, getAttributeName, getGetMethodName, getSetMethodName, readOnly, readWrite, setAttributeName, setGetMethodName, setIsReadOnly, setSetMethodName, setWeight |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public DirectCollectionMapping()
Method Detail |
public void addReferenceKeyFieldName(java.lang.String referenceForeignKeyFieldName, java.lang.String sourcePrimaryKeyFieldName)
public java.lang.String getDirectFieldName()
public java.util.Vector getReferenceKeyFieldNames()
public java.lang.String getReferenceTableName()
public java.lang.String getReferenceTableQualifiedName()
public java.util.Vector getSourceKeyFieldNames()
public void setContainerPolicy(oracle.toplink.internal.queryframework.ContainerPolicy containerPolicy)
setContainerPolicy
in interface ContainerMapping
setContainerPolicy
in class CollectionMapping
public void setCustomInsertQuery(DataModifyQuery query)
public void setDirectFieldName(java.lang.String fieldName)
public void setInsertSQLString(java.lang.String sqlString)
public void setReferenceKeyFieldName(java.lang.String fieldName)
public void setReferenceKeyFieldNames(java.util.Vector fieldNames)
public void setReferenceTableName(java.lang.String tableName)
public void setSessionName(java.lang.String name)
setSessionName
in class CollectionMapping
public void setSourceKeyFieldNames(java.util.Vector fieldNames)
public void simpleAddToCollectionChangeRecord(java.lang.Object referenceKey, java.lang.Object objectToAdd, oracle.toplink.internal.sessions.ObjectChangeSet changeSet, oracle.toplink.publicinterface.Session session)
simpleAddToCollectionChangeRecord
in class CollectionMapping
public void simpleRemoveFromCollectionChangeRecord(java.lang.Object referenceKey, java.lang.Object objectToRemove, oracle.toplink.internal.sessions.ObjectChangeSet changeSet, oracle.toplink.publicinterface.Session session)
simpleRemoveFromCollectionChangeRecord
in class CollectionMapping
public void useCollectionClass(java.lang.Class concreteClass)
jdk1.2.x: The container class must implement (directly or indirectly) the Collection interface.
jdk1.1.x: The container class must be a subclass of Vector.
useCollectionClass
in interface ContainerMapping
useCollectionClass
in class CollectionMapping
public void useMapClass(java.lang.Class concreteClass, java.lang.String methodName)
useMapClass
in interface ContainerMapping
useMapClass
in class CollectionMapping
DirectMapMapping
|
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |