Interface ERForeignKey

All Superinterfaces:

ADClientAble, ADFindAble, ADHistoryAble, ADM2AttrModifyAble, ELContainerAble, ELContAsgnAble, ELDeleteAble, ELElement, ELNamedElement, ELNamespaceAsgnAble, ELObject, ELShortNameAble, ELUUIDAble, ELValueContainerAble, IMKey, IMKeyRelationship, MECommentAble, MEConstraintAble, MEModelElement, MENamedElement, MENamespaceAsgnAble, MEStereotypeAble, METermAble, MMAttachmentAble, MMCommentContainerAble, MMLabelAble, MMLabelTextAttachmentAble, MMStereotypeAble, MMTextAble

public interface ERForeignKey
extends IMKeyRelationship, ELShortNameAble

A ERForeignKey is a collection of attributes of its EREntity. The foreign key normally implements a relationship by referencing an ERUniqueKey.

See Also:

• ERForeignKeyHelper

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	ERForeignKey.VAttr

Method Summary

Modifier and Type	Method	Description
IMForeignKeyAble	getForeignKeyAble()	Reference to the foreign key inducing element (generalization or relationship role of the foreign key).
ERGeneralizationSet	getGeneralizationSet()	Reference to the ERGeneralizationSet for which this foreign key is created.
EREntity	getOwningEntity()	Reference to the entity of the foreign key.
ERRelationship	getRelationship()	Reference to the ERRelationship for which this foreign key is created.
EREntity	getUniqueKeyEntity()	The entity that owns the referenced key.
List<MEStereotypeAble>	maintain()	Runs all maintaining methods for this foreign key in the following order: maintainAssignForeignKeyAble(...) maintainCreateForeignAttributes(...) maintainHierarchicalPrimaryKey(...)
IMForeignKeyAble	maintainAssignForeignKeyAble()	This maintaining method assigns (if not yet assigned) this foreign key to an appropriate role or generalization. This foreign key's entity shall be known as the FK entity and the referenced unique key's entity as the UK entity. The first step is to search a generalization which has the FK entity as the specializing entity and the UK entity as the general entity.
List<IMKeyRelationshipFeature>	maintainCreateForeignAttributes()	This maintaining method creates the missed foreign key attributes.
IMForeignKeyAble	maintainCreateRelationship()	If the ERForeignKey is not yet assigned to an IMForeignKeyAble (role or generalization), an ERRelationship will be created for this foreign key. Returns the role on the unique key side of the newly-created relationship or null.
List<MEStereotypeAble>	maintainHierarchicalPrimaryKey()	This method maintains the primary key of the entity of this foreign key, if the foreign key is assigned to a hierarchical relationship. A hierarchical relationship is either a generalization or a relationship with a weak entity. All attributes of this foreign key should be part of the primary key in the same entity, unless a primary key with an attribute which is not part of this foreign key already exists. If necessary, a primary key will be created.
void	maintainNotnull()	This maintaining method sets the not null property of the foreign key attributes according to the assigned role.
void	setForeignKeyAble(IMForeignKeyAble value)	Set the value of Foreign Key ForeignKeyAble.
void	setGeneralizationSet(ERGeneralizationSet value)	Set the value of View GeneralizationSet.
void	setRelationship(ERRelationship value)	Set the value of View Relationship.

Methods inherited from interface ADClientAble

getAnnotation, getEndAnalysisDia, getLogic, getLogic, getPresentationContext, getSection, getStartAnalysisDia

Methods inherited from interface ADHistoryAble

getCreateTime, getCreator, getHistory, getModifier, getModifyTime, modifyHistory, setHistory

Methods inherited from interface ADM2AttrModifyAble

getTabCell, getTabCellObjectList, getTabCreateTemplate, getTabCreateTemplateObjectList, getTabElement, getTabElementRelshipTypeList, getTabElementRowList, getTabElementRowTypeList, getTabRelshipList, getTabRowList, tabCellModify, tabCreateTemplate, tabElementModify

Methods inherited from interface ELContainerAble

getClientDependency, getOwnedElement, getOwnedElementTransitiveDown, getOwnedElementTransitiveDown, getOwnedElementTransitiveDownAndUnresolved, getOwnedElementTransitiveDownAndUnresolved, getOwnedOrReferencedElementTransitiveDown, getOwnedOrReferencedElementTransitiveDown, getOwnedRelshipBinDirWithTarget, getOwnedRelshipBinDirWithTarget, getRedirectedModelContainer, getRelshipBinDirSource, getSelfAndOwnedElementTransitiveDown, getSelfAndOwnedElementTransitiveDown, getSortedContents, sortContents

Methods inherited from interface ELContAsgnAble

getAsgnKind, getContSortOrder, getFirstOwnerWhichIsConformTo, getOwner, getOwnerTransitive, getOwnerTransitive, getSelfAndOwnerTransitive, getSelfAndOwnerTransitive, getVersionRoot, isTransitiveChildOf, setAsgnKind, setContSortOrder, setOwner

Methods inherited from interface ELDeleteAble

delete

Methods inherited from interface ELElement

duplicateElement, getAssignAbleToVattr, getAssignAbleToVattr, getClientId, getCreateTemplateOfInstance, getDisplayBitmap, getDisplayColor, getDisplayFont, getDisplayLine, getDisplayName, getDisplayNameShort, getDisplayNSName, getElementCache, getElementMappingInformation, getNotificationElement, getQualifiedNamespaceName, getRelshipBinDir, getRelshipBinDir, getRelshipBinDirTarget, getUnitToLock, getValSpecElement, isContainedInProfile, isUnresolved, lockUnit, setUnresolved, unlockUnit

Methods inherited from interface ELNamedElement

getName, getNameKind, getQualifiedDisplayName, getQualifiedName, getQualifiedTLName, getSupplierDependency, rename, setName, setNameKind

Methods inherited from interface ELNamespaceAsgnAble

getMnClassicTREFName, getNamespace, getNamespaceName, getPath, getSeparator, getVisibility, setUniqueName, setVisibility

Methods inherited from interface ELObject

getId, getLongId, getMetaClass, getMetaName, getOclClass, getSrvCon, hasRead

Methods inherited from interface ELShortNameAble

getShortName, getShortNameKind, setShortName, setShortNameKind, setUniqueShortName

Methods inherited from interface ELUUIDAble

getHyperlinkReferenceAble, getInnoRef, getNotToTranslateAttribute, getTranslatedValue, getUUID, setUUID

Methods inherited from interface ELValueContainerAble

getValueReUseAble, setValueReUseAble

Methods inherited from interface IMKey

getAddableProperty, getAddableProperty, getFeatureNames, getOwnedKeyFeature, getOwningClassifier, getProperty, getProperty, hasNullProperty, isCompleteInView, setFeatureNames, setNull

Methods inherited from interface IMKeyRelationship

getJoinExpressionFlow, getKeyClassifier, getKeyClassifier, getOwnedKeyRelationshipFeature, getUniqueKey, getUniqueKeyClassifier, getViewFrom, isIdentifying, isMaxOne, isOptional, maintainDeleteForeignProperties, setUniqueKey, setUniqueKeyAndMaintain

Methods inherited from interface MECommentAble

getAssignedComment, getAssignedComment, getCommentAssign

Methods inherited from interface MEConstraintAble

getAssignedConstraint, getAssignedConstraint, getConstraintAssign

Methods inherited from interface MEModelElement

buildProxyConnection, getActivityPartition, getConsider, getContentStereotypeByClass, getCreateTemplateByClass, getDataModel, getDataModelName, getElementColor, getFirstValidContentStereotype, getIgnore, getKnownTypeSystems, getMEModelName, getModelElement, getModelElement, getPresContext, getPresContext, getPresetMapping, getPRPresContent, setElementColor

Methods inherited from interface MENamedElement

getMappingSourceElement, getMappingSourceElement, getMESupplierDependency, getMESupplierMappingDependency

Methods inherited from interface MENamespaceAsgnAble

getSignatureMessage

Methods inherited from interface MEStereotypeAble

getClientMappingDependency, getDecisionMade, getDecisionOwned, getKnowledgeSourceOfOwner, getMappingTargetElement, getMappingTargetElement, getMEClientDependency, getProxyAsgProperty, getRepresentingArtifact, getRequirementOfStakeholder, getRequirementOfStakeholderOwner, isMapped, setMapped, setRequirementOfStakeholder

Methods inherited from interface METermAble

getTerm, setTerm

Methods inherited from interface MMAttachmentAble

getAssignedAttachment, getAttachmentAssign, getDefaultAttachment, getOwnedAttachment, setDefaultAttachment

Methods inherited from interface MMCommentContainerAble

getOutgoingConceptRealization, getOwnedComment, getRealizedConcept, getRealizedConcept, replaceRealizedConcepts, setRealizedConcept

Methods inherited from interface MMLabelAble

getLabel, getLabelBoolValue, getLabelColor, getLabelInfo, getLabelLongValue, getLabelNameValue, getLabelStringValue, getLabelValueByPattern, getLabelValueByPattern, getLabelValueList, getOwnedLabelValSpec, hasLabel, modifyLabelValuesByName, setLabelInfo

Methods inherited from interface MMStereotypeAble

assignStereotypeDlg, cloneElement, completelySynchronizeOthers, completelySynchronizeThis, getAttrCnstrEffective, getCreateTemplate, getDisplayType, getExtendingStereotype, getExtendingStereotypeNames, getOwnedFormat, getOwnedStereotypePropertyValSpec, getOwnedStereotypeTSOptionValSpec, getOwnedSyncedElement, getPropBoolValue, getPropLongValue, getPropStringValue, getPropValueList, getStereoPropValueByPattern, getStereoPropValueByPattern, getStereotype, getStereotypeName, getStereotypeProperty, getStereotypePropertyInfo, getStereotypePropertyNameValue, getStereotypeTSOption, getStereotypeTSOptionBoolValue, getStereotypeTSOptionInfo, getStereotypeTSOptionLongValue, getStereotypeTSOptionNameValue, getStereotypeTSOptionStringValue, getStereotypeTSOptionValueByPattern, getStereotypeTSOptionValueByPattern, getStereotypeTSOptionValueList, getSyncedElement, getSyncedStereotypeAble, getSyncedStereotypeAble, isCloneAbleElement, modifyStereotypePropertyValuesByName, modifyStereotypeTSOptionValuesByName, setExtendingStereotype, setStereotype, setStereotypePropertyInfo, setStereotypeTSOptionInfo, setSyncedStereotypeAble

Methods inherited from interface MMTextAble

getFlowExpandedValue, getModifyFlowDocuments, getModifyTextValues, getModifyTextValuesDlgInit, getOwnedTextValue, getOwnedTextValueByPattern, getText, getTextExpandedValue, getTextStringValue, getURIList, modifyFlowDocuments, modifyTextValuesDlg

Method Details

getRelationship

ERRelationship getRelationship()
                        throws InoNetException,
SrvErrorException

Reference to the ERRelationship for which this foreign key is created.

Throws:

InoNetException

SrvErrorException

setRelationship

void setRelationship(ERRelationship value)
              throws InoNetException,
SrvErrorException

Set the value of View Relationship.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getGeneralizationSet

ERGeneralizationSet getGeneralizationSet()
                                  throws InoNetException,
SrvErrorException

Reference to the ERGeneralizationSet for which this foreign key is created.

Throws:

InoNetException

SrvErrorException

setGeneralizationSet

void setGeneralizationSet(ERGeneralizationSet value)
                   throws InoNetException,
SrvErrorException

Set the value of View GeneralizationSet.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

maintainAssignForeignKeyAble

IMForeignKeyAble maintainAssignForeignKeyAble()
                                       throws InoNetException,
SrvErrorException

This maintaining method assigns (if not yet assigned) this foreign key to an appropriate role or generalization.
This foreign key's entity shall be known as the FK entity and the referenced unique key's entity as the UK entity.
The first step is to search a generalization which has the FK entity as the specializing entity and the UK entity as the general entity. This generalization must not already have a foreign key in the FK entity. If such a generalization were not found, the next thing to try is to find a role. The role must be a part of a relationship between the FK and UK entity. The FK entity must be the owner of this role. This indicates the foreign key side of a relationship. This role must not already have a foreign key in the FK entity.
If either a generalization or role is found, assign it to this foreign key.
Returns the newly assigned generalization or role.

Throws:

InoNetException

SrvErrorException

maintain

List<MEStereotypeAble> maintain()
                         throws InoNetException,
SrvErrorException

Runs all maintaining methods for this foreign key in the following order:
maintainAssignForeignKeyAble(...) maintainCreateForeignAttributes(...) maintainHierarchicalPrimaryKey(...)

Throws:

InoNetException

SrvErrorException

maintainCreateForeignAttributes

List<IMKeyRelationshipFeature> maintainCreateForeignAttributes()
                                                        throws InoNetException,
SrvErrorException

This maintaining method creates the missed foreign key attributes. It looks to the unique key referenced by this foreign key. For all unique key features which have not got a referencing key relationship feature in this foreign key, a new attribute will be created and assigned to this foreign key.
If this foreign key does not have any key relationship features to start with, the sort order of a new key relationship feature will be equal to its referenced unique key feature.
Returns the list of the created key relationship features.

Throws:

InoNetException

SrvErrorException

maintainCreateRelationship

IMForeignKeyAble maintainCreateRelationship()
                                     throws InoNetException,
SrvErrorException

If the ERForeignKey is not yet assigned to an IMForeignKeyAble (role or generalization), an ERRelationship will be created for this foreign key.
Returns the role on the unique key side of the newly-created relationship or null.

Throws:

InoNetException

SrvErrorException

maintainHierarchicalPrimaryKey

List<MEStereotypeAble> maintainHierarchicalPrimaryKey()
                                               throws InoNetException,
SrvErrorException

This method maintains the primary key of the entity of this foreign key, if the foreign key is assigned to a hierarchical relationship.
A hierarchical relationship is either a generalization or a relationship with a weak entity.
All attributes of this foreign key should be part of the primary key in the same entity, unless a primary key with an attribute which is not part of this foreign key already exists.
If necessary, a primary key will be created. The foreign attributes will be assigned to the primary key.
Returns a list of created elements. These can be the primary key (always returned as first element) and the created unique key features.

Throws:

InoNetException

SrvErrorException

maintainNotnull

void maintainNotnull()
              throws InoNetException,
SrvErrorException

This maintaining method sets the not null property of the foreign key attributes according to the assigned role.

Throws:

InoNetException

SrvErrorException

getUniqueKeyEntity

EREntity getUniqueKeyEntity()
                     throws InoNetException,
SrvErrorException

The entity that owns the referenced key.

Throws:

InoNetException

SrvErrorException

getForeignKeyAble

IMForeignKeyAble getForeignKeyAble()
                            throws InoNetException,
SrvErrorException

Reference to the foreign key inducing element (generalization or relationship role of the foreign key).

Throws:

InoNetException

SrvErrorException

setForeignKeyAble

void setForeignKeyAble(IMForeignKeyAble value)
                throws InoNetException,
SrvErrorException

Set the value of Foreign Key ForeignKeyAble.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getOwningEntity

EREntity getOwningEntity()
                  throws InoNetException,
SrvErrorException

Reference to the entity of the foreign key.

Throws:

InoNetException

SrvErrorException