|
Oracle Fusion Middleware Java API Reference for Oracle TopLink 11g Release 1 (11.1.1) B32476-03 |
||||||||
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
public abstract class ForeignReferenceMapping
Purpose: Abstract class for relationship mappings
11/26/2008 - 11.1.1.1.0 Michael O'Brien
- 7596027: Remove TopLink JPA provider which is replaced by org.eclipse.persistence.jpa.PersistenceProvider
Field Summary | |
---|---|
static int |
INNER_JOIN
Specify any INNER join on a join fetch. |
static int |
NONE
Specify no join fetch, this is the default. |
static int |
OUTER_JOIN
Specify any OUTER join on a join fetch. |
Method Summary | |
---|---|
void |
dontUseBatchReading()
Indicates whether the referenced object should always be batch read on read all queries. |
void |
dontUseIndirection()
Indirection means that a ValueHolder will be put in-between the attribute and the real object. |
int |
getJoinFetch()
Return if this relationship should always be join fetched. |
java.lang.Class |
getReferenceClass()
Returns the reference class. |
java.lang.String |
getRelationshipPartnerAttributeName()
Use this method retreive the relationship partner attribute name of this bidirectional Mapping. |
boolean |
isCascadeMerge()
Check cascading value for the MERGE operation. |
boolean |
isCascadePersist()
Check cascading value for the CREATE operation. |
boolean |
isCascadeRefresh()
Check cascading value for the REFRESH operation. |
boolean |
isCascadeRemove()
Check cascading value for the REMOVE operation. |
boolean |
isInnerJoinFetched()
Return if this relationship should always be INNER join fetched. |
boolean |
isJoinFetched()
Return if this relationship should always be join fetched. |
boolean |
isOuterJoinFetched()
Return if this relationship should always be OUTER join fetched. |
boolean |
isPrivateOwned()
Return true if referenced objects are privately owned else false. |
void |
privateOwnedRelationship()
Sets the reference object to be a private owned. |
void |
setCascadeAll(boolean value)
Sets the cascading for all JPA operations. |
void |
setCascadeMerge(boolean value)
Sets the cascading for the JPA MERGE operation. |
void |
setCascadePersist(boolean value)
Sets the cascading for the JPA CREATE operation. |
void |
setCascadeRefresh(boolean value)
Sets the cascading for the JPA REFRESH operation. |
void |
setCascadeRemove(boolean value)
Sets the cascading for the JPA REMOVE operation. |
void |
setCustomSelectionQuery(ReadQuery query)
Relationship mappings creates a read query to read reference objects. |
void |
setIndirectionPolicy(oracle.toplink.internal.indirection.IndirectionPolicy indirectionPolicy)
ADVANCED: Set the indirection policy. |
void |
setIsPrivateOwned(boolean isPrivateOwned)
Set if the relationship is privately owned. |
void |
setJoinFetch(int joinFetch)
Indicates whether the referenced object(s) should always be joined on read queries. |
void |
setReferenceClass(java.lang.Class referenceClass)
Set the referenced class. |
void |
setRelationshipPartnerAttributeName(java.lang.String attributeName)
Use this method to specify the relationship partner attribute name of a bidirectional Mapping. |
void |
setSelectionCall(Call call)
This is a property on the mapping which will allow custom call to be substituted for reading a reference object. |
void |
setSelectionCriteria(Expression anExpression)
Sets the selection criteria to be used as a where clause to read reference objects. |
void |
setSelectionSQLString(java.lang.String sqlString)
This is a property on the mapping which will allow custom SQL to be substituted for reading a reference object. |
void |
setUsesBatchReading(boolean usesBatchReading)
Indicates whether the referenced object should always be batch read on read all queries. |
void |
setUsesIndirection(boolean usesIndirection)
Indirection means that a ValueHolder will be put in-between the attribute and the real object. |
boolean |
shouldUseBatchReading()
Indicates whether the referenced object should always be batch read on read all queries. |
void |
useBasicIndirection()
Indirection means that a ValueHolder will be put in-between the attribute and the real object. |
void |
useBatchReading()
Indicates whether the referenced object should always be batch read on read all queries. |
void |
useContainerIndirection(java.lang.Class containerClass)
Indirection means that a IndirectContainer (wrapping a ValueHolder) will be put in-between the attribute and the real object. |
void |
useInnerJoinFetch()
Specify this relationship to always be join fetched using an INNER join. |
void |
useOuterJoinFetch()
Specify this relationship to always be join fetched using an OUTER join. |
boolean |
usesIndirection()
Indirection means that some sort of indirection object will be put in-between the attribute and the real object. |
Methods inherited from class oracle.toplink.mappings.DatabaseMapping |
---|
getAttributeAccessor, getAttributeClassification, getAttributeName, getGetMethodName, getProperty, getSetMethodName, isLazy, isOptional, isUsingMethodAccess, readOnly, readWrite, setAttributeAccessor, setAttributeName, setGetMethodName, setIsLazy, setIsOptional, setIsReadOnly, setProperty, setSetMethodName, setWeight, simpleAddToCollectionChangeRecord, simpleRemoveFromCollectionChangeRecord |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int INNER_JOIN
ForeignReferenceMapping
public static final int OUTER_JOIN
ForeignReferenceMapping
public static final int NONE
ForeignReferenceMapping
Method Detail |
---|
public void dontUseBatchReading()
public void dontUseIndirection()
public java.lang.Class getReferenceClass()
public java.lang.String getRelationshipPartnerAttributeName()
public boolean isCascadePersist()
public boolean isCascadeMerge()
public boolean isCascadeRefresh()
public boolean isCascadeRemove()
public boolean isPrivateOwned()
isPrivateOwned
in class DatabaseMapping
public void privateOwnedRelationship()
setIsPrivateOwned(boolean)
public void setCascadeAll(boolean value)
public void setCascadePersist(boolean value)
public void setCascadeMerge(boolean value)
public void setCascadeRefresh(boolean value)
public void setCascadeRemove(boolean value)
public void setCustomSelectionQuery(ReadQuery query)
public void setIndirectionPolicy(oracle.toplink.internal.indirection.IndirectionPolicy indirectionPolicy)
public void setIsPrivateOwned(boolean isPrivateOwned)
public void setReferenceClass(java.lang.Class referenceClass)
public void setRelationshipPartnerAttributeName(java.lang.String attributeName)
public void setSelectionCriteria(Expression anExpression)
public void setSelectionSQLString(java.lang.String sqlString)
public void setSelectionCall(Call call)
public void setUsesBatchReading(boolean usesBatchReading)
public void setUsesIndirection(boolean usesIndirection)
useBasicIndirection()
,
dontUseIndirection()
public boolean shouldUseBatchReading()
public void useBasicIndirection()
public void useBatchReading()
public void useContainerIndirection(java.lang.Class containerClass)
public boolean usesIndirection()
public void setJoinFetch(int joinFetch)
ObjectLevelReadQuery.addJoinedAttribute(String)
,
ReadAllQuery.addBatchReadAttribute(String)
public int getJoinFetch()
public boolean isJoinFetched()
public boolean isInnerJoinFetched()
public boolean isOuterJoinFetched()
public void useInnerJoinFetch()
public void useOuterJoinFetch()
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |