er.extensions.eof

Interface ERXCopyable<T extends ERXCopyable<T>>

Type Parameters:

T - the specific subclass of ERXCopyable that is being copied

All Superinterfaces:

com.webobjects.eocontrol.EODeferredFaulting, com.webobjects.eocontrol.EOEnterpriseObject, com.webobjects.eocontrol.EOFaulting, com.webobjects.eocontrol.EOKeyValueCoding, com.webobjects.eocontrol.EOKeyValueCodingAdditions, com.webobjects.eocontrol.EORelationshipManipulation, com.webobjects.eocontrol.EOValidation, ERXEnterpriseObject, com.webobjects.foundation.NSKeyValueCoding, com.webobjects.foundation.NSKeyValueCoding.ErrorHandling, com.webobjects.foundation.NSKeyValueCodingAdditions, com.webobjects.foundation.NSValidation, Serializable

public interface ERXCopyable<T extends ERXCopyable<T>>
extends ERXEnterpriseObject

This class specifies an interface for flexible copying of EOEnterpriseObjects, a default implementation for doing the actual copying, and a Utility class that provides convenience methods to make implementing the interface easier.

There are several ways to implement this interface:

1. Manually implement the interface in each Entity.java class that you want to be able to copy
   This is the quickest way to get started. Simply add specify that your EO implements ERXCopyable<MyEntity> in the class declaration, then implement the required methods. Here is what you'll need to add to get started:

   
    @Override
    public MyEntity copy() {
           MyEntity copy = copy(new NSMutableDictionary<EOGlobalID, ERXCopyable<?>>());
           return copy;
    }
    
    @Override
    public MyEntity copy(NSMutableDictionary<EOGlobalID, ERXCopyable<?>> copiedObjects) {
           MyEntity copy = ERXCopyable.DefaultImplementation.copy(copiedObjects, (MyEntity) this);
           return copy;
    }
    
    @Override
    public MyEntity duplicate(NSMutableDictionary<EOGlobalID, ERXCopyable<?>> copiedObjects) {
           MyEntity duplicate = ERXCopyable.Utility.deepCopy(copiedObjects, (MyEntity) this);
           return duplicate;
    }
    

2. Manually implement the interface in a ERXGenericRecord subclass
   This is almost as easy as option #1 but has the added advantage of allowing you to implement the interface just once, and then override the default behavior as needed for individual EOs. Simply specify that your ERXGenericRecord subclass implements ERXCopyable<MyGenericRecord> in the class declaration and then implement the required methods. The defaults are very similar to option #1:

   
    @Override
    public MyGenericRecord copy() {
           MyGenericRecord copy = copy(new NSMutableDictionary<EOGlobalID, ERXCopyable<?>>());
           return copy;
    }
    
    @Override
    public MyGenericRecord copy(NSMutableDictionary<EOGlobalID, ERXCopyable<?>> copiedObjects) {
           MyGenericRecord copy = ERXCopyable.DefaultImplementation.copy(copiedObjects, this);
           return copy;
    }
    
    @Override
    public MyGenericRecord duplicate(NSMutableDictionary<EOGlobalID, ERXCopyable<?>> copiedObjects) {
           MyGenericRecord duplicate = ERXCopyable.Utility.deepCopy(copiedObjects, this);
           return duplicate;
    }
    

3. Add UserInfo dictionary entries into your EOModel and make some additions to your EOGenerator templates that will automatically implement this interface based on your model settings.
   This option is the most powerful and flexible, and requires the least amount of ongoing programming, but takes more work to get setup. It's well worth it if you are going to be implementing ERXCopyable on more than just a few EOs. Here's what you'll need to do:
   1. Create or modify your own EOGenerator template with the following additions:
      • In the imports section, add the following:

          #if(${entity.userInfo.ERXCopyable})
          import er.extensions.eof.ERXCopyable;
          #end
         

      • At the very end of the class declaration line (just prior to the opening '{') insert the following:

         #if(${entity.userInfo.ERXCopyable}) implements ERXCopyable<${entity.classNameWithOptionalPackage}>#end
         

      • Somewhere in the body of the class (immediately before the closing '}' at the end of the template is easiest) insert the following:

          #if(${entity.userInfo.ERXCopyable} == 'Model' || ${entity.userInfo.ERXCopyable} == 'Default')
         
         
             public ${entity.classNameWithOptionalPackage} copy() {
                 $entity.classNameWithOptionalPackage copy = copy(new NSMutableDictionary<EOGlobalID, ERXCopyable<?>>());
                 return copy;
             }
         
             public ${entity.classNameWithOptionalPackage} copy(NSMutableDictionary<EOGlobalID, ERXCopyable<?>> copiedObjects) {
                 ${entity.classNameWithOptionalPackage} copy = duplicate(copiedObjects);
                 return copy;
             }
         
             public ${entity.classNameWithOptionalPackage} duplicate(NSMutableDictionary<EOGlobalID, ERXCopyable<?>> copiedObjects) {
         #if(${entity.userInfo.ERXCopyable} == 'Model')
                 ${entity.classNameWithOptionalPackage} duplicate = ERXCopyable.Utility.modelCopy(copiedObjects, (${entity.classNameWithOptionalPackage}) this);
         #elseif(${entity.userInfo.ERXCopyable} == 'Default')
                 ${entity.classNameWithOptionalPackage} duplicate = ERXCopyable.Utility.deepCopy(copiedObjects, (${entity.classNameWithOptionalPackage}) this);
         #end
                 return duplicate;
             }
         #end
         

Author:

Chuck Hill, Sacha Mallais, David Avendasora

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ERXCopyable.CopyType Enum that specifies the valid ways in which an EOModel's EOPropertys can be copied.
static class	ERXCopyable.DefaultImplementation This class provides a default implementation of ERXCopyable that handles the most common situations encountered copying EOEnterpriseObject s.
static class	ERXCopyable.Utility This class provides utility methods for use implementing ERXCopyable.

Nested classes/interfaces inherited from interface er.extensions.eof.ERXEnterpriseObject

ERXEnterpriseObject.Observer, ERXEnterpriseObject.Processor

Nested classes/interfaces inherited from interface com.webobjects.eocontrol.EOKeyValueCoding

com.webobjects.eocontrol.EOKeyValueCoding._BestBindingCreation, com.webobjects.eocontrol.EOKeyValueCoding._KeyBindingCreation, com.webobjects.eocontrol.EOKeyValueCoding._StoredForwardingBinding

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSKeyValueCoding

com.webobjects.foundation.NSKeyValueCoding._BooleanFieldBinding, com.webobjects.foundation.NSKeyValueCoding._BooleanMethodBinding, com.webobjects.foundation.NSKeyValueCoding._FieldBinding, com.webobjects.foundation.NSKeyValueCoding._ForwardingBinding, com.webobjects.foundation.NSKeyValueCoding._KeyBinding, com.webobjects.foundation.NSKeyValueCoding._MethodBinding, com.webobjects.foundation.NSKeyValueCoding._NumberFieldBinding, com.webobjects.foundation.NSKeyValueCoding._NumberMethodBinding, com.webobjects.foundation.NSKeyValueCoding._ReflectionKeyBindingCreation, com.webobjects.foundation.NSKeyValueCoding.ErrorHandling, com.webobjects.foundation.NSKeyValueCoding.MapImplementation, com.webobjects.foundation.NSKeyValueCoding.Null<T>, com.webobjects.foundation.NSKeyValueCoding.UnknownKeyException, com.webobjects.foundation.NSKeyValueCoding.ValueAccessor

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSValidation

com.webobjects.foundation.NSValidation._MethodBinding, com.webobjects.foundation.NSValidation._ValidationBinding, com.webobjects.foundation.NSValidation.ValidationException

Field Summary

Fields

Modifier and Type	Field and Description
static String	COPY_TYPE_KEY "ERXCopyable.CopyType" which is the exact String that must be used as the key in an Attribute's or Relationship's EOModel UserInfo dictionary to specify the way the property should be copied by ERXCopyable.
static org.slf4j.Logger	copyLogger
static String	ERXCOPYABLE_KEY "ERXCopyable" which is the exact String that must be used as the key in the Entity's EOModel UserInfo dictionary to designate it as implementing ERXCopyable interface.

Fields inherited from interface er.extensions.eof.ERXEnterpriseObject

applyRestrictingQualifierOnInsert, DidDeleteProcessor, DidInsertProcessor, DidRevertProcessor, DidUpdateProcessor, FlushCachesProcessor, insertionTrackingLog, KEY_MARKER, log, logMod, tranLogDidDelete, tranLogDidInsert, tranLogDidRevert, tranLogDidUpdate, tranLogMightDelete, tranLogWillDelete, tranLogWillInsert, tranLogWillRevert, tranLogWillUpdate, validation, validationException, WillDeleteProcessor, WillInsertProcessor, WillRevertProcessor, WillUpdateProcessor

Fields inherited from interface com.webobjects.eocontrol.EOEnterpriseObject

_CLASS

Fields inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions

_KeyPathSeparatorChar, KeyPathSeparator

Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding

NullValue

Method Summary

Modifier and Type	Method and Description
T	copy() Convenience cover method for copy(NSMutableDictionary) that creates the dictionary for you.
T	copy(NSMutableDictionary<com.webobjects.eocontrol.EOGlobalID,ERXCopyable<?>> copiedObjects) Returns a copy of this object, copying related objects as well.
T	duplicate(NSMutableDictionary<com.webobjects.eocontrol.EOGlobalID,ERXCopyable<?>> copiedObjects) Returns a copy of this object.

Methods inherited from interface er.extensions.eof.ERXEnterpriseObject

_setUpdateInverseRelationships, addObjectsToBothSidesOfRelationshipWithKey, changesFromCommittedSnapshot, committedSnapshotValueForKey, didDelete, didInsert, didRevert, didUpdate, encryptedPrimaryKey, flushCaches, foreignKeyForRelationshipWithKey, getClassLog, isDeletedEO, isNewObject, localInstanceIn, localInstanceOf, localInstancesOf, mightDelete, parentObjectStoreIsObjectStoreCoordinator, primaryKey, primaryKeyAttributeNames, primaryKeyInTransaction, rawPrimaryKey, rawPrimaryKeyInTransaction, refetchObjectFromDBinEditingContext, removeObjectsFromBothSidesOfRelationshipWithKey, removeObjectsFromPropertyWithKey, self, toLongString, trimSpaces, willDelete, willInsert, willRevert, willUpdate

Methods inherited from interface com.webobjects.eocontrol.EOEnterpriseObject

allPropertyKeys, attributeKeys, awakeFromClientUpdate, awakeFromFetch, awakeFromInsertion, changesFromSnapshot, classDescription, classDescriptionForDestinationKey, clearProperties, deleteRuleForRelationshipKey, editingContext, entityName, eoDescription, eoShallowDescription, inverseForRelationshipKey, invokeRemoteMethod, isReadOnly, isToManyKey, opaqueState, ownsDestinationObjectsForRelationshipKey, prepareValuesForClient, propagateDeleteWithEditingContext, reapplyChangesFromDictionary, snapshot, toManyRelationshipKeys, toOneRelationshipKeys, updateFromSnapshot, userPresentableDescription, willChange

Methods inherited from interface com.webobjects.eocontrol.EOKeyValueCodingAdditions

takeValuesFromDictionary, takeValuesFromDictionaryWithMapping, valuesForKeys, valuesForKeysWithMapping

Methods inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions

takeValueForKeyPath, valueForKeyPath

Methods inherited from interface com.webobjects.eocontrol.EOKeyValueCoding

storedValueForKey, takeStoredValueForKey

Methods inherited from interface com.webobjects.foundation.NSKeyValueCoding

takeValueForKey, valueForKey

Methods inherited from interface com.webobjects.foundation.NSKeyValueCoding.ErrorHandling

handleQueryWithUnboundKey, handleTakeValueForUnboundKey, unableToSetNullForKey

Methods inherited from interface com.webobjects.eocontrol.EORelationshipManipulation

addObjectToBothSidesOfRelationshipWithKey, addObjectToPropertyWithKey, removeObjectFromBothSidesOfRelationshipWithKey, removeObjectFromPropertyWithKey

Methods inherited from interface com.webobjects.eocontrol.EOValidation

validateClientUpdate, validateForDelete, validateForInsert, validateForSave, validateForUpdate

Methods inherited from interface com.webobjects.foundation.NSValidation

validateTakeValueForKeyPath, validateValueForKey

Methods inherited from interface com.webobjects.eocontrol.EODeferredFaulting

willReadRelationship

Methods inherited from interface com.webobjects.eocontrol.EOFaulting

clearFault, faultHandler, isFault, turnIntoFault, willRead

Field Detail

copyLogger

static final org.slf4j.Logger copyLogger

ERXCOPYABLE_KEY

static final String ERXCOPYABLE_KEY

"ERXCopyable" which is the exact String that must be used as the key in the Entity's EOModel UserInfo dictionary to designate it as implementing ERXCopyable interface.

COPY_TYPE_KEY

static final String COPY_TYPE_KEY

"ERXCopyable.CopyType" which is the exact String that must be used as the key in an Attribute's or Relationship's EOModel UserInfo dictionary to specify the way the property should be copied by ERXCopyable.

Method Detail

copy

T copy()

Convenience cover method for copy(NSMutableDictionary) that creates the dictionary for you. You can use this to start the copying of a graph if you have no need to reference the dictionary.

Returns:

a copy of this object

copy

T copy(NSMutableDictionary<com.webobjects.eocontrol.EOGlobalID,ERXCopyable<?>> copiedObjects)

Returns a copy of this object, copying related objects as well. The actual copy mechanism (by reference, deep, or custom) for each object is up to the object being copied. If a copy already exists in copiedObjects, then that copy is returned instead of making a new copy. This allows complex graphs of objects, including those with cycles, to be copied without producing duplicate objects. The graph of copied objects will be the same regardless of where copy is started with two exceptions: if it is started on a reference copied object or if a reference copied object is the only path between two disconnected parts of the graph. In these cases the reference copied object prevents the copy from following the graph further.

Parameters:

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

Returns:

a copy of this object

duplicate

T duplicate(NSMutableDictionary<com.webobjects.eocontrol.EOGlobalID,ERXCopyable<?>> copiedObjects)

Returns a copy of this object. Each ERXCopyable should implement this to produce the actual copy by an appropriate mechanism (reference, shallow, deep, or custom).

Parameters:

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

Returns:

a copy of this object