Up
Authors
- Mirko Viviani (
mirko.viviani@gmail.com)
-
- Manuel Guesdon (
mguesdon@orange-concept.com)
-
Version: 27916
Date: 2009-02-18 15:47:26 +0100 (Mit, 18. Feb 2009)
Copyright: (C)
2000-2002,2003,2004,2005 Free Software
Foundation, Inc.
- Declared in:
- EOAccess/EORelationship.h
- Conforms to:
- EOPropertyListEncoding
Description forthcoming.
Instance Variables
Method summary
+ (id)
relationshipWithPropertyList: (NSDictionary*)propertyList
owner: (id)owner;
Description forthcoming.
- (NSArray*)
componentRelationships;
Returns the array of relationships composing this
flattend relationship. Returns nil of
the reciever isn't flattend.
- (NSString*)
definition;
Description forthcoming.
- (EODeleteRule)
deleteRule;
Description forthcoming.
- (NSArray*)
destinationAttributes;
Description forthcoming.
- (
EOEntity*)
destinationEntity;
Returns the relationship's destination entity
(direct destination entity or destination entity of
the last relationship in definition.
- (NSString*)
docComment;
Accessing documentation comments
- (
EOEntity*)
entity;
Returns the relationship's source entity.
- (
EORelationship*)
hiddenInverseRelationship;
Description forthcoming.
- (
EORelationship*)
inverseRelationship;
"Search only already created inverse relationship
in destination entity relationships. Nil if none"
- (BOOL)
isBidirectional;
Description forthcoming.
- (BOOL)
isCompound;
Returns YES if the relationship have
more than 1 join (i.e. join on more that one
(sourceAttribute/destinationAttribute),
NO otherwise (1 or less join)
- (BOOL)
isFlattened;
Returns YES when the relationship
traverses at least two entities (exemple:
aRelationship.anotherRelationship),
NO otherwise.
- (BOOL)
isMandatory;
Description forthcoming.
- (BOOL)
isParentRelationship;
Description forthcoming.
- (BOOL)
isToMany;
return YES if the relation if a to-many
one, NO otherwise (please read books to
know what to-many mean :-)
- (NSString*)
joinSemanticString;
Description forthcoming.
- (NSArray*)
joins;
Description forthcoming.
- (NSString*)
name;
Description forthcoming.
- (unsigned int)
numberOfToManyFaultsToBatchFetch;
Description forthcoming.
- (BOOL)
ownsDestination;
Description forthcoming.
- (BOOL)
propagatesPrimaryKey;
Description forthcoming.
- (EOQualifier*)
qualifierWithSourceRow: (NSDictionary*)sourceRow;
Description forthcoming.
- (BOOL)
referencesProperty: (id)property;
Description forthcoming.
- (NSArray*)
sourceAttributes;
Description forthcoming.
- (NSDictionary*)
userInfo;
Description forthcoming.
Instance Variables for EORelationship Class
@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.
@protected NSMutableArray* _componentRelationships;
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.
@protected EOExpressionArray* _definitionArray;
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.
@protected EOEntity* _destination;
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.
@protected NSArray* _destinationAttributes;
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.
@protected NSMutableDictionary* _destinationNames;
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.
@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.
@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.
@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.
@protected EORelationship* _hiddenInverseRelationship;
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.
@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.
@protected EORelationship* _inverseRelationship;
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.
@protected EOJoinSemantic _joinSemantic;
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.
@protected NSMutableArray* _joins;
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.
@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.
@protected EOQualifier* _qualifier;
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.
@protected NSArray* _sourceAttributes;
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.
@protected NSMutableDictionary* _sourceNames;
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.
@protected id _sourceRowToForeignKeyMapping;
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.
@protected NSDictionary* _sourceToDestinationKeyMap;
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.
@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.
- Declared in:
- EOAccess/EORelationship.h
Description forthcoming.
Method summary
- (void)
addJoin: (
EOJoin*)join;
Description forthcoming.
- (void)
beautifyName;
Description forthcoming.
- (void)
removeJoin: (
EOJoin*)join;
Description forthcoming.
- (void)
setDefinition: (NSString*)definition;
Description forthcoming.
- (void)
setDeleteRule: (EODeleteRule)deleteRule;
Description forthcoming.
- (void)
setDocComment: (NSString*)docComment;
Description forthcoming.
- (void)
setEntity: (
EOEntity*)entity;
Sets the entity of the reciever.
If the receiver already has an entity
assigned to it the old relationship will will be
removed first.
This method is used by
[EOEntity -addRelationship:]
and [EOEntity -removeRelationship:]
which should be used for general relationship manipulations. This method should only be useful when creating flattend relationships programmatically.
- (void)
setInternalInfo: (NSDictionary*)dictionary;
Description forthcoming.
- (void)
setIsBidirectional: (BOOL)flag;
Description forthcoming.
- (void)
setIsMandatory: (BOOL)isMandatory;
Description forthcoming.
- (void)
setJoinSemantic: (
EOJoinSemantic)joinSemantic;
Description forthcoming.
- (void)
setName: (NSString*)name;
Description forthcoming.
- (void)
setNumberOfToManyFaultsToBatchFetch: (unsigned int)size;
Description forthcoming.
- (void)
setOwnsDestination: (BOOL)flag;
Description forthcoming.
- (void)
setPropagatesPrimaryKey: (BOOL)flag;
Description forthcoming.
- (void)
setToMany: (BOOL)flag;
Description forthcoming.
- (void)
setUserInfo: (NSDictionary*)dictionary;
Description forthcoming.
- (NSException*)
validateName: (NSString*)name;
Description forthcoming.
- Declared in:
- EOAccess/EORelationship.h
Description forthcoming.
Method summary
- (EOExpressionArray*)
_definitionArray;
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.
- (EODeleteRule)
_deleteRuleFromString: (NSString*)deleteRuleString;
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.
- (void)
_flushCache;
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.
- (EOMutableKnownKeyDictionary*)
_foreignKeyForSourceRow: (NSDictionary*)row;
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.
Return dictionary of
key/value for destination object of source
row/object
- (void)
_joinsChanged;
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.
- (NSDictionary*)
_leftSideKeyMap;
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.
- (NSDictionary*)
_rightSideKeyMap;
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.
- (NSArray*)
_sourceAttributeNames;
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.
- (EOMKKDSubsetMapping*)
_sourceRowToForeignKeyMapping;
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.
- (NSString*)
_stringFromDeleteRule: (EODeleteRule)deleteRule;
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.
- (
EORelationship*)
_substitutionRelationshipForRow: (NSDictionary*)row;
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.
- (id)
auxiliaryQualifier;
Description forthcoming.
- (BOOL)
isPropagatesPrimaryKeyPossible;
Description forthcoming.
- (id)
qualifierOmittingAuxiliaryQualifierWithSourceRow: (id)param0;
Description forthcoming.
- (void)
setAuxiliaryQualifier: (id)param0;
Description forthcoming.
- Declared in:
- EOAccess/EORelationship.h
Description forthcoming.
Method summary
- (NSException*)
validateValue: (id*)valueP;
If the reciever is a manditory relationship, this method
returns an exception if the value pointed to by
VALUEP is either nil or the EONull
instance for to-one relationships or an empty
NSArray for to-many relationships. Otherwise it
returns nil. EOClassDescription adds
further information to this exception before it
gets passed to the application or user.
- Declared in:
- EOAccess/EORelationship.h
Description forthcoming.
Method summary
- (NSArray*)
_intermediateAttributes;
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.
- (void)
_setSourceToDestinationKeyMap: (id)param0;
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.
- (NSDictionary*)
_sourceToDestinationKeyMap;
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.
- (
EORelationship*)
firstRelationship;
Return the 1st relationship if self is flattened,
self otherwise.
- (BOOL)
foreignKeyInDestination;
Description forthcoming.
- (
EOEntity*)
intermediateEntity;
Description forthcoming.
- (BOOL)
isMultiHop;
Description forthcoming.
- (BOOL)
isToManyToOne;
Description forthcoming.
- (
EORelationship*)
lastRelationship;
Return the last relationship if self is flattened,
self otherwise.
- (id)
primaryKeyForTargetRowFromSourceDBSnapshot: (id)param0;
Description forthcoming.
- (id)
qualifierForDBSnapshot: (id)param0;
Description forthcoming.
- (NSString*)
relationshipPath;
Return relationship path (like toRel1.toRel2) if
self is flattened, slef name otherwise.
typedef enum ... EOJoinSemantic;
Description forthcoming.
Up