Interface IRelationshipClass
- Namespace
- ESRI.ArcGIS.Geodatabase
- Assembly
- ESRI.Server.Geodatabase.dll
Provides access to members that return information about the relationship class, create relationships, relationship rules and get related objects.
[Guid("22B00693-8895-11D2-8A0D-006097AFF44E")]
[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
public interface IRelationshipClass
Remarks
Relationships can be between spatial, non-spatial objects, or between spatial and non-spatial objects. The spatial objects will be stored in feature classes, and the non-spatial in object classes, however, all of the relationships will be maintained in the relationship class. RelationshipClasses can be created using the IRelationshipClassContainer interface on the FeatureDataset Class.
The IRelationshipClass interface provides information about a relationship class, functionality to create and delete individual relationships, and methods to find related objects. The members of this interface can be split into three logical groups: the properties that correspond to how the relationship class was created, the object-to-object methods that deal with individual relationships, and lastly the relationship rules methods.
The OriginPrimaryKey, OriginForeignKey, DestinationPrimaryKey, and DestinationForeignKey properties can be somewhat confusing—their use is different depending on whether the relationship class is attributed.
The object-to-object methods such as GetObjectsRelatedToObjectSet make a lot of use of the ISet interface, which manipulates a set of generic objects. When adding objects to a set with a cursor, make sure that the cursor is non-recycling.
When using CreateRelationship, remember that this operation will write a value into the foreign key field. Therefore it is possible that you could overwrite, and therefore delete, an existing relationship. Similarly, DeleteRelationship will remove the foreign key value, so that field must allow null values unless you want to ensure that all objects in the class belong to relationships.
The IRelationshipClass::IsAttributed property will only return true if there are extra relationship attributes beyond those required to relate the objects. The IRelationshipClass::GetRelationship method is useful for accessing the relationship attributes.
This C# example deletes all the relationships for features satisfying the where clause parameter.public void DelRelationships(IRelationshipClass relationshipClass, IFeatureClass featureClass, string whereClause)
{
// Get the features whose relationships you want to delete
IQueryFilter queryFilter = new QueryFilterClass();
queryFilter.WhereClause = whereClause;
IFeatureCursor featureCursor = featureClass.Search(queryFilter, false);
IFeature feature = null;
ISet featureSet = new ESRI.ArcGIS.esriSystem.SetClass();
while ((feature = featureCursor.NextFeature()) != null) {
featureSet.Add(feature);
}
// Delete the relationships
featureSet.Reset();
Console.WriteLine("Count {0}", featureSet.Count);
relationshipClass.DeleteRelationshipsForObjectSet(featureSet);
}
Properties
BackwardPathLabel
The backward path label for the relationship class.
string BackwardPathLabel { get; }
Property Value
Remarks
The BackwardPathLabel property returns the path label for the backward direction path. An example can be shown by using a relationship between a pump station and its pumps. A backward path label may be something like "Contained by". It would be read as a pump is 'Contained by' the pump station.
Cardinality
The cardinality for the relationship class.
esriRelCardinality Cardinality { get; }
Property Value
Remarks
The Cardinality property returns the cardinality of the relationship class as an esriRelCardinality enumeration value. It refers to the type of relationship formed between an origin class and a destination class. It can be one of three types: esriRelCardinalityOneToOne (1-1), esriRelCardinalityOneToMany (1-M), or esriRelCardinalityManyToMany (M-N).
DestinationClass
The destination object class.
IObjectClass DestinationClass { get; }
Property Value
DestinationForeignKey
The relationship destination foreign Key.
string DestinationForeignKey { get; }
Property Value
Remarks
The DestinationForeignKey property returns the name of the destination foreign key field. This property is null except in the case of attributed relationship classes, in which case it is the name of a field in the relationship table. The values in this field reference values in the field designated as the destination primary key.
DestinationPrimaryKey
The relationship destination primary Key.
string DestinationPrimaryKey { get; }
Property Value
FeatureDataset
The feature dataset, if any, to which this relationship class belongs.
IFeatureDataset FeatureDataset { get; }
Property Value
Remarks
The FeatureDataset property returns the feature dataset that this relationship class belongs to. If the relationship class exists outside of a feature dataset, a null value will be returned.
ForwardPathLabel
The forward path label for the relationship class.
string ForwardPathLabel { get; }
Property Value
Remarks
The ForwardPathLabel property returns the path label for the forward direction path. An example can be shown by using a relationship between a pump station and its pumps. A forward path label may be something like "Contains". It would be read as a pump station 'Contains' pumps.
IsAttributed
Indicates if the relationships in this relationship class have attributes.
bool IsAttributed { get; }
Property Value
Remarks
The IsAttributed property indicates whether this relationship class is attributed or not. An attributed relationship class has extra attributes that are being maintained for each relationship. For example, in a relationship class between parcels and owners, percentage of ownership each particular owner has could be stored as a relationship attribute.
The IsAttributed property will only return true if there are extra relationship attributes beyond those required to relate the objects. In the case of relationship classes with M:N cardinality, there will be a relationship table (see 'AttributedRelationshipClass' in the object model diagram), but IsAttributed will return False, unless there are additional attributes.
IsComposite
Indicates if the relationship class represents a composite relationship in which the origin object class represents the composite object.
bool IsComposite { get; }
Property Value
Remarks
The IsComposite property indicates whether this relationship class is composite or simple. A composite relationship class is one where objects in the origin class control the lifetime of the objects in the destination class. When the origin object is deleted, the related destination object is also deleted. Composite relationship classes are always one to many relationships, but this can be constrained to one to one through the use of relationship rules.
If a relationship class is not composite, it is considered 'simple', and related objects are independent of each other. Simple relationships can be of any cardinality.
Notification
The notification direction for the relationship class.
esriRelNotification Notification { get; }
Property Value
Remarks
The Notification property returns the relationship class' notification behavior as as esriRelNotification enumeration value. A notification occurs when an event happens, such as a deletion or an edit. It can be one of four type: esriRelNotificationNone, esriRelNotificationForward, esriRelNotificationBackward, or esriRelNotificationBoth. None means no notification will take place, forward means that notification will happen from the origin to the destination, backward means notification occurs from the destination to the origin, and both means notification will happen both ways when an event occurs.
OriginClass
The origin object class.
IObjectClass OriginClass { get; }
Property Value
Remarks
When using a relationship class, the OriginClass property is used for returning an interface to the origin objectclass .
OriginForeignKey
The relationship origin foreign Key.
string OriginForeignKey { get; }
Property Value
OriginPrimaryKey
The relationship origin primary Key.
string OriginPrimaryKey { get; }
Property Value
RelationshipClassID
The relationship class ID.
int RelationshipClassID { get; }
Property Value
Remarks
The RelationshipClassID property returns the ID of the relationship class. This ID uniquely identifies a relationship class within its geodatabase relative to other relationship classes. It is equivalent to IObjectClass::ObjectClassID except that it applies to relationship classes rather than object classes.
RelationshipRules
The relationship rules that apply to this relationship class.
IEnumRule RelationshipRules { get; }
Property Value
Remarks
The RelationshipRules property retrieves the relationship rules of the relationship class as an IEnumRule enumerator. These rules are used to control which object subtypes from the origin class can be related to which object subtypes in the destination class. They can also be used to specify a valid cardinality range for all permissable subtype pairs. For example, in a feature class containing utility poles divided into wooden and steel subtypes, relationship rules could be used to specify that wooden poles may have one to three transformers attached, but steel poles may have one to five transformers attached.
Methods
AddRelationshipRule(IRule)
Adds a relationship rule to this relationship class.
void AddRelationshipRule(IRule Rule)
Parameters
RuleIRule
Remarks
The AddRelationshipRule method adds a new relationship rule to the relationship class. Relationship classes can have an associated set of relationship rules. These rules are used to control which object subtypes from the origin class can be related to which object subtypes in the destination class. They can also be used to specify a valid cardinality range for all permissable subtype pairs. For example, in a feature class containing utility poles divided into wooden and steel subtypes, relationship rules could be used to specify that wooden poles may have one to three transformers attached, but steel poles may have one to five transformers attached.
Below is a small C# code sample of how to add a relationship rule:
IFeatureClass originFeatureClass = featureWorkspace.OpenFeatureClass("us_counties");
IFeatureClass destFeatureClass = featureWorkspace.OpenFeatureClass("poles");
IRelationshipClass relationshipClass = featureWorkspace.OpenRelationshipClass("transformers");IRelationshipRule relationshipRule = (IRelationshipRule) new RelationshipRuleClass();
relationshipRule.DestinationClassID = destFeatureClass.ObjectClassID;
relationshipRule.DestinationSubtypeCode = 0;
relationshipRule.DestinationMaximumCardinality = 1;
relationshipRule.DestinationMinimumCardinality = 5;
relationshipRule.OriginClassID = originFeatureClass.ObjectClassID;
relationshipRule.OriginSubtypeCode = 0;
relationshipRule.OriginMaximumCardinality = 1;
relationshipRule.OriginMinimumCardinality = 1;relationshipClass.AddRelationshipRule(relationshipRule);
CreateRelationship(IObject, IObject)
Creates a new relationship between the two specified objects.
IRelationship CreateRelationship(IObject OriginObject, IObject DestinationObject)
Parameters
Returns
Remarks
The CreateRelationship method creates a relationship between the origin object and the destination object specified in the parameters. By default, when a relationship class is created, a relationship is created between the objects with corresponding primary and foreign key values. When subsequently using CreateRelationship, remember that this operation will write a value into the foreign key field. Therefore, in the case of 1:1 and 1:M relationship classes, it is possible that you could overwrite, and therefore delete, an existing relationship.
This method should be called within an edit session.
DeleteRelationship(IObject, IObject)
Deletes the relationship that associates the two specified objects.
void DeleteRelationship(IObject OriginObject, IObject DestinationObject)
Parameters
Remarks
The DeleteRelationship method deletes the relationship between the origin object and destination object specified in the parameters. This will remove the entry for this relationship from the relationship class.
This method should be called within an edit session.
DeleteRelationshipRule(IRule)
Deletes a relationship rule from this relationship class.
void DeleteRelationshipRule(IRule Rule)
Parameters
RuleIRule
Remarks
The DeleteRelationshipRule method deletes a relationship rule from the relationship class. Relationship classes can have an associated set of relationship rules. These rules are used to control which object subtypes from the origin class can be related to which object subtypes in the destination class. They can also be used to specify a valid cardinality range for all permissable subtype pairs. For example, in a feature class containing utility poles divided into wooden and steel subtypes, relationship rules could be used to specify that wooden poles may have one to three transformers attached, but steel poles may have one to five transformers attached.
DeleteRelationshipsForObject(IObject)
Deletes all relationships that apply to a specified object.
void DeleteRelationshipsForObject(IObject anObject)
Parameters
anObjectIObject
Remarks
The DeleteRelationshipsForObject method is used for removing all of the relationships in the relationship class that the specified object belongs to. Note that this method is bi-directional; the specified object could belong to the origin class or destination class.
This method should be called within an edit session.
DeleteRelationshipsForObjectSet(ISet)
Deletes all relationships that apply to the specified origin or destination object set.
void DeleteRelationshipsForObjectSet(ISet anObjectSet)
Parameters
anObjectSetISet
Remarks
The DeleteRelationshipsForObjectSet method is used for removing all relationships in a particular relationship class for the specified set of objects.
This method works in the same way as the DeleteRelationshipsForObject method, except on a set of objects rather than a single one. If a cursor is used to populate the set with objects, ensure that a non-recycling cursor is used.
This method should be called within an edit session.
//e.g., nameOfRelClass = "relclass"
// nameOfOriginTable = "origintable"
public void IRelationshipClass__DeleteRelationshipsForObjectSet(IWorkspace workspace, string nameOfRelClass, string nameOfOriginTable)
{
IFeatureWorkspace featureWorkspace = (IFeatureWorkspace)workspace;
IRelationshipClass relationshipClass = featureWorkspace.OpenRelationshipClass(nameOfRelClass);
ITable originTable = featureWorkspace.OpenTable(nameOfOriginTable);
ESRI.ArcGIS.esriSystem.ISet objectSet = new ESRI.ArcGIS.esriSystem.SetClass();
objectSet.Add(originTable.GetRow(1));
objectSet.Add(originTable.GetRow(2));
objectSet.Add(originTable.GetRow(3));
objectSet.Reset();
IWorkspaceEdit workspaceEdit = (IWorkspaceEdit)workspace;
workspaceEdit.StartEditing(true);
workspaceEdit.StartEditOperation();
relationshipClass.DeleteRelationshipsForObjectSet(objectSet);
workspaceEdit.StopEditOperation();
workspaceEdit.StopEditing(true);
objectSet = null;
}
GetObjectsMatchingObjectSet(ISet)
Gets rows pairs of objects that are related to the specified origin or destination object set.
IRelClassEnumRowPairs GetObjectsMatchingObjectSet(ISet srcObjectSet)
Parameters
srcObjectSetISet
Returns
Remarks
The GetObjectsMatchingObjectSet method returns an enumerator of related object pairs based on the object set provided as a parameter. The enumerator contains a related object pair for each relationship participated in by the input objects. For example, in a relationship class with 1:1 cardinality, passing three objects into this method will return three related object pairs, assuming all three objects participate in a relationship. In a relationship class with 1:M or M:N cardinality, passing in a single object could conceivably result in an enumerator with multiple related object pairs, if the object participates in several relationships.
If the input set is constructed with a cursor, ensure that a non-recycling cursor is used.
GetObjectsRelatedToObject(IObject)
Gets the objects that are related to the specified object.
ISet GetObjectsRelatedToObject(IObject anObject)
Parameters
anObjectIObject
Returns
Remarks
The GetObjectsRelatedToObject method returns a set of Objects (or subtypes of Object, such as features) that are related to the anObject object.
GetObjectsRelatedToObjectSet(ISet)
Gets the objects that are related to the specified origin or destination object set.
ISet GetObjectsRelatedToObjectSet(ISet anObjectSet)
Parameters
anObjectSetISet
Returns
Remarks
The GetObjectsRelatedToObjectSet method returns a set of objects that are related to the objects contained by the anObjectSet parameter. It behaves the same as GetObjectsRelatedToObject, except that it accepts a set of objects as a parameter.
If multiple objects in the input set are related to a common object, that object will only be included once in the returned set.
If the input set is constructed with a cursor, ensure that a non-recycling cursor is used.
//e.g., nameOfRelClass = "relclass"
// nameOfOriginTable = "origintable"
public void IRelationshipClass__GetObjectsRelatedToObjectSet(IWorkspace workspace, string nameOfRelClass, string nameOfOriginTable)
{
IFeatureWorkspace featureWorkspace = (IFeatureWorkspace)workspace;
IRelationshipClass relationshipClass = featureWorkspace.OpenRelationshipClass(nameOfRelClass);
ITable originTable = featureWorkspace.OpenTable(nameOfOriginTable);
ESRI.ArcGIS.esriSystem.ISet objectSet = new ESRI.ArcGIS.esriSystem.SetClass();
objectSet.Add(originTable.GetRow(1));
objectSet.Add(originTable.GetRow(2));
objectSet.Add(originTable.GetRow(3));
objectSet.Reset();
ESRI.ArcGIS.esriSystem.ISet resultSet = relationshipClass.GetObjectsRelatedToObjectSet(objectSet);
objectSet = null;
}
GetRelationship(IObject, IObject)
Get the relationship that associates the two specified objects.
IRelationship GetRelationship(IObject OriginObject, IObject DestinationObject)
Parameters
Returns
Remarks
When using a relationship class, the GetRelationship method is used for returning a relationship interface to the relationship between the origin object and destination object specified in the function parameters. This can be used to retrieve the relationship between two objects.
GetRelationshipsForObject(IObject)
Get all relationships that apply to a specified object.
IEnumRelationship GetRelationshipsForObject(IObject anObject)
Parameters
anObjectIObject
Returns
Remarks
The GetRelationshipsForObject method returns an IEnumRelationship enumerator containing the relationships that the anObject parameter participates in.
GetRelationshipsForObjectSet(ISet)
Get all relationships that apply to the specified origin or destination object set.
IEnumRelationship GetRelationshipsForObjectSet(ISet anObjectSet)
Parameters
anObjectSetISet
Returns
Remarks
The GetRelationshipsForObjectSet method returns an IEnumRelationship enumerator containing the relationships that the objects in anObjectSet parameter participate in.
If the input set is constructed with a cursor, ensure that a non-recycling cursor is used.