ERXEOControlUtilities (Project Wonder Reference Documentation)

java.lang.Object
- er.extensions.eof.ERXEOControlUtilities

```
public class ERXEOControlUtilities
extends Object
```
Collection of EOF utility method centered around EOControl. EOControl provides infrastructure for creating and managing enterprise objects.

Constructor Summary

Constructors
Constructor and Description

ERXEOControlUtilities()

Constructors
Constructor and Description
`ERXEOControlUtilities()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Object`	`_aggregateFunctionWithQualifier(EOEditingContext ec, String entityName, String attributeName, String function, Class valueClass, String valueType, EOQualifier qualifier)`
`static Object`	`_aggregateFunctionWithQualifierAndAggregateAttribute(EOEditingContext ec, String entityName, EOQualifier qualifier, EOAttribute aggregateAttribute)` Returns the number of objects in the database with the qualifier and counting attribute.
`static String`	`_stringForPrimaryKey(Object pk)` Returns the propertylist-encoded string representation of the primary key for a given object.
`static void`	`addObjectToObjectOnBothSidesOfRelationshipWithKey(EOEnterpriseObject addedObject, EOEnterpriseObject referenceObject, String key)` Adds an object to another objects relationship.
`static Number`	`aggregateFunctionWithQualifier(EOEditingContext ec, String entityName, String attributeName, String function, EOQualifier qualifier)` Computes an aggregate function for a given string attribute restricted by a given qualifier.
`static Number`	`aggregateFunctionWithQualifier(EOEditingContext ec, String entityName, String attributeName, String function, String fetchSpecificationName, NSDictionary bindings)` Computes an aggregate function for a given attribute restricted by a given qualifier.
`static String`	`aggregateStringWithQualifier(EOEditingContext ec, String entityName, String attributeName, String function, EOQualifier qualifier)` Computes an aggregate function for a given attribute restricted by a given qualifier.
`static NSTimestamp`	`aggregateTimestampWithQualifier(EOEditingContext ec, String entityName, String attributeName, String function, EOQualifier qualifier)` Computes an aggregate function for a given attribute restricted by a given qualifier.
`static EOQualifier`	`andQualifier(EOQualifier q1, EOQualifier q2)` Joins the given qualifiers with an AND.
`static NSArray`	`arrayFromDataSource(EODataSource dataSource)` Converts a data source into an array.
`static NSDictionary<String,Integer>`	`changedRegisteredObjectCount(NSDictionary<String,Integer> currentCounts, NSDictionary<String,Integer> oldCounts)` Returns the changes in count registered objects in the EC grouped by entity name, which is useful for memory debugging.
`static void`	`clearSnapshotForRelationshipNamed(EOEnterpriseObject eo, String relationshipName)` Clears snapshot the relationship of a given enterprise so it will be read again when next accessed.
`static void`	`clearSnapshotForRelationshipNamedInDatabase(EOEnterpriseObject eo, String relationshipName, EODatabase database)` Clears snapshot the relationship of a given enterprise so it will be read again when next accessed.
`static Object`	`convertEOtoGID(Object obj)` Given a dictionary, array, set, EO, etc, this will recursively turn EO's into GID's.
`static Object`	`convertGIDtoEO(EOEditingContext editingContext, Object obj)` Given a dictionary, array, set, EO, etc, this will recursively turn GID's into EO's.
`static EOEnterpriseObject`	`createAndAddObjectToRelationship(EOEditingContext editingContext, EOEnterpriseObject source, String relationshipName, String destinationEntityName, NSDictionary objectInfo)` Creates an object using the utility method `createEO` from this utility class.
`static <T extends EOEnterpriseObject> T`	`createAndInsertObject(EOEditingContext ec, Class<T> eoClass)` Creates an enterprise object for the given entity name by first looking up the class description of the entity to create the enterprise object.
`static EOEnterpriseObject`	`createAndInsertObject(EOEditingContext editingContext, String entityName)` Creates an enterprise object for the given entity name by first looking up the class description of the entity to create the enterprise object.
`static EOEnterpriseObject`	`createAndInsertObject(EOEditingContext editingContext, String entityName, NSDictionary objectInfo)` Creates an enterprise object for the given entity name by first looking up the class description of the entity to create the enterprise object and then adding values from the dictionary.
`static EOArrayDataSource`	`dataSourceForArray(EOEditingContext ec, String entityName, NSArray array)` Simple utility method that will convert an array of enterprise objects into an EOArrayDataSource.
`static EOArrayDataSource`	`dataSourceForArray(NSArray<? extends EOEnterpriseObject> array)` Simple utility method that will convert an array of enterprise objects into an EOArrayDataSource.
`static EODetailDataSource`	`dataSourceForObjectAndKey(EOEnterpriseObject object, String key)` Creates a detail data source for a given enterprise object and a relationship key.
`static NSMutableArray`	`deletedObjects(EOEditingContext editingContext, NSArray<String> entityNames, EOQualifier qualifier)` Return the array of objects of the given type that have been deleted from the editing context and match the given qualifier.
`static String`	`destinationEntityNameForKeyPath(EOEnterpriseObject eo, String keyPath)` Convenience to get the destination entity name from a key path of an object.
`static <T> NSArray<T>`	`distinctValuesForKeyPath(EOEditingContext editingContext, String entityName, String keyPath, EOQualifier qualifier, NSArray<EOSortOrdering> sortOrderings)` Returns an NSArray of distinct values available for the given entity and key path.
`static <T extends EOEnterpriseObject> T`	`editableInstanceOfObject(T eo, boolean createNestedContext)` Creates a new, editable instance of the supplied object.
`static boolean`	`eoEquals(EOEnterpriseObject firstEO, EOEnterpriseObject secondEO)` Determines if two EOs are equal by comparing their EOGlobalIDs.
`static <T extends EOEnterpriseObject> NSArray<T>`	`faultsForGlobalIDs(EOEditingContext ec, NSArray<? extends EOGlobalID> gids)` Returns a NSArray containing EOEnterpriseObjects (actually faults...) for the provided EOGlobalIDs.
`static <T extends EOEnterpriseObject> NSArray<T>`	`faultsForRawRowsFromEntity(EOEditingContext ec, NSArray primKeys, String entityName)`
`static EOFetchSpecification`	`fetchSpecificationNamedWithBindings(String entityName, String fetchSpecificationName, NSDictionary bindings)` Gets a fetch specification from a given entity.
`static NSArray`	`filteredObjectsWithQualifier(EOEditingContext editingContext, NSArray objectsToFilter, String entityName, EOQualifier qualifier, NSArray sortOrderings, boolean usesDistinct, boolean isDeep, boolean includeNewObjects, boolean includeNewObjectsInParentEditingContext, boolean filterUpdatedObjects, boolean removeDeletedObjects)` Utility method used to filter an array of objects given a qualifier.
`static EOGlobalID`	`globalIDForString(EOEditingContext ec, String entityName, String string)` Returns the decoded global id for an propertylist encoded string representation of the primary key for a given object.
`static NSArray<EOGlobalID>`	`globalIDsForObjects(NSArray<? extends EOEnterpriseObject> eos)` Returns a NSArray containing EOGlobalIDs from the provided eos.
`static NSMutableArray`	`insertedObjects(EOEditingContext editingContext, NSArray<String> entityNames, EOQualifier qualifier)` Returns the array of objects of the given type that have been inserted into the editing context and match the given qualifier.
`static boolean`	`isNewObject(EOEnterpriseObject eo)` Determines if an enterprise object is a new object and hasn't been saved to the database yet.
`static <T extends EOEnterpriseObject> T`	`localInstanceOfObject(EOEditingContext ec, T eo)` This has one advantage over the standard EOUtilites method of first checking if the editingcontexts are equal before creating a fault for the object in the editing context.
`static EOQualifier`	`localInstancesInQualifier(EOEditingContext ec, EOQualifier q)` Faults every EO in the qualifiers into the specified editingContext.
`static <T extends EOEnterpriseObject> NSArray<T>`	`localInstancesOfObjects(EOEditingContext ec, NSArray<T> eos)` Provides the same functionality as the equivalent method in `EOUtilities` except it will use the localInstanceOfObject method from this utilities class which has a few enhancements.
`static void`	`makeQualifierTrue(EOQualifier qualifier, Object obj)` Given a qualifier of EOAndQualifiers and EOKVQualifiers, make then evaluate to true on the given object.
`static NSDictionary<String,Object>`	`newPrimaryKeyDictionaryForEntityNamed(EOEditingContext ec, String entityName)` Utility method to generate a new primary key dictionary using the adaptor for a given entity.
`static NSDictionary<String,Object>`	`newPrimaryKeyDictionaryForObject(EOEnterpriseObject eo)` Utility method to generate a new primary key for an object.
`static NSDictionary<String,Object>`	`newPrimaryKeyDictionaryForObjectFromClassProperties(EOEnterpriseObject eo)` Utility method to generate a new primary key dictionary using the objects class properties.
`static Integer`	`objectCountForToManyRelationship(EOEnterpriseObject object, String relationshipName)` Counts the objects in a toMany relationship in an effective way.
`static Integer`	`objectCountUniqueWithQualifierAndAttribute(EOEditingContext ec, String entityName, EOQualifier qualifier, String attributeName)` Returns the number of unique objects matching the given qualifier for a given entity name.
`static Integer`	`objectCountWithQualifier(EOEditingContext ec, String entityName, EOQualifier qualifier)` Returns the number of objects matching the given qualifier for a given entity name.
`static NSArray`	`objectsForFaults(EOEditingContext ec, NSArray possibleFaults)` Triggers all faults in an efficient manner.
`static NSArray`	`objectsForFaultWithSortOrderings(EOEditingContext ec, NSArray possibleFaults, NSArray sortOrderings)` Uses `ERXEOControlUtilities.objectForFaults` to turn the faults into objects, then does in memory ordering with `EOSortOrdering.EOSortOrdering.sortedArrayUsingKeyOrderArray()`
`static <T extends EOEnterpriseObject> NSArray<T>`	`objectsForGlobalIDs(EOEditingContext ec, NSArray<EOGlobalID> globalIDs)` Aggregate method for `EOEditingContext.objectForGlobalID()`.
`static <T extends EOEnterpriseObject> NSArray<T>`	`objectsInRange(EOEditingContext ec, EOFetchSpecification spec, int start, int end)` Returns an `NSArray` containing the objects from the resulting rows starting at start and stopping at end using a custom SQL, derived from the SQL which the `EOFetchSpecification` would use normally `setHints()`
`static <T extends EOEnterpriseObject> NSArray<T>`	`objectsInRange(EOEditingContext ec, EOFetchSpecification spec, int start, int end, boolean rawRowsForCustomQueries)` Returns an `NSArray` containing the objects from the resulting rows starting at start and stopping at end using a custom SQL, derived from the SQL which the `EOFetchSpecification` would use normally `setHints()`
`static NSArray`	`objectsWithQualifier(EOEditingContext ec, String entityName, EOQualifier qualifier, NSArray prefetchKeyPaths, boolean includeNewObjects)` Calls objectsWithQualifier(ec, entityName, qualifier, prefetchKeyPaths, includeNewObjects, false).
`static NSArray`	`objectsWithQualifier(EOEditingContext _editingContext, String _entityName, EOQualifier _qualifier, NSArray _prefetchKeyPaths, boolean _includeNewObjects, boolean _includeNewObjectsInParentEditingContext)`
`static NSArray`	`objectsWithQualifier(EOEditingContext editingContext, String entityName, EOQualifier qualifier, NSArray prefetchKeyPaths, boolean includeNewObjects, boolean includeNewObjectsInParentEditingContext, boolean filterUpdatedObjects, boolean removeDeletedObjects)` Utility method used to fetch an array of objects given a qualifier.
`static NSArray`	`objectsWithQualifier(EOEditingContext editingContext, String entityName, EOQualifier qualifier, NSArray prefetchKeyPaths, NSArray sortOrderings, boolean usesDistinct, boolean isDeep, NSDictionary hints, boolean includeNewObjects, boolean includeNewObjectsInParentEditingContext, boolean filterUpdatedObjects, boolean removeDeletedObjects)` Utility method used to fetch an array of objects given a qualifier.
`static NSArray`	`objectsWithQualifier(EOEditingContext editingContext, String entityName, EOQualifier qualifier, NSArray prefetchKeyPaths, NSArray sortOrderings, int fetchLimit, boolean usesDistinct, boolean isDeep, NSDictionary hints, boolean includeNewObjects, boolean includeNewObjectsInParentEditingContext, boolean filterUpdatedObjects, boolean removeDeletedObjects)` Utility method used to fetch an array of objects given a qualifier.
`static NSArray`	`objectsWithQualifierFormat(EOEditingContext ec, String entityName, String qualifierFormat, NSArray args, NSArray prefetchKeyPaths, boolean includeNewObjects)` Calls `objectsWithQualifierFormat(ec, entityName, qualifierFormat, args, prefetchKeyPaths, includeNewObjects, false)`.
`static NSArray`	`objectsWithQualifierFormat(EOEditingContext ec, String entityName, String qualifierFormat, NSArray args, NSArray prefetchKeyPaths, boolean includeNewObjects, boolean includeNewObjectsInParentEditingContexts)` Enhanced version of the utility method found in EOUtilities.
`static EOEnterpriseObject`	`objectWithPrimaryKeyValue(EOEditingContext ec, String entityName, Object primaryKeyValue, NSArray prefetchingKeyPaths)` Fetches an enterprise object based on a given primary key value.
`static EOEnterpriseObject`	`objectWithPrimaryKeyValue(EOEditingContext ec, String entityName, Object primaryKeyValue, NSArray prefetchingKeyPaths, boolean refreshRefetchedObjects)` Fetches an enterprise object based on a given primary key value.
`static EOEnterpriseObject`	`objectWithPrimaryKeyValue(EOEditingContext ec, String entityName, Object primaryKeyValue, NSArray prefetchingKeyPaths, boolean refreshRefetchedObjects, boolean throwIfMissing)` Fetches an enterprise object based on a given primary key value.
`static EOEnterpriseObject`	`objectWithQualifier(EOEditingContext editingContext, String entityName, EOQualifier qualifier)` Returns the single object of the given type matching the qualifier.
`static EOQualifier`	`orQualifier(EOQualifier q1, EOQualifier q2)` Joins the given qualifiers with an OR.
`static EOQualifier`	`orQualifierForKeyPaths(NSArray keyPaths, NSSelector selector, NSArray values)` Creates an OR qualifier with the given selector for all the given key paths and all the given search terms.
`static EOQualifier`	`orQualifierForKeyPaths(NSArray keyPaths, NSSelector selector, Object value)` Creates an OR qualifier with the given selector for all the given key paths.
`static NSArray`	`primaryKeyArrayForObject(EOEnterpriseObject obj)` Gives the primary key array for a given enterprise object.
`static NSDictionary<String,Object>`	`primaryKeyDictionaryForString(EOEditingContext ec, String entityName, String string)` Returns the decoded dictionary for an propertylist encoded string representation of the primary key for a given object.
`static EOFetchSpecification`	`primaryKeyFetchSpecificationForEntity(EOEditingContext ec, String entityName, EOQualifier eoqualifier, NSArray<EOSortOrdering> sortOrderings, NSArray<String> additionalKeys)` Constructs a fetch specification that will only fetch the primary keys for a given qualifier.
`static Object`	`primaryKeyObjectForObject(EOEnterpriseObject eo)` Returns either the single object the PK consist of or the NSArray of its values if the key is compound.
`static NSArray`	`primaryKeysMatchingQualifier(EOEditingContext ec, String entityName, EOQualifier eoqualifier, NSArray<EOSortOrdering> sortOrderings)` Fetches an array of primary keys matching a given qualifier and sorted with a given array of sort orderings.
`static String`	`primaryKeyStringForGlobalID(EOKeyGlobalID gid)` Returns the propertylist-encoded string representation of the global ID.
`static String`	`primaryKeyStringForObject(EOEnterpriseObject eo)` Returns the propertylist-encoded string representation of the primary key for a given object.
`static NSArray<NSDictionary<String,Object>>`	`primaryKeyValuesInRange(EOEditingContext ec, EOFetchSpecification spec, int start, int end)` Returns an `NSArray` containing the primary keys from the resulting rows starting at start and stopping at end using a custom SQL, derived from the SQL which the `EOFetchSpecification` would use normally `setHints()`
`static EOQualifier`	`qualifierMatchingAnyKey(NSArray keys, NSSelector selector, Object value)` Creates an OR qualifier of EOKeyValueQualifiers for every keypath in the given array of keys.
`static void`	`refaultObject(EOEnterpriseObject eo)` Turns a given enterprise object back into a fault.
`static void`	`refreshObject(EOEnterpriseObject eo)` Sets the fetch time stamp of the eo's ec to now to ensure fresh data.
`static NSDictionary<String,Integer>`	`registeredObjectCount(EOEditingContext ec)` Returns the count of registered objects in the EC grouped by entity name, which is useful for memory debugging.
`static EOEnterpriseObject`	`requiredObjectWithQualifier(EOEditingContext editingContext, String entityName, EOQualifier qualifier)` Returns the single object of the given type matching the qualifier.
`static EOEntity`	`rootEntity(EOEnterpriseObject eo)` Returns the root entity from the EOEnterpriseObject
`static String`	`rootEntityName(EOEnterpriseObject eo)` Returns the name from the root entity from the EOEnterpriseObject
`static EOFetchSpecification`	`schemaBasedFetchSpecification(EOEditingContext ec, EOFetchSpecification fetchSpecification)` Useful for ensuring a fetch specification is safe to pass around between threads and not having to be concerned about references to EOs in the qualifier.
`static EOQualifier`	`schemaBasedQualifier(EOEditingContext ec, String entityName, EOQualifier qualifier)` Useful for ensuring a qualifier is safe to pass around between threads and not having to be concerned about references to EOs in it.
`static EOEnterpriseObject`	`sharedObjectMatchingKeyAndValue(String entityName, String key, Object value)` Finds an object in the shared editing context matching a key and value.
`static NSArray`	`sharedObjectsForEntityNamed(String entityName)` Gets all of the shared objects for a given entity name.
`static NSArray`	`sharedObjectsMatchingKeyAndValue(String entityName, String key, Object value)` Finds objects in the shared editing context matching a key and value.
`static NSArray`	`sharedObjectsWithFetchSpecificationNamed(String entityName, String fetchSpecName)` Fetches a shared enterprise object from the default shared editing context given the name of a fetch specification.
`static EOEnterpriseObject`	`sharedObjectWithFetchSpec(String entityName, String fetchSpec)` Fetches a shared enterprise object for a given fetch specification from the default shared editing context.
`static EOEnterpriseObject`	`sharedObjectWithPrimaryKey(String entityName, Object primaryKey)` Gets the shared enterprise object with the given primary from the default shared editing context.
`static NSArray`	`stringAttributeListForEntityNamed(EOEditingContext ec, String entityName)` Calculates all of the EOAttributes of a given entity that are mapped to String objects.
`static void`	`trimSpaces(EOEnterpriseObject object)` Trims all values from string attributes from the given EO unless the EO itself or the string attribute is flagged as read-only.
`static NSMutableArray`	`updatedObjects(EOEditingContext editingContext, NSArray<String> entityNames, EOQualifier qualifier)` Returns the array of objects of the given type that have been updated in the editing context and match the given qualifier.
`static void`	`validateUniquenessOf(EOEnterpriseObject eo, EOQualifier restrictingQualifier, String... keys)` Convenience method which passes `null` for `entityName`.
`static void`	`validateUniquenessOf(EOEnterpriseObject eo, String... keys)` Convenience method which passes `null` for `restrictingQualifier` and `entityName`.
`static void`	`validateUniquenessOf(String entityName, EOEnterpriseObject eo, EOQualifier restrictingQualifier, String... keys)` Validates whether the values of the specified keyPaths are unique for an Entity.
`static void`	`validateUniquenessOf(String entityName, EOEnterpriseObject eo, String... keys)` Convenience method which passes `null` for `restrictingQualifier`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
 - ERXEOControlUtilities
```
public ERXEOControlUtilities()
```
- Method Detail
 - localInstancesOfObjects
```
public static <T extends EOEnterpriseObject> NSArray<T> localInstancesOfObjects(EOEditingContext ec,
 NSArray<T> eos)
```
 Provides the same functionality as the equivalent method in EOUtilities except it will use the localInstanceOfObject method from this utilities class which has a few enhancements.
 
 Type Parameters:
 
 T - data type of enterprise objects
 
 Parameters:
 
 ec - editing context to pull local object copies
 
 eos - array of enterprise objects
 
 Returns:
 
 an array of copies of local objects
 - dataSourceForArray
```
public static EOArrayDataSource dataSourceForArray(NSArray<? extends EOEnterpriseObject> array)
```
 Simple utility method that will convert an array of enterprise objects into an EOArrayDataSource.
 Note that the data source that is constructed uses the class description and editing context of the first object of the array.
 
 Parameters:
 
 array - collection of objects to be turned into a data source
 
 Returns:
 
 an array data source corresponding to the array of objects passed in.
 - dataSourceForArray
```
public static EOArrayDataSource dataSourceForArray(EOEditingContext ec,
 String entityName,
 NSArray array)
```
 Simple utility method that will convert an array of enterprise objects into an EOArrayDataSource.
 Note that the data source that is constructed uses the class description and editing context of the first object of the array.
 
 Parameters:
 
 ec - editing context for the data source
 
 entityName - entity name
 
 array - collection of objects to be turned into a data source
 
 Returns:
 
 an array data source corresponding to the array of objects passed in.
 - arrayFromDataSource
