er.extensions.eof

Class ERXEOGlobalIDUtilities

java.lang.Object

er.extensions.eof.ERXEOGlobalIDUtilities

public class ERXEOGlobalIDUtilities
extends Object

Utilities that help with batch loading sets of global IDs.

Author:

ak

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ERXEOGlobalIDUtilities.Info Decrypts the byte array of NSData PKs so you get the process number or port, host and timestamp.

Constructor Summary

Constructors

Constructor and Description
ERXEOGlobalIDUtilities()

Method Summary

Modifier and Type	Method and Description
static com.webobjects.eocontrol.EOKeyGlobalID	createGlobalID(String entityName, Object[] values) Creates a global ID for the given entity name and its primary key value(s).
static <T extends com.webobjects.eocontrol.EOGlobalID> NSMutableArray<com.webobjects.eocontrol.EOEnterpriseObject>	fetchObjectsWithGlobalIDs(com.webobjects.eocontrol.EOEditingContext ec, Collection<T> globalIDs) Fetches an array of objects defined by the globalIDs in a single fetch per entity without refreshing refetched objects.
static <T extends com.webobjects.eocontrol.EOGlobalID> NSMutableArray<com.webobjects.eocontrol.EOEnterpriseObject>	fetchObjectsWithGlobalIDs(com.webobjects.eocontrol.EOEditingContext ec, Collection<T> globalIDs, boolean refreshesRefetchedObjects) Fetches an array of objects defined by the globalIDs in a single fetch per entity.
static com.webobjects.eocontrol.EOEnterpriseObject	fetchObjectWithGlobalID(com.webobjects.eocontrol.EOEditingContext ec, com.webobjects.eocontrol.EOGlobalID gid) Fetches an object defined by gid without refreshing refetched objects.
static <T extends com.webobjects.eocontrol.EOGlobalID> NSArray<com.webobjects.eocontrol.EOEnterpriseObject>	fireFaultsForGlobalIDs(com.webobjects.eocontrol.EOEditingContext ec, Collection<T> globalIDs) Fires all faults in the given global IDs on one batch.
static <T extends com.webobjects.eocontrol.EOGlobalID> NSArray<com.webobjects.eocontrol.EOEnterpriseObject>	fireFaultsForGlobalIDs(com.webobjects.eocontrol.EOEditingContext ec, Collection<T> globalIDs, Collection<String> prefetchingKeypaths) Fires all faults in the given global IDs on one batch together with their relationships.
static <T extends com.webobjects.eocontrol.EOGlobalID> NSDictionary<String,NSArray<T>>	globalIDsGroupedByEntityName(Collection<T> globalIDs) Groups an array of global IDs by their entity name.
static NSArray<com.webobjects.eocontrol.EOGlobalID>	globalIDsWithPrimaryKeyValues(String entityName, Collection<Object> values) Translates an array of single-value raw primary key values to EOGlobalIDs.
static <T extends com.webobjects.eocontrol.EOGlobalID> NSArray<Object>	primaryKeyValuesWithGlobalIDs(Collection<T> globalIDs) Translates an array of EOGlobalID to primary key values.

Methods inherited from class java.lang.Object

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

Constructor Detail

ERXEOGlobalIDUtilities

public ERXEOGlobalIDUtilities()

Method Detail

globalIDsGroupedByEntityName

public static <T extends com.webobjects.eocontrol.EOGlobalID> NSDictionary<String,NSArray<T>> globalIDsGroupedByEntityName(Collection<T> globalIDs)

Groups an array of global IDs by their entity name.

Type Parameters:

T - subclass of EOGlobalID

Parameters:

globalIDs - list of global IDs

Returns:

dictionary with global IDs grouped by their entity name

primaryKeyValuesWithGlobalIDs

public static <T extends com.webobjects.eocontrol.EOGlobalID> NSArray<Object> primaryKeyValuesWithGlobalIDs(Collection<T> globalIDs)

Translates an array of EOGlobalID to primary key values. Throws an exception if the given global IDs are not EOKeyGlobalIDs and the primary keys are not single values.

Type Parameters:

T - subclass of EOGlobalID

Parameters:

globalIDs - list of global IDs

Returns:

list of primary key values

globalIDsWithPrimaryKeyValues

public static NSArray<com.webobjects.eocontrol.EOGlobalID> globalIDsWithPrimaryKeyValues(String entityName,
                                                                                         Collection<Object> values)

Translates an array of single-value raw primary key values to EOGlobalIDs.

Parameters:

entityName - the entity name of the raw primary values

values - list of raw primary key values

Returns:

list of global IDs

fetchObjectWithGlobalID

public static com.webobjects.eocontrol.EOEnterpriseObject fetchObjectWithGlobalID(com.webobjects.eocontrol.EOEditingContext ec,
                                                                                  com.webobjects.eocontrol.EOGlobalID gid)

Fetches an object defined by gid without refreshing refetched objects.

Parameters:

ec - the editing context to fetch within

gid - the global ID to fetch

Returns:

the fetched EO

fetchObjectsWithGlobalIDs

public static <T extends com.webobjects.eocontrol.EOGlobalID> NSMutableArray<com.webobjects.eocontrol.EOEnterpriseObject> fetchObjectsWithGlobalIDs(com.webobjects.eocontrol.EOEditingContext ec,
                                                                                                                                                    Collection<T> globalIDs)

Fetches an array of objects defined by the globalIDs in a single fetch per entity without refreshing refetched objects.

Type Parameters:

T - subclass of EOGlobalID

Parameters:

ec - the editing context to fetch within

globalIDs - the global IDs to fetch

Returns:

the fetched EOs

fetchObjectsWithGlobalIDs

public static <T extends com.webobjects.eocontrol.EOGlobalID> NSMutableArray<com.webobjects.eocontrol.EOEnterpriseObject> fetchObjectsWithGlobalIDs(com.webobjects.eocontrol.EOEditingContext ec,
                                                                                                                                                    Collection<T> globalIDs,
                                                                                                                                                    boolean refreshesRefetchedObjects)

Fetches an array of objects defined by the globalIDs in a single fetch per entity.

Type Parameters:

T - subclass of EOGlobalID

Parameters:

ec - the editing context to fetch within

globalIDs - the global IDs to fetch

refreshesRefetchedObjects - whether or not to refresh refetched objects

Returns:

the fetched EOs

fireFaultsForGlobalIDs

public static <T extends com.webobjects.eocontrol.EOGlobalID> NSArray<com.webobjects.eocontrol.EOEnterpriseObject> fireFaultsForGlobalIDs(com.webobjects.eocontrol.EOEditingContext ec,
                                                                                                                                          Collection<T> globalIDs,
                                                                                                                                          Collection<String> prefetchingKeypaths)

Fires all faults in the given global IDs on one batch together with their relationships. This is much more efficient than triggering the individual faults and relationships later on. The method should use only 1 fetch for all objects per entity and then one for each relationship per entity.

Type Parameters:

T - subclass of EOGlobalID

Parameters:

ec - editing context to fault into

globalIDs - the global IDs to fault

prefetchingKeypaths - list of key paths to prefetch or null

Returns:

faulted objects

fireFaultsForGlobalIDs

public static <T extends com.webobjects.eocontrol.EOGlobalID> NSArray<com.webobjects.eocontrol.EOEnterpriseObject> fireFaultsForGlobalIDs(com.webobjects.eocontrol.EOEditingContext ec,
                                                                                                                                          Collection<T> globalIDs)

Fires all faults in the given global IDs on one batch. This is much more efficient than triggering the individual faults later on. The method should use only 1 fetch for all objects per entity.

Type Parameters:

T - subclass of EOGlobalID

Parameters:

ec - editing context to fault in

globalIDs - the global IDs to fault

Returns:

list of faulted objects

createGlobalID

public static com.webobjects.eocontrol.EOKeyGlobalID createGlobalID(String entityName,
                                                                    Object[] values)

Creates a global ID for the given entity name and its primary key value(s).

Parameters:

entityName - the entity name

values - one or more primary key values

Returns:

global ID object