EclipseLink Core 4.0.2 · org.eclipse.persistence.sessions.CopyGroup

Modifier and Type	Field and Description
public static final int	CASCADE_ALL_PARTS Depth level indicating that all relationships with mappings should be used when building the copied object graph
public static final int	CASCADE_PRIVATE_PARTS Depth level indicating that only relationships with mapping indicated privately- owned should be copied
public static final int	CASCADE_TREE Depth level indicating that only the attributes found in the attribute group should be copied
protected Map<K, V>	copies
protected int	depth Policy depth that determines how the copy will cascade to the object's related parts
public static final int	NO_CASCADE Depth level indicating that NO relationships should be included in the copy.
protected transient AbstractSession	session
protected boolean	shouldResetPrimaryKey
protected boolean	shouldResetVersion

Access	Constructor and Description
public	CopyGroup() PUBLIC: By default only copy the attributes found in the attribute group and don't null primary keys.
public	CopyGroup(String name) PUBLIC: By default only copy the attributes found in the attribute group and don't null primary keys.

Method Summary

Modifier and Type	Method and Description
public void	addAttribute(String A simple attribute, array or attributes forming a path attributeNameOrPath, CoreAttributeGroup<ATTRIBUTE_ITEM extends CoreAttributeItem, DESCRIPTOR extends CoreDescriptor<ATTRIBUTE_GROUP extends CoreAttributeGroup, DESCRIPTOR_EVENT_MANAGER extends CoreDescriptorEventManager, FIELD extends CoreField, INHERITANCE_POLICY extends CoreInheritancePolicy, INSTANTIATION_POLICY extends CoreInstantiationPolicy, LIST extends List<E>, OBJECT_BUILDER extends CoreObjectBuilder>> - an AttributeGroup to be added. group) Overrides org.eclipse.persistence.core.queries.CoreAttributeGroup.addAttribute. 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.
public void	addAttribute(String attributeNameOrPath, CopyGroup group)
public void	cascadeAllParts() PUBLIC: Set if the copy should cascade all relationships when copying the object(s).
public void	cascadePrivateParts() PUBLIC: Set if the copy should cascade only those relationships that are configured as privately-owned.
public void	cascadeTree() PUBLIC: Set if the copy should cascade only those attributes that are found in the group.
public CopyGroup	clone() Overrides org.eclipse.persistence.queries.AttributeGroup.clone. Creates and returns a copy of this object.
public void	dontCascade() PUBLIC: Set if the copy should not cascade relationships when copying the object(s)
public Map<K, V>	getCopies() INTERNAL: Get the session.
public int	getDepth() INTERNAL: Return the cascade depth.
public CopyGroup	getGroup(String attributeNameOrPath) Overrides org.eclipse.persistence.queries.AttributeGroup.getGroup. Returns CopyGroup corresponding to the passed (possibly nested) attribute.
public AbstractSession	getSession() INTERNAL: Return the session.
public boolean	isCopyGroup() Overrides org.eclipse.persistence.queries.AttributeGroup.isCopyGroup. INTERNAL: This method is used internally when converting to a copy group.
protected CopyGroup	newGroup(String name, CoreAttributeGroup<ATTRIBUTE_ITEM extends CoreAttributeItem, DESCRIPTOR extends CoreDescriptor<ATTRIBUTE_GROUP extends CoreAttributeGroup, DESCRIPTOR_EVENT_MANAGER extends CoreDescriptorEventManager, FIELD extends CoreField, INHERITANCE_POLICY extends CoreInheritancePolicy, INSTANTIATION_POLICY extends CoreInstantiationPolicy, LIST extends List<E>, OBJECT_BUILDER extends CoreObjectBuilder>> parent) Overrides org.eclipse.persistence.queries.AttributeGroup.newGroup. Subclass may create different types.
public void	setCopies(Map<K, V> newCopies) INTERNAL: Set the copies.
public void	setDepth(int newDepth) INTERNAL: Set the cascade depth.
public void	setSession(AbstractSession newSession) INTERNAL: Set the session.
public void	setShouldResetPrimaryKey(boolean newShouldResetPrimaryKey) PUBLIC: Set if the primary key should be reset to null.
public void	setShouldResetVersion(boolean newShouldResetVersion) PUBLIC: Set if the version should be reset to null.
public boolean	shouldCascade() PUBLIC: Return true if has been configured to CASCADE_ALL_PARTS or CASCADE_PRIVATE_PARTS.
public boolean	shouldCascadeAllParts() PUBLIC: Return true if should CASCADE_ALL_PARTS
public boolean	shouldCascadePrivateParts() PUBLIC: Return true if should CASCADE_PRIVATE_PARTS
public boolean	shouldCascadeTree() PUBLIC: Return true if should CASCADE_TREE
public boolean	shouldResetPrimaryKey() PUBLIC: Return if the primary key should be reset to null.
public boolean	shouldResetVersion() PUBLIC: Return if the version should be reset to null.
protected String	toStringAdditionalInfo() Overrides org.eclipse.persistence.core.queries.CoreAttributeGroup.toStringAdditionalInfo. INTERNAL:

Inherited from org.eclipse.persistence.queries.AttributeGroup:: addAttribute findGroup getItem isConcurrent isLoadGroup isSupersetOf newItem newItem toCopyGroup toCopyGroup toFetchGroup toFetchGroup toLoadGroup toLoadGroup

CASCADE_ALL_PARTS	back to summary
public static final int CASCADE_ALL_PARTS Depth level indicating that all relationships with mappings should be used when building the copied object graph

CASCADE_PRIVATE_PARTS	back to summary
public static final int CASCADE_PRIVATE_PARTS Depth level indicating that only relationships with mapping indicated privately- owned should be copied

CASCADE_TREE	back to summary
public static final int CASCADE_TREE Depth level indicating that only the attributes found in the attribute group should be copied

copies	back to summary
protected Map<K, V> copies

depth	back to summary
protected int depth Policy depth that determines how the copy will cascade to the object's related parts

NO_CASCADE	back to summary
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

session	back to summary
protected transient AbstractSession session

shouldResetPrimaryKey	back to summary
protected boolean shouldResetPrimaryKey

shouldResetVersion	back to summary
protected boolean shouldResetVersion

CopyGroup	back to summary
public CopyGroup() PUBLIC: By default only copy the attributes found in the attribute group and don't null primary keys.

CopyGroup	back to summary
public CopyGroup(String name) PUBLIC: By default only copy the attributes found in the attribute group and don't null primary keys.

Method Detail

addAttribute back to summary

addAttribute	back to summary
public void addAttribute(String attributeNameOrPath, CoreAttributeGroup<ATTRIBUTE_ITEM extends CoreAttributeItem, DESCRIPTOR extends CoreDescriptor<ATTRIBUTE_GROUP extends CoreAttributeGroup, DESCRIPTOR_EVENT_MANAGER extends CoreDescriptorEventManager, FIELD extends CoreField, INHERITANCE_POLICY extends CoreInheritancePolicy, INSTANTIATION_POLICY extends CoreInstantiationPolicy, LIST extends List<E>, OBJECT_BUILDER extends CoreObjectBuilder>> group) Overrides org.eclipse.persistence.core.queries.CoreAttributeGroup.addAttribute. Doc from org.eclipse.persistence.core.queries.CoreAttributeGroup.addAttribute. 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. Example: `group.addAttribute("firstName", group1); group.addAttribute("manager.address", group2);` Note that existing group corresponding to attributeNameOrPath will be overridden with the passed group. Parameters attributeNameOrPath:String A simple attribute, array or attributes forming a path group:CoreAttributeGroup<ATTRIBUTE_ITEM extends CoreAttributeItem, DESCRIPTOR extends CoreDescriptor<ATTRIBUTE_GROUP extends CoreAttributeGroup, DESCRIPTOR_EVENT_MANAGER extends CoreDescriptorEventManager, FIELD extends CoreField, INHERITANCE_POLICY extends CoreInheritancePolicy, INSTANTIATION_POLICY extends CoreInstantiationPolicy, LIST extends List<E>, OBJECT_BUILDER extends CoreObjectBuilder>> - an AttributeGroup to be added. Annotations @Override

