er.extensions.eof

Class ERXFetchSpecification<T extends 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:

EOKeyValueArchiving, NSCoding, Serializable, Cloneable

Direct Known Subclasses:

ERXGroupingFetchSpecification

public class ERXFetchSpecification<T extends EOEnterpriseObject>
extends 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

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

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

EOKeyValueArchiving._NullValueSupport, EOKeyValueArchiving._NumberSupport, EOKeyValueArchiving._TimestampSupport, EOKeyValueArchiving.Awaking, EOKeyValueArchiving.FinishInitialization, EOKeyValueArchiving.Support

Field Summary

Fields inherited from class com.webobjects.eocontrol.EOFetchSpecification

_CLASS

Constructor Summary

Constructors

Constructor and Description
ERXFetchSpecification(EOFetchSpecification spec)
ERXFetchSpecification(ERXFetchSpecification<T> spec)
ERXFetchSpecification(String entityName) Constructs a new fetch specification for the given entity with isDeep = true.
ERXFetchSpecification(String entityName, EOQualifier qualifier, NSArray<EOSortOrdering> sortOrderings)
ERXFetchSpecification(String entityName, EOQualifier qualifier, NSArray<EOSortOrdering> sortOrderings, boolean usesDistinct, boolean isDeep, NSDictionary hints)

Method Summary

Modifier and Type	Method and Description
protected String	additionalIdentifierInfo()
Object	clone()
NSArray<T>	fetchObjects(EOEditingContext ec) Type-safe method to fetch objects for this fetch spec.
NSRange	fetchRange()
NSArray<NSDictionary<String,Object>>	fetchRawRows(EOEditingContext ec) Type-safe method to fetch raw rows.
static <T extends EOEnterpriseObject> ERXFetchSpecification<T>	fetchSpec(EOFetchSpecification fs) Converts a normal fetch spec to an ERX one.
static <T extends EOEnterpriseObject> ERXFetchSpecification<T>	fetchSpec(EOFetchSpecification fs, Class<T> clazz) Converts a normal fetch spec to an ERX one that returns instances of T.
static EOFetchSpecification	fetchSpec(String entityName, EOQualifier qualifier, NSArray<EOSortOrdering> sortOrderings, boolean usesDistinct, boolean isDeep, NSDictionary hints)
String	identifier() Collects all relevant attributes and the bindings and returns a key suitable for caching.
static String	identifierForFetchSpec(EOFetchSpecification fs) Builds an identifier for the given fetch spec which is suitable for caching.
protected static String	identifierForQualifier(EOQualifier qualifier) Helper to create a string from a qualifier.
boolean	includeEditingContextChanges() Returns whether or not to include editing context changes.
Object	objectForKey(String key) Gets an arbitrary value.
ERXFetchSpecification<T>	qualify(EOQualifier qualifier) Sets the qualifier on this fetch specification and returns "this" for chaining.
void	setFetchRange(NSRange range) Defines a batch range that should be applied to the SQL statement.
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(Object value, String key) Sets a arbitrary value.
void	setPrefetchingRelationshipKeyPaths(ERXKey<?>... prefetchingRelationshipKeyPaths) Sets the relationships to prefetch along with the main fetch.
void	setRawRowKeyPaths(String keyPath, String... keyPaths) Sets a list of attribute keys to be fetched as raw data.
ERXFetchSpecification<T>	sort(EOSortOrdering sortOrdering) Sets the sort orderings on this fetch specification and returns "this" for chaining.
ERXFetchSpecification<T>	sort(NSArray<EOSortOrdering> sortOrderings) Sets the sort orderings on this fetch specification and returns "this" for chaining.
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(String entityName,
                             EOQualifier qualifier,
                             NSArray<EOSortOrdering> sortOrderings,
                             boolean usesDistinct,
                             boolean isDeep,
                             NSDictionary hints)

ERXFetchSpecification

public ERXFetchSpecification(String entityName,
                             EOQualifier qualifier,
                             NSArray<EOSortOrdering> sortOrderings)

ERXFetchSpecification

public ERXFetchSpecification(EOFetchSpecification spec)

ERXFetchSpecification

public ERXFetchSpecification(ERXFetchSpecification<T> spec)

ERXFetchSpecification

public ERXFetchSpecification(String entityName)

Constructs a new fetch specification for the given entity with isDeep = true.

Parameters:

entityName - the name of the entity

Method Detail

fetchSpec

public static EOFetchSpecification fetchSpec(String entityName,
                                             EOQualifier qualifier,
                                             NSArray<EOSortOrdering> sortOrderings,
                                             boolean usesDistinct,
                                             boolean isDeep,
                                             NSDictionary hints)

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(Object value,
                            String key)

Sets a arbitrary value.

Parameters:

value -

key -

objectForKey

public Object objectForKey(String key)

Gets an arbitrary value.

Parameters:

key -

Returns:

object for given key

userInfo

public NSDictionary userInfo()

Gets the user info.

Returns:

user info dictionary

fetchRange

public NSRange fetchRange()

setFetchRange

public void setFetchRange(NSRange range)

Defines a batch range that should be applied to the SQL statement. Only useful if the database plugin supports it and as an alternative to fetchLimit. The SQL generation behavior when both a fetchLimit and a fetchRange are specified is undefined and dependent on the individual database plugin.

Parameters:

range -

fetchObjects

public NSArray<T> fetchObjects(EOEditingContext ec)

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

Parameters:

ec -

Returns:

object array

fetchRawRows

public NSArray<NSDictionary<String,Object>> fetchRawRows(EOEditingContext ec)

Type-safe method to fetch raw rows.

Parameters:

ec -

Returns:

array of raw row dictionaries

setRawRowKeyPaths

public void setRawRowKeyPaths(String keyPath,
                              String... keyPaths)

Sets a list of attribute keys to be fetched as raw data. Uses two params for backwards compatibility as a setRawRowKeyPaths(null) would be ambiguous otherwise.

Parameters:

keyPath -

keyPaths - list of attribute keys

See Also:

EOFetchSpecification.setRawRowKeyPaths(NSArray)

setPrefetchingRelationshipKeyPaths

public void setPrefetchingRelationshipKeyPaths(ERXKey<?>... prefetchingRelationshipKeyPaths)

Sets the relationships to prefetch along with the main fetch.

Parameters:

prefetchingRelationshipKeyPaths - list of keys to prefetch

See Also:

EOFetchSpecification.setPrefetchingRelationshipKeyPaths(NSArray)

identifier

public String identifier()

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

Returns:

identifier string

additionalIdentifierInfo

protected String additionalIdentifierInfo()

clone

public Object clone()

Overrides:

clone in class EOFetchSpecification

qualify

public ERXFetchSpecification<T> qualify(EOQualifier qualifier)

Sets the qualifier on this fetch specification and returns "this" for chaining.

Parameters:

qualifier - the qualifier to set

Returns:

this

sort

public ERXFetchSpecification<T> sort(NSArray<EOSortOrdering> sortOrderings)

Sets the sort orderings on this fetch specification and returns "this" for chaining.

Parameters:

sortOrderings - the sort orderings to set

Returns:

this

sort

public ERXFetchSpecification<T> sort(EOSortOrdering sortOrdering)

Sets the sort orderings on this fetch specification and returns "this" for chaining.

Parameters:

sortOrdering - the sort ordering to set

Returns:

this

fetchSpec

public static <T extends EOEnterpriseObject> ERXFetchSpecification<T> fetchSpec(EOFetchSpecification fs,
                                                                                Class<T> clazz)

Converts a normal fetch spec to an ERX one that returns instances of T.

Type Parameters:

T -

Parameters:

fs -

clazz -

Returns:

converted fetch spec

fetchSpec

public static <T extends EOEnterpriseObject> ERXFetchSpecification<T> fetchSpec(EOFetchSpecification fs)

Converts a normal fetch spec to an ERX one.

Type Parameters:

T -

Parameters:

fs -

Returns:

converted fetch spec

identifierForQualifier

protected static String identifierForQualifier(EOQualifier qualifier)

Helper to create a string from a qualifier.

Parameters:

qualifier -

Returns:

qualifier string

identifierForFetchSpec

public static String identifierForFetchSpec(EOFetchSpecification fs)

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

Parameters:

fs -

Returns:

fetch spec string