org.eclipse.persistence.sessions
Class ObjectCopyingPolicy

java.lang.Object
  org.eclipse.persistence.sessions.ObjectCopyingPolicy

public class ObjectCopyingPolicy
extends java.lang.Object

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:

• Indicate through CASCADE levels the depth relationships will copied.
• Indicate if PK attributes should be copied with existing value or should be reset.

See Also:

Session.copyObject(Object, ObjectCopyingPolicy)

Since:

TOPLink/Java 3.0

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

shouldResetPrimaryKey

protected boolean shouldResetPrimaryKey

session

protected org.eclipse.persistence.internal.sessions.AbstractSession session

copies

protected java.util.Map copies

depth

protected int depth

Policy depth that determines how the copy will cascade to the object's related parts

NO_CASCADE

public static final int NO_CASCADE

Depth level indicating that NO relationships should be included in the copy. Relationships that are not copied will include the default value of the object's instantiation policy

See Also:

Constant Field Values

CASCADE_PRIVATE_PARTS

public static final int CASCADE_PRIVATE_PARTS

Depth level indicating that only relationships with mapping indicated privately- owned should be copied

See Also:

Constant Field Values

CASCADE_ALL_PARTS

public static final int CASCADE_ALL_PARTS

Depth level indicating that all relationships with mappings should be used when building the copied object graph

See Also:

Constant Field Values

Constructor Detail

ObjectCopyingPolicy

public ObjectCopyingPolicy()

PUBLIC: Return a new copying policy. By default the policy cascades privately owned parts and nulls primary keys.

Method Detail

cascadeAllParts

public void cascadeAllParts()

PUBLIC: Set if the copy should cascade all relationships when copying the object(s).

cascadePrivateParts

public void cascadePrivateParts()

PUBLIC: Set if the copy should cascade only those relationships that are configured as privately-owned.

dontCascade

public void dontCascade()

PUBLIC: Set if the copy should not cascade relationships when copying the object(s)

getCopies

public java.util.Map getCopies()

INTERNAL: Get the session.

getDepth

public int getDepth()

INTERNAL: Return the cascade depth.

getSession

public org.eclipse.persistence.internal.sessions.AbstractSession getSession()

INTERNAL: Return the session.

setCopies

public void setCopies(java.util.Map newCopies)

INTERNAL: Set the copies.

setDepth

public void setDepth(int newDepth)

INTERNAL: Set the cascade depth.

setSession

public void setSession(org.eclipse.persistence.internal.sessions.AbstractSession newSession)

INTERNAL: Set the session.

setShouldResetPrimaryKey

public void setShouldResetPrimaryKey(boolean newShouldResetPrimaryKey)

PUBLIC: Set if the primary key should be reset to null.

shouldCascade

public boolean shouldCascade()

PUBLIC: Return true if the policy has been configured to CASCADE_ALL_PARTS or CASCADE_PRIVATE_PARTS.

shouldCascadeAllParts

public boolean shouldCascadeAllParts()

PUBLIC: Return true if the policy should CASCADE_ALL_PARTS

shouldCascadePrivateParts

public boolean shouldCascadePrivateParts()

PUBLIC: Return true if the policy should CASCADE_PRIVATE_PARTS

shouldResetPrimaryKey

public boolean shouldResetPrimaryKey()

PUBLIC: Return if the primary key should be reset to null.

toString

public java.lang.String toString()

INTERNAL:

Overrides:

toString in class java.lang.Object