Up

EOEntity Class

Authors

Mirko Viviani (mirko.viviani@rccr.cremona.it)
Manuel Guesdon (mguesdon@orange-concept.com)

Version: 23472

Date: 2006-09-12 21:36:24 +0200 (Die, 12 Sep 2006)

Copyright: (C) 2000, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.

Contents -

  1. Software documentation for the EOEntity class
  2. Software documentation for the EOEntityClassDescription class
  3. Software documentation for the EOEntity(EOEntityClassDescription) category
  4. Software documentation for the EOEntity(EOEntityEditing) category
  5. Software documentation for the EOEntity(EOEntityGDL2Additions) category
  6. Software documentation for the EOEntity(EOModelBeautifier) category
  7. Software documentation for the EOEntity(EOModelReferentialIntegrity) category
  8. Software documentation for the EOEntity(EOPrimaryKeyGeneration) category
  9. Software documentation for the EOEntity(EOStoredProcedures) category
  10. Software documentation for the EOEntity(GDL2Extenstions) category
  11. Software documentation for the EOEntityClassDescription(GDL2Extenstions) category
  12. Software documentation for the NSObject(EOEntity) category
  13. Software documentation for the NSString(EODatabaseNameConversion) category

Software documentation for the EOEntity class

EOEntity : GCObject

Declared in:
EOAccess/EOEntity.h
Conforms to:
EOPropertyListEncoding
Availability: OpenStep

Description forthcoming.
Instance Variables

Method summary

anyAttributeNamed: 

- (EOAttribute*) anyAttributeNamed: (NSString*)attributeName;
Availability: OpenStep

returns attribute named attributeName (no relationship)

anyRelationshipNamed: 

- (EORelationship*) anyRelationshipNamed: (NSString*)relationshipNamed;
Availability: OpenStep

Description forthcoming.

attributeNamed: 

- (EOAttribute*) attributeNamed: (NSString*)attributeName;
Availability: OpenStep

Description forthcoming.

attributes 

- (NSArray*) attributes;
Availability: OpenStep

Description forthcoming.

attributesToFetch 

- (NSArray*) attributesToFetch;
Availability: OpenStep

Description forthcoming.

attributesUsedForLocking 

- (NSArray*) attributesUsedForLocking;
Availability: OpenStep

Description forthcoming.

cachesObjects 

- (BOOL) cachesObjects;
Availability: OpenStep

Description forthcoming.

className 

- (NSString*) className;
Availability: OpenStep

Description forthcoming.

classProperties 

- (NSArray*) classProperties;
Availability: OpenStep

Description forthcoming.

classPropertyNames 

- (NSArray*) classPropertyNames;
Availability: OpenStep

Description forthcoming.

externalName 

- (NSString*) externalName;
Availability: OpenStep

Description forthcoming.

externalQuery 

- (NSString*) externalQuery;
Availability: OpenStep

Description forthcoming.

fetchSpecificationNamed: 

- (EOFetchSpecification*) fetchSpecificationNamed: (NSString*)fetchSpecName;
Availability: OpenStep

Description forthcoming.

fetchSpecificationNames 

- (NSArray*) fetchSpecificationNames;
Availability: OpenStep

Description forthcoming.

globalIDForRow: 

- (EOGlobalID*) globalIDForRow: (NSDictionary*)row;
Availability: OpenStep

Description forthcoming.

isAbstractEntity 

- (BOOL) isAbstractEntity;
Availability: OpenStep

Description forthcoming.

isPrimaryKeyValidInObject: 

- (BOOL) isPrimaryKeyValidInObject: (id)object;
Availability: OpenStep

Description forthcoming.

isQualifierForPrimaryKey: 

- (BOOL) isQualifierForPrimaryKey: (EOQualifier*)qualifier;
Availability: OpenStep

Description forthcoming.

isReadOnly 

- (BOOL) isReadOnly;
Availability: OpenStep

Description forthcoming.

isValidAttributeUsedForLocking: 

- (BOOL) isValidAttributeUsedForLocking: (EOAttribute*)anAttribute;
Availability: OpenStep

Description forthcoming.

isValidClassProperty: 

- (BOOL) isValidClassProperty: (id)aProperty;
Availability: OpenStep

Description forthcoming.

isValidPrimaryKeyAttribute: 

- (BOOL) isValidPrimaryKeyAttribute: (EOAttribute*)anAttribute;
Availability: OpenStep

Description forthcoming.

maxNumberOfInstancesToBatchFetch 

- (unsigned int) maxNumberOfInstancesToBatchFetch;
Availability: OpenStep

Description forthcoming.

model 

- (EOModel*) model;
Availability: OpenStep

Description forthcoming.

name 

- (NSString*) name;
Availability: OpenStep

Description forthcoming.

parentEntity 

- (EOEntity*) parentEntity;
Availability: OpenStep

Description forthcoming.

primaryKeyAttributeNames 

- (NSArray*) primaryKeyAttributeNames;
Availability: OpenStep

Description forthcoming.

primaryKeyAttributes 

- (NSArray*) primaryKeyAttributes;
Availability: OpenStep

Description forthcoming.

primaryKeyForGlobalID: 

- (NSDictionary*) primaryKeyForGlobalID: (EOKeyGlobalID*)gid;
Availability: OpenStep

Description forthcoming.

primaryKeyForRow: 

- (NSDictionary*) primaryKeyForRow: (NSDictionary*)row;
Availability: OpenStep

Description forthcoming.

qualifierForPrimaryKey: 

- (EOQualifier*) qualifierForPrimaryKey: (NSDictionary*)row;
Availability: OpenStep

Description forthcoming.

relationshipNamed: 

- (EORelationship*) relationshipNamed: (NSString*)relationshipName;
Availability: OpenStep

Description forthcoming.

relationships 

- (NSArray*) relationships;
Availability: OpenStep

Description forthcoming.

restrictingQualifier 

- (EOQualifier*) restrictingQualifier;
Availability: OpenStep

Description forthcoming.

sharedObjectFetchSpecificationNames 

- (NSArray*) sharedObjectFetchSpecificationNames;
Availability: OpenStep

Description forthcoming.

subEntities 

- (NSArray*) subEntities;
Availability: OpenStep

Description forthcoming.

userInfo 

- (NSDictionary*) userInfo;
Availability: OpenStep

Description forthcoming.

Instance Variables for EOEntity Class

_adaptorDictionaryInitializer

@protected EOMKKDInitializer* _adaptorDictionaryInitializer;
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_attributes

@protected GCMutableArray* _attributes;
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_attributesByName

@protected GCMutableDictionary* _attributesByName;
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_attributesToFetch

@protected GCMutableArray* _attributesToFetch;
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_attributesToSave

@protected GCMutableArray* _attributesToSave;
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_attributesUsedForLocking

@protected GCMutableArray* _attributesUsedForLocking;
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_batchCount

@protected unsigned int _batchCount;
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_classDescription

@protected EOClassDescription* _classDescription;
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_classForInstances

@protected Class _classForInstances;
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_className

@protected NSString* _className;
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_classProperties

@protected GCMutableArray* _classProperties;
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_classPropertyAttributeNames

@protected NSArray* _classPropertyAttributeNames;
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_classPropertyNames

@protected NSArray* _classPropertyNames;
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_classPropertyToManyRelationshipNames

@protected NSArray* _classPropertyToManyRelationshipNames;
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_classPropertyToOneRelationshipNames

@protected NSArray* _classPropertyToOneRelationshipNames;
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_dbSnapshotKeys

@protected GCArray* _dbSnapshotKeys;
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_docComment

@protected NSString* _docComment;
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_externalName

@protected NSString* _externalName;
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_externalQuery

@protected NSString* _externalQuery;
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_fetchSpecificationDictionary

@protected NSMutableDictionary* _fetchSpecificationDictionary;
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_fetchSpecificationNames

@protected NSArray* _fetchSpecificationNames;
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_flags

@protected struct ... _flags;
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_hiddenRelationships

@protected NSMutableArray* _hiddenRelationships;
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_instanceDictionaryInitializer

@protected EOMKKDInitializer* _instanceDictionaryInitializer;
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_internalInfo

@protected NSDictionary* _internalInfo;
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_model

@protected EOModel* _model;
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_name

@protected NSString* _name;
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_parent

@protected EOEntity* _parent;
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_primaryKeyAttributeNames

@protected NSArray* _primaryKeyAttributeNames;
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_primaryKeyAttributes

@protected GCMutableArray* _primaryKeyAttributes;
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_primaryKeyDictionaryInitializer

@protected EOMKKDInitializer* _primaryKeyDictionaryInitializer;
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_propertiesToFault

@protected GCMutableArray* _propertiesToFault;
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_propertyDictionaryInitializer

@protected EOMKKDInitializer* _propertyDictionaryInitializer;
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_relationships

@protected GCMutableArray* _relationships;
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_relationshipsByName

@protected GCMutableDictionary* _relationshipsByName;
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_restrictingQualifier

@protected EOQualifier* _restrictingQualifier;
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_snapshotDictionaryInitializer

@protected EOMKKDInitializer* _snapshotDictionaryInitializer;
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_snapshotToAdaptorRowSubsetMapping

@protected EOMKKDSubsetMapping* _snapshotToAdaptorRowSubsetMapping;
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_storedProcedures

@protected NSMutableDictionary* _storedProcedures;
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_subEntities

@protected GCMutableArray* _subEntities;
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_userInfo

@protected NSDictionary* _userInfo;
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.


Software documentation for the EOEntityClassDescription class

EOEntityClassDescription : EOClassDescription

Declared in:
EOAccess/EOEntity.h
Availability: OpenStep

Description forthcoming.
Instance Variables

Method summary

entity 

- (EOEntity*) entity;
Availability: OpenStep

Description forthcoming.

fetchSpecificationNamed: 

- (EOFetchSpecification*) fetchSpecificationNamed: (NSString*)name;
Availability: OpenStep

Description forthcoming.

initWithEntity: 

- (id) initWithEntity: (EOEntity*)entity;
Availability: OpenStep

Description forthcoming.

Instance Variables for EOEntityClassDescription Class

_entity

@protected EOEntity* _entity;
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

extraRefCount

@protected unsigned int extraRefCount;
Description forthcoming.


Software documentation for the EOEntity(EOEntityClassDescription) category

EOEntity(EOEntityClassDescription)

Declared in:
EOAccess/EOEntity.h
Availability: OpenStep

Description forthcoming.
Method summary

classDescriptionForInstances 

- (EOClassDescription*) classDescriptionForInstances;
Availability: OpenStep

Description forthcoming.

Software documentation for the EOEntity(EOEntityEditing) category

EOEntity(EOEntityEditing)

Declared in:
EOAccess/EOEntity.h
Availability: OpenStep

Description forthcoming.
Method summary

addAttribute: 

- (void) addAttribute: (EOAttribute*)attribute;
Availability: OpenStep

Description forthcoming.

addFetchSpecification: withName: 

- (void) addFetchSpecification: (EOFetchSpecification*)fetchSpec withName: (NSString*)name;
Availability: OpenStep

Description forthcoming.

addRelationship: 

- (void) addRelationship: (EORelationship*)relationship;
Availability: OpenStep

Description forthcoming.

addSharedObjectFetchSpecificationByName: 

- (void) addSharedObjectFetchSpecificationByName: (NSString*)name;
Availability: OpenStep

Description forthcoming.

addSubEntity: 

- (void) addSubEntity: (EOEntity*)child;
Availability: OpenStep

Description forthcoming.

removeAttribute: 

- (void) removeAttribute: (EOAttribute*)attribute;
Availability: OpenStep

Removes the attribute from the -attributes array, and the -classProperties , and -primaryKeyAttributes arrays if they contain it. does not remove any references to the attribute from other properties. the caller should insure that no such references exist by calling -referencesProperty: or [EOModel -referencesToProperty:].

removeFetchSpecificationNamed: 

- (void) removeFetchSpecificationNamed: (NSString*)name;
Availability: OpenStep

Description forthcoming.

removeRelationship: 

- (void) removeRelationship: (EORelationship*)relationship;
Availability: OpenStep

Removes the relationship from the -relationships array and the -classProperties array if it contains the relationship. The caller should insure that no references to the relationship exist by calling -referencesProperty: or [EOModel -referencesToProperty].

removeSharedObjectFetchSpecificationByName: 

- (void) removeSharedObjectFetchSpecificationByName: (NSString*)name;
Availability: OpenStep

Description forthcoming.

removeSubEntity: 

- (void) removeSubEntity: (EOEntity*)child;
Availability: OpenStep

Description forthcoming.

setAttributesUsedForLocking: 

- (BOOL) setAttributesUsedForLocking: (NSArray*)attributes;
Availability: OpenStep

Description forthcoming.

setCachesObjects: 

- (void) setCachesObjects: (BOOL)flag;
Availability: OpenStep

Description forthcoming.

setClassName: 

- (void) setClassName: (NSString*)name;
Availability: OpenStep

Description forthcoming.

setClassProperties: 

- (BOOL) setClassProperties: (NSArray*)properties;
Availability: OpenStep

Description forthcoming.

setExternalName: 

- (void) setExternalName: (NSString*)name;
Availability: OpenStep

Description forthcoming.

setExternalQuery: 

- (void) setExternalQuery: (NSString*)query;
Availability: OpenStep

Description forthcoming.

setIsAbstractEntity: 

- (void) setIsAbstractEntity: (BOOL)flag;
Availability: OpenStep

Description forthcoming.

setMaxNumberOfInstancesToBatchFetch: 

- (void) setMaxNumberOfInstancesToBatchFetch: (unsigned int)size;
Availability: OpenStep

Description forthcoming.

setName: 

- (void) setName: (NSString*)name;
Availability: OpenStep

Description forthcoming.

setPrimaryKeyAttributes: 

- (BOOL) setPrimaryKeyAttributes: (NSArray*)keys;
Availability: OpenStep

Description forthcoming.

setReadOnly: 

- (void) setReadOnly: (BOOL)flag;
Availability: OpenStep

Description forthcoming.

setRestrictingQualifier: 

- (void) setRestrictingQualifier: (EOQualifier*)qualifier;
Availability: OpenStep

Description forthcoming.

setSharedObjectFetchSpecificationsByName: 

- (void) setSharedObjectFetchSpecificationsByName: (NSArray*)names;
Availability: OpenStep

Description forthcoming.

setUserInfo: 

- (void) setUserInfo: (NSDictionary*)dictionary;
Availability: OpenStep

Description forthcoming.

validateName: 

- (NSException*) validateName: (NSString*)name;
Availability: OpenStep

Description forthcoming.

Software documentation for the EOEntity(EOEntityGDL2Additions) category

EOEntity(EOEntityGDL2Additions)

Declared in:
EOAccess/EOEntity.h
Availability: OpenStep

Useful private methods made public in GDL2
Method summary

attributeForPath: 

- (EOAttribute*) attributeForPath: (NSString*)path;
Availability: OpenStep

Returns attribute (if any) for path

relationshipForPath: 

- (EORelationship*) relationshipForPath: (NSString*)path;
Availability: OpenStep

Returns relationship (if any) for path

Software documentation for the EOEntity(EOModelBeautifier) category

EOEntity(EOModelBeautifier)

Declared in:
EOAccess/EOEntity.h
Availability: OpenStep

Description forthcoming.
Method summary

beautifyName 

- (void) beautifyName;
Availability: OpenStep

Description forthcoming.

Software documentation for the EOEntity(EOModelReferentialIntegrity) category

EOEntity(EOModelReferentialIntegrity)

Declared in:
EOAccess/EOEntity.h
Availability: OpenStep

Description forthcoming.
Method summary

externalModelsReferenced 

- (NSArray*) externalModelsReferenced;
Availability: OpenStep

Description forthcoming.

referencesProperty: 

- (BOOL) referencesProperty: (id)property;
Availability: OpenStep

Description forthcoming.

Software documentation for the EOEntity(EOPrimaryKeyGeneration) category

EOEntity(EOPrimaryKeyGeneration)

Declared in:
EOAccess/EOEntity.h
Availability: OpenStep

Description forthcoming.
Method summary

primaryKeyRootName 

- (NSString*) primaryKeyRootName;
Availability: OpenStep

Description forthcoming.

Software documentation for the EOEntity(EOStoredProcedures) category

EOEntity(EOStoredProcedures)

Declared in:
EOAccess/EOEntity.h
Availability: OpenStep

Description forthcoming.
Method summary

setStoredProcedure: forOperation: 

- (void) setStoredProcedure: (EOStoredProcedure*)storedProcedure forOperation: (NSString*)operation;
Availability: OpenStep

Description forthcoming.

storedProcedureForOperation: 

- (EOStoredProcedure*) storedProcedureForOperation: (NSString*)operation;
Availability: OpenStep

Description forthcoming.

Software documentation for the EOEntity(GDL2Extenstions) category

EOEntity(GDL2Extenstions)

Declared in:
EOAccess/EOEntity.h
Availability: OpenStep

Description forthcoming.
Method summary

docComment 

- (NSString*) docComment;
Availability: OpenStep

Description forthcoming.

setDocComment: 

- (void) setDocComment: (NSString*)docComment;
Availability: OpenStep

Description forthcoming.

Software documentation for the EOEntityClassDescription(GDL2Extenstions) category

EOEntityClassDescription(GDL2Extenstions)

Declared in:
EOAccess/EOEntity.h
Availability: OpenStep

Description forthcoming.
Method summary

dictionaryForInstanceProperties 

- (EOMutableKnownKeyDictionary*) dictionaryForInstanceProperties;
Availability: OpenStep

returns a new autoreleased mutable dictionary to store properties returns nil if there's no key in the instanceDictionaryInitializer

Software documentation for the NSObject(EOEntity) category

NSObject(EOEntity)

Declared in:
EOAccess/EOEntity.h
Availability: OpenStep

Description forthcoming.
Method summary

_instanceDictionaryInitializerExcludedPropertyNames 

+ (NSArray*) _instanceDictionaryInitializerExcludedPropertyNames;
Availability: OpenStep

should returns an array of property names to exclude from entity instanceDictionaryInitializer
Warning the underscore at the start of the name of this method indicates that it is private, for internal use only, and you should not use the method in your code.
should returns a set of property names to exclude from entity instanceDictionaryInitializer

Software documentation for the NSString(EODatabaseNameConversion) category

NSString(EODatabaseNameConversion)

Declared in:
EOAccess/EOEntity.h
Availability: OpenStep

Description forthcoming.
Method summary

externalNameForInternalName: separatorString: useAllCaps: 

+ (NSString*) externalNameForInternalName: (NSString*)internalName separatorString: (NSString*)separatorString useAllCaps: (BOOL)allCaps;
Availability: OpenStep

Description forthcoming.

nameForExternalName: separatorString: initialCaps: 

+ (NSString*) nameForExternalName: (NSString*)externalName separatorString: (NSString*)separatorString initialCaps: (BOOL)initialCaps;
Availability: OpenStep

Description forthcoming.

Up