```
public static NSArray arrayFromDataSource(EODataSource dataSource)
```
 Converts a data source into an array.
 
 Parameters:
 
 dataSource - data source to be converted
 
 Returns:
 
 array of objects that the data source represents
 - dataSourceForObjectAndKey
```
public static EODetailDataSource dataSourceForObjectAndKey(EOEnterpriseObject object,
 String key)
```
 Creates a detail data source for a given enterprise object and a relationship key. These types of data sources can be very handy when you are displaying a list of objects a la D2W style and then some objects are added or removed from the relationship. If an array data source were used then the list would not reflect the changes made, however the detail data source will reflect changes made to the relationship.
 Note: the relationship key does not have to be an eo relationship, instead it just has to return an array of enterprise objects.
 
 Parameters:
 
 object - that has the relationship
 
 key - relationship key
 
 Returns:
 
 detail data source for the given object-key pair.
 - editableInstanceOfObject
```
public static <T extends EOEnterpriseObject> T editableInstanceOfObject(T eo,
 boolean createNestedContext)
```
 Creates a new, editable instance of the supplied object. Takes into account if the object is newly inserted, lives in a shared context and can either create a peer or nested context.
 
 Type Parameters:
 
 T - data type of the enterprise object
 
 Parameters:
 
 eo - object for the new instance
 
 createNestedContext - true, if we should create a nested context (otherwise we create a peer context)
 
 Returns:
 
 new EO in new editing context
 - localInstanceOfObject
```
public static <T extends EOEnterpriseObject> T localInstanceOfObject(EOEditingContext ec,
 T eo)
```
 This has one advantage over the standard EOUtilites method of first checking if the editingcontexts are equal before creating a fault for the object in the editing context.
 
 Type Parameters:
 
 T - data type of the enterprise object
 
 Parameters:
 
 ec - editing context to get a local instance of the object in
 
 eo - object to get a local copy of
 
 Returns:
 
 enterprise object local to the passed in editing context
 - eoEquals
```
public static boolean eoEquals(EOEnterpriseObject firstEO,
 EOEnterpriseObject secondEO)
```
 Determines if two EOs are equal by comparing their EOGlobalIDs. This does not require the two EOs to be in the same EOEditingContext and will be safe when either is or both are null. This does not test the two EOs for content equality.
 
 Parameters:
 
 firstEO - first EO to compare
 
 secondEO - second EO to compare
 
 Returns:
 
 true if firstEO and secondEO correspond to the same object or if both are null. false otherwise.
 - createAndInsertObject
```
public static <T extends EOEnterpriseObject> T createAndInsertObject(EOEditingContext ec,
 Class<T> eoClass)
```
 Creates an enterprise object for the given entity name by first looking up the class description of the entity to create the enterprise object. The object is then inserted into the editing context and returned.
 
 Type Parameters:
 
 T - data type of the enterprise object
 
 Parameters:
 
 ec - editingContext to insert the created object into
 
 eoClass - class of the enterprise object to be created
 
 Returns:
 
 created and inserted enterprise object of type T
 - createAndInsertObject
```
public static EOEnterpriseObject createAndInsertObject(EOEditingContext editingContext,
 String entityName)
```
 Creates an enterprise object for the given entity name by first looking up the class description of the entity to create the enterprise object. The object is then inserted into the editing context and returned.
 
 Parameters:
 
 editingContext - editingContext to insert the created object into
 
 entityName - name of the entity to be created.
 
 Returns:
 
 created and inserted enterprise object
 - createAndInsertObject
```
public static EOEnterpriseObject createAndInsertObject(EOEditingContext editingContext,
 String entityName,
 NSDictionary objectInfo)
```
 Creates an enterprise object for the given entity name by first looking up the class description of the entity to create the enterprise object and then adding values from the dictionary. The object is then inserted into the editing context and returned.
 
 Parameters:
 
 editingContext - editingContext to insert the created object into
 
 entityName - name of the entity to be created.
 
 objectInfo - dictionary of values pushed onto the object before being inserted into the editing context.
 
 Returns:
 
 created and inserted enterprise object
 - createAndAddObjectToRelationship
```
public static EOEnterpriseObject createAndAddObjectToRelationship(EOEditingContext editingContext,
 EOEnterpriseObject source,
 String relationshipName,
 String destinationEntityName,
 NSDictionary objectInfo)
```
 Creates an object using the utility method createEO from this utility class. After creating the enterprise object it is added to the relationship of the enterprise object passed in. For instance:
 createAndAddObjectToRelationship(ec, foo, "toBars", "Bar", dictValues);
 will create an instance of Bar, set all of the key-value pairs from the dictValues dictionary, insert it into an editing context and then add it to both sides of the relationship "toBars" off of the enterprise object foo.
 
 Parameters:
 
 editingContext - editing context to create the object in
 
 source - enterprise object to whose relationship the newly created object will be added.
 
 relationshipName - relationship name of the enterprise object that is passed in to which the newly created eo should be added.
 
 destinationEntityName - name of the entity of the object to be created.
 
 objectInfo - dictionary of values to be set on the newly created object before it is inserted into the editing context.
 
 Returns:
 
 the newly created enterprise object
 - addObjectToObjectOnBothSidesOfRelationshipWithKey
```
public static void addObjectToObjectOnBothSidesOfRelationshipWithKey(EOEnterpriseObject addedObject,
 EOEnterpriseObject referenceObject,
 String key)
```
 Adds an object to another objects relationship. Has the advantage of ensuring that the added object is in the same editing context as the reference object.
 
 Parameters:
 
 addedObject - object to be added to the relationship
 
 referenceObject - object that has the relationship
 
 key - relationship key
 - refaultObject
```
public static void refaultObject(EOEnterpriseObject eo)
```
 Turns a given enterprise object back into a fault.
 
 Parameters:
 
 eo - enterprise object to refault
 - refreshObject
```
public static void refreshObject(EOEnterpriseObject eo)
```
 Sets the fetch time stamp of the eo's ec to now to ensure fresh data. and refreshes the EO (which merges latest database snapshots with current unsaved changes if we have unsaved changes)
 
 Parameters:
 
 eo - EO to be refreshed
 - clearSnapshotForRelationshipNamed
```
public static void clearSnapshotForRelationshipNamed(EOEnterpriseObject eo,
 String relationshipName)
```
 Clears snapshot the relationship of a given enterprise so it will be read again when next accessed.
 
 Parameters:
 
 eo - enterprise object
 
 relationshipName - relationship name
 - clearSnapshotForRelationshipNamedInDatabase
```
public static void clearSnapshotForRelationshipNamedInDatabase(EOEnterpriseObject eo,
 String relationshipName,
 EODatabase database)
```
 Clears snapshot the relationship of a given enterprise so it will be read again when next accessed.
 
 Parameters:
 
 eo - enterprise object
 
 relationshipName - relationship name
 
 database - database object
 - primaryKeyFetchSpecificationForEntity
```
public static EOFetchSpecification primaryKeyFetchSpecificationForEntity(EOEditingContext ec,
 String entityName,
 EOQualifier eoqualifier,
 NSArray<EOSortOrdering> sortOrderings,
 NSArray<String> additionalKeys)
```
 Constructs a fetch specification that will only fetch the primary keys for a given qualifier.
 
 Parameters:
 
 ec - editing context, only used to determine the entity
 
 entityName - name of the entity, only used to determine the entity
 
 eoqualifier - to construct the fetch specification with
 
 sortOrderings - array of sort orderings to sort the result set with.
 
 additionalKeys - array of additional key paths to construct the raw rows key paths to fetch.
 
 Returns:
 
 fetch specification that can be used to fetch primary keys for a given qualifier and sort orderings.
 - primaryKeysMatchingQualifier
```
public static NSArray primaryKeysMatchingQualifier(EOEditingContext ec,
 String entityName,
 EOQualifier eoqualifier,
 NSArray<EOSortOrdering> sortOrderings)
```
 Fetches an array of primary keys matching a given qualifier and sorted with a given array of sort orderings.
 
 Parameters:
 
 ec - editing context to fetch into
 
 entityName - name of the entity
 
 eoqualifier - to restrict matching primary keys
 
 sortOrderings - array of sort orders to sort result set
 
 Returns:
 
 array of primary keys matching a given qualifier
 - objectWithPrimaryKeyValue
```
public static EOEnterpriseObject objectWithPrimaryKeyValue(EOEditingContext ec,
 String entityName,
 Object primaryKeyValue,
 NSArray prefetchingKeyPaths)
```
 Fetches an enterprise object based on a given primary key value. This method has an advantage over the standard EOUtilities method in that you can specify prefetching key paths as well as refreshing the snapshot of the given object
 
 Parameters:
 
 ec - editing context to fetch into
 
 entityName - name of the entity
 
 primaryKeyValue - primary key value. Compound primary keys are given as NSDictionaries.
 
 prefetchingKeyPaths - key paths to fetch off of the eo
 
 Returns:
 
 enterprise object matching the given value
 - objectWithPrimaryKeyValue
```
public static EOEnterpriseObject objectWithPrimaryKeyValue(EOEditingContext ec,
 String entityName,
 Object primaryKeyValue,
 NSArray prefetchingKeyPaths,
 boolean refreshRefetchedObjects)
```
 Fetches an enterprise object based on a given primary key value. This method has an advantage over the standard EOUtilities method in that you can specify prefetching key paths as well as refreshing the snapshot of the given object
 
 Parameters:
 
 ec - editing context to fetch into
 
 entityName - name of the entity
 
 primaryKeyValue - primary key value. Compound primary keys are given as NSDictionaries.
 
 prefetchingKeyPaths - key paths to fetch off of the eo
 
 refreshRefetchedObjects - if true, the object will be refetched and refreshed
 
 Returns:
 
 enterprise object matching the given value or null if none is found
 
 Throws:
 
 IllegalStateException - if the entity has a compound key and only one key is provided or if more than one object is found matching the value.
 - objectWithPrimaryKeyValue
```
public static EOEnterpriseObject objectWithPrimaryKeyValue(EOEditingContext ec,
 String entityName,
 Object primaryKeyValue,
 NSArray prefetchingKeyPaths,
 boolean refreshRefetchedObjects,
 boolean throwIfMissing)
```
 Fetches an enterprise object based on a given primary key value. This method has an advantage over the standard EOUtilities method in that you can specify prefetching key paths as well as refreshing the snapshot of the given object.
 
 Parameters:
 
 ec - editing context to fetch into
 
 entityName - name of the entity
 
 primaryKeyValue - primary key value. Compound primary keys are given as NSDictionaries.
 
 prefetchingKeyPaths - key paths to prefetch for the eo
 
 refreshRefetchedObjects - if true, the object will be refetched and refreshed
 
 throwIfMissing - if true, an exception is thrown for a missing object
 
 Returns:
 
 enterprise object matching the given value or null if none is found
 
 Throws:
 
 IllegalStateException - if the entity has a compound key and only one key is provided or if more than one object is found matching the value.
 
 EOObjectNotAvailableException - if throwIfMissing is true and the object is missing
 - objectsInRange
```
public static <T extends EOEnterpriseObject> NSArray<T> objectsInRange(EOEditingContext ec,
 EOFetchSpecification spec,
 int start,
 int end)
```
 Returns an NSArray containing the objects from the resulting rows starting at start and stopping at end using a custom SQL, derived from the SQL which the EOFetchSpecification would use normally setHints()
 
 Type Parameters:
 
 T - data type of the enterprise objects
 
 Parameters:
 
 ec - editing context to fetch objects into
 
 spec - fetch specification for the fetch
 
 start - the starting row number
 
 end - the last row number
 
 Returns:
 
 objects in the given range
 - objectsInRange
```
public static <T extends EOEnterpriseObject> NSArray<T> objectsInRange(EOEditingContext ec,
 EOFetchSpecification spec,
 int start,
 int end,
 boolean rawRowsForCustomQueries)
```
 Returns an NSArray containing the objects from the resulting rows starting at start and stopping at end using a custom SQL, derived from the SQL which the EOFetchSpecification would use normally setHints()
 
 Type Parameters:
 
 T - data type of the enterprise objects
 
 Parameters:
 
 ec - editing context to fetch objects into
 
 spec - fetch specification for the fetch
 
 start - the starting row number
 
 end - the last row number
 
 rawRowsForCustomQueries - if true, raw rows will be returned from the fetch when there is a custom query
 
 Returns:
 
 objects in the given range
 - primaryKeyValuesInRange
```
public static NSArray<NSDictionary<String,Object>> primaryKeyValuesInRange(EOEditingContext ec,
 EOFetchSpecification spec,
 int start,
 int end)
```
 Returns an NSArray containing the primary keys from the resulting rows starting at start and stopping at end using a custom SQL, derived from the SQL which the EOFetchSpecification would use normally setHints()
 
 Parameters:
 
 ec - editing context to fetch objects into
 
 spec - fetch specification for the fetch
 
 start - the starting row number
 
 end - the last row number
 
 Returns:
 
 primary keys in the given range
 - objectCountWithQualifier
```
public static Integer objectCountWithQualifier(EOEditingContext ec,
 String entityName,
 EOQualifier qualifier)
```
 Returns the number of objects matching the given qualifier for a given entity name. Implementation wise this method will generate the correct SQL to only perform a count, i.e. all of the objects wouldn't be pulled into memory.
 
 Parameters:
 
 ec - editing context to use for the count qualification
 
 entityName - name of the entity to fetch
 
 qualifier - to find the matching objects
 
 Returns:
 
 number of matching objects
 - objectCountUniqueWithQualifierAndAttribute
```
public static Integer objectCountUniqueWithQualifierAndAttribute(EOEditingContext ec,
 String entityName,
 EOQualifier qualifier,
 String attributeName)
```
 Returns the number of unique objects matching the given qualifier for a given entity name. This method will generate the correct SQL to perform a count and not to fetch the objects.
 
 Parameters:
 
 ec - editing context to use for the count qualification
 
 entityName - name of the entity to fetch
 
 qualifier - to find the matching objects
 
 attributeName - name of attribute in same entity to consider in order to determine uniqueness
 
 Returns:
 
 number of matching objects
 - objectCountForToManyRelationship
```
public static Integer objectCountForToManyRelationship(EOEnterpriseObject object,
 String relationshipName)
```
 Counts the objects in a toMany relationship in an effective way. If the relationship fault has already been fired, it just returns the array count. If relationship is a fault, it looks for a relationship snapshot array, and if that is present, returns the count of the snapshot array. Finally if it is a fault and no snapshot array exists, performs a count in the database.
 
 Parameters:
 
 object - the EOEnterpriseObject whose relationship is being counted.
 
 relationshipName - the name of the relationship being counted.
 
 Returns:
 
 count of related objects in the relationship named relationshipName
 
 Throws:
 
 NullPointerException - if either object or relationshipName are null
 
 IllegalArgumentException - if relationshipName is not a toMany relationship key
 - _aggregateFunctionWithQualifierAndAggregateAttribute
```
public static Object _aggregateFunctionWithQualifierAndAggregateAttribute(EOEditingContext ec,
 String entityName,
 EOQualifier qualifier,
 EOAttribute aggregateAttribute)
```
 Returns the number of objects in the database with the qualifier and counting attribute. This implementation queries the database directly without loading the objects into memory.
 
 Parameters:
 
 ec - the editing context
 
 entityName - the name of the entity
 
 qualifier - the qualifier to filter with
 
 aggregateAttribute - the attribute that contains the "count(*)" definition
 
 Returns:
 
 the number of objects
 - aggregateFunctionWithQualifier
```
public static Number aggregateFunctionWithQualifier(EOEditingContext ec,
 String entityName,
 String attributeName,
 String function,
 String fetchSpecificationName,
 NSDictionary bindings)
```
 Computes an aggregate function for a given attribute restricted by a given qualifier. For instance select MAX(AGE) from User where name like 'M*'
 
 Parameters:
 
 ec - editing context used for the fetch
 
 entityName - name of the entity
 
 attributeName - attribute for the function to be performed on
 
 function - name, ie MAX, MIN, AVG, etc.
 
 fetchSpecificationName - name of a fetch specification
 
 bindings - bindings for the fetch specification
 
 Returns:
 
 aggregate result of the function call
 - aggregateFunctionWithQualifier
```
public static Number aggregateFunctionWithQualifier(EOEditingContext ec,
 String entityName,
 String attributeName,
 String function,
 EOQualifier qualifier)
```
 Computes an aggregate function for a given string attribute restricted by a given qualifier. For instance select MAX(age) from User where name like 'M*'
 
 Parameters:
 
 ec - editing context used for the fetch
 
 entityName - name of the entity
 
 attributeName - attribute for the function to be performed on
 
 function - name, ie MAX, MIN, AVG, etc.
 
 qualifier - to restrict data set
 
 Returns:
 
 aggregate result of the function call
 - aggregateStringWithQualifier
```
public static String aggregateStringWithQualifier(EOEditingContext ec,
 String entityName,
 String attributeName,
 String function,
 EOQualifier qualifier)
```
 Computes an aggregate function for a given attribute restricted by a given qualifier. For instance select MAX(invoiceNumber) from Invoice where invoiceNumber like 'INV22*'
 
 Parameters:
 
 ec - editing context used for the fetch
 
 entityName - name of the entity
 
 attributeName - attribute for the function to be performed on
 
 function - name, ie MAX, MIN, AVG, etc.
 
 qualifier - to restrict data set
 
 Returns:
 
 aggregate result of the fuction call
 - aggregateTimestampWithQualifier
```
public static NSTimestamp aggregateTimestampWithQualifier(EOEditingContext ec,
 String entityName,
 String attributeName,
 String function,
 EOQualifier qualifier)
```
 Computes an aggregate function for a given attribute restricted by a given qualifier. For instance select MAX(birthdate) from User where name like 'M*'
 
 Parameters:
 
 ec - editing context used for the fetch
 
 entityName - name of the entity
 
 attributeName - attribute for the function to be performed on
 
 function - name, ie MAX, MIN, AVG, etc.
 
 qualifier - to restrict data set
 
 Returns:
 
 aggregate result of the fuction call
 - _aggregateFunctionWithQualifier
```
public static Object _aggregateFunctionWithQualifier(EOEditingContext ec,
 String entityName,
 String attributeName,
 String function,
 Class valueClass,
 String valueType,
 EOQualifier qualifier)
```
 - sharedObjectMatchingKeyAndValue
```
public static EOEnterpriseObject sharedObjectMatchingKeyAndValue(String entityName,
 String key,
 Object value)
```
 Finds an object in the shared editing context matching a key and value. This has the benefit of not requiring a database round trip if the entity is shared.
 
 Parameters:
 
 entityName - name of the shared entity
 
 key - to match against
 
 value - value to match
 
 Returns:
 
 matching shared object
 - sharedObjectsMatchingKeyAndValue
```
public static NSArray sharedObjectsMatchingKeyAndValue(String entityName,
 String key,
 Object value)
```
 Finds objects in the shared editing context matching a key and value. This has the benefit of not requiring a database round trip if the entity is shared.
 
 Parameters:
 
 entityName - name of the shared entity
 
 key - to match against
 
 value - value to match
 
 Returns:
 
 array of shared objects matching key and value
 - sharedObjectsForEntityNamed
```
public static NSArray sharedObjectsForEntityNamed(String entityName)
```
 Gets all of the shared objects for a given entity name. Note that if the shared objects for the corresponding model have not been loaded yet, this method will trigger their loading (unless automatic loading has been disabled via a call to EODatabaseContext.setSharedObjectLoadingEnabled(boolean)). Returns an empty array if no shared objects were found.
 
 Parameters:
 
 entityName - name of the shared entity
 
 Returns:
 
 array of bound shared objects for the given entity name, or an empty array
 - sharedObjectWithFetchSpec
```
public static EOEnterpriseObject sharedObjectWithFetchSpec(String entityName,
 String fetchSpec)
```
 Fetches a shared enterprise object for a given fetch specification from the default shared editing context.
 
 Parameters:
 
 fetchSpec - specification on the shared object
 
 entityName - name of the shared entity
 
 Returns:
 
 the shared enterprise object fetch by the fetch spec named.
 - sharedObjectsWithFetchSpecificationNamed
```
public static NSArray sharedObjectsWithFetchSpecificationNamed(String entityName,
 String fetchSpecName)
```
 Fetches a shared enterprise object from the default shared editing context given the name of a fetch specification.
 
 Parameters:
 
 fetchSpecName - name of the fetch specification on the shared object.
 
 entityName - name of the shared entity
 
 Returns:
 
 the shared enterprise object fetch by the fetch spec named.
 - sharedObjectWithPrimaryKey
```
public static EOEnterpriseObject sharedObjectWithPrimaryKey(String entityName,
 Object primaryKey)
```
 Gets the shared enterprise object with the given primary from the default shared editing context. This has the advantage of not requiring a roundtrip to the database to lookup the object. But it will fetch if the object is not found in the default shared editing context.
 
 Parameters:
 
 entityName - name of the entity
 
 primaryKey - primary key of object to be found
 
 Returns:
 
 the shared object registered in the default shared editing context
 - fetchSpecificationNamedWithBindings
```
public static EOFetchSpecification fetchSpecificationNamedWithBindings(String entityName,
 String fetchSpecificationName,
 NSDictionary bindings)
```
 Gets a fetch specification from a given entity. If qualifier binding variables are passed in then the fetch specification is cloned and the binding variables are substituted, returning a fetch specification that can be used.
 
 Parameters:
 
 entityName - name of the entity that the fetch specification is bound to
 
 fetchSpecificationName - name of the fetch specification
 
 bindings - dictionary of qualifier bindings
 
 Returns:
 
 fetch specification identified by name and potentially with the qualifier bindings replaced.
 - newPrimaryKeyDictionaryForObjectFromClassProperties
```
public static NSDictionary<String,Object> newPrimaryKeyDictionaryForObjectFromClassProperties(EOEnterpriseObject eo)
```
 Utility method to generate a new primary key dictionary using the objects class properties. Use it when your PKs are class properties.
 
 Parameters:
 
 eo - object in question
 
 Returns:
 
 new primary key dictionary or null if one of the properties is null or one of the primary key attributes is not a class property.
 - newPrimaryKeyDictionaryForObject
```
public static NSDictionary<String,Object> newPrimaryKeyDictionaryForObject(EOEnterpriseObject eo)
```
 Utility method to generate a new primary key for an object. Calls newPrimaryKeyDictionaryForObjectFromClassProperties(EOEnterpriseObject) and if that returns null, newPrimaryKeyDictionaryForEntityNamed(EOEditingContext, String)
 
 Parameters:
 
 eo - enterprise object to create keys for
 
 Returns:
 
 new primary key dictionary or null if a failure occurred.
 - newPrimaryKeyDictionaryForEntityNamed
```
public static NSDictionary<String,Object> newPrimaryKeyDictionaryForEntityNamed(EOEditingContext ec,
 String entityName)
```
 Utility method to generate a new primary key dictionary using the adaptor for a given entity. This is can be handy if you need to have a primary key for an object before it is saved to the database. This method uses the same method that EOF uses by default for generating primary keys. See ERXGeneratesPrimaryKeyInterface for more information about using a newly created dictionary as the primary key for an enterprise object.
 
 Parameters:
 
 ec - editing context
 
 entityName - name of the entity to generate the primary key dictionary for.
 
 Returns:
 
 a dictionary containing a new primary key for the given entity.
 - primaryKeyStringForObject
```
public static String primaryKeyStringForObject(EOEnterpriseObject eo)
```
 Returns the propertylist-encoded string representation of the primary key for a given object.
 
 Parameters:
 
 eo - object to get the primary key for.
 
 Returns:
 
 string representation of the primary key of the object.
 - primaryKeyStringForGlobalID
```
public static String primaryKeyStringForGlobalID(EOKeyGlobalID gid)
```
 Returns the propertylist-encoded string representation of the global ID.
 
 Parameters:
 
 gid - the global id of the object to get the primary key for.
 
 Returns:
 
 string representation of the primary key of the object.
 - _stringForPrimaryKey
```
public static String _stringForPrimaryKey(Object pk)
```
 Returns the propertylist-encoded string representation of the primary key for a given object. Made public only for ERXGenericRecord.
 
 Parameters:
 
 pk - the primary key
 
 Returns:
 
 string representation of the primary key.
 - primaryKeyDictionaryForString
```
public static NSDictionary<String,Object> primaryKeyDictionaryForString(EOEditingContext ec,
 String entityName,
 String string)
```
 Returns the decoded dictionary for an propertylist encoded string representation of the primary key for a given object.
 
 Returns:
 
 string representation of the primary key of the object.
 - globalIDForString
```
public static EOGlobalID globalIDForString(EOEditingContext ec,
 String entityName,
 String string)
```
 Returns the decoded global id for an propertylist encoded string representation of the primary key for a given object.
 - primaryKeyObjectForObject
```
public static Object primaryKeyObjectForObject(EOEnterpriseObject eo)
```
 Returns either the single object the PK consist of or the NSArray of its values if the key is compound.
 
 Parameters:
 
 eo - object to get the primary key for.
 
 Returns:
 
 single object or NSArray
 - primaryKeyArrayForObject
```
public static NSArray primaryKeyArrayForObject(EOEnterpriseObject obj)
```
 Gives the primary key array for a given enterprise object. This has the advantage of not firing the fault of the object, unlike the method in EOUtilities.
 
 Parameters:
 
 obj - enterprise object to get the primary key array from.
 
 Returns:
 
 array of all the primary key values for the object.
 - objectsWithQualifierFormat
```
public static NSArray objectsWithQualifierFormat(EOEditingContext ec,
 String entityName,
 String qualifierFormat,
 NSArray args,
 NSArray prefetchKeyPaths,
 boolean includeNewObjects)
```
 Calls objectsWithQualifierFormat(ec, entityName, qualifierFormat, args, prefetchKeyPaths, includeNewObjects, false). That is, passes false for includeNewObjectsInParentEditingContexts. This method exists to maintain API compatibility.
 - objectsWithQualifierFormat
```
public static NSArray objectsWithQualifierFormat(EOEditingContext ec,
 String entityName,
 String qualifierFormat,
 NSArray args,
 NSArray prefetchKeyPaths,
 boolean includeNewObjects,
 boolean includeNewObjectsInParentEditingContexts)
```
 Enhanced version of the utility method found in EOUtilities. Adds support for including newly created objects in the fetch as well as prefetching key paths.
 
 Parameters:
 
 ec - editing context to fetch it into
 
 entityName - name of the entity
 
 qualifierFormat - format of the qualifier string
 
 args - qualifier arguments
 
 prefetchKeyPaths - prefetching key paths
 
 includeNewObjects - option to include newly inserted objects in the result set
 
 includeNewObjectsInParentEditingContexts - option to include newly inserted objects in parent editing contexts
 
 Returns:
 
 array of objects matching the constructed qualifier
 - objectsWithQualifier
```
public static NSArray objectsWithQualifier(EOEditingContext ec,
 String entityName,
 EOQualifier qualifier,
 NSArray prefetchKeyPaths,
 boolean includeNewObjects)
```
 Calls objectsWithQualifier(ec, entityName, qualifier, prefetchKeyPaths, includeNewObjects, false). That is, passes false for includeNewObjectsInParentEditingContexts. This method exists to maintain API compatibility.
 - objectsWithQualifier
```
public static NSArray objectsWithQualifier(EOEditingContext _editingContext,
 String _entityName,
 EOQualifier _qualifier,
 NSArray _prefetchKeyPaths,
 boolean _includeNewObjects,
 boolean _includeNewObjectsInParentEditingContext)
```
 - objectsWithQualifier
```
public static NSArray objectsWithQualifier(EOEditingContext editingContext,
 String entityName,
 EOQualifier qualifier,
 NSArray prefetchKeyPaths,
 boolean includeNewObjects,
 boolean includeNewObjectsInParentEditingContext,
 boolean filterUpdatedObjects,
 boolean removeDeletedObjects)
```
 Utility method used to fetch an array of objects given a qualifier. Also has support for filtering the newly inserted, updated, and deleted objects in the passed editing context or any parent editing contexts as well as specifying prefetching key paths. Note that only NEW objects are supported in parent editing contexts.
 
 Parameters:
 
 editingContext - editing context to fetch it into
 
 entityName - name of the entity
 
 qualifier - qualifier
 
 prefetchKeyPaths - prefetching key paths
 
 includeNewObjects - option to include newly inserted objects in the result set
 
 includeNewObjectsInParentEditingContext - option to include newly inserted objects in parent editing contexts. if true, the editing context lineage is explored, any newly-inserted objects matching the qualifier are collected and faulted down through all parent editing contexts of ec.
 
 filterUpdatedObjects - option to include updated objects that now match the qualifier or remove updated objects thats no longer match the qualifier
 
 removeDeletedObjects - option to remove objects that have been deleted
 
 Returns:
 
 array of objects matching the constructed qualifier
 - objectsWithQualifier
```
public static NSArray objectsWithQualifier(EOEditingContext editingContext,
 String entityName,
 EOQualifier qualifier,
 NSArray prefetchKeyPaths,
 NSArray sortOrderings,
 boolean usesDistinct,
 boolean isDeep,
 NSDictionary hints,
 boolean includeNewObjects,
 boolean includeNewObjectsInParentEditingContext,
 boolean filterUpdatedObjects,
 boolean removeDeletedObjects)
```
 Utility method used to fetch an array of objects given a qualifier. Also has support for filtering the newly inserted, updated, and deleted objects in the passed editing context or any parent editing contexts as well as specifying prefetching key paths. Note that only NEW objects are supported in parent editing contexts.
 
 Parameters:
 
 editingContext - editing context to fetch it into
 
 entityName - name of the entity
 
 qualifier - qualifier
 
 prefetchKeyPaths - prefetching key paths
 
 sortOrderings - the sort orderings to use on the results
 
 usesDistinct - whether or not to distinct the results
 
 isDeep - whether or not to fetch deeply
 
 hints - fetch hints to apply
 
 includeNewObjects - option to include newly inserted objects in the result set
 
 includeNewObjectsInParentEditingContext - option to include newly inserted objects in parent editing contexts. if true, the editing context lineage is explored, any newly-inserted objects matching the qualifier are collected and faulted down through all parent editing contexts of ec.
 
 filterUpdatedObjects - option to include updated objects that now match the qualifier or remove updated objects thats no longer match the qualifier
 
 removeDeletedObjects - option to remove objects that have been deleted
 
 Returns:
 
 array of objects matching the constructed qualifier
 - objectsWithQualifier
```
public static NSArray objectsWithQualifier(EOEditingContext editingContext,
 String entityName,
 EOQualifier qualifier,
 NSArray prefetchKeyPaths,
 NSArray sortOrderings,
 int fetchLimit,
 boolean usesDistinct,
 boolean isDeep,
 NSDictionary hints,
 boolean includeNewObjects,
 boolean includeNewObjectsInParentEditingContext,
 boolean filterUpdatedObjects,
 boolean removeDeletedObjects)
```
 Utility method used to fetch an array of objects given a qualifier. Also has support for filtering the newly inserted, updated, and deleted objects in the passed editing context or any parent editing contexts as well as specifying prefetching key paths. Note that only NEW objects are supported in parent editing contexts.
 
 Parameters:
 
 editingContext - editing context to fetch it into
 
 entityName - name of the entity
 
 qualifier - qualifier
 
 prefetchKeyPaths - prefetching key paths
 
 sortOrderings - the sort orderings to use on the results
 
 fetchLimit - the fetch limit to use
 
 usesDistinct - whether or not to distinct the results
 
 isDeep - whether or not to fetch deeply
 
 hints - fetch hints to apply
 
 includeNewObjects - option to include newly inserted objects in the result set
 
 includeNewObjectsInParentEditingContext - option to include newly inserted objects in parent editing contexts. if true, the editing context lineage is explored, any newly-inserted objects matching the qualifier are collected and faulted down through all parent editing contexts of ec.
 
 filterUpdatedObjects - option to include updated objects that now match the qualifier or remove updated objects thats no longer match the qualifier
 
 removeDeletedObjects - option to remove objects that have been deleted
 
 Returns:
 
 array of objects matching the constructed qualifier
 - filteredObjectsWithQualifier
```
public static NSArray filteredObjectsWithQualifier(EOEditingContext editingContext,
 NSArray objectsToFilter,
 String entityName,
 EOQualifier qualifier,
 NSArray sortOrderings,
 boolean usesDistinct,
 boolean isDeep,
 boolean includeNewObjects,
 boolean includeNewObjectsInParentEditingContext,
 boolean filterUpdatedObjects,
 boolean removeDeletedObjects)
```
 Utility method used to filter an array of objects given a qualifier. Also has support for filtering the newly inserted, updated, and deleted objects in the passed editing context or any parent editing contexts as well as specifying prefetching key paths. Note that only NEW objects are supported in parent editing contexts.
 
 Parameters:
 
 editingContext - editing context to fetch it into
 
 objectsToFilter - objects to filter
 
 entityName - name of the entity
 
 qualifier - qualifier
 
 sortOrderings - the sort orderings to use on the results
 
 usesDistinct - whether or not to distinct the results
 
 isDeep - whether or not to fetch deeply
 
 includeNewObjects - option to include newly inserted objects in the result set
 
 includeNewObjectsInParentEditingContext - option to include newly inserted objects in parent editing contexts. if true, the editing context lineage is explored, any newly-inserted objects matching the qualifier are collected and faulted down through all parent editing contexts of ec.
 
 filterUpdatedObjects - option to include updated objects that now match the qualifier or remove updated objects thats no longer match the qualifier
 
 removeDeletedObjects - option to remove objects that have been deleted
 
 Returns:
 
 array of objects matching the constructed qualifier
 - objectWithQualifier
```
public static EOEnterpriseObject objectWithQualifier(EOEditingContext editingContext,
 String entityName,
 EOQualifier qualifier)
```
 Returns the single object of the given type matching the qualifier.
 
 Parameters:
 
 editingContext - the editing context to look in
 
 entityName - the name of the entity to look for
 
 qualifier - the qualifier to restrict by
 
 Returns:
 
 the single object of the given type matching the qualifier or null if no matching object found
 
 Throws:
 
 EOUtilities.MoreThanOneException - if more than one object matches the qualifier
 - requiredObjectWithQualifier
```
public static EOEnterpriseObject requiredObjectWithQualifier(EOEditingContext editingContext,
 String entityName,
 EOQualifier qualifier)
```
 Returns the single object of the given type matching the qualifier.
 
 Parameters:
 
 editingContext - the editing context to look in
 
 entityName - the name of the entity to look for
 
 qualifier - the qualifier to restrict by
 
 Returns:
 
 he single object of the given type matching the qualifier
 
 Throws:
 
 EOObjectNotAvailableException - if no objects match the qualifier
 
 EOUtilities.MoreThanOneException - if more than one object matches the qualifier
 - insertedObjects
```
public static NSMutableArray insertedObjects(EOEditingContext editingContext,
 NSArray<String> entityNames,
 EOQualifier qualifier)
```
 Returns the array of objects of the given type that have been inserted into the editing context and match the given qualifier. Yes, it's odd that it returns NSMutableArray -- it's an optimization specifically for objectsWithQualifier. Returns an empty array if no objects match.
 
 Parameters:
 
 editingContext - the editing context to look in
 
 entityNames - the names of the entity to look for
 
 qualifier - the qualifier to restrict by
 
 Returns:
 
 array of filtered inserted objects
 - updatedObjects
```
public static NSMutableArray updatedObjects(EOEditingContext editingContext,
 NSArray<String> entityNames,
 EOQualifier qualifier)
```
 Returns the array of objects of the given type that have been updated in the editing context and match the given qualifier. Returns an empty array if no objects match.
 
 Parameters:
 
 editingContext - the editing context to look in
 
 entityNames - the names of the entity to look for
 
 qualifier - the qualifier to restrict by
 
 Returns:
 
 array of filtered updated objects
 - deletedObjects
```
public static NSMutableArray deletedObjects(EOEditingContext editingContext,
 NSArray<String> entityNames,
 EOQualifier qualifier)
```
 Return the array of objects of the given type that have been deleted from the editing context and match the given qualifier.
 
 Parameters:
 
 editingContext - the editing context to look in
 
 entityNames - the names of the entity to look for
 
 qualifier - the qualifier to restrict by
 
 Returns:
 
 array of objects or an empty array
 - localInstancesInQualifier
```
public static EOQualifier localInstancesInQualifier(EOEditingContext ec,
 EOQualifier q)
```
 Faults every EO in the qualifiers into the specified editingContext. This is important for in memory filtering and eo comparison.
 
 Parameters:
 
 ec -
 
 q -
 - globalIDsForObjects
```
public static NSArray<EOGlobalID> globalIDsForObjects(NSArray<? extends EOEnterpriseObject> eos)
```
 Returns a NSArray containing EOGlobalIDs from the provided eos.
 
 Parameters:
 
 eos - the NSArray of EOEnterpriseObjects
 
 Returns:
 
 a NSArray of EOGlobalIDs
 - objectsForGlobalIDs
```
public static <T extends EOEnterpriseObject> NSArray<T> objectsForGlobalIDs(EOEditingContext ec,
 NSArray<EOGlobalID> globalIDs)
```
 Aggregate method for EOEditingContext.objectForGlobalID(). NOTE: this only returns objects that are already registered, if you need all objects from the GIDs, use faultsForGlobalIDs(EOEditingContext, NSArray).
 
 Parameters:
 
 ec - the EOEditingContext in which the EOEnterpriseObjects should be faulted
 
 globalIDs - the EOGlobalIDs
 
 Returns:
 
 a NSArray of EOEnterpriseObjects
 
 See Also:
 
 EOEditingContext.objectForGlobalID(EOGlobalID)
 - faultsForGlobalIDs
```
public static <T extends EOEnterpriseObject> NSArray<T> faultsForGlobalIDs(EOEditingContext ec,
 NSArray<? extends EOGlobalID> gids)
```
 Returns a NSArray containing EOEnterpriseObjects (actually faults...) for the provided EOGlobalIDs.
 
 Parameters:
 
 ec - the EOEditingContext in which the EOEnterpriseObjects should be faulted
 
 gids - the EOGlobalIDs
 
 Returns:
 
 a NSArray of EOEnterpriseObjects
 - faultsForRawRowsFromEntity
```
public static <T extends EOEnterpriseObject> NSArray<T> faultsForRawRowsFromEntity(EOEditingContext ec,
 NSArray primKeys,
 String entityName)
```
 - isNewObject
```
public static boolean isNewObject(EOEnterpriseObject eo)
```
 Determines if an enterprise object is a new object and hasn't been saved to the database yet.
 Note: An object that has been deleted will have it's editing context set to null which means this method would report true for an object that has been deleted from the database.
 
 Parameters:
 
 eo - enterprise object to check
 
 Returns:
 
 true or false depending on if the object is a new object.
 - qualifierMatchingAnyKey
```
public static EOQualifier qualifierMatchingAnyKey(NSArray keys,
 NSSelector selector,
 Object value)
```
 Creates an OR qualifier of EOKeyValueQualifiers for every keypath in the given array of keys. This is useful when trying to find a string in a set of attributes.
 
 Parameters:
 
 keys -
 
 selector -
 
 value -
 
 Author:
 
 ak
 - objectsForFaultWithSortOrderings
```
public static NSArray objectsForFaultWithSortOrderings(EOEditingContext ec,
 NSArray possibleFaults,
 NSArray sortOrderings)
```
 Uses ERXEOControlUtilities.objectForFaults to turn the faults into objects, then does in memory ordering with EOSortOrdering.EOSortOrdering.sortedArrayUsingKeyOrderArray()
 
 Parameters:
 
 ec -
 
 possibleFaults -
 
 sortOrderings -
 
 Returns:
 
 sorted array of EOs (no faults)
 - objectsForFaults
```
public static NSArray objectsForFaults(EOEditingContext ec,
 NSArray possibleFaults)
```
 Triggers all faults in an efficient manner.
 
 Parameters:
 
 ec -
 
 possibleFaults - globalIDs
 - rootEntityName
```
public static String rootEntityName(EOEnterpriseObject eo)
```
 Returns the name from the root entity from the EOEnterpriseObject
 
 Parameters:
 
 eo - the EOEnterpriseObject from which to the the root entity
 
 Returns:
 
 the name from the root entity from the EOEnterpriseObject
 - rootEntity
```
public static EOEntity rootEntity(EOEnterpriseObject eo)
```
 Returns the root entity from the EOEnterpriseObject
 
 Parameters:
 
 eo - the EOEnterpriseObject from which to the the root entity
 
 Returns:
 
 the root entity from the EOEnterpriseObject
 - stringAttributeListForEntityNamed
```
public static NSArray stringAttributeListForEntityNamed(EOEditingContext ec,
 String entityName)
```
 Calculates all of the EOAttributes of a given entity that are mapped to String objects.
 
 Returns:
 
 array of all attribute names that are mapped to String objects.
 - trimSpaces
```
public static void trimSpaces(EOEnterpriseObject object)
```
 Trims all values from string attributes from the given EO unless the EO itself or the string attribute is flagged as read-only.
 
 Parameters:
 
 object - the EO whose string attributes should be trimmed
 - destinationEntityNameForKeyPath
```
public static String destinationEntityNameForKeyPath(EOEnterpriseObject eo,
 String keyPath)
```
 Convenience to get the destination entity name from a key path of an object. Returns null if no destination found.
 
 Parameters:
 
 eo - an enterprise object
 
 keyPath - key path
 
 Returns:
 
 entity name or null
 - orQualifierForKeyPaths
```
public static EOQualifier orQualifierForKeyPaths(NSArray keyPaths,
 NSSelector selector,
 Object value)
```
 Creates an OR qualifier with the given selector for all the given key paths. If you want LIKE matches, you need to the add "*" yourself.
 
 Parameters:
 
 keyPaths -
 
 selector -
 
 value -
 - orQualifierForKeyPaths
```
public static EOQualifier orQualifierForKeyPaths(NSArray keyPaths,
 NSSelector selector,
 NSArray values)
```
 Creates an OR qualifier with the given selector for all the given key paths and all the given search terms. If you want LIKE matches, you need to the add "*" yourself.
 
 Parameters:
 
 keyPaths -
 
 selector -
 
 values -
 - andQualifier
```
public static EOQualifier andQualifier(EOQualifier q1,
 EOQualifier q2)
```
 Joins the given qualifiers with an AND. One or both arguments may be null, if both are null, null is returned.
 
 Parameters:
 
 q1 - first qualifier
 
 q2 - second qualifier
 
 Returns:
 
 combined qualifier
 - orQualifier
```
public static EOQualifier orQualifier(EOQualifier q1,
 EOQualifier q2)
```
 Joins the given qualifiers with an OR. One or both arguments may be null, if both are null, null is returned.
 
 Parameters:
 
 q1 - first qualifier
 
 q2 - second qualifier
 
 Returns:
 
 combined qualifier
 - makeQualifierTrue
```
public static void makeQualifierTrue(EOQualifier qualifier,
 Object obj)
```
 Given a qualifier of EOAndQualifiers and EOKVQualifiers, make then evaluate to true on the given object.
 
 Parameters:
 
 qualifier - the qualifier to apply to the object
 
 obj - the object to make qualifier evaluate to true for
 - convertEOtoGID
```
public static Object convertEOtoGID(Object obj)
```
 Given a dictionary, array, set, EO, etc, this will recursively turn EO's into GID's. You should lock the editingContext before calling this.
 
 Parameters:
 
 obj - the object to recursively turn EO's into GID's for
 
 Returns:
 
 the GIDful object
 - convertGIDtoEO
```
public static Object convertGIDtoEO(EOEditingContext editingContext,
 Object obj)
```
 Given a dictionary, array, set, EO, etc, this will recursively turn GID's into EO's. You should lock the editingContext before calling this.
 
 Parameters:
 
 obj - the object to recursively turn GID's into EO's for
 
 Returns:
 
 the EOful object
 - validateUniquenessOf
```
public static void validateUniquenessOf(String entityName,
 EOEnterpriseObject eo,
 EOQualifier restrictingQualifier,
 String... keys)
```
 Validates whether the values of the specified keyPaths are unique for an Entity. Throws a ERXValidationException if there is already an EO with the same values on the given key paths. Should be combined with a constraint on the corresponding database columns.
 Based on Zak Burke's idea he posted to WOCode a while ago.
 Use in validateForSave like this:
```
 ...
 public class WikiPage extends _WikiPage {
 ...
 public void validateForSave() throws ValidationException {
 super.validateForSave();
 ERXEOControlUtilities.validateUniquenessOf(null, this, ERXQ.equals("active", true), "title", "wiki");
 }
 ...
 }
 
```
 Combine with entries in ValidationTemplate.strings like:
```
 "WikiPage.title,space.UniquenessViolationNewObject" = "The page cannot be created. There is already a page named @@value.title@@ in Wiki @@value.wiki.name@@.";
 "WikiPage.title,space.UniquenessViolationExistingObject" = "The page cannot be changed this way. There is already a page named @@value.title@@ in Wiki @@value.wiki.name@@.";
 
```
 Parameters:
 
 eo - the EOEnterpriseObject to validate
 
 keys - an arbitrary number of keyPaths to validate.
 
 restrictingQualifier - an optional restricting qualifier to exclude certain objects from the check
 
 entityName - the name of the entity to check. Defaults to eo.entityName(). It can be necessary to set this to the name of the parent entity when using single table inheritance.
 
 Throws:
 
 ERXValidationException - if an EO with the same property values already exists. If you specify more than one keyPath to validate, the 'key' property will be a comma separated string of the provided keyPaths. 'value' will be a dictionary with the supplied keyPaths as keys and the values corresponding to these keys in the supplied eo as values.
 
 Author:
 
 th
 - validateUniquenessOf
```
public static void validateUniquenessOf(EOEnterpriseObject eo,
 EOQualifier restrictingQualifier,
 String... keys)
```
 Convenience method which passes null for entityName.
 
 Parameters:
 
 eo - the EOEnterpriseObject to validate
 
 restrictingQualifier - an optional restricting qualifier to exclude certain objects from the check
 
 keys - an arbitrary number of keyPaths to validate.
 
 Author:
 
 th
 - validateUniquenessOf
```
public static void validateUniquenessOf(EOEnterpriseObject eo,
 String... keys)
```
 Convenience method which passes null for restrictingQualifier and entityName.
 
 Parameters:
 
 eo - the EOEnterpriseObject to validate
 
 keys - an arbitrary number of keyPaths to validate.
 
 Author:
 
 th
 - validateUniquenessOf
```
public static void validateUniquenessOf(String entityName,
 EOEnterpriseObject eo,
 String... keys)
```
 Convenience method which passes null for restrictingQualifier.
 
 Parameters:
 
 eo - the EOEnterpriseObject to validate
 
 keys - an arbitrary number of keyPaths to validate.
 
 entityName - the name of the entity to check. Defaults to eo.entityName(). It can be necessary to set this to the name of the parent entity when using single table inheritance.
 
 Author:
 
 th
 - distinctValuesForKeyPath
```
public static <T> NSArray<T> distinctValuesForKeyPath(EOEditingContext editingContext,
 String entityName,
 String keyPath,
 EOQualifier qualifier,
 NSArray<EOSortOrdering> sortOrderings)
```
 Returns an NSArray of distinct values available for the given entity and key path. The result can be narrowed by an optional qualifier and optionally sorted with sort orderings
 
 Type Parameters:
 
 T - type of values for the key path
 
 Parameters:
 
 editingContext - editingContext
 
 entityName - entityName
 
 keyPath - keyPath
 
 qualifier - restricting qualifier (optional)
 
 sortOrderings - sortOrderings to be applied (optional)
 
 Returns:
 
 array of values
 
 Author:
 
 th
 - registeredObjectCount
```
public static NSDictionary<String,Integer> registeredObjectCount(EOEditingContext ec)
```
 Returns the count of registered objects in the EC grouped by entity name, which is useful for memory debugging. Put this in a log on session.sleep() for example.
 
 Parameters:
 
 ec - editing context to get count of
 
 Returns:
 
 dictionary of counts
 - changedRegisteredObjectCount
```
public static NSDictionary<String,Integer> changedRegisteredObjectCount(NSDictionary<String,Integer> currentCounts,
 NSDictionary<String,Integer> oldCounts)
```
 Returns the changes in count registered objects in the EC grouped by entity name, which is useful for memory debugging.
 
 Parameters:
 
 currentCounts - current count of objects
 
 oldCounts - previous count of objects
 
 Returns:
 
 dictionary of counts
 - schemaBasedFetchSpecification
```
public static EOFetchSpecification schemaBasedFetchSpecification(EOEditingContext ec,
 EOFetchSpecification fetchSpecification)
```
 Useful for ensuring a fetch specification is safe to pass around between threads and not having to be concerned about references to EOs in the qualifier.
 
 Parameters:
 
 ec - a locked EOEditingContext that can be used for getting the entity
 
 fetchSpecification -
 
 Returns:
 
 a clone of the fetchSpecification with the EOQualifier converted to a schema-based qualifier, or the original fetchSpec if the fetchSpec has no qualifier
 - schemaBasedQualifier
```
public static EOQualifier schemaBasedQualifier(EOEditingContext ec,
 String entityName,
 EOQualifier qualifier)
```
 Useful for ensuring a qualifier is safe to pass around between threads and not having to be concerned about references to EOs in it. Also handy to verify that an EOQualifier can be used in a database fetch.
 
 Parameters:
 
 ec - a locked EOEditingContext that can be used for getting the entity
 
 entityName - the entity being qualified
 
 qualifier - original qualifier
 
 Returns:
 
 a schema based qualifier that contains no references to EOEnterpriseObjects

Class ERXEOControlUtilities

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ERXEOControlUtilities

Method Detail

localInstancesOfObjects

dataSourceForArray

dataSourceForArray

arrayFromDataSource

dataSourceForObjectAndKey

editableInstanceOfObject

localInstanceOfObject

eoEquals

createAndInsertObject

createAndInsertObject

createAndInsertObject

createAndAddObjectToRelationship

addObjectToObjectOnBothSidesOfRelationshipWithKey

refaultObject

refreshObject

clearSnapshotForRelationshipNamed

clearSnapshotForRelationshipNamedInDatabase

primaryKeyFetchSpecificationForEntity

primaryKeysMatchingQualifier

objectWithPrimaryKeyValue

objectWithPrimaryKeyValue

objectWithPrimaryKeyValue

objectsInRange

objectsInRange

primaryKeyValuesInRange

objectCountWithQualifier

objectCountUniqueWithQualifierAndAttribute

objectCountForToManyRelationship

_aggregateFunctionWithQualifierAndAggregateAttribute

aggregateFunctionWithQualifier

aggregateFunctionWithQualifier

aggregateStringWithQualifier

aggregateTimestampWithQualifier

_aggregateFunctionWithQualifier

sharedObjectMatchingKeyAndValue

sharedObjectsMatchingKeyAndValue

sharedObjectsForEntityNamed

sharedObjectWithFetchSpec

sharedObjectsWithFetchSpecificationNamed

sharedObjectWithPrimaryKey

fetchSpecificationNamedWithBindings

newPrimaryKeyDictionaryForObjectFromClassProperties

newPrimaryKeyDictionaryForObject

newPrimaryKeyDictionaryForEntityNamed

primaryKeyStringForObject

primaryKeyStringForGlobalID

_stringForPrimaryKey

primaryKeyDictionaryForString

globalIDForString

primaryKeyObjectForObject

primaryKeyArrayForObject

objectsWithQualifierFormat

objectsWithQualifierFormat

objectsWithQualifier

objectsWithQualifier

objectsWithQualifier

objectsWithQualifier

objectsWithQualifier

filteredObjectsWithQualifier

objectWithQualifier

requiredObjectWithQualifier

insertedObjects

updatedObjects

deletedObjects

localInstancesInQualifier

globalIDsForObjects

objectsForGlobalIDs

faultsForGlobalIDs

faultsForRawRowsFromEntity

isNewObject

qualifierMatchingAnyKey

objectsForFaultWithSortOrderings

objectsForFaults