er.extensions.eof
Class ERXFetchSpecification<T extends com.webobjects.eocontrol.EOEnterpriseObject>

java.lang.Object
  com.webobjects.eocontrol.EOFetchSpecification
      er.extensions.eof.ERXFetchSpecification<T>

Type Parameters:

T - the type of objects this fetch spec will return

All Implemented Interfaces:

com.webobjects.eocontrol.EOKeyValueArchiving, com.webobjects.foundation.NSCoding, java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

ERXGroupingFetchSpecification

public class ERXFetchSpecification<T extends com.webobjects.eocontrol.EOEnterpriseObject>
extends com.webobjects.eocontrol.EOFetchSpecification

Extended fetch specification.

• has an identifier for caching
• type-safe, can fetch objects of a certain type
• has a user info

See Also:

Serialized Form

Author:

ak

Nested Class Summary

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

com.webobjects.foundation.NSCoding._BigDecimalSupport, com.webobjects.foundation.NSCoding._BigIntegerSupport, com.webobjects.foundation.NSCoding._BooleanSupport, com.webobjects.foundation.NSCoding._ByteSupport, com.webobjects.foundation.NSCoding._CharacterSupport, com.webobjects.foundation.NSCoding._DateSupport, com.webobjects.foundation.NSCoding._DoubleSupport, com.webobjects.foundation.NSCoding._FloatSupport, com.webobjects.foundation.NSCoding._IntegerSupport, com.webobjects.foundation.NSCoding._LongSupport, com.webobjects.foundation.NSCoding._NumberSupport, com.webobjects.foundation.NSCoding._ShortSupport, com.webobjects.foundation.NSCoding._StringSupport, com.webobjects.foundation.NSCoding.Support

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

com.webobjects.eocontrol.EOKeyValueArchiving._NullValueSupport, com.webobjects.eocontrol.EOKeyValueArchiving._NumberSupport, com.webobjects.eocontrol.EOKeyValueArchiving._TimestampSupport, com.webobjects.eocontrol.EOKeyValueArchiving.Awaking, com.webobjects.eocontrol.EOKeyValueArchiving.FinishInitialization, com.webobjects.eocontrol.EOKeyValueArchiving.Support

Field Summary

Fields inherited from class com.webobjects.eocontrol.EOFetchSpecification

_CLASS

Constructor Summary

ERXFetchSpecification(com.webobjects.eocontrol.EOFetchSpecification spec)

ERXFetchSpecification(ERXFetchSpecification<T> spec)

ERXFetchSpecification(java.lang.String entityName, com.webobjects.eocontrol.EOQualifier qualifier, com.webobjects.foundation.NSArray sortOrderings)

ERXFetchSpecification(java.lang.String entityName, com.webobjects.eocontrol.EOQualifier qualifier, com.webobjects.foundation.NSArray sortOrderings, boolean usesDistinct, boolean isDeep, com.webobjects.foundation.NSDictionary hints)

Method Summary

protected java.lang.String	additionalIdentifierInfo()
java.lang.Object	clone()
com.webobjects.foundation.NSArray<T>	fetchObjects(com.webobjects.eocontrol.EOEditingContext ec) Type-safe method to fetch objects for this fetch spec.
com.webobjects.foundation.NSArray<com.webobjects.foundation.NSDictionary<java.lang.String,java.lang.Object>>	fetchRawRows(com.webobjects.eocontrol.EOEditingContext ec) Type-safe method to fetch raw rows.
static <T extends com.webobjects.eocontrol.EOEnterpriseObject> ERXFetchSpecification<T>	fetchSpec(com.webobjects.eocontrol.EOFetchSpecification fs) Converts a normal fetch spec to an ERX one.
static <T extends com.webobjects.eocontrol.EOEnterpriseObject> ERXFetchSpecification<T>	fetchSpec(com.webobjects.eocontrol.EOFetchSpecification fs, java.lang.Class<T> clazz) Converts a normal fetch spec to an ERX one.
java.lang.String	identifier() Collects all relevant attributes and the bindings and returns a key suitable for caching.
static java.lang.String	identifierForFetchSpec(com.webobjects.eocontrol.EOFetchSpecification fs) Builds an identifier for the given fetch spec which is suitable for caching.
protected static java.lang.String	identifierForQualifier(com.webobjects.eocontrol.EOQualifier q) Helper to create a string from a qualifier.
boolean	includeEditingContextChanges() Returns whether or not to include editing context changes.
java.lang.Object	objectForKey(java.lang.String key) Gets an arbitrary value.
void	setIncludeEditingContextChanges(boolean includeEditingContextChanges) When true, objectsWithFetchSpecification will include newly inserted objects, newly removed objects, and newly updated objects in your fetch results (@see ERXEOControlUtilities.objectsWithQualifier).
void	setObjectForKey(java.lang.Object value, java.lang.String key) Sets a arbitrary value.
com.webobjects.foundation.NSDictionary	userInfo() Gets the user info.

Methods inherited from class com.webobjects.eocontrol.EOFetchSpecification

_decodeWithKeyValueUnarchiver, classForCoder, decodeObject, decodeWithKeyValueUnarchiver, encodeWithCoder, encodeWithKeyValueArchiver, entityName, fetchesRawRows, fetchLimit, fetchSpecificationNamed, fetchSpecificationWithQualifierBindings, hints, isDeep, locksObjects, prefetchingRelationshipKeyPaths, promptsAfterFetchLimit, qualifier, rawRowKeyPaths, refreshesRefetchedObjects, requiresAllQualifierBindingVariables, setEntityName, setFetchesRawRows, setFetchLimit, setHints, setIsDeep, setLocksObjects, setPrefetchingRelationshipKeyPaths, setPromptsAfterFetchLimit, setQualifier, setRawRowKeyPaths, setRefreshesRefetchedObjects, setRequiresAllQualifierBindingVariables, setSortOrderings, setUsesDistinct, sortOrderings, toString, usesDistinct

Methods inherited from class java.lang.Object

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

Constructor Detail

ERXFetchSpecification

public ERXFetchSpecification(java.lang.String entityName,
                             com.webobjects.eocontrol.EOQualifier qualifier,
                             com.webobjects.foundation.NSArray sortOrderings,
                             boolean usesDistinct,
                             boolean isDeep,
                             com.webobjects.foundation.NSDictionary hints)

ERXFetchSpecification

public ERXFetchSpecification(java.lang.String entityName,
                             com.webobjects.eocontrol.EOQualifier qualifier,
                             com.webobjects.foundation.NSArray sortOrderings)

ERXFetchSpecification

public ERXFetchSpecification(com.webobjects.eocontrol.EOFetchSpecification spec)

ERXFetchSpecification

public ERXFetchSpecification(ERXFetchSpecification<T> spec)

Method Detail

setIncludeEditingContextChanges

public void setIncludeEditingContextChanges(boolean includeEditingContextChanges)

When true, objectsWithFetchSpecification will include newly inserted objects, newly removed objects, and newly updated objects in your fetch results (@see ERXEOControlUtilities.objectsWithQualifier).

Parameters:

includeEditingContextChanges - whether or not to include editing context changes

includeEditingContextChanges

public boolean includeEditingContextChanges()

Returns whether or not to include editing context changes.

Returns:

whether or not to include editing context changes

setObjectForKey

public void setObjectForKey(java.lang.Object value,
                            java.lang.String key)

Sets a arbitrary value.

objectForKey

public java.lang.Object objectForKey(java.lang.String key)

Gets an arbitrary value.

Parameters:

key -

userInfo

public com.webobjects.foundation.NSDictionary userInfo()

Gets the user info.

fetchObjects

public com.webobjects.foundation.NSArray<T> fetchObjects(com.webobjects.eocontrol.EOEditingContext ec)

Type-safe method to fetch objects for this fetch spec.

Parameters:

ec -

fetchRawRows

public com.webobjects.foundation.NSArray<com.webobjects.foundation.NSDictionary<java.lang.String,java.lang.Object>> fetchRawRows(com.webobjects.eocontrol.EOEditingContext ec)

Type-safe method to fetch raw rows.

Parameters:

ec -

identifier

public java.lang.String identifier()

Collects all relevant attributes and the bindings and returns a key suitable for caching.

additionalIdentifierInfo

protected java.lang.String additionalIdentifierInfo()

clone

public java.lang.Object clone()

Overrides:

clone in class com.webobjects.eocontrol.EOFetchSpecification

fetchSpec

public static <T extends com.webobjects.eocontrol.EOEnterpriseObject> ERXFetchSpecification<T> fetchSpec(com.webobjects.eocontrol.EOFetchSpecification fs,
                                                                                                         java.lang.Class<T> clazz)

Converts a normal fetch spec to an ERX one.

Type Parameters:

T -

Parameters:

fs -

clazz -

fetchSpec

public static <T extends com.webobjects.eocontrol.EOEnterpriseObject> ERXFetchSpecification<T> fetchSpec(com.webobjects.eocontrol.EOFetchSpecification fs)

Converts a normal fetch spec to an ERX one.

Type Parameters:

T -

Parameters:

fs -

identifierForQualifier

protected static java.lang.String identifierForQualifier(com.webobjects.eocontrol.EOQualifier q)

Helper to create a string from a qualifier.

Parameters:

q -

identifierForFetchSpec

public static java.lang.String identifierForFetchSpec(com.webobjects.eocontrol.EOFetchSpecification fs)

Builds an identifier for the given fetch spec which is suitable for caching.

Parameters:

fs -