org.modelio.metamodel.uml.statik

Interface Instance

All Superinterfaces:

java.lang.Comparable<MObject>, Element, MObject, ModelElement, UmlModelElement

All Known Subinterfaces:

BindableInstance, Port

public interface Instance
extends UmlModelElement

Instance v0.0.9054 In Modelio, Instances represent both the UML 2.0 Instance specification, and the UML 2.0 Part within structured Classifiers. The distinction is made through the definition context. If the context is a namespacing context (such as Package or Class), then it corresponds to the UML 2.0 instance specification. If the context of the instance is an instantiation context, such as typically in the case of Collaborations, then it corresponds to Parts. Parts and Ports are handled as instances in Modelio, whereas UML 2.0 handles them as properties. An Instance is connected to zero or several Classifiers, which declare its structure and behavior. It has a set of attribute values (Slot in UML, and AttributeLink in Modelio) and is connected to a set of Links, where both sets match the definitions of its Classifiers/NameSpaces (if there are any). The two sets implement the current state of the Instance. In Modelio, an Instance belongs to its NameSpace (Class, Package, Collaboration, and so on), or to another Instance (Cluster association). There exist three important cases of configuration for instances in Modelio: 1 - The Instance belongs to a Package. This corresponds to the UML 2.0 notion of InstanceSpecification. 2 - The Instance belongs to a Collaboration (it is a Part, and its links are Connectors). 3 - The Instance belongs to a Classifier. In this case, it is a Part or a Port of the Classifier. (UML 2.0 semantics): When an Instance of the containing Classifier is created, a set of Instances corresponding to its properties may be created either immediately or at some later time, depending on the multiplicity. These Instances are Instances of the Classifier typing the property. A Part specifies that a set of Instances may exist. This set of Instances is a subset of the total set of Instances specified by the Classifier typing the Part. A Part of a Classifier declares that an Instance of this Classifier may contain a set of Instances by composition. All such Instances are destroyed when the container Classifier Instance is destroyed. In Modelio, an Instance belongs to another Instance (embedded or clustered Instances) or belongs to a NameSpace (Package, Class, Collaboration).

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MNAME The metaclass simple name.
static java.lang.String	MQNAME The metaclass qualified name.

Method Summary

Modifier and Type	Method and Description
NameSpace	getBase() Getter for relation 'Instance->Base' Metamodel description: Defines the Classifier as the model of the Instance or Role.
java.lang.String	getMultiplicityMax() Getter for attribute 'Instance.MultiplicityMax' Metamodel description: Maximum number of Instances that can exist in the context of the owner NameSpace.
java.lang.String	getMultiplicityMin() Getter for attribute 'Instance.MultiplicityMin' Metamodel description: Minimum number of Instances that can exist.
<any>	getOwnedEnd() Getter for relation 'Instance->OwnedEnd' Metamodel description: null
<T extends LinkEnd> java.util.List<T>	getOwnedEnd(java.lang.Class<T> filterClass) Filtered Getter for relation 'Instance->OwnedEnd' Metamodel description: null
<any>	getOwnedNaryEnd() Getter for relation 'Instance->OwnedNaryEnd' Metamodel description: null
<T extends NaryLinkEnd> java.util.List<T>	getOwnedNaryEnd(java.lang.Class<T> filterClass) Filtered Getter for relation 'Instance->OwnedNaryEnd' Metamodel description: null
NameSpace	getOwner() Getter for relation 'Instance->Owner' Metamodel description: null
<any>	getPart() Getter for relation 'Instance->Part' Metamodel description: Instances can be embedded.
<T extends BindableInstance> java.util.List<T>	getPart(java.lang.Class<T> filterClass) Filtered Getter for relation 'Instance->Part' Metamodel description: Instances can be embedded.
<any>	getRepresentedCommunicationNode() Getter for relation 'Instance->RepresentedCommunicationNode' Metamodel description: null
<T extends CommunicationNode> java.util.List<T>	getRepresentedCommunicationNode(java.lang.Class<T> filterClass) Filtered Getter for relation 'Instance->RepresentedCommunicationNode' Metamodel description: null
<any>	getRepresentedLifeLine() Getter for relation 'Instance->RepresentedLifeLine' Metamodel description: null
<T extends Lifeline> java.util.List<T>	getRepresentedLifeLine(java.lang.Class<T> filterClass) Filtered Getter for relation 'Instance->RepresentedLifeLine' Metamodel description: null
<any>	getRepresentingObjectNode() Getter for relation 'Instance->RepresentingObjectNode' Metamodel description: null
<T extends ObjectNode> java.util.List<T>	getRepresentingObjectNode(java.lang.Class<T> filterClass) Filtered Getter for relation 'Instance->RepresentingObjectNode' Metamodel description: null
<any>	getSlot() Getter for relation 'Instance->Slot' Metamodel description: Occurrences of attributes for the current object (Instance or Role).
<T extends AttributeLink> java.util.List<T>	getSlot(java.lang.Class<T> filterClass) Filtered Getter for relation 'Instance->Slot' Metamodel description: Occurrences of attributes for the current object (Instance or Role).
<any>	getTargetingEnd() Getter for relation 'Instance->TargetingEnd' Metamodel description: null
<T extends LinkEnd> java.util.List<T>	getTargetingEnd(java.lang.Class<T> filterClass) Filtered Getter for relation 'Instance->TargetingEnd' Metamodel description: null
java.lang.String	getValue() Getter for attribute 'Instance.Value' Metamodel description: Current value of the Instance.
boolean	isIsConstant() Getter for attribute 'Instance.IsConstant' Metamodel description: Determines whether it is a constant.
void	setBase(NameSpace value) Setter for relation 'Instance->Base' Metamodel description: Defines the Classifier as the model of the Instance or Role.
void	setIsConstant(boolean value) Setter for attribute 'Instance.IsConstant' Metamodel description: Determines whether it is a constant.
void	setMultiplicityMax(java.lang.String value) Setter for attribute 'Instance.MultiplicityMax' Metamodel description: Maximum number of Instances that can exist in the context of the owner NameSpace.
void	setMultiplicityMin(java.lang.String value) Setter for attribute 'Instance.MultiplicityMin' Metamodel description: Minimum number of Instances that can exist.
void	setOwner(NameSpace value) Setter for relation 'Instance->Owner' Metamodel description: null
void	setValue(java.lang.String value) Setter for attribute 'Instance.Value' Metamodel description: Current value of the Instance.

Methods inherited from interface org.modelio.metamodel.uml.infrastructure.UmlModelElement

getConstraintDefinition, getConstraintDefinition, getDefaultParametering, getDefaultParametering, getManifesting, getManifesting, getOwnerTemplateParameter, getReceivedInfo, getReceivedInfo, getRepresentingConnector, getRepresentingConnector, getRepresentingEnd, getRepresentingEnd, getRepresentingInstance, getRepresentingInstance, getRepresentingPartition, getRepresentingPartition, getRepresents, getRepresents, getSentInfo, getSentInfo, getTemplateSubstitution, getTemplateSubstitution, getTypingParameter, getTypingParameter, setOwnerTemplateParameter

Methods inherited from interface org.modelio.metamodel.uml.infrastructure.ModelElement

addStereotype, getAttached, getAttached, getDependsOnDependency, getDependsOnDependency, getDescriptor, getDescriptor, getExtension, getExtension, getImpactDependsOn, getImpactDependsOn, getImpactedDependency, getImpactedDependency, getImpactImpacted, getImpactImpacted, getLocalProperties, getLocalProperty, getMatrix, getMatrix, getName, getNote, getNote, getNote, getNoteContent, getNoteContent, getNoteContent, getProduct, getProduct, getProperties, getProperties, getProperties, getProperties, getProperties, getProperty, getProperty, getProperty, getProperty, getStereotype, getTag, getTag, getTag, getTag, getTag, getTagValue, getTagValue, getTagValue, getTagValues, getTagValues, getTagValues, isStereotyped, isStereotyped, isTagged, isTagged, isTagged, putNoteContent, putNoteContent, putNoteContent, putTagValue, putTagValue, putTagValue, putTagValues, putTagValues, putTagValues, removeNotes, removeNotes, removeNotes, removeStereotypes, removeTags, removeTags, removeTags, setLocalProperties, setLocalProperty, setName, setProperty, setProperty, setProperty, setProperty

Methods inherited from interface org.modelio.metamodel.uml.infrastructure.Element

getAddedToQuery, getAddedToQuery, getCausedImpact, getCausedImpact, getDiagramElement, getDiagramElement

Methods inherited from interface org.modelio.vcore.smkernel.mapi.MObject

accept, delete, getCompositionChildren, getCompositionOwner, getMClass, getStatus, getUuid, isDeleted, isModifiable, isShell, isValid, mGet, mGet, mSet

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

MNAME

static final java.lang.String MNAME

The metaclass simple name.

See Also:

Constant Field Values

MQNAME

static final java.lang.String MQNAME

The metaclass qualified name.

See Also:

Constant Field Values

Method Detail

isIsConstant

boolean isIsConstant()

Getter for attribute 'Instance.IsConstant' Metamodel description: Determines whether it is a constant.

setIsConstant

void setIsConstant(boolean value)

Setter for attribute 'Instance.IsConstant' Metamodel description: Determines whether it is a constant.

getMultiplicityMin

java.lang.String getMultiplicityMin()

Getter for attribute 'Instance.MultiplicityMin' Metamodel description: Minimum number of Instances that can exist. In the case where the Instance belongs to a Collaboration (typically in the case of internalStructure) this represents the number of instances at the time of creation of the container NameSpace or Classifier.

setMultiplicityMin

void setMultiplicityMin(java.lang.String value)

Setter for attribute 'Instance.MultiplicityMin' Metamodel description: Minimum number of Instances that can exist. In the case where the Instance belongs to a Collaboration (typically in the case of internalStructure) this represents the number of instances at the time of creation of the container NameSpace or Classifier.

getMultiplicityMax

java.lang.String getMultiplicityMax()

Getter for attribute 'Instance.MultiplicityMax' Metamodel description: Maximum number of Instances that can exist in the context of the owner NameSpace.

setMultiplicityMax

void setMultiplicityMax(java.lang.String value)

Setter for attribute 'Instance.MultiplicityMax' Metamodel description: Maximum number of Instances that can exist in the context of the owner NameSpace.

getValue

java.lang.String getValue()

Getter for attribute 'Instance.Value' Metamodel description: Current value of the Instance. This can be an expression, used instead of the set of values of the AttributeLinks of the instance.

setValue

void setValue(java.lang.String value)

Setter for attribute 'Instance.Value' Metamodel description: Current value of the Instance. This can be an expression, used instead of the set of values of the AttributeLinks of the instance.

getRepresentedCommunicationNode

<any> getRepresentedCommunicationNode()

Getter for relation 'Instance->RepresentedCommunicationNode' Metamodel description: null

getRepresentedCommunicationNode

<T extends CommunicationNode> java.util.List<T> getRepresentedCommunicationNode(java.lang.Class<T> filterClass)

Filtered Getter for relation 'Instance->RepresentedCommunicationNode' Metamodel description: null

getOwnedEnd

<any> getOwnedEnd()

Getter for relation 'Instance->OwnedEnd' Metamodel description: null

getOwnedEnd

<T extends LinkEnd> java.util.List<T> getOwnedEnd(java.lang.Class<T> filterClass)

Filtered Getter for relation 'Instance->OwnedEnd' Metamodel description: null

getBase

NameSpace getBase()

Getter for relation 'Instance->Base' Metamodel description: Defines the Classifier as the model of the Instance or Role.

setBase

void setBase(NameSpace value)

Setter for relation 'Instance->Base' Metamodel description: Defines the Classifier as the model of the Instance or Role.

getRepresentingObjectNode

<any> getRepresentingObjectNode()

Getter for relation 'Instance->RepresentingObjectNode' Metamodel description: null

getRepresentingObjectNode

<T extends ObjectNode> java.util.List<T> getRepresentingObjectNode(java.lang.Class<T> filterClass)

Filtered Getter for relation 'Instance->RepresentingObjectNode' Metamodel description: null

getOwner

NameSpace getOwner()

Getter for relation 'Instance->Owner' Metamodel description: null

setOwner

void setOwner(NameSpace value)

Setter for relation 'Instance->Owner' Metamodel description: null

getOwnedNaryEnd

<any> getOwnedNaryEnd()

Getter for relation 'Instance->OwnedNaryEnd' Metamodel description: null

getOwnedNaryEnd

<T extends NaryLinkEnd> java.util.List<T> getOwnedNaryEnd(java.lang.Class<T> filterClass)

Filtered Getter for relation 'Instance->OwnedNaryEnd' Metamodel description: null

getRepresentedLifeLine

<any> getRepresentedLifeLine()

Getter for relation 'Instance->RepresentedLifeLine' Metamodel description: null

getRepresentedLifeLine

<T extends Lifeline> java.util.List<T> getRepresentedLifeLine(java.lang.Class<T> filterClass)

Filtered Getter for relation 'Instance->RepresentedLifeLine' Metamodel description: null

getSlot

<any> getSlot()

Getter for relation 'Instance->Slot' Metamodel description: Occurrences of attributes for the current object (Instance or Role).

getSlot

<T extends AttributeLink> java.util.List<T> getSlot(java.lang.Class<T> filterClass)

Filtered Getter for relation 'Instance->Slot' Metamodel description: Occurrences of attributes for the current object (Instance or Role).

getPart

<any> getPart()

Getter for relation 'Instance->Part' Metamodel description: Instances can be embedded. This can represent cluster. In Modelio, this is used to represent ComponentInstance supported by NodeInstances, or Objects in ComponentInstances or NodeInstances.

getPart

<T extends BindableInstance> java.util.List<T> getPart(java.lang.Class<T> filterClass)

Filtered Getter for relation 'Instance->Part' Metamodel description: Instances can be embedded. This can represent cluster. In Modelio, this is used to represent ComponentInstance supported by NodeInstances, or Objects in ComponentInstances or NodeInstances.

getTargetingEnd

<any> getTargetingEnd()

Getter for relation 'Instance->TargetingEnd' Metamodel description: null

getTargetingEnd

<T extends LinkEnd> java.util.List<T> getTargetingEnd(java.lang.Class<T> filterClass)

Filtered Getter for relation 'Instance->TargetingEnd' Metamodel description: null