RelationshipInfo class final
An object that defines information about the relationship between tables.
A relationship consists of two and only two tables, each having one of these roles in the relationship:
- Origin table, sometimes referred to as the source table or original table.
- Destination table.
One table must have one of these roles and the other table must have the other role. A table can participate in more than one relationship. Further, a table may be an origin table in one relationship and also a destination table in another relationship. The relationship's cardinality describes whether features in a table are related to only one feature in the other table, or whether a feature may be related to multiple features. In a simple relationship, the features in the participating tables can exist without the other. For example, a transformer and an electric pole may be related but one's existence does not depend on the other. Deleting the origin features will simply disassociate the destination features from the origin features. In a composite relationship, the destination features cannot exist without the origin features. When the origin feature is deleted, the related destination feature is deleted as well. This is called a cascade delete. This dependency also means that each destination feature must be linked to a counterpart origin feature.
- Implemented types
Properties
- cardinality → RelationshipCardinality
-
The cardinality of this relationship.
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- id → int
-
The ID of this relationship.
no setter
- isComposite → bool
-
Whether this is a composite relationship.
no setter
- keyField → String
-
The key field, the field that links the origin and destination tables of
this relationship.
no setter
- keyFieldInRelationshipTable → String
-
The key field in the relationship table.
no setter
- name → String
-
The name of the relationship.
no setter
-
The ID of the related table.
no setter
- relationshipTableId → int
-
The ID of the relationship table. The default value is -1, indicating that
no table exists.
no setter
- role → RelationshipRole
-
The role that this table has in this relationship.
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited