|
EclipseLink 2.0.0, build 'v20091127-r5931' API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.persistence.sessions.ObjectCopyingPolicy
public class ObjectCopyingPolicy
Purpose: Define how an object is to be copied.
Description: This is for usage with the object copying feature, not the unit of work. This is useful for copying an entire object graph as part of the host application's logic.
Responsibilities:
Session.copyObject(Object, ObjectCopyingPolicy)
Field Summary | |
---|---|
static int |
CASCADE_ALL_PARTS
Depth level indicating that all relationships with mappings should be used when building the copied object graph |
static int |
CASCADE_PRIVATE_PARTS
Depth level indicating that only relationships with mapping indicated privately- owned should be copied |
protected java.util.Map |
copies
|
protected int |
depth
Policy depth that determines how the copy will cascade to the object's related parts |
static int |
NO_CASCADE
Depth level indicating that NO relationships should be included in the copy. |
protected org.eclipse.persistence.internal.sessions.AbstractSession |
session
|
protected boolean |
shouldResetPrimaryKey
|
Constructor Summary | |
---|---|
ObjectCopyingPolicy()
PUBLIC: Return a new copying policy. |
Method Summary | |
---|---|
void |
cascadeAllParts()
PUBLIC: Set if the copy should cascade all relationships when copying the object(s). |
void |
cascadePrivateParts()
PUBLIC: Set if the copy should cascade only those relationships that are configured as privately-owned. |
void |
dontCascade()
PUBLIC: Set if the copy should not cascade relationships when copying the object(s) |
java.util.Map |
getCopies()
INTERNAL: Get the session. |
int |
getDepth()
INTERNAL: Return the cascade depth. |
org.eclipse.persistence.internal.sessions.AbstractSession |
getSession()
INTERNAL: Return the session. |
void |
setCopies(java.util.Map newCopies)
INTERNAL: Set the copies. |
void |
setDepth(int newDepth)
INTERNAL: Set the cascade depth. |
void |
setSession(org.eclipse.persistence.internal.sessions.AbstractSession newSession)
INTERNAL: Set the session. |
void |
setShouldResetPrimaryKey(boolean newShouldResetPrimaryKey)
PUBLIC: Set if the primary key should be reset to null. |
boolean |
shouldCascade()
PUBLIC: Return true if the policy has been configured to CASCADE_ALL_PARTS or CASCADE_PRIVATE_PARTS. |
boolean |
shouldCascadeAllParts()
PUBLIC: Return true if the policy should CASCADE_ALL_PARTS |
boolean |
shouldCascadePrivateParts()
PUBLIC: Return true if the policy should CASCADE_PRIVATE_PARTS |
boolean |
shouldResetPrimaryKey()
PUBLIC: Return if the primary key should be reset to null. |
java.lang.String |
toString()
INTERNAL: |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected boolean shouldResetPrimaryKey
protected org.eclipse.persistence.internal.sessions.AbstractSession session
protected java.util.Map copies
protected int depth
public static final int NO_CASCADE
public static final int CASCADE_PRIVATE_PARTS
public static final int CASCADE_ALL_PARTS
Constructor Detail |
---|
public ObjectCopyingPolicy()
Method Detail |
---|
public void cascadeAllParts()
public void cascadePrivateParts()
public void dontCascade()
public java.util.Map getCopies()
public int getDepth()
public org.eclipse.persistence.internal.sessions.AbstractSession getSession()
public void setCopies(java.util.Map newCopies)
public void setDepth(int newDepth)
public void setSession(org.eclipse.persistence.internal.sessions.AbstractSession newSession)
public void setShouldResetPrimaryKey(boolean newShouldResetPrimaryKey)
public boolean shouldCascade()
public boolean shouldCascadeAllParts()
public boolean shouldCascadePrivateParts()
public boolean shouldResetPrimaryKey()
public java.lang.String toString()
toString
in class java.lang.Object
|
EclipseLink 2.0.0, build 'v20091127-r5931' API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |