|
EclipseLink 2.3.2, build 'v20111125-r10461' API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.persistence.queries.AttributeGroup
org.eclipse.persistence.sessions.CopyGroup
public class CopyGroup
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#copy(Object, CopyGroup)
,
Serialized FormField 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 |
static int |
CASCADE_TREE
Depth level indicating that only the attributes found in the attribute group 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
|
protected boolean |
shouldResetVersion
|
Fields inherited from class org.eclipse.persistence.queries.AttributeGroup |
---|
items |
Constructor Summary | |
---|---|
CopyGroup()
PUBLIC: By default only copy the attributes found in the attribute group and don't null primary keys. |
|
CopyGroup(java.lang.String name)
PUBLIC: By default only copy the attributes found in the attribute group and don't null primary keys. |
Method Summary | |
---|---|
void |
addAttribute(java.lang.String attributeNameOrPath,
AttributeGroup group)
Add a basic attribute or nested attribute with each String representing an attribute on the path to what needs to be included in the AttributeGroup. |
void |
addAttribute(java.lang.String attributeNameOrPath,
CopyGroup group)
|
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 |
cascadeTree()
PUBLIC: Set if the copy should cascade only those attributes that are found in the group. |
CopyGroup |
clone()
|
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. |
CopyGroup |
getGroup(java.lang.String attributeNameOrPath)
Returns CopyGroup corresponding to the passed (possibly nested) attribute. |
org.eclipse.persistence.internal.sessions.AbstractSession |
getSession()
INTERNAL: Return the session. |
boolean |
isCopyGroup()
|
protected CopyGroup |
newGroup(java.lang.String name,
AttributeGroup parent)
Subclass may create different types. |
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. |
void |
setShouldResetVersion(boolean newShouldResetVersion)
PUBLIC: Set if the version should be reset to null. |
boolean |
shouldCascade()
PUBLIC: Return true if has been configured to CASCADE_ALL_PARTS or CASCADE_PRIVATE_PARTS. |
boolean |
shouldCascadeAllParts()
PUBLIC: Return true if should CASCADE_ALL_PARTS |
boolean |
shouldCascadePrivateParts()
PUBLIC: Return true if should CASCADE_PRIVATE_PARTS |
boolean |
shouldCascadeTree()
PUBLIC: Return true if should CASCADE_TREE |
boolean |
shouldResetPrimaryKey()
PUBLIC: Return if the primary key should be reset to null. |
boolean |
shouldResetVersion()
PUBLIC: Return if the version should be reset to null. |
protected java.lang.String |
toStringAdditionalInfo()
INTERNAL: |
Methods inherited from class org.eclipse.persistence.queries.AttributeGroup |
---|
addAttribute, addAttributes, containsAttribute, containsAttributeInternal, convert, equals, getAttributeNames, getItem, getItems, getName, hasItems, isFetchGroup, isLoadGroup, isSupersetOf, newItem, removeAttribute, setAttributeNames, setName, toCopyGroup, toFetchGroup, toLoadGroup, toString, toStringItems, toStringPath |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected boolean shouldResetPrimaryKey
protected boolean shouldResetVersion
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
public static final int CASCADE_TREE
Constructor Detail |
---|
public CopyGroup()
public CopyGroup(java.lang.String name)
Method Detail |
---|
public void cascadeAllParts()
public void cascadePrivateParts()
public void cascadeTree()
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 void setShouldResetVersion(boolean newShouldResetVersion)
public boolean shouldCascade()
public boolean shouldCascadeAllParts()
public boolean shouldCascadePrivateParts()
public boolean shouldCascadeTree()
public boolean shouldResetPrimaryKey()
public boolean shouldResetVersion()
protected java.lang.String toStringAdditionalInfo()
toStringAdditionalInfo
in class AttributeGroup
public void addAttribute(java.lang.String attributeNameOrPath, AttributeGroup group)
AttributeGroup
Example:
group.addAttribute("firstName", group1);
Note that existing group corresponding to attributeNameOrPath
will be overridden with the passed group.
group.addAttribute("manager.address", group2);
addAttribute
in class AttributeGroup
group
- - an AttributeGroup to be added.public void addAttribute(java.lang.String attributeNameOrPath, CopyGroup group)
public boolean isCopyGroup()
isCopyGroup
in class AttributeGroup
public CopyGroup clone()
clone
in class AttributeGroup
public CopyGroup getGroup(java.lang.String attributeNameOrPath)
getGroup
in class AttributeGroup
protected CopyGroup newGroup(java.lang.String name, AttributeGroup parent)
AttributeGroup
newGroup
in class AttributeGroup
|
EclipseLink 2.3.2, build 'v20111125-r10461' API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |