EOEnterpriseObjectClazz (Project Wonder Reference Documentation)

java.lang.Object
- er.extensions.eof.EOEnterpriseObjectClazz<T>

Type Parameters:

T - eo class to represent

Direct Known Subclasses:

ERXCustomObject.ERXCustomObjectClazz, ERXGenericRecord.ERXGenericRecordClazz
```
public class EOEnterpriseObjectClazz<T extends EOEnterpriseObject>
extends Object
```
Adds class-level inheritance to EOF.
In Java, static methods are similar to class methods in Objective-C, but one cannot use static methods in interfaces and static methods cannot be overridden by a subclass. Using the clazz pattern removes those limitations.
Instead of using a static method, we can use a static inner class (a clazz) instead. This allows for the methods on the clazz to be available statically to the class. The advantage is that static utility methods don't need to be generated for every subclass of an EOEnterpriseObject. It is generally sufficient to simply use the utility methods available on the EOEnterpriseObjectClazz.
Every subclass of this class will get their own "ClazzObject" instance, so it's OK to store things which might be different in superclasses. That is, the "User"'s implementation can override the "Person"'s and because Person.clazz() will get it's own instance, it will do only "Person" things.
Use subclasses of EOEnterpriseObjectClazz as inner classes in your EO subclasses to work around the missing class object inheritance of java. They must be named XX.XXClazz to work.
The methods from EOUtilities are mirrored here so you don't have to import EOAccess in your subclasses, which is not legal for client-side classes. The implementation for a client-side class could then be easily switched to use the server-side EOUtilites implementation.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`EOEnterpriseObjectClazz.ClazzFactory` Provides a hook to control how a clazz object is chosen from a given entity.
`static class`	`EOEnterpriseObjectClazz.DefaultClazzFactory` Default factory implementation.

Constructor Summary

Constructors
Constructor and Description

EOEnterpriseObjectClazz()
Default public constructor.

EOEnterpriseObjectClazz(String entityName)
Constructor that also supplies an entity name.

Constructors
Constructor and Description
`EOEnterpriseObjectClazz()` Default public constructor.
`EOEnterpriseObjectClazz(String entityName)` Constructor that also supplies an entity name.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`NSArray<T>`	`allObjects(EOEditingContext ec)` Gets all of the objects for the clazz's entity.
`EOClassDescription`	`classDescription()` Returns the class description for the entity.
`static EOEnterpriseObjectClazz`	`clazzForEntityNamed(String entityName)` Method used to get a clazz object for a given entity name.
`T`	`createAndInsertObject(EOEditingContext ec)` Creates and inserts an object of the type of the clazz into the given editing context.
`ERXFetchSpecification<T>`	`createFetchSpecification(EOQualifier qualifier, NSArray<EOSortOrdering> sortings)` Creates a fetch spec for the entity.
`protected void`	`discoverEntityName()`
`EOEntity`	`entity()` Gets the entity corresponding to the entity name of the clazz.
`EOEntity`	`entity(EOEditingContext ec)` Gets the entity corresponding to the entity name of the clazz.
`String`	`entityName()` Gets the entity name of the clazz.
`protected String`	`entityNameFromRawRow(EOEditingContext ec, NSDictionary dict)` Utility method to get the entity name from a raw row dictionary, taking subclasses and restricting qualifiers into account.
`static EOEnterpriseObjectClazz.ClazzFactory`	`factory()`
`NSArray<T>`	`faultsFromRawRows(EOEditingContext ec, NSArray nsarray)` Constructs an array of faults for a given array of primary keys in a given editing context for the clazz's entity.
`NSArray<T>`	`faultsMatchingQualifier(EOEditingContext ec, EOQualifier eoqualifier)` Fetches an array of faults matching a given qualifier.
`NSArray<T>`	`faultsMatchingQualifier(EOEditingContext ec, EOQualifier eoqualifier, NSArray<EOSortOrdering> sortOrderings)` Fetches an array of faults matching a given qualifier and sorted by an array of sort orderings.
`NSArray<T>`	`faultsMatchingValues(EOEditingContext ec, NSDictionary nsdictionary, NSArray<EOSortOrdering> sortOrderings)` Fetches an array of faults for a given set of criteria.
`EOFetchSpecification`	`fetchSpecificationNamed(EOEditingContext ec, String name)` Gets a fetch specification for a given name.
`EOFetchSpecification`	`fetchSpecificationNamed(String name)` Gets a fetch specification for a given name.
`NSArray<T>`	`filteredArray(NSArray<T> array, EOFetchSpecification spec, NSDictionary bindings)` Filters an array with a given fetch spec.
`EOEnterpriseObjectClazz`	`init(String entityName)` Convenience init so you can chain constructor calls:
`protected void`	`initialize()` Called by the constructor.
`EOArrayDataSource`	`newArrayDataSource(EOEditingContext ec)` Utility to return a new array datasource
`EODatabaseDataSource`	`newDatabaseDataSource(EOEditingContext ec)` Utility to return a new database datasource
`NSArray`	`newPrimaryKeys(EOEditingContext ec, int i)` Generates an array of primary key values for the clazz's entity.
`protected static EOAttribute`	`objectCountAttribute()` Creates and caches an eo attribute that can be used to return the number of objects that a given fetch specification will return.
`protected static EOAttribute`	`objectCountUniqueAttribute(EOAttribute foo)`
`Number`	`objectCountWithFetchSpecificationAndBindings(EOEditingContext ec, String fetchSpecName, NSDictionary bindings)` Find the number of objects matching the given fetch specification and bindings for the clazz's entity name.
`Number`	`objectCountWithQualifier(EOEditingContext ec, EOQualifier qualifier)` Returns the number of objects matching the given qualifier for the clazz's entity name.
`T`	`objectFromRawRow(EOEditingContext ec, NSDictionary dict)` Creates an enterprise object from a raw row for the clazz's entity in the given editing context.
`T`	`objectMatchingKeyAndValue(EOEditingContext ec, String key, Object value)` Fetches the object matching the given key and value corresponding to the clazz's entity using the given editing context.
`NSArray<T>`	`objectsMatchingKeyAndValue(EOEditingContext ec, String key, Object value)` Fetches all of the objects matching the given key and value corresponding to the clazz's entity using the given editing context.
`NSArray<T>`	`objectsMatchingQualifier(EOEditingContext ec, EOQualifier qualifier)`
`NSArray<T>`	`objectsMatchingQualifier(EOEditingContext ec, EOQualifier qualifier, NSArray<EOSortOrdering> sortOrdering)`
`NSArray<T>`	`objectsWithFetchSpecificationAndBindings(EOEditingContext ec, String name, NSDictionary bindings)` Fetches an array of objects for a given fetch specification and an array of bindings.
`NSArray<T>`	`objectsWithQualifierFormat(EOEditingContext ec, String qualifier, NSArray args)` Fetches all of the objects matching the given qualifier format corresponding to the clazz's entity using the given editing context.
`T`	`objectWithPrimaryKeyValue(EOEditingContext ec, Object pk)` Fetches the enterprise object for the specified primary key value and corresponding to the clazz's entity name.
`EOFetchSpecification`	`primaryKeyFetchSpecificationForEntity(EOQualifier qualifier, NSArray<EOSortOrdering> sortOrderings, NSArray<String> additionalKeys)` Constructs a fetch specification that will only fetch the primary keys for a given qualifier.
`NSArray`	`primaryKeysMatchingQualifier(EOEditingContext ec, EOQualifier eoqualifier, NSArray sortOrderings)` Fetches an array of primary keys matching a given qualifier and sorted with a given array of sort orderings.
`NSArray`	`primaryKeysMatchingValues(EOEditingContext ec, NSDictionary nsdictionary, NSArray sortOrderings)` Fetches an array of primary keys matching the values in a given dictionary.
`static void`	`resetClazzCache()` Resets the clazz cache.
`protected void`	`setEntityName(String name)` Sets the entity name of the clazz.
`static void`	`setFactory(EOEnterpriseObjectClazz.ClazzFactory value)`

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

- Constructor Detail
  - EOEnterpriseObjectClazz
```
public EOEnterpriseObjectClazz()
```
    Default public constructor. In case you let your code generate with a template, you can simply call:
```
 public static FooClazz clazz = new FooClazz();
 
```
    and the constructor will auto-discover your entity name. This only works when you have a concrete subclass for the entity in question, though.
  - EOEnterpriseObjectClazz
```
public EOEnterpriseObjectClazz(String entityName)
```
    Constructor that also supplies an entity name.
    
    Parameters:
    
    entityName - entity name
- Method Detail
  - objectCountAttribute
```
protected static EOAttribute objectCountAttribute()
```
    Creates and caches an eo attribute that can be used to return the number of objects that a given fetch specification will return.
    
    Returns:
    
    eo count attribute
  - objectCountUniqueAttribute
```
protected static EOAttribute objectCountUniqueAttribute(EOAttribute foo)
```
    Parameters:
    
    foo -
  - initialize
```
protected void initialize()
```
    Called by the constructor.
  - discoverEntityName
```
protected void discoverEntityName()
```
  - init
```
public EOEnterpriseObjectClazz init(String entityName)
```
    Convenience init so you can chain constructor calls:
```
 public static FooClazz clazz = (FooClazz)new FooClazz().init("Foo");
 
```
    without having to override the default constructor or the one that takes an entity name. Also useful when you don't have a special clazz defined for your entity, but would rather take one from a superclass.
    Parameters:
    
    entityName - entity name
  - classDescription
```
public EOClassDescription classDescription()
```
    Returns the class description for the entity.
    
    Returns:
    
    class description
  - newArrayDataSource
```
public EOArrayDataSource newArrayDataSource(EOEditingContext ec)
```
    Utility to return a new array datasource
    
    Parameters:
    
    ec - an editing context
    
    Returns:
    
    array datasource
  - newDatabaseDataSource
```
public EODatabaseDataSource newDatabaseDataSource(EOEditingContext ec)
```
    Utility to return a new database datasource
    
    Parameters:
    
    ec - an editing context
    
    Returns:
    
    database datasource
  - resetClazzCache
```
public static void resetClazzCache()
```
    Resets the clazz cache.
  - clazzForEntityNamed
```
public static EOEnterpriseObjectClazz clazzForEntityNamed(String entityName)
```
    Method used to get a clazz object for a given entity name. This method will cache the generated clazz object so that for a given entity name only one clazz object will be created.
    
    Parameters:
    
    entityName - name of the entity to get the Clazz object for
    
    Returns:
    
    clazz object for the given entity
  - createAndInsertObject
```
public T createAndInsertObject(EOEditingContext ec)
```
    Creates and inserts an object of the type of the clazz into the given editing context.
    
    Parameters:
    
    ec - an editing context
    
    Returns:
    
    newly created and inserted object
  - newPrimaryKeys
```
public NSArray newPrimaryKeys(EOEditingContext ec,
                              int i)
```
    Generates an array of primary key values for the clazz's entity. Uses the database context for the entity's model and the given editing context.
    
    Parameters:
    
    ec - an editing context
    
    i - number of primary keys to generate
    
    Returns:
    
    array of new primary keys
  - allObjects
```
public NSArray<T> allObjects(EOEditingContext ec)
```
    Gets all of the objects for the clazz's entity. Just a cover method for the EOUtilities method objectsForEntityNamed.
    
    Parameters:
    
    ec - editing context to fetch the objects into
    
    Returns:
    
    array of all the objects for a given entity name.
  - objectFromRawRow
```
public T objectFromRawRow(EOEditingContext ec,
                          NSDictionary dict)
```
    Creates an enterprise object from a raw row for the clazz's entity in the given editing context.
    
    Parameters:
    
    ec - editing context to create the eo in
    
    dict - raw row dictionary
    
    Returns:
    
    enterprise object for the raw row
  - entityNameFromRawRow
```
protected String entityNameFromRawRow(EOEditingContext ec,
                                      NSDictionary dict)
```
    Utility method to get the entity name from a raw row dictionary, taking subclasses and restricting qualifiers into account.
    
    Parameters:
    
    ec - an editing context
    
    dict - raw row dictionary
    
    Returns:
    
    entity name, if any
  - objectWithPrimaryKeyValue
```
public T objectWithPrimaryKeyValue(EOEditingContext ec,
                                   Object pk)
```
    Fetches the enterprise object for the specified primary key value and corresponding to the clazz's entity name.
    
    Parameters:
    
    ec - editing context to fetch into
    
    pk - primary key value. Compound primary keys are given as NSDictionaries.
    
    Returns:
    
    enterprise object for the specified primary key value.
  - objectsWithQualifierFormat
```
public NSArray<T> objectsWithQualifierFormat(EOEditingContext ec,
                                             String qualifier,
                                             NSArray args)
```
    Fetches all of the objects matching the given qualifier format corresponding to the clazz's entity using the given editing context.
    
    Parameters:
    
    ec - editing context
    
    qualifier - qualifier string
    
    args - qualifier format arguments
    
    Returns:
    
    array of objects corresponding to the passed in parameters.
  - objectsMatchingKeyAndValue
```
public NSArray<T> objectsMatchingKeyAndValue(EOEditingContext ec,
                                             String key,
                                             Object value)
```
    Fetches all of the objects matching the given key and value corresponding to the clazz's entity using the given editing context.
    
    Parameters:
    
    ec - editing context
    
    key - key string
    
    value - value
    
    Returns:
    
    array of objects corresponding to the passed in parameters.
  - objectsMatchingQualifier
```
public NSArray<T> objectsMatchingQualifier(EOEditingContext ec,
                                           EOQualifier qualifier)
```
  - objectsMatchingQualifier
```
public NSArray<T> objectsMatchingQualifier(EOEditingContext ec,
                                           EOQualifier qualifier,
                                           NSArray<EOSortOrdering> sortOrdering)
```
  - objectMatchingKeyAndValue
```
public T objectMatchingKeyAndValue(EOEditingContext ec,
                                   String key,
                                   Object value)
```
    Fetches the object matching the given key and value corresponding to the clazz's entity using the given editing context. If more than one matches, throws a EOMoreThanOneException, otherwise returns null or the match.
    
    Parameters:
    
    ec - editing context
    
    key - key string
    
    value - value
    
    Returns:
    
    array of objects corresponding to the passed in parameters.
  - objectsWithFetchSpecificationAndBindings
```
public NSArray<T> objectsWithFetchSpecificationAndBindings(EOEditingContext ec,
                                                           String name,
                                                           NSDictionary bindings)
```
    Fetches an array of objects for a given fetch specification and an array of bindings. The fetch specification is resolved off of the entity corresponding to the current clazz.
    
    Parameters:
    
    ec - editing content to fetch into
    
    name - fetch specification name
    
    bindings - used to resolve binding keys within the fetch specification
    
    Returns:
    
    array of objects fetched using the given fetch specification
  - setEntityName
```
protected void setEntityName(String name)
```
    Sets the entity name of the clazz. Also registers the clazz in the cache.
    
    Parameters:
    
    name - of the entity
  - entityName
```
public String entityName()
```
    Gets the entity name of the clazz.
    
    Returns:
    
    entity name of the clazz.
  - entity
```
public EOEntity entity()
```
    Gets the entity corresponding to the entity name of the clazz.
    
    Returns:
    
    entity for the clazz
  - entity
```
public EOEntity entity(EOEditingContext ec)
```
    Gets the entity corresponding to the entity name of the clazz.
    
    Parameters:
    
    ec - an editing context
    
    Returns:
    
    entity for the clazz
  - fetchSpecificationNamed
```
public EOFetchSpecification fetchSpecificationNamed(String name)
```
    Gets a fetch specification for a given name.
    
    Parameters:
    
    name - of the fetch specification
    
    Returns:
    
    fetch specification for the given name and the clazz's entity name
  - fetchSpecificationNamed
```
public EOFetchSpecification fetchSpecificationNamed(EOEditingContext ec,
                                                    String name)
```
    Gets a fetch specification for a given name.
    
    Parameters:
    
    ec - editing context to use for finding the model group
    
    name - of the fetch specification
    
    Returns:
    
    fetch specification for the given name and the clazz's entity name
  - createFetchSpecification
```
public ERXFetchSpecification<T> createFetchSpecification(EOQualifier qualifier,
                                                         NSArray<EOSortOrdering> sortings)
```
    Creates a fetch spec for the entity.
    
    Returns:
    
    fetch specification for the given name and the clazz's entity name
  - filteredArray
```
public NSArray<T> filteredArray(NSArray<T> array,
                                EOFetchSpecification spec,
                                NSDictionary bindings)
```
    Filters an array with a given fetch spec.
    
    Parameters:
    
    array -
    
    spec -
    
    bindings -
  - objectCountWithQualifier
```
public Number objectCountWithQualifier(EOEditingContext ec,
                                       EOQualifier qualifier)
```
    Returns the number of objects matching the given qualifier for the clazz's 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
    
    qualifier - to find the matching objects
    
    Returns:
    
    number of matching objects
  - objectCountWithFetchSpecificationAndBindings
```
public Number objectCountWithFetchSpecificationAndBindings(EOEditingContext ec,
                                                           String fetchSpecName,
                                                           NSDictionary bindings)
```
    Find the number of objects matching the given fetch specification and bindings for the clazz's entity name. Implementation wise the sql generated will only return the count of the query, not all of the rows matching the qualification.
    
    Parameters:
    
    ec - ec used to perform the count in
    
    fetchSpecName - name of the fetch specification
    
    bindings - dictionary of bindings for the fetch specification
    
    Returns:
    
    number of objects matching the given fetch specification and bindings
  - primaryKeyFetchSpecificationForEntity
```
public EOFetchSpecification primaryKeyFetchSpecificationForEntity(EOQualifier qualifier,
                                                                  NSArray<EOSortOrdering> sortOrderings,
                                                                  NSArray<String> additionalKeys)
```
    Constructs a fetch specification that will only fetch the primary keys for a given qualifier.
    
    Parameters:
    
    qualifier - to construct the fetch spec 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 NSArray primaryKeysMatchingQualifier(EOEditingContext ec,
                                            EOQualifier eoqualifier,
                                            NSArray 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
    
    eoqualifier - to restrict matching primary keys
    
    sortOrderings - array of sort orders to sort result set
    
    Returns:
    
    array of primary keys matching a given qualifier
  - primaryKeysMatchingValues
```
public NSArray primaryKeysMatchingValues(EOEditingContext ec,
                                         NSDictionary nsdictionary,
                                         NSArray sortOrderings)
```
    Fetches an array of primary keys matching the values in a given dictionary.
    
    Parameters:
    
    ec - editing context to fetch into
    
    nsdictionary - dictionary of key value pairs to match against.
    
    sortOrderings - array of sort orders to sort the result set by.
    
    Returns:
    
    array of primary keys matching the given criteria.
  - faultsFromRawRows
```
public NSArray<T> faultsFromRawRows(EOEditingContext ec,
                                    NSArray nsarray)
```
    Constructs an array of faults for a given array of primary keys in a given editing context for the clazz's entity.
    
    Parameters:
    
    ec - editing context to construct the faults in
    
    nsarray - array of primary key dictionaries
    
    Returns:
    
    array of faults for an array of primary key dictionaries.
  - faultsMatchingQualifier
```
public NSArray<T> faultsMatchingQualifier(EOEditingContext ec,
                                          EOQualifier eoqualifier)
```
    Fetches an array of faults matching a given qualifier.
    
    Parameters:
    
    ec - editing context to use to fetch into
    
    eoqualifier - qualifier to match against
    
    Returns:
    
    array of faults that match the given qualifier
  - faultsMatchingQualifier
```
public NSArray<T> faultsMatchingQualifier(EOEditingContext ec,
                                          EOQualifier eoqualifier,
                                          NSArray<EOSortOrdering> sortOrderings)
```
    Fetches an array of faults matching a given qualifier and sorted by an array of sort orderings.
    
    Parameters:
    
    ec - editing context to use to fetch into
    
    eoqualifier - qualifier to match against
    
    sortOrderings - array of sort orderings to order the faults
    
    Returns:
    
    array of faults that match the given qualifier
  - faultsMatchingValues
```
public NSArray<T> faultsMatchingValues(EOEditingContext ec,
                                       NSDictionary nsdictionary,
                                       NSArray<EOSortOrdering> sortOrderings)
```
    Fetches an array of faults for a given set of criteria.
    
    Parameters:
    
    ec - editing context to use to fetch into
    
    nsdictionary - key value criteria to match against
    
    sortOrderings - array of sort orderings to order the faults
    
    Returns:
    
    array of faults that match the given criteria
  - factory
```
public static EOEnterpriseObjectClazz.ClazzFactory factory()
```
  - setFactory
```
public static void setFactory(EOEnterpriseObjectClazz.ClazzFactory value)
```

Class EOEnterpriseObjectClazz<T extends EOEnterpriseObject>

Adds class-level inheritance to EOF.

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EOEnterpriseObjectClazz

EOEnterpriseObjectClazz

Method Detail

objectCountAttribute

objectCountUniqueAttribute

initialize

discoverEntityName

init

classDescription

newArrayDataSource

newDatabaseDataSource

resetClazzCache

clazzForEntityNamed

createAndInsertObject

newPrimaryKeys

allObjects

objectFromRawRow

entityNameFromRawRow

objectWithPrimaryKeyValue

objectsWithQualifierFormat

objectsMatchingKeyAndValue

objectsMatchingQualifier

objectsMatchingQualifier

objectMatchingKeyAndValue

objectsWithFetchSpecificationAndBindings

setEntityName

entityName

entity

entity

fetchSpecificationNamed

fetchSpecificationNamed

createFetchSpecification

filteredArray

objectCountWithQualifier

objectCountWithFetchSpecificationAndBindings

primaryKeyFetchSpecificationForEntity

primaryKeysMatchingQualifier

primaryKeysMatchingValues

faultsFromRawRows

faultsMatchingQualifier

faultsMatchingQualifier

faultsMatchingValues

factory

setFactory