public void addAttribute(String attributeNameOrPath, CoreAttributeGroup<ATTRIBUTE_ITEM extends CoreAttributeItem, DESCRIPTOR extends CoreDescriptor<ATTRIBUTE_GROUP extends CoreAttributeGroup, DESCRIPTOR_EVENT_MANAGER extends CoreDescriptorEventManager, FIELD extends CoreField, INHERITANCE_POLICY extends CoreInheritancePolicy, INSTANTIATION_POLICY extends CoreInstantiationPolicy, LIST extends List<E>, OBJECT_BUILDER extends CoreObjectBuilder>> group)

Overrides org.eclipse.persistence.core.queries.CoreAttributeGroup.addAttribute.

Doc from org.eclipse.persistence.core.queries.CoreAttributeGroup.addAttribute.

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.

Example: group.addAttribute("firstName", group1); group.addAttribute("manager.address", group2); Note that existing group corresponding to attributeNameOrPath will be overridden with the passed group.

Parameters

attributeNameOrPath:String: A simple attribute, array or attributes forming a path
group:CoreAttributeGroup<ATTRIBUTE_ITEM extends CoreAttributeItem, DESCRIPTOR extends CoreDescriptor<ATTRIBUTE_GROUP extends CoreAttributeGroup, DESCRIPTOR_EVENT_MANAGER extends CoreDescriptorEventManager, FIELD extends CoreField, INHERITANCE_POLICY extends CoreInheritancePolicy, INSTANTIATION_POLICY extends CoreInstantiationPolicy, LIST extends List<E>, OBJECT_BUILDER extends CoreObjectBuilder>>: - an AttributeGroup to be added.

Annotations

@Override

addAttribute	back to summary
public void addAttribute(String attributeNameOrPath, CopyGroup group)

cascadeAllParts	back to summary
public void cascadeAllParts() PUBLIC: Set if the copy should cascade all relationships when copying the object(s).

cascadePrivateParts	back to summary
public void cascadePrivateParts() PUBLIC: Set if the copy should cascade only those relationships that are configured as privately-owned.

cascadeTree	back to summary
public void cascadeTree() PUBLIC: Set if the copy should cascade only those attributes that are found in the group.

clone back to summary

clone	back to summary
public CopyGroup clone() Overrides org.eclipse.persistence.queries.AttributeGroup.clone. Doc from java.lang.Object.clone. Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object `x`, the expression: x.clone() != x will be true, and that the expression: x.clone().getClass() == x.getClass() will be `true`, but these are not absolute requirements. While it is typically the case that: x.clone().equals(x) will be `true`, this is not an absolute requirement. By convention, the returned object should be obtained by calling `super.clone`. If a class and all of its superclasses (except `Object`) obey this convention, it will be the case that `x.clone().getClass() == x.getClass()`. By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by `super.clone` before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by `super.clone` need to be modified. Returns:CopyGroup a clone of this instance. Annotations @Override

public CopyGroup clone()

Overrides org.eclipse.persistence.queries.AttributeGroup.clone.

Doc from java.lang.Object.clone.

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

x.clone() != x

will be true, and that the expression:

x.clone().getClass() == x.getClass()

will be true, but these are not absolute requirements. While it is typically the case that:

x.clone().equals(x)

will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Returns:CopyGroup

a clone of this instance.

Annotations

@Override

dontCascade	back to summary
public void dontCascade() PUBLIC: Set if the copy should not cascade relationships when copying the object(s)

getCopies	back to summary
public Map<K, V> getCopies() INTERNAL: Get the session.

getDepth	back to summary
public int getDepth() INTERNAL: Return the cascade depth.

getGroup	back to summary
public CopyGroup getGroup(String attributeNameOrPath) Overrides org.eclipse.persistence.queries.AttributeGroup.getGroup. Returns CopyGroup corresponding to the passed (possibly nested) attribute. Annotations @Override

getGroup

back to summary

public CopyGroup getGroup(String attributeNameOrPath)

Overrides org.eclipse.persistence.queries.AttributeGroup.getGroup.

Returns CopyGroup corresponding to the passed (possibly nested) attribute.

Annotations

@Override

getSession	back to summary
public AbstractSession getSession() INTERNAL: Return the session.

isCopyGroup	back to summary
public boolean isCopyGroup() Overrides org.eclipse.persistence.queries.AttributeGroup.isCopyGroup. Doc from org.eclipse.persistence.queries.AttributeGroup.isCopyGroup. INTERNAL: This method is used internally when converting to a copy group. Annotations @Override

isCopyGroup

back to summary

public boolean isCopyGroup()

Overrides org.eclipse.persistence.queries.AttributeGroup.isCopyGroup.

Doc from org.eclipse.persistence.queries.AttributeGroup.isCopyGroup.

INTERNAL: This method is used internally when converting to a copy group.

Annotations

@Override

newGroup	back to summary
protected CopyGroup newGroup(String name, CoreAttributeGroup<ATTRIBUTE_ITEM extends CoreAttributeItem, DESCRIPTOR extends CoreDescriptor<ATTRIBUTE_GROUP extends CoreAttributeGroup, DESCRIPTOR_EVENT_MANAGER extends CoreDescriptorEventManager, FIELD extends CoreField, INHERITANCE_POLICY extends CoreInheritancePolicy, INSTANTIATION_POLICY extends CoreInstantiationPolicy, LIST extends List<E>, OBJECT_BUILDER extends CoreObjectBuilder>> parent) Overrides org.eclipse.persistence.queries.AttributeGroup.newGroup. Doc from org.eclipse.persistence.queries.AttributeGroup.newGroup. Subclass may create different types. Annotations @Override

newGroup

back to summary

protected CopyGroup newGroup(String name, CoreAttributeGroup<ATTRIBUTE_ITEM extends CoreAttributeItem, DESCRIPTOR extends CoreDescriptor<ATTRIBUTE_GROUP extends CoreAttributeGroup, DESCRIPTOR_EVENT_MANAGER extends CoreDescriptorEventManager, FIELD extends CoreField, INHERITANCE_POLICY extends CoreInheritancePolicy, INSTANTIATION_POLICY extends CoreInstantiationPolicy, LIST extends List<E>, OBJECT_BUILDER extends CoreObjectBuilder>> parent)

Overrides org.eclipse.persistence.queries.AttributeGroup.newGroup.

Doc from org.eclipse.persistence.queries.AttributeGroup.newGroup.

Subclass may create different types.

Annotations

@Override

setCopies	back to summary
public void setCopies(Map<K, V> newCopies) INTERNAL: Set the copies.

setDepth	back to summary
public void setDepth(int newDepth) INTERNAL: Set the cascade depth.

setSession	back to summary
public void setSession(AbstractSession newSession) INTERNAL: Set the session.

setShouldResetPrimaryKey	back to summary
public void setShouldResetPrimaryKey(boolean newShouldResetPrimaryKey) PUBLIC: Set if the primary key should be reset to null.

setShouldResetVersion	back to summary
public void setShouldResetVersion(boolean newShouldResetVersion) PUBLIC: Set if the version should be reset to null.

shouldCascade	back to summary
public boolean shouldCascade() PUBLIC: Return true if has been configured to CASCADE_ALL_PARTS or CASCADE_PRIVATE_PARTS.

shouldCascadeAllParts	back to summary
public boolean shouldCascadeAllParts() PUBLIC: Return true if should CASCADE_ALL_PARTS

shouldCascadePrivateParts	back to summary
public boolean shouldCascadePrivateParts() PUBLIC: Return true if should CASCADE_PRIVATE_PARTS

shouldCascadeTree	back to summary
public boolean shouldCascadeTree() PUBLIC: Return true if should CASCADE_TREE

shouldResetPrimaryKey	back to summary
public boolean shouldResetPrimaryKey() PUBLIC: Return if the primary key should be reset to null.

shouldResetVersion	back to summary
public boolean shouldResetVersion() PUBLIC: Return if the version should be reset to null.

toStringAdditionalInfo	back to summary
protected String toStringAdditionalInfo() Overrides org.eclipse.persistence.core.queries.CoreAttributeGroup.toStringAdditionalInfo. INTERNAL: Annotations @Override

toStringAdditionalInfo

back to summary

protected String toStringAdditionalInfo()

Overrides org.eclipse.persistence.core.queries.CoreAttributeGroup.toStringAdditionalInfo.

INTERNAL:

Annotations

@Override

public Class CopyGroup

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail