er.extensions.eof

Class ERXCopyable.Utility

java.lang.Object

er.extensions.eof.ERXCopyable.Utility

Enclosing interface:

ERXCopyable<T extends ERXCopyable<T>>

public static class ERXCopyable.Utility
extends Object

This class provides utility methods for use implementing ERXCopyable. They handle the most common situations encountered copying EO objects. The ERXCopyable.DefaultImplementation uses them internally. The implementations of

• modelCopy(NSMutableDictionary, ERXCopyable)
• referenceCopy(ERXEnterpriseObject)
• Utility#shallowCopy(ERXCopyable)
• deepCopy(NSMutableDictionary, ERXCopyable)

should be suitable for most EOEnterpriseObject instances to use for their ERXCopyable.duplicate(NSMutableDictionary) method. However there are some situations that can not be handled with this generic code:

1. An attribute or relationship must not be copied (e.g. order numbers).
2. An attribute or relationship needs special handling (e.g. dateModified should reflect when the copy was made, not when the original object was created).
3. An EO object should not be copied the same way in all situations (e.g. the relationship from one object should be copied deeply, but from another object should be a reference copy).
4. The relationships must be copied in a certain order (e.g. due to side effects in the methods setting the relationships).

In these situations you will need to write a custom implementation of the duplicate(NSMutableDictionary) method. This can be as simple as invoking the default implementation and then cleaning up the result to as complex as doing it all by hand. ERXCopyable.Utility also provides lower-level methods that you can use to copy any or all attributes or relationships when creating a custom duplicate(NSMutableDictionary) method.

Debugging information can be turned on with the DEBUG level of the log4j logger er.extensions.eof.ERXCopyable.

Field Summary

Fields

Modifier and Type	Field and Description
protected static NSMutableDictionary<String,NSArray<EOAttribute>>	_classAttributesDictionary
protected static NSMutableDictionary<String,NSArray<com.webobjects.eoaccess.EORelationship>>	_classRelationshipsDictionary
protected static NSMutableDictionary<String,NSArray<EOAttribute>>	_exposedPKAndFKAttributeDictionary

Constructor Summary

Constructors

Constructor and Description
Utility()

Method Summary

Modifier and Type	Method and Description
static NSArray<EOAttribute>	classAttributes(com.webobjects.eoaccess.EOEntity entity)
static NSArray<com.webobjects.eoaccess.EORelationship>	classRelationships(com.webobjects.eoaccess.EOEntity entity)
static <T extends ERXEnterpriseObject> void	cleanRelationships(T source, T destination) When an EO object is created it can already have some relationships set.
static <T extends ERXEnterpriseObject> void	copyAttribute(T source, T destination, EOAttribute attribute)
static <T extends ERXEnterpriseObject> void	copyClassAttributes(T source, T destination) This copies only the class attributes from the source ERXCopyable to the destination.
static ERXCopyable.CopyType	copyType(com.webobjects.eoaccess.EOProperty property)
static ERXCopyable.CopyType	copyType(com.webobjects.eoaccess.EOProperty property, NSDictionary<String,Object> userInfo) Abstracted out of copyType(EOProperty) to handle exceptions if the userInfo dictionary is null, there is no ERXCopyable.CopyType key, or the value for the key is null or invalid.
static <T extends ERXCopyable<T>> T	deepCopy(NSMutableDictionary<com.webobjects.eocontrol.EOGlobalID,ERXCopyable<?>> copiedObjects, T source) Returns a deep copy of this object, the attribute values are reference copied and the relationships are copied by calling ERXCopyable.copy(NSMutableDictionary) on them.
static <T extends ERXCopyable<T>> void	deepCopyClassRelationships(NSMutableDictionary<com.webobjects.eocontrol.EOGlobalID,ERXCopyable<?>> copiedObjects, T source, T destination) This copies related objects from the source ERXCopyable to the destination by calling deepCopyRelationship on them.
static <T extends ERXCopyable<T>> void	deepCopyRelationship(NSMutableDictionary<com.webobjects.eocontrol.EOGlobalID,ERXCopyable<?>> copiedObjects, T source, T destination, com.webobjects.eoaccess.EORelationship relationship) This copies the object(s) for the named relationship from the source ERXCopyable to the destination by calling ERXCopyable.copy(NSMutableDictionary) on them.
static <T extends ERXCopyable<T>> void	deepCopyToManyRelationship(NSMutableDictionary<com.webobjects.eocontrol.EOGlobalID,ERXCopyable<?>> copiedObjects, T source, T destination, com.webobjects.eoaccess.EORelationship relationship)
static <T extends ERXCopyable<T>> void	deepCopyToOneRelationship(NSMutableDictionary<com.webobjects.eocontrol.EOGlobalID,ERXCopyable<?>> copiedObjects, T source, T destination, com.webobjects.eoaccess.EORelationship relationship)
static <T extends ERXEnterpriseObject> com.webobjects.eoaccess.EOEntity	entity(T enterpriseObject) Returns the entity for the current object.
static NSArray<String>	exposedPKandFKAttributeNames(ERXEnterpriseObject source) Returns an array of attribute names from the EOEntity of source that are used in the primary key, or in forming relationships.
static NSArray<EOAttribute>	exposedPKAndFKAttributes(ERXEnterpriseObject source) Returns an array of class EOAttributes from the EOEntity of source that are used in the primary key, or in forming EORelationships.
static com.webobjects.eocontrol.EOGlobalID	globalIDForObject(ERXEnterpriseObject enterpriseObject) Convenience method to get EOGlobalID for an EOEnterpriseObject from its own EOEditingContext.
static void	handleMissingERXCopyableKey(Class<?> invalidClass)
static void	handleMissingOrInvalidCopyType(com.webobjects.eoaccess.EOProperty property, ERXCopyable.CopyType copyType) Creates a meaningful error message to be displayed when modelCopy was specified for the ERXCopyable key in an Entity's UserInfo dictionary, but not all attributes and relationships have a valid ERXCopyable.CopyType specified.
static <T extends ERXCopyable<T>> T	modelCopy(NSMutableDictionary<com.webobjects.eocontrol.EOGlobalID,ERXCopyable<?>> copiedObjects, T source) Creates a new instance of the source's Entity, then steps through all attributes and relationships, copying them as defined in each property's UserInfo dictionary in the EOModel.
static <T extends ERXCopyable<T>> void	modelCopyAttribute(T source, T destination, EOAttribute attribute)
static <T extends ERXCopyable<T>> void	modelCopyClassAttributes(T source, T destination)
static <T extends ERXCopyable<T>> void	modelCopyClassRelationships(NSMutableDictionary<com.webobjects.eocontrol.EOGlobalID,ERXCopyable<?>> copiedObjects, T source, T destination) Reads the values set in the EOModel's attribute and relationship UserInfo dictionaries and then uses them to control how the source object is copied.
static <T extends ERXCopyable<T>> void	modelCopyRelationship(NSMutableDictionary<com.webobjects.eocontrol.EOGlobalID,ERXCopyable<?>> copiedObjects, T source, T destination, com.webobjects.eoaccess.EORelationship relationship) Reads the values set in the EOModel's attribute and relationship UserInfo dictionaries and then uses them to control how the source object is copied.
static <T extends ERXEnterpriseObject> T	newInstance(T source) This creates and returns a new, completely empty instance of the same Entity as source.
static NSArray<EOAttribute>	primaryAndForeignKeyAttributes(ERXEnterpriseObject source)
static String	propertyType(com.webobjects.eoaccess.EOProperty property)
static <T extends ERXEnterpriseObject> T	referenceCopy(T source) Returns a copy of this object by reference.
static <T extends ERXEnterpriseObject> void	referenceCopyClassRelationships(T source, T destination) This copies all objects for all class-property relationships from the source onto the destination.
static <T extends ERXEnterpriseObject> void	referenceCopyRelationship(T source, T destination, com.webobjects.eoaccess.EORelationship relationship)
static <T extends ERXEnterpriseObject> void	referenceCopyToManyClassRelationships(T source, T destination) This copies to-one related objects from the source ERXCopyable to the destination by reference.
static <T extends ERXEnterpriseObject,E extends ERXEnterpriseObject> void	referenceCopyToManyRelationship(T source, T destination, com.webobjects.eoaccess.EORelationship relationship)
static <T extends ERXEnterpriseObject> void	referenceCopyToOneClassRelationships(T source, T destination) This copies related objects from the source ERXCopyable to the destination by reference.
static <T extends ERXEnterpriseObject,E extends ERXEnterpriseObject> void	referenceCopyToOneRelationship(T source, T destination, com.webobjects.eoaccess.EORelationship relationship)
static <T extends ERXEnterpriseObject> T	shallowCopy(T source) Returns a shallow copy of this object, the attribute and relationships are copied by reference.
static <T extends ERXEnterpriseObject> void	shallowCopyRelationship(T source, T destination, com.webobjects.eoaccess.EORelationship relationship)
static <T extends ERXEnterpriseObject> void	shallowCopyToManyRelationship(T source, T destination, com.webobjects.eoaccess.EORelationship relationship) Creates a new instance for each of the of the source's related objects' Entity and reference copies the attributes and relationships to it
static <T extends ERXEnterpriseObject> void	shallowCopyToOneRelationship(T source, T destination, com.webobjects.eoaccess.EORelationship relationship) Creates a new instance of the source's related object's Entity and reference copies the attributes and relationships to it

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_exposedPKAndFKAttributeDictionary

protected static volatile NSMutableDictionary<String,NSArray<EOAttribute>> _exposedPKAndFKAttributeDictionary

_classAttributesDictionary

protected static volatile NSMutableDictionary<String,NSArray<EOAttribute>> _classAttributesDictionary

_classRelationshipsDictionary

protected static volatile NSMutableDictionary<String,NSArray<com.webobjects.eoaccess.EORelationship>> _classRelationshipsDictionary

Constructor Detail

Utility

public Utility()

Method Detail

entity

public static <T extends ERXEnterpriseObject> com.webobjects.eoaccess.EOEntity entity(T enterpriseObject)

Returns the entity for the current object. Defers to ERXEOAccessUtilities.entityNamed() for the actual work.

Type Parameters:

T - the Type of the enterpriseObject

Parameters:

enterpriseObject -

Returns:

EOEntity of the enterpriseObject

cleanRelationships

public static <T extends ERXEnterpriseObject> void cleanRelationships(T source,
                                                                      T destination)

When an EO object is created it can already have some relationships set. This can come from to one relationships that are marked as 'owns destination' and also from the effects of awakeFromInsertion() and need some special handling prior to making a copy.

1. All objects are disconnected from the relationship.
2. If a disconnected object has a temporary EOGlobalID it is deleted.

Type Parameters:

T - the Type of the source and destination

Parameters:

source - the ERXCopyable that copy was created from

destination - the newly instantiated copy of source that needs to have its relationships cleaned

copyClassAttributes

public static <T extends ERXEnterpriseObject> void copyClassAttributes(T source,
                                                                       T destination)

This copies only the class attributes from the source ERXCopyable to the destination. However if an attribute is a class property and also used in a relationship it is assumed to be an exposed primary- or foreign-key and are not copied. Such attributes are set to null. See #exposedPKandFKAttributeNames(ERXCopyable) for details on how this is determined. It can be used when creating custom implementations of the ERXCopyable.duplicate(NSMutableDictionary) method.

Type Parameters:

T - the Type of the source and destination

Parameters:

source - object to copy attribute values from

destination - object to copy attribute values to

copyAttribute

public static <T extends ERXEnterpriseObject> void copyAttribute(T source,
                                                                 T destination,
                                                                 EOAttribute attribute)

Type Parameters:

T - the Type of the source and destination

Parameters:

source - object to copy the attribute value from

destination - object to copy the attribute value to

attribute - the EOAttribute that should have its value copied

Since:

Feb 10, 2013

deepCopy

public static <T extends ERXCopyable<T>> T deepCopy(NSMutableDictionary<com.webobjects.eocontrol.EOGlobalID,ERXCopyable<?>> copiedObjects,
                                                    T source)

Returns a deep copy of this object, the attribute values are reference copied and the relationships are copied by calling ERXCopyable.copy(NSMutableDictionary) on them. Thus each related object will be copied based on its own implementation of the ERXCopyable.duplicate(NSMutableDictionary) method. The copy is registered with copiedObjects dictionary as soon as it is created so that circular relationships can be safely copied without triggering infinite loops. This method of copying is suitable for duplicating complex graphs of objects.

Type Parameters:

T - the Type of the source object

Parameters:

copiedObjects - the dictionary of objects that have already been copied, keyed on the EOGlobalIDs of the source object that the copy was made from.

source - the subclass of ERXCopyable to copy

Returns:

a copy of this object

deepCopyClassRelationships

public static <T extends ERXCopyable<T>> void deepCopyClassRelationships(NSMutableDictionary<com.webobjects.eocontrol.EOGlobalID,ERXCopyable<?>> copiedObjects,
                                                                         T source,
                                                                         T destination)

This copies related objects from the source ERXCopyable to the destination by calling deepCopyRelationship on them. It can be used when creating custom implementations of the duplicate() method in ERXCopyable. Only relationships which are class properties are copied.

Type Parameters:

T - the Type of the source and destination

Parameters:

copiedObjects - the copied objects keyed on the EOGlobalID of the object the copy was made from

source - the subclass of ERXCopyable to copy attribute values from

destination - the subclass of ERXCopyable to copy attribute values to

classRelationships

public static NSArray<com.webobjects.eoaccess.EORelationship> classRelationships(com.webobjects.eoaccess.EOEntity entity)

Parameters:

entity - the EOEntity for the object being copied

Returns:

an array of EOAttributes that are designated as class attributes in the entity

deepCopyRelationship

public static <T extends ERXCopyable<T>> void deepCopyRelationship(NSMutableDictionary<com.webobjects.eocontrol.EOGlobalID,ERXCopyable<?>> copiedObjects,
                                                                   T source,
                                                                   T destination,
                                                                   com.webobjects.eoaccess.EORelationship relationship)

This copies the object(s) for the named relationship from the source ERXCopyable to the destination by calling ERXCopyable.copy(NSMutableDictionary) on them. Thus each related object will be copied by its own reference, shallow, deep, or custom ERXCopyable.duplicate(NSMutableDictionary) method. It can be used when creating custom implementations of the ERXCopyable.duplicate(NSMutableDictionary) method.

Type Parameters:

T - the Type of the source and destination

Parameters:

copiedObjects - the copied objects keyed on the EOGlobalID of the object the copy was made from

source - the subclass of ERXCopyable to copy attribute values from

destination - the subclass of ERXCopyable to copy attribute values to

relationship - the EORelationship to copy

deepCopyToOneRelationship

public static <T extends ERXCopyable<T>> void deepCopyToOneRelationship(NSMutableDictionary<com.webobjects.eocontrol.EOGlobalID,ERXCopyable<?>> copiedObjects,
                                                                        T source,
                                                                        T destination,
                                                                        com.webobjects.eoaccess.EORelationship relationship)

Type Parameters:

T - the Type of the source and destination

Parameters:

copiedObjects - the copied objects keyed on the EOGlobalID of the object the copy was made from

source - the subclass of ERXCopyable to copy attribute values from

destination - the subclass of ERXCopyable to copy attribute values to

relationship - the to-one EORelationship to copy

deepCopyToManyRelationship

public static <T extends ERXCopyable<T>> void deepCopyToManyRelationship(NSMutableDictionary<com.webobjects.eocontrol.EOGlobalID,ERXCopyable<?>> copiedObjects,
                                                                         T source,
                                                                         T destination,
                                                                         com.webobjects.eoaccess.EORelationship relationship)

Type Parameters:

T - the Type of the source and destination

Parameters:

copiedObjects - the copied objects keyed on the EOGlobalID of the object the copy was made from

source - the subclass of ERXCopyable to copy attribute values from

destination - the subclass of ERXCopyable to copy attribute values to

relationship - the to-many EORelationship to copy

exposedPKandFKAttributeNames

public static NSArray<String> exposedPKandFKAttributeNames(ERXEnterpriseObject source)

Returns an array of attribute names from the EOEntity of source that are used in the primary key, or in forming relationships. These can be presumed to be exposed primary or foreign keys and must be handled differently when copying an object.

Parameters:

source - the ERXCopyable to copy attribute values from

Returns:

an array of EOAttribute.name() values from the source's EOEntity that are used in forming EORelationships.

exposedPKAndFKAttributes

public static NSArray<EOAttribute> exposedPKAndFKAttributes(ERXEnterpriseObject source)

Returns an array of class EOAttributes from the EOEntity of source that are used in the primary key, or in forming EORelationships. These are presumed to be exposed primary- or foreign-keys and must be handled differently when copying an object.

Parameters:

source - the subclass of ERXCopyable that will be copied

Returns:

an array of attribute names from the EOEntity of source that are used in forming relationships.

classAttributes

public static NSArray<EOAttribute> classAttributes(com.webobjects.eoaccess.EOEntity entity)

Parameters:

entity - the EOEntity for the object being copied

Returns:

an array of EOAttributes that are designated as class attributes in the entity

globalIDForObject

public static com.webobjects.eocontrol.EOGlobalID globalIDForObject(ERXEnterpriseObject enterpriseObject)

Convenience method to get EOGlobalID for an EOEnterpriseObject from its own EOEditingContext.

Parameters:

enterpriseObject - the EOEnterpriseObject to return the EOGlobalID for

Returns:

the EOGlobalID of the enterpriseObject parameter

newInstance

public static <T extends ERXEnterpriseObject> T newInstance(T source)

This creates and returns a new, completely empty instance of the same Entity as source.

The reason that copying should use this method is because when an EO object is created it can already have some relationships and attributes set. These can come from to one relationships that are marked as 'owns destination' and also from awakeFromInsertion(). Preset/default attributes will be overwritten when all attributes are copied, but the relationships need some special handling. See the method Utility#cleanRelationships(ERXCopyable, ERXCopyable) for details on what is done.

This method is for use in custom implementations of ERXCopyable.duplicate(NSMutableDictionary).

Type Parameters:

T - the Type of the source

Parameters:

source - the subclass of ERXCopyable to copy

Returns:

a new instance of the same Entity as source

referenceCopy

public static <T extends ERXEnterpriseObject> T referenceCopy(T source)

Returns a copy of this object by reference. This simply returns the receiver. This method of copying is suitable for lookup list / enumeration items and other objects which should never be duplicated.

Type Parameters:

T - the Type of the source

Parameters:

source - the subclass of ERXCopyable to copy

Returns:

a copy of this object

shallowCopy

public static <T extends ERXEnterpriseObject> T shallowCopy(T source)

Returns a shallow copy of this object, the attribute and relationships are copied by reference. This method of copying is suitable for things like an order item where duplication of the product is not wanted and where the order will not be changed (the copied order item will be on the original order, not a copy of it).

Type Parameters:

T - the Type of the source

Parameters:

source - the subclass of ERXCopyable to copy

Returns:

a copy of this object

referenceCopyClassRelationships

public static <T extends ERXEnterpriseObject> void referenceCopyClassRelationships(T source,
                                                                                   T destination)

This copies all objects for all class-property relationships from the source onto the destination. It can be used when creating custom implementations of ERXCopyable.duplicate(NSMutableDictionary).

Type Parameters:

T - the Type of the source and destination

Parameters:

source - the subclass of ERXCopyable to copy attribute values from

destination - the subclass of ERXCopyable to copy attribute values to

referenceCopyRelationship

public static <T extends ERXEnterpriseObject> void referenceCopyRelationship(T source,
                                                                             T destination,
                                                                             com.webobjects.eoaccess.EORelationship relationship)

Type Parameters:

T - the Type of the source and destination

Parameters:

source - the subclass of ERXCopyable to copy attribute values from

destination - the subclass of ERXCopyable to copy attribute values to

relationship - the EORelationship to copy from the source to the destination

referenceCopyToOneClassRelationships

public static <T extends ERXEnterpriseObject> void referenceCopyToOneClassRelationships(T source,
                                                                                        T destination)

This copies related objects from the source ERXCopyable to the destination by reference. Only relationships which are class properties are copied. It can be used to streamline creating custom implementations of the ERXCopyable.duplicate(NSMutableDictionary) method.

Type Parameters:

T - the Type of the source and destination

Parameters:

source - the subclass of ERXCopyable to copy to-one relationships values from

destination - the subclass of ERXCopyable to copy to-one relationships values to

referenceCopyToOneRelationship

public static <T extends ERXEnterpriseObject,E extends ERXEnterpriseObject> void referenceCopyToOneRelationship(T source,
                                                                                                                T destination,
                                                                                                                com.webobjects.eoaccess.EORelationship relationship)

Type Parameters:

T - the Type of the source and destination

E -

Parameters:

source - the subclass of ERXCopyable to copy the relationship's value from

destination - the subclass of ERXCopyable to copy the relationship's value to

relationship - the EORelationship to copy from the source to the destination

referenceCopyToManyClassRelationships

public static <T extends ERXEnterpriseObject> void referenceCopyToManyClassRelationships(T source,
                                                                                         T destination)

This copies to-one related objects from the source ERXCopyable to the destination by reference. Only relationships which are class properties are copied. It can be used when creating custom implementations of the duplicate() method in ERXCopyable.

Type Parameters:

T - the Type of the source and destination

Parameters:

source - the subclass of ERXCopyable to copy to-many relationship's values from

destination - the subclass of ERXCopyable to copy to-many relationship's values to

referenceCopyToManyRelationship

public static <T extends ERXEnterpriseObject,E extends ERXEnterpriseObject> void referenceCopyToManyRelationship(T source,
                                                                                                                 T destination,
                                                                                                                 com.webobjects.eoaccess.EORelationship relationship)

Type Parameters:

T - the Type of the source and destination

E -

Parameters:

source - the subclass of ERXCopyable to copy the relationship's value(s) from

destination - the subclass of ERXCopyable to copy the relationship's value(s) to

relationship - the EORelationship to copy values for from the source to the destination

Since:

Feb 10, 2013

shallowCopyRelationship

public static <T extends ERXEnterpriseObject> void shallowCopyRelationship(T source,
                                                                           T destination,
                                                                           com.webobjects.eoaccess.EORelationship relationship)

Type Parameters:

T - the Type of the source and destination

Parameters:

source - the subclass of ERXCopyable to copy attribute values from

destination - the subclass of ERXCopyable to copy attribute values to

relationship - the EORelationship to copy from the source to the destination

shallowCopyToManyRelationship

public static <T extends ERXEnterpriseObject> void shallowCopyToManyRelationship(T source,
                                                                                 T destination,
                                                                                 com.webobjects.eoaccess.EORelationship relationship)

Creates a new instance for each of the of the source's related objects' Entity and reference copies the attributes and relationships to it

Type Parameters:

T - the Type of the source and destination

Parameters:

source - the subclass of ERXCopyable to copy the relationship's value(s) from

destination - the subclass of ERXCopyable to copy the relationship's value(s) to

relationship - the EORelationship to copy values for from the source to the destination

Since:

Feb 10, 2013

shallowCopyToOneRelationship

public static <T extends ERXEnterpriseObject> void shallowCopyToOneRelationship(T source,
                                                                                T destination,
                                                                                com.webobjects.eoaccess.EORelationship relationship)

Creates a new instance of the source's related object's Entity and reference copies the attributes and relationships to it

Type Parameters:

T - the Type of the source and destination

Parameters:

source - the subclass of ERXCopyable to copy the relationship's value from

destination - the subclass of ERXCopyable to copy the relationship's value to

relationship - the EORelationship to copy from the source to the destination

modelCopy

public static <T extends ERXCopyable<T>> T modelCopy(NSMutableDictionary<com.webobjects.eocontrol.EOGlobalID,ERXCopyable<?>> copiedObjects,
                                                     T source)

Creates a new instance of the source's Entity, then steps through all attributes and relationships, copying them as defined in each property's UserInfo dictionary in the EOModel.

To make use of this method of copying an EO, simply override the duplicate(NSMutableDictionary) method in your EO with the following:

 public MyEO duplicate(NSMutableDictionary<EOGlobalID, ERXCopyable<?>> copiedObjects) {
        MyEO duplicate = ERXCopyable.Utility.modelCopy(copiedObjects, (MyEO) this);
        return duplicate;
 }
 

Type Parameters:

T - the Type of the source and returned objects

Parameters:

copiedObjects - the copied objects keyed on the EOGlobalID of the object the copy was made from.

source - the subclass of ERXCopyable to copy

Returns:

a copy of the source object in the same EOEditingContext

Author:

David Avendasora

modelCopyClassRelationships

public static <T extends ERXCopyable<T>> void modelCopyClassRelationships(NSMutableDictionary<com.webobjects.eocontrol.EOGlobalID,ERXCopyable<?>> copiedObjects,
                                                                          T source,
                                                                          T destination)

Reads the values set in the EOModel's attribute and relationship UserInfo dictionaries and then uses them to control how the source object is copied.

Type Parameters:

T - the Type of the source and destination

Parameters:

copiedObjects - the copied objects keyed on the EOGlobalID of the object the copy was made from.

source - the subclass of ERXCopyable to copy all (to-one and to-many) class relationships values from

destination - the subclass of ERXCopyable to copy all (to-one and to-many) class relationships values to

modelCopyRelationship

public static <T extends ERXCopyable<T>> void modelCopyRelationship(NSMutableDictionary<com.webobjects.eocontrol.EOGlobalID,ERXCopyable<?>> copiedObjects,
                                                                    T source,
                                                                    T destination,
                                                                    com.webobjects.eoaccess.EORelationship relationship)

Reads the values set in the EOModel's attribute and relationship UserInfo dictionaries and then uses them to control how the source object is copied.

Type Parameters:

T - the Type of the source and destination objects

Parameters:

copiedObjects - the copied objects keyed on the EOGlobalID of the object the copy was made from. the Type of the source and destination

source - the subclass of ERXCopyable to copy the relationship's value(s) from

destination - the subclass of ERXCopyable to copy the relationship's value(s) to

relationship - the EORelationship to copy values for from the source to the destination

modelCopyClassAttributes

public static <T extends ERXCopyable<T>> void modelCopyClassAttributes(T source,
                                                                       T destination)

Type Parameters:

T - the Type of the source and destination objects

Parameters:

source - the subclass of ERXCopyable to copy the class attribute values from

destination - the subclass of ERXCopyable to copy the class attribute values to

modelCopyAttribute

public static <T extends ERXCopyable<T>> void modelCopyAttribute(T source,
                                                                 T destination,
                                                                 EOAttribute attribute)

Type Parameters:

T - the Type of the source and destination objects

Parameters:

source - the subclass of ERXCopyable to copy the attribute's value from

destination - the subclass of ERXCopyable to copy the attribute's value to

attribute - the EOAttribute that should have its value copied from the source to the destination

copyType

public static ERXCopyable.CopyType copyType(com.webobjects.eoaccess.EOProperty property)

Parameters:

property - the attribute or relationship being copied

Returns:

the ERXCopyable.CopyType value specified for the ERXCopyable.CopyType key in the property's UserInfo dictionary in the EOModel

copyType

public static ERXCopyable.CopyType copyType(com.webobjects.eoaccess.EOProperty property,
                                            NSDictionary<String,Object> userInfo)

Abstracted out of copyType(EOProperty) to handle exceptions if the userInfo dictionary is null, there is no ERXCopyable.CopyType key, or the value for the key is null or invalid.

Parameters:

property - the attribute or relationship being copied

userInfo - the property's UserInfo dictionary that contains a ERXCopyable.CopyType key

Returns:

the ERXCopyable.CopyType value specified for the ERXCopyable.CopyType key in userInfo dictionary for property's UserInfo dictionary in the EOModel

handleMissingERXCopyableKey

public static void handleMissingERXCopyableKey(Class<?> invalidClass)

handleMissingOrInvalidCopyType

public static void handleMissingOrInvalidCopyType(com.webobjects.eoaccess.EOProperty property,
                                                  ERXCopyable.CopyType copyType)

Creates a meaningful error message to be displayed when modelCopy was specified for the ERXCopyable key in an Entity's UserInfo dictionary, but not all attributes and relationships have a valid ERXCopyable.CopyType specified.

Parameters:

property - the attribute or relationship being copied

copyType - the invalid ERXCopyable.CopyType specified in the property's UserInfo dictionary in the EOModel

propertyType

public static String propertyType(com.webobjects.eoaccess.EOProperty property)

Parameters:

property - the attribute or relationship being copied

Returns:

"attribute" if the passed in property is an instance of EOAttribute, "relationship" if it is an instance of EORelationship

primaryAndForeignKeyAttributes

public static NSArray<EOAttribute> primaryAndForeignKeyAttributes(ERXEnterpriseObject source)

Parameters:

source - the subclass of ERXCopyable that is being copied

Returns:

an array of EOAttributes that are the Primary- and Foreign-Key attributes for the source subclass of ERXCopyable