org.modelio.metamodel.uml.infrastructure

Interface ModelElement

All Superinterfaces:

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

All Known Subinterfaces:

AbstractDiagram, Abstraction, AbstractProject, AbstractPseudoState, AbstractResource, AcceptCallEventAction, AcceptChangeEventAction, AcceptSignalAction, AcceptTimeEventAction, Access, ActiveStructureElement, Activity, ActivityAction, ActivityDiagram, ActivityEdge, ActivityFinalNode, ActivityGroup, ActivityNode, ActivityParameterNode, ActivityPartition, Actor, Aggregation, AnalystContainer, AnalystElement, AnalystItem, AnalystProject, AndJunction, ApplicationCollaboration, ApplicationComponent, ApplicationEvent, ApplicationFolder, ApplicationFunction, ApplicationInteraction, ApplicationInterface, ApplicationInternalActiveStructureElement, ApplicationInternalBehaviorElement, ApplicationProcess, ApplicationService, ArchimateAbstractElement, ArchimateProject, ArchimateView, Artifact, Artifact, Assessment, Assignment, Association, Association, AssociationEnd, Attribute, AttributeLink, Behavior, BehavioralFeature, BehaviorDiagram, BehaviorElement, BehaviorParameter, BindableInstance, Binding, BpmnActivity, BpmnAdHocSubProcess, BpmnArtifact, BpmnAssociation, BpmnBaseElement, BpmnBoundaryEvent, BpmnBusinessRuleTask, BpmnCallActivity, BpmnCancelEventDefinition, BpmnCatchEvent, BpmnCollaboration, BpmnCollaborationDiagram, BpmnCompensateEventDefinition, BpmnComplexBehaviorDefinition, BpmnComplexGateway, BpmnConditionalEventDefinition, BpmnDataAssociation, BpmnDataInput, BpmnDataObject, BpmnDataOutput, BpmnDataState, BpmnDataStore, BpmnEndEvent, BpmnEndPoint, BpmnErrorEventDefinition, BpmnEscalationEventDefinition, BpmnEvent, BpmnEventBasedGateway, BpmnEventDefinition, BpmnExclusiveGateway, BpmnFlowElement, BpmnFlowNode, BpmnGateway, BpmnGroup, BpmnImplicitThrowEvent, BpmnInclusiveGateway, BpmnInterface, BpmnIntermediateCatchEvent, BpmnIntermediateThrowEvent, BpmnItemAwareElement, BpmnItemDefinition, BpmnLane, BpmnLaneSet, BpmnLinkEventDefinition, BpmnLoopCharacteristics, BpmnManualTask, BpmnMessage, BpmnMessageEventDefinition, BpmnMessageFlow, BpmnMultiInstanceLoopCharacteristics, BpmnOperation, BpmnParallelGateway, BpmnParticipant, BpmnProcess, BpmnProcessCollaborationDiagram, BpmnProcessDesignDiagram, BpmnReceiveTask, BpmnResource, BpmnResourceParameter, BpmnResourceParameterBinding, BpmnResourceRole, BpmnScriptTask, BpmnSendTask, BpmnSequenceFlow, BpmnSequenceFlowDataAssociation, BpmnServiceTask, BpmnSharedDefinitions, BpmnSharedElement, BpmnSignalEventDefinition, BpmnStandardLoopCharacteristics, BpmnStartEvent, BpmnSubProcess, BpmnSubProcessDiagram, BpmnTask, BpmnTerminateEventDefinition, BpmnThrowEvent, BpmnTimerEventDefinition, BpmnTransaction, BpmnUserTask, BusinessActor, BusinessCollaboration, BusinessEvent, BusinessFolder, BusinessFunction, BusinessInteraction, BusinessInterface, BusinessInternalActiveStructureElement, BusinessInternalBehaviorElement, BusinessObject, BusinessPassiveStructureElement, BusinessProcess, BusinessRole, BusinessRule, BusinessRuleContainer, BusinessService, CallAction, CallBehaviorAction, CallOperationAction, Capability, CentralBufferNode, ChoicePseudoState, Class, ClassAssociation, ClassDiagram, Classifier, Clause, Collaboration, CollaborationUse, CombinedFragment, CommunicationChannel, CommunicationDiagram, CommunicationInteraction, CommunicationMessage, CommunicationNetwork, CommunicationNode, Component, ComponentRealization, CompositeElement, CompositeStructureDiagram, Composition, Concept, ConditionalNode, ConnectionPointReference, Connector, ConnectorEnd, Constraint, Constraint, Contract, ControlFlow, ControlNode, CourseOfAction, DataFlow, DataObject, DataStoreNode, DataType, DecisionMergeNode, DeepHistoryPseudoState, Deliverable, Dependency, DependencyRelationship, DeploymentDiagram, Device, DiagramSet, Dictionary, DistributionNetwork, Document, Driver, DurationConstraint, DynamicPropertyDefinition, DynamicRelationship, Element, ElementImport, ElementRealization, EntryPointPseudoState, EnumeratedPropertyType, Enumeration, EnumerationLiteral, Equipment, Event, Event, ExceptionHandler, ExecutionOccurenceSpecification, ExecutionSpecification, ExitPointPseudoState, ExpansionNode, ExpansionRegion, ExtensionPoint, ExternalActiveStructureElement, ExternalBehaviorElement, ExternElement, ExternProcessor, Facility, Feature, FinalNode, FinalState, Flow, FlowFinalNode, Folder, ForkJoinNode, ForkPseudoState, Gap, Gate, GeneralClass, Generalization, GenericAnalystContainer, GenericAnalystElement, Goal, Goal, GoalContainer, GraphDiagram, Grouping, ImpactDiagram, ImpactLink, ImpactModel, ImpactProject, ImplementationEvent, ImplementationFolder, Influence, InformationFlow, InformationItem, InitialNode, InitialPseudoState, InputPin, Instance, InstanceNode, Interaction, InteractionFragment, InteractionOperand, InteractionUse, Interface, InterfaceRealization, InternalActiveStructureElement, InternalBehaviorElement, InternalTransition, InterruptibleActivityRegion, JoinPseudoState, Junction, JunctionPseudoState, KPI, KPIContainer, Lifeline, Link, LinkEnd, Location, LoopNode, Manifestation, Material, MatrixDefinition, Meaning, Message, MessageEnd, MessageFlow, MethodologicalLink, Model, ModelTree, ModuleComponent, ModuleParameter, MotivationElement, MotivationFolder, NameSpace, NaryAssociation, NaryAssociationEnd, NaryConnector, NaryConnectorEnd, NaryLink, NaryLinkEnd, Node, Node, Note, NoteType, ObjectDiagram, ObjectFlow, ObjectNode, OccurrenceSpecification, OpaqueAction, OpaqueBehavior, Operation, OrJunction, OtherRelationship, Outcome, OutputPin, Package, PackageImport, PackageMerge, Parameter, PartDecomposition, PassiveStructureElement, Path, PhysicalFolder, Pin, Plateau, Port, Principle, Product, Profile, Project, PropertyDefinition, PropertyEnumerationLitteral, PropertyTableDefinition, PropertyType, ProvidedInterface, RaisedException, Realization, Region, Relationship, RelationshipConnector, Representation, RequiredInterface, Requirement, Requirement, RequirementContainer, Resource, Resource, ResourceType, Risk, RiskContainer, SendSignalAction, SequenceDiagram, Serving, ShallowHistoryPseudoState, Signal, Specialization, Stakeholder, State, StateInvariant, StateMachine, StateMachineDiagram, StateVertex, StaticDiagram, Stereotype, StrategyBehaviorElement, StrategyFolder, StructuralFeature, StructuralRelationship, StructuredActivityNode, StructureElement, Substitution, SystemSoftware, TaggedValue, TagType, TechnologyActiveStructureElement, TechnologyCollaboration, TechnologyEvent, TechnologyFolder, TechnologyFunction, TechnologyInteraction, TechnologyInterface, TechnologyInternalActiveStructureElement, TechnologyInternalBehaviorElement, TechnologyObject, TechnologyProcess, TechnologyService, TemplateBinding, TemplateParameter, TemplateParameterSubstitution, Term, TerminatePseudoState, TerminateSpecification, Test, TestContainer, Transition, Triggering, UmlModelElement, Usage, UseCase, UseCaseDependency, UseCaseDiagram, Value, ValuePin, ValueStream, ViewPoint, ViewPointDiagram, WorkPackage

public interface ModelElement
extends Element

ModelElement v3.6.00

A ModelElement describes every element that can exist in a model. Only low-level Elements are not ModelElements.

ModelElements can be extended by Stereotypes and TaggedValues, can have Notes, can be the origin or target of Dependencies, and can have Constraints.

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
void	addStereotype(java.lang.String moduleName, java.lang.String stereotypeName) This method add the stereotype specified by the (moduleName, stereotypeName) pair.
<any>	getAttached() Getter for relation 'ModelElement->Attached' Metamodel description: Attached resources
<T extends AbstractResource> java.util.List<T>	getAttached(java.lang.Class<T> filterClass) Filtered Getter for relation 'ModelElement->Attached' Metamodel description: Attached resources
<any>	getDependsOnDependency() Getter for relation 'ModelElement->DependsOnDependency' Metamodel description: Designates a Dependency that relates to a supplier ModelElement.
<T extends Dependency> java.util.List<T>	getDependsOnDependency(java.lang.Class<T> filterClass) Filtered Getter for relation 'ModelElement->DependsOnDependency' Metamodel description: Designates a Dependency that relates to a supplier ModelElement.
<any>	getDescriptor() Getter for relation 'ModelElement->Descriptor' Metamodel description: Notes (documentation, code, and so on) describing the ModelElement.
<T extends Note> java.util.List<T>	getDescriptor(java.lang.Class<T> filterClass) Filtered Getter for relation 'ModelElement->Descriptor' Metamodel description: Notes (documentation, code, and so on) describing the ModelElement.
<any>	getExtension() Getter for relation 'ModelElement->Extension' Metamodel description:
<T extends Stereotype> java.util.List<T>	getExtension(java.lang.Class<T> filterClass) Filtered Getter for relation 'ModelElement->Extension' Metamodel description:
<any>	getImpactDependsOn() Getter for relation 'ModelElement->impactDependsOn' Metamodel description: Impact links from this element.
<T extends ImpactLink> java.util.List<T>	getImpactDependsOn(java.lang.Class<T> filterClass) Filtered Getter for relation 'ModelElement->impactDependsOn' Metamodel description: Impact links from this element.
<any>	getImpactedDependency() Getter for relation 'ModelElement->ImpactedDependency' Metamodel description: Dependencies whose source depend on this element.
<T extends Dependency> java.util.List<T>	getImpactedDependency(java.lang.Class<T> filterClass) Filtered Getter for relation 'ModelElement->ImpactedDependency' Metamodel description: Dependencies whose source depend on this element.
<any>	getImpactImpacted() Getter for relation 'ModelElement->impactImpacted' Metamodel description: Impact link targeting this element.
<T extends ImpactLink> java.util.List<T>	getImpactImpacted(java.lang.Class<T> filterClass) Filtered Getter for relation 'ModelElement->impactImpacted' Metamodel description: Impact link targeting this element.
LocalPropertyTable	getLocalProperties() Getter for relation 'ModelElement->LocalProperties' Metamodel description: The local property table.
java.lang.String	getLocalProperty(java.lang.String key) Get a local property value.
<any>	getMatrix() Getter for relation 'ModelElement->Matrix' Metamodel description: Owned matrices.
<T extends MatrixDefinition> java.util.List<T>	getMatrix(java.lang.Class<T> filterClass) Filtered Getter for relation 'ModelElement->Matrix' Metamodel description: Owned matrices.
java.lang.String	getName() Getter for attribute 'ModelElement.Name' Metamodel description: Name of the element.
Note	getNote(NoteType noteType) Get the first note of the given type.
Note	getNote(java.lang.String moduleName, java.lang.String noteTypeName) Deprecated. since Modelio 3.8, it is recommended to use getNote(String, String, String) instead.
Note	getNote(java.lang.String moduleName, java.lang.String ownerName, java.lang.String noteTypeName) This operation returns the first note of the type indicated by the (moduleName, noteTypeName) pair.
java.lang.String	getNoteContent(NoteType noteType) This method returns the content of the first note of the given type.
java.lang.String	getNoteContent(java.lang.String moduleName, java.lang.String noteTypeName) Deprecated. since Modelio 3.8, it is recommended to use getNoteContent(String, String, String) instead.
java.lang.String	getNoteContent(java.lang.String moduleName, java.lang.String ownerName, java.lang.String noteTypeName) This method returns the content of the first note of the type indicated by the (moduleName, noteTypeName) pair.
<any>	getProduct() Getter for relation 'ModelElement->Product' Metamodel description: null
<T extends AbstractDiagram> java.util.List<T>	getProduct(java.lang.Class<T> filterClass) Filtered Getter for relation 'ModelElement->Product' Metamodel description: null
<any>	getProperties() Getter for relation 'ModelElement->Properties' Metamodel description: Owned property tables.
<T extends PropertyTable> java.util.List<T>	getProperties(java.lang.Class<T> filterClass) Filtered Getter for relation 'ModelElement->Properties' Metamodel description: Owned property tables.
TypedPropertyTable	getProperties(MetaclassReference ref) Get the property table for the properties defined by the given metaclass reference.
TypedPropertyTable	getProperties(Stereotype stereotype) Get the property table for the properties defined by the given stereotype.
PropertyTable	getProperties(java.lang.String name) Get the first found PropertyTable that has the given name.
java.lang.String	getProperty(MetaclassReference ref, java.lang.String key) Get the value of a property defined by a MetaclassReference.
java.lang.String	getProperty(Stereotype stereotype, java.lang.String key) Get the value of a property defined by a Stereotype.
java.lang.String	getProperty(java.lang.String tableName, java.lang.String key) Get a property value.
java.lang.String	getProperty(java.lang.String moduleName, java.lang.String stereotypeName, java.lang.String key) Get a Stereotype defined property value.
Stereotype	getStereotype(java.lang.String moduleName, java.lang.String stereotypeName) Get the first stereotype applied to this element that matches the (moduleName, stereotypeName) pair from this model element.
<any>	getTag() Getter for relation 'ModelElement->Tag' Metamodel description: TaggedValues annotating the ModelElement.
<T extends TaggedValue> java.util.List<T>	getTag(java.lang.Class<T> filterClass) Filtered Getter for relation 'ModelElement->Tag' Metamodel description: TaggedValues annotating the ModelElement.
TaggedValue	getTag(java.lang.String moduleName, java.lang.String tagTypeName) Deprecated. since Modelio 3.8, it is recommended to use getTagValue(String, String, String) instead.
TaggedValue	getTag(java.lang.String moduleName, java.lang.String ownerName, java.lang.String tagTypeName) This method returns the (first) tagged value of the type indicated by the (moduleName, tagTypeName) pair.
TaggedValue	getTag(TagType tagType) This method returns the first tagged value of the given type.
java.lang.String	getTagValue(java.lang.String moduleName, java.lang.String tagTypeName) Deprecated. since Modelio 3.8, it is recommended to use getTagValue(String, String, String) instead.
java.lang.String	getTagValue(java.lang.String moduleName, java.lang.String ownerName, java.lang.String tagTypeName) This method returns the first parameter value of the first tagged value of the type indicated by the (moduleName, tagTypeName) pair.
java.lang.String	getTagValue(TagType tagType) This method returns the first parameter value of the first tagged value of the given type.
java.util.List<java.lang.String>	getTagValues(java.lang.String moduleName, java.lang.String tagTypeName) Deprecated. since Modelio 3.8, it is recommended to use getTagValues(String, String, String) instead.
java.util.List<java.lang.String>	getTagValues(java.lang.String moduleName, java.lang.String ownerName, java.lang.String tagTypeName) This method returns the parameter values of the first tagged value of the type indicated by the (moduleName, tagTypeName) pair.
java.util.List<java.lang.String>	getTagValues(TagType tagType) This method returns the parameter values of the first tagged value of the given type.
boolean	isStereotyped(Stereotype stereotype)
boolean	isStereotyped(java.lang.String moduleName, java.lang.String stereotypeName) Checks if a model element has the stereotype specified by the (moduleName, stereotypeName) pair.
boolean	isTagged(java.lang.String moduleName, java.lang.String tagTypeName) Deprecated. since Modelio 3.8, it is recommended to use isTagged(String, String, String) instead.
boolean	isTagged(java.lang.String moduleName, java.lang.String ownerName, java.lang.String tagTypeName) This method returns true if the element has a tagged value of the type indicated by the (moduleName, tagTypeName) pair.
boolean	isTagged(TagType tagType) This method returns true if the element has a tagged value of the given type.
void	putNoteContent(NoteType noteType, java.lang.String content) This method sets the content of the first note of the given type.
void	putNoteContent(java.lang.String moduleName, java.lang.String noteTypeName, java.lang.String content) Deprecated. since Modelio 3.8, it is recommended to use putNoteContent(String, String, String, String) instead.
void	putNoteContent(java.lang.String moduleName, java.lang.String ownerName, java.lang.String noteTypeName, java.lang.String content) This method sets the content of the first note of the type indicated by the (moduleName, noteTypeName) pair.
void	putTagValue(java.lang.String moduleName, java.lang.String tagTypeName, java.lang.String value) Deprecated. since Modelio 3.8, it is recommended to use putTagValue(String, String, String, String) instead.
void	putTagValue(java.lang.String moduleName, java.lang.String ownerName, java.lang.String tagTypeName, java.lang.String value) This method sets the first parameter of the tagged value of the type indicated by the (moduleName, tagTypeName) pair.
void	putTagValue(TagType tagType, java.lang.String value) This method sets the first parameter of the tagged value of the given type.
void	putTagValues(java.lang.String moduleName, java.lang.String tagTypeName, java.util.List<java.lang.String> values) Deprecated. since Modelio 3.8, it is recommended to use putTagValues(String, String, String, List) instead.
void	putTagValues(java.lang.String moduleName, java.lang.String ownerName, java.lang.String tagTypeName, java.util.List<java.lang.String> values) This method sets the parameters of the tagged value of the type indicated by the (moduleName, tagTypeName) pair.
void	putTagValues(TagType tagType, java.util.List<java.lang.String> values) This method sets the parameters of the tagged value of the given type.
void	removeNotes(NoteType noteType) This method deletes all the notes having this note Type .
void	removeNotes(java.lang.String moduleName, java.lang.String noteTypeName) Deprecated. since Modelio 3.8, it is recommended to use removeNotes(String, String, String) instead.
void	removeNotes(java.lang.String moduleName, java.lang.String ownerName, java.lang.String noteTypeName) This method deletes all the notes having this noteType of the type indicated by the (moduleName, noteTypeName) pair.
void	removeStereotypes(java.lang.String moduleName, java.lang.String stereotypeName) This method removes the stereotype specified by the (moduleName, stereotypeName) pair.
void	removeTags(java.lang.String moduleName, java.lang.String tagTypeName) Deprecated. since Modelio 3.8, it is recommended to use removeTags(String, String, String) instead.
void	removeTags(java.lang.String moduleName, java.lang.String ownerName, java.lang.String tagTypeName) This method deletes all the tagged values of the type indicated by the (moduleName, tagTypeName) pair.
void	removeTags(TagType tagType) This method deletes all the tagged values of given type .
void	setLocalProperties(LocalPropertyTable value) Setter for relation 'ModelElement->LocalProperties' Metamodel description: The local property table.
void	setLocalProperty(java.lang.String key, java.lang.String value) Set a local property value.
void	setName(java.lang.String value) Setter for attribute 'ModelElement.Name' Metamodel description: Name of the element.
void	setProperty(MetaclassReference ref, java.lang.String key, java.lang.String value) Set a property value.
void	setProperty(Stereotype stereotype, java.lang.String key, java.lang.String value) Set a property value.
void	setProperty(java.lang.String tableName, java.lang.String key, java.lang.String value) Set a property value.
void	setProperty(java.lang.String moduleName, java.lang.String stereotypeName, java.lang.String key, java.lang.String value) Set a property value.

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

addStereotype

void addStereotype(java.lang.String moduleName,
                   java.lang.String stereotypeName)
            throws ExtensionNotFoundException

This method add the stereotype specified by the (moduleName, stereotypeName) pair.

Does nothing if the stereotype is already present.

Parameters:

moduleName - the name of the module providing the type. Cannot be null.

stereotypeName - The stereotype to find. Cannot be null.

Throws:

ExtensionNotFoundException - when the stereotype has not been found.

Since:

Modelio 3.4

getLocalProperty

java.lang.String getLocalProperty(java.lang.String key)

Get a local property value.

Return null if no LocalPropertyTable with the given name exists or it does not contain the given property.

Parameters:

key - a property name

Returns:

The property value or null.

getNote

@Deprecated
Note getNote(java.lang.String moduleName,
                         java.lang.String noteTypeName)

Deprecated. since Modelio 3.8, it is recommended to use getNote(String, String, String) instead.

This operation returns the first note of the type indicated by the (moduleName, noteTypeName) pair.

Parameters:

moduleName - the name of the module providing the type. Cannot be null.

noteTypeName - the note type name. Cannot be null.

Returns:

The note or null if the note can't be found.

getNote

Note getNote(java.lang.String moduleName,
             java.lang.String ownerName,
             java.lang.String noteTypeName)

This operation returns the first note of the type indicated by the (moduleName, noteTypeName) pair.

Parameters:

moduleName - the name of the module providing the type. Cannot be null.

ownerName - the name of the Stereotype or MetaclassReference owning the type. If null, only types owned by a MetaclassReference are considered.

noteTypeName - the note type name. Cannot be null.

Returns:

The note or null if the note can't be found.

Since:

Modelio 3.8

getNote

Note getNote(NoteType noteType)

Get the first note of the given type.

Parameters:

noteType - a note type

Returns:

the first matching note or null.

Since:

3.8

getNoteContent

@Deprecated
java.lang.String getNoteContent(java.lang.String moduleName,
                                            java.lang.String noteTypeName)

Deprecated. since Modelio 3.8, it is recommended to use getNoteContent(String, String, String) instead.

This method returns the content of the first note of the type indicated by the (moduleName, noteTypeName) pair.

Parameters:

moduleName - the name of the module providing the type. Cannot be null.

noteTypeName - the note type name. Cannot be null.

Returns:

The note or null if the note can't be found.

getNoteContent

java.lang.String getNoteContent(java.lang.String moduleName,
                                java.lang.String ownerName,
                                java.lang.String noteTypeName)

This method returns the content of the first note of the type indicated by the (moduleName, noteTypeName) pair.

Parameters:

moduleName - the name of the module providing the type. Cannot be null.

ownerName - the name of the Stereotype or MetaclassReference owning the type. Cannot be null.

noteTypeName - the note type name. Cannot be null.

Returns:

The note or null if the note can't be found.

Since:

Modelio 3.8

getNoteContent

java.lang.String getNoteContent(NoteType noteType)

This method returns the content of the first note of the given type.

Parameters:

noteType - the note type.

Returns:

The note or null if the note can't be found.

Since:

3.8

getProperties

PropertyTable getProperties(java.lang.String name)

Get the first found PropertyTable that has the given name.

Parameters:

name - a property table name

Returns:

the found table or null.

getProperty

java.lang.String getProperty(java.lang.String tableName,
                             java.lang.String key)

Get a property value.

Return null if no PropertyTable with the given name exists or it does not contain the given property.

Parameters:

tableName - The table name. The table may not exist.

key - a property name

Returns:

The property value or null.

getProperty

java.lang.String getProperty(java.lang.String moduleName,
                             java.lang.String stereotypeName,
                             java.lang.String key)
                      throws ExtensionNotFoundException

Get a Stereotype defined property value.

Return null if no TypedPropertyTable for the stereotype exists or it does not contain the given property.

Parameters:

moduleName - the name of the module providing stereotype. Cannot be null.

stereotypeName - the name of the stereotype providing the table type. Cannot be null.

key - a property name

Returns:

The property value or null.

Throws:

ExtensionNotFoundException - when the Stereotype has not been found.

Since:

Modelio 3.4

getStereotype

Stereotype getStereotype(java.lang.String moduleName,
                         java.lang.String stereotypeName)

Get the first stereotype applied to this element that matches the (moduleName, stereotypeName) pair from this model element.

The returned stereotype may be a sub stereotype that derives from the given specification.

Parameters:

moduleName - the name of the module providing the type. Cannot be null.

stereotypeName - The stereotype to find. Cannot be null.

Returns:

the specified stereotype or null.

getTag

@Deprecated
TaggedValue getTag(java.lang.String moduleName,
                               java.lang.String tagTypeName)

Deprecated. since Modelio 3.8, it is recommended to use getTagValue(String, String, String) instead.

This method returns the (first) tagged value of the type indicated by the (moduleName, tagTypeName) pair.

Parameters:

moduleName - the name of the module providing the type. Cannot be null.

tagTypeName - The tagged value type name. Cannot be null.

Returns:

The tag or null if it can't be found

getTag

TaggedValue getTag(java.lang.String moduleName,
                   java.lang.String ownerName,
                   java.lang.String tagTypeName)

This method returns the (first) tagged value of the type indicated by the (moduleName, tagTypeName) pair.

Parameters:

moduleName - the name of the module providing the type. Cannot be null.

ownerName - the name of the Stereotype or MetaclassReference owning the type. Cannot be null.

tagTypeName - The tagged value type name. Cannot be null.

Returns:

The tag or null if it can't be found

Since:

Modelio 3.8

getTag

TaggedValue getTag(TagType tagType)

This method returns the first tagged value of the given type.

Parameters:

tagType - a tag type

Returns:

The tag or null if it can't be found.

Since:

3.8

getTagValue

@Deprecated
java.lang.String getTagValue(java.lang.String moduleName,
                                         java.lang.String tagTypeName)

Deprecated. since Modelio 3.8, it is recommended to use getTagValue(String, String, String) instead.

This method returns the first parameter value of the first tagged value of the type indicated by the (moduleName, tagTypeName) pair.

Parameters:

moduleName - the name of the module providing the type. Cannot be null.

tagTypeName - The tagged value type name. Cannot be null.

Returns:

null if no tag can be found or there are no parameters, otherwise the first parameter value.

getTagValue

java.lang.String getTagValue(java.lang.String moduleName,
                             java.lang.String ownerName,
                             java.lang.String tagTypeName)

This method returns the first parameter value of the first tagged value of the type indicated by the (moduleName, tagTypeName) pair.

Parameters:

moduleName - the name of the module providing the type. Cannot be null.

ownerName - the name of the Stereotype or MetaclassReference owning the type. Cannot be null.

tagTypeName - The tagged value type name. Cannot be null.

Returns:

null if no tag can be found or there are no parameters, otherwise the first parameter value.

Since:

Modelio 3.8

getTagValue

java.lang.String getTagValue(TagType tagType)

This method returns the first parameter value of the first tagged value of the given type.

Parameters:

tagType - a tag type

Returns:

null if no tag can be found or there are no parameters, otherwise the first parameter value.

Since:

3.8

getTagValues

@Deprecated
java.util.List<java.lang.String> getTagValues(java.lang.String moduleName,
                                                          java.lang.String tagTypeName)

Deprecated. since Modelio 3.8, it is recommended to use getTagValues(String, String, String) instead.

This method returns the parameter values of the first tagged value of the type indicated by the (moduleName, tagTypeName) pair.

Parameters:

moduleName - the name of the module providing the type. Cannot be null.

tagTypeName - The tagged value type name. Cannot be null.

Returns:

null if no tag can be found otherwise the (possibly empty) parameter list

getTagValues

java.util.List<java.lang.String> getTagValues(java.lang.String moduleName,
                                              java.lang.String ownerName,
                                              java.lang.String tagTypeName)

This method returns the parameter values of the first tagged value of the type indicated by the (moduleName, tagTypeName) pair.

Parameters:

moduleName - the name of the module providing the type. Cannot be null.

ownerName - the name of the Stereotype or MetaclassReference owning the type. Cannot be null.

tagTypeName - The tagged value type name. Cannot be null.

Returns:

null if no tag can be found otherwise the (possibly empty) parameter list

Since:

Modelio 3.8

getTagValues

java.util.List<java.lang.String> getTagValues(TagType tagType)

This method returns the parameter values of the first tagged value of the given type.

Parameters:

tagType - a tag type

Returns:

null if no tag can be found otherwise the (possibly empty) parameter list.

Since:

3.8

isStereotyped

boolean isStereotyped(Stereotype stereotype)

isStereotyped

boolean isStereotyped(java.lang.String moduleName,
                      java.lang.String stereotypeName)

Checks if a model element has the stereotype specified by the (moduleName, stereotypeName) pair.

Parameters:

moduleName - the name of the module providing the type. Cannot be null.

stereotypeName - The stereotype to find. Cannot be null.

Returns:

true if the element has the given stereotype or a stereotype derived from the given one.

isTagged

@Deprecated
boolean isTagged(java.lang.String moduleName,
                             java.lang.String tagTypeName)

Deprecated. since Modelio 3.8, it is recommended to use isTagged(String, String, String) instead.

This method returns true if the element has a tagged value of the type indicated by the (moduleName, tagTypeName) pair.

Parameters:

moduleName - the name of the module providing the type. Cannot be null.

tagTypeName - The tagged value type name. Cannot be null.

Returns:

true if the element has a tagged value with the corresponding type.

isTagged

boolean isTagged(java.lang.String moduleName,
                 java.lang.String ownerName,
                 java.lang.String tagTypeName)

This method returns true if the element has a tagged value of the type indicated by the (moduleName, tagTypeName) pair.

Parameters:

moduleName - the name of the module providing the type. Cannot be null.

ownerName - the name of the Stereotype or MetaclassReference owning the type. Cannot be null.

tagTypeName - The tagged value type name. Cannot be null.

Returns:

true if the element has a tagged value with the corresponding type.

Since:

Modelio 3.8

isTagged

boolean isTagged(TagType tagType)

This method returns true if the element has a tagged value of the given type.

Parameters:

tagType - a tag type

Returns:

true if the element has a tagged value with the corresponding type.

Since:

3.8

putNoteContent

@Deprecated
void putNoteContent(java.lang.String moduleName,
                                java.lang.String noteTypeName,
                                java.lang.String content)
                         throws ExtensionNotFoundException

Deprecated. since Modelio 3.8, it is recommended to use putNoteContent(String, String, String, String) instead.

This method sets the content of the first note of the type indicated by the (moduleName, noteTypeName) pair.

If no note with the given type is found, one is created.

Parameters:

moduleName - the name of the module providing the type. Cannot be null.

noteTypeName - the note type name. Cannot be null.

content - the note content

Throws:

ExtensionNotFoundException - when the NoteType has not been found.

putNoteContent

void putNoteContent(java.lang.String moduleName,
                    java.lang.String ownerName,
                    java.lang.String noteTypeName,
                    java.lang.String content)
             throws ExtensionNotFoundException

This method sets the content of the first note of the type indicated by the (moduleName, noteTypeName) pair.

If no note with the given type is found, one is created.

Parameters:

moduleName - the name of the module providing the type. Cannot be null.

ownerName - the name of the Stereotype or MetaclassReference owning the type. Cannot be null.

noteTypeName - the note type name. Cannot be null.

content - the note content

Throws:

ExtensionNotFoundException - when the NoteType has not been found.

Since:

Modelio 3.8

putNoteContent

void putNoteContent(NoteType noteType,
                    java.lang.String content)

This method sets the content of the first note of the given type.

If no note with the given type is found, one is created.

Parameters:

noteType - a note type

content - the note content

Since:

3.8

putTagValue

@Deprecated
void putTagValue(java.lang.String moduleName,
                             java.lang.String tagTypeName,
                             java.lang.String value)
                      throws ExtensionNotFoundException

Deprecated. since Modelio 3.8, it is recommended to use putTagValue(String, String, String, String) instead.

This method sets the first parameter of the tagged value of the type indicated by the (moduleName, tagTypeName) pair.

The tagged value and the parameter are created if they don't exist.
Other parameters are deleted.

If value is null the existing tag is deleted.

Parameters:

moduleName - the name of the module providing the type. Cannot be null.

tagTypeName - The tagged value type name. Cannot be null.

value - the values to store on the tag parameters. If value is null the tag is deleted.

Throws:

ExtensionNotFoundException - when the TagType has not been found.

putTagValue

void putTagValue(java.lang.String moduleName,
                 java.lang.String ownerName,
                 java.lang.String tagTypeName,
                 java.lang.String value)
          throws ExtensionNotFoundException

This method sets the first parameter of the tagged value of the type indicated by the (moduleName, tagTypeName) pair.

The tagged value and the parameter are created if they don't exist.
Other parameters are deleted.

If value is null the existing tag is deleted.

Parameters:

moduleName - the name of the module providing the type. Cannot be null.

ownerName - the name of the Stereotype or MetaclassReference owning the type. Cannot be null.

tagTypeName - The tagged value type name. Cannot be null.

value - the values to store on the tag parameters. If value is null the tag is deleted.

Throws:

ExtensionNotFoundException - when the TagType has not been found.

Since:

Modelio 3.8

putTagValue

void putTagValue(TagType tagType,
                 java.lang.String value)

This method sets the first parameter of the tagged value of the given type.

The tagged value and the parameter are created if they don't exist.
Other parameters are deleted.

If value is null the existing tag is deleted.

Parameters:

tagType - a tag type

value - the value to store on the tag parameter. If value is null the tag is deleted.

Since:

3.8

putTagValues

@Deprecated
void putTagValues(java.lang.String moduleName,
                              java.lang.String tagTypeName,
                              java.util.List<java.lang.String> values)
                       throws ExtensionNotFoundException

Deprecated. since Modelio 3.8, it is recommended to use putTagValues(String, String, String, List) instead.

This method sets the parameters of the tagged value of the type indicated by the (moduleName, tagTypeName) pair.

The tagged value and the parameters are created if they don't exist, or updated otherwise.
Superfluous parameters are deleted.

If values is null or empty list, the existing tag is deleted.

Parameters:

moduleName - the name of the module providing the type. Cannot be null.

tagTypeName - The tagged value type name. Cannot be null.

values - the values to store on the tag parameters. If value is null or empty list, the tag is deleted.

Throws:

ExtensionNotFoundException - when the TagType has not been found.

putTagValues

void putTagValues(java.lang.String moduleName,
                  java.lang.String ownerName,
                  java.lang.String tagTypeName,
                  java.util.List<java.lang.String> values)
           throws ExtensionNotFoundException

This method sets the parameters of the tagged value of the type indicated by the (moduleName, tagTypeName) pair.

The tagged value and the parameters are created if they don't exist, or updated otherwise.
Superfluous parameters are deleted.

If values is null or empty list, the existing tag is deleted.

Parameters:

moduleName - the name of the module providing the type. Cannot be null.

ownerName - the name of the Stereotype or MetaclassReference owning the type. Cannot be null.

tagTypeName - The tagged value type name. Cannot be null.

values - the values to store on the tag parameters. If value is null or empty list, the tag is deleted.

Throws:

ExtensionNotFoundException - when the TagType has not been found.

Since:

Modelio 3.8

putTagValues

void putTagValues(TagType tagType,
                  java.util.List<java.lang.String> values)

This method sets the parameters of the tagged value of the given type.

The tagged value and the parameters are created if they don't exist, or updated otherwise.
Superfluous parameters are deleted.

If values is null or empty list, the existing tag is deleted.

Parameters:

tagType - a tag type

values - the new tag parameters

Since:

3.8

removeNotes

@Deprecated
void removeNotes(java.lang.String moduleName,
                             java.lang.String noteTypeName)

Deprecated. since Modelio 3.8, it is recommended to use removeNotes(String, String, String) instead.

This method deletes all the notes having this noteType of the type indicated by the (moduleName, noteTypeName) pair.

Parameters:

moduleName - the name of the module providing the type. Cannot be null.

noteTypeName - the note type name. Cannot be null.

removeNotes

void removeNotes(java.lang.String moduleName,
                 java.lang.String ownerName,
                 java.lang.String noteTypeName)

This method deletes all the notes having this noteType of the type indicated by the (moduleName, noteTypeName) pair.

Parameters:

moduleName - the name of the module providing the type. Cannot be null.

ownerName - the name of the Stereotype or MetaclassReference owning the type. Cannot be null.

noteTypeName - the note type name. Cannot be null.

Since:

Modelio 3.8

removeNotes

void removeNotes(NoteType noteType)

This method deletes all the notes having this note Type .

Parameters:

noteType - the type of the notes to delete.

removeStereotypes

void removeStereotypes(java.lang.String moduleName,
                       java.lang.String stereotypeName)

This method removes the stereotype specified by the (moduleName, stereotypeName) pair.

If several instances of the stereotype are present, they are all removed.

Parameters:

moduleName - the name of the module providing the type. Cannot be null.

stereotypeName - The stereotype to find. Cannot be null.

Since:

Modelio 3.4

removeTags

@Deprecated
void removeTags(java.lang.String moduleName,
                            java.lang.String tagTypeName)

Deprecated. since Modelio 3.8, it is recommended to use removeTags(String, String, String) instead.

This method deletes all the tagged values of the type indicated by the (moduleName, tagTypeName) pair.

Parameters:

moduleName - the name of the module providing the type. Cannot be null.

tagTypeName - The tagged value type name. Cannot be null.

removeTags

void removeTags(java.lang.String moduleName,
                java.lang.String ownerName,
                java.lang.String tagTypeName)

This method deletes all the tagged values of the type indicated by the (moduleName, tagTypeName) pair.

Parameters:

moduleName - the name of the module providing the type. Cannot be null.

ownerName - the name of the Stereotype or MetaclassReference owning the type. Cannot be null.

tagTypeName - The tagged value type name. Cannot be null.

Since:

Modelio 3.8

removeTags

void removeTags(TagType tagType)

This method deletes all the tagged values of given type .

Parameters:

tagType - a tag type

setLocalProperty

void setLocalProperty(java.lang.String key,
                      java.lang.String value)

Set a local property value.

Update the value of a property in a LocalPropertyTable. If missing, the table itself is created.

Warning: local property tables are only part of the local project, and are never shared with other users.

Parameters:

key - a property name

value - the property value.

setProperty

void setProperty(java.lang.String moduleName,
                 java.lang.String stereotypeName,
                 java.lang.String key,
                 java.lang.String value)
          throws ExtensionNotFoundException

Set a property value.

Update the value of a property in a stereotype's TypedPropertyTable. If missing, the table itself is created.

Parameters:

moduleName - the name of the module providing stereotype. Cannot be null.

stereotypeName - the name of the stereotype providing the table type. Cannot be null.

key - a property name

value - the property value.

Throws:

ExtensionNotFoundException - when the stereotype has not been found.

Since:

Modelio 3.4

setProperty

void setProperty(java.lang.String tableName,
                 java.lang.String key,
                 java.lang.String value)

Set a property value.

Update the value of a property in a PropertyTable. If missing, the table itself is created.

Parameters:

tableName - The table name. The table may not exist.

key - a property name

value - the property value.

Since:

Modelio 3.4

getProperties

TypedPropertyTable getProperties(Stereotype stereotype)

Get the property table for the properties defined by the given stereotype.

Parameters:

stereotype - a stereotype, must not be null.

Returns:

the found property table or null.

Since:

3.8

getProperty

java.lang.String getProperty(Stereotype stereotype,
                             java.lang.String key)

Get the value of a property defined by a Stereotype.

Return null if no TypedPropertyTable for the stereotype exists or it does not contain the given property.

Parameters:

stereotype - the stereotype providing the table type. Cannot be null.

key - a property name

Returns:

The property value or null.

Since:

Modelio 3.8

setProperty

void setProperty(Stereotype stereotype,
                 java.lang.String key,
                 java.lang.String value)

Set a property value.

Update the value of a property in a stereotype's TypedPropertyTable. If missing, the table itself is created.

Parameters:

stereotype - the stereotype providing the table type. Cannot be null.

key - a property name

value - the property value.

Since:

Modelio 3.8

getProperties

TypedPropertyTable getProperties(MetaclassReference ref)

Get the property table for the properties defined by the given metaclass reference.

Parameters:

ref - the metaclass reference providing the table type. Cannot be null.

Returns:

the found property table or null.

Since:

3.8.1

setProperty

void setProperty(MetaclassReference ref,
                 java.lang.String key,
                 java.lang.String value)

Set a property value.

Update the value of a property in a metaclass reference's TypedPropertyTable. If missing, the table itself is created.

Parameters:

ref - the metaclass reference providing the table type. Cannot be null.

key - a property name

value - the property value.

Since:

3.8.1, Modelio 3.8

getProperty

java.lang.String getProperty(MetaclassReference ref,
                             java.lang.String key)

Get the value of a property defined by a MetaclassReference.

Return null if no TypedPropertyTable for the metaclass reference exists or it does not contain the given property.

Parameters:

ref - the metaclass reference providing the table type. Cannot be null.

key - a property name

Returns:

The property value or null.

Since:

3.8.1, Modelio 3.8

getName

java.lang.String getName()

Getter for attribute 'ModelElement.Name' Metamodel description: Name of the element.

Specified by:

getName in interface MObject

Returns:

the name of the object.

setName

void setName(java.lang.String value)

Setter for attribute 'ModelElement.Name' Metamodel description: Name of the element.

Specified by:

setName in interface MObject

Parameters:

value - the name of the object.

getLocalProperties

LocalPropertyTable getLocalProperties()

Getter for relation 'ModelElement->LocalProperties' Metamodel description: The local property table. This table is not copied with the element. This table is not versioned with the element on SVN managed models, it is local to the working copy.

setLocalProperties

void setLocalProperties(LocalPropertyTable value)

Setter for relation 'ModelElement->LocalProperties' Metamodel description: The local property table. This table is not copied with the element. This table is not versioned with the element on SVN managed models, it is local to the working copy.

getExtension

<any> getExtension()

Getter for relation 'ModelElement->Extension' Metamodel description:

Stereotypes metaclassifying the ModelElement.

getExtension

<T extends Stereotype> java.util.List<T> getExtension(java.lang.Class<T> filterClass)

Filtered Getter for relation 'ModelElement->Extension' Metamodel description:

Stereotypes metaclassifying the ModelElement.

getDependsOnDependency

<any> getDependsOnDependency()

Getter for relation 'ModelElement->DependsOnDependency' Metamodel description: Designates a Dependency that relates to a supplier ModelElement.

getDependsOnDependency

<T extends Dependency> java.util.List<T> getDependsOnDependency(java.lang.Class<T> filterClass)

Filtered Getter for relation 'ModelElement->DependsOnDependency' Metamodel description: Designates a Dependency that relates to a supplier ModelElement.

getTag

<any> getTag()

Getter for relation 'ModelElement->Tag' Metamodel description: TaggedValues annotating the ModelElement.

getTag

<T extends TaggedValue> java.util.List<T> getTag(java.lang.Class<T> filterClass)

Filtered Getter for relation 'ModelElement->Tag' Metamodel description: TaggedValues annotating the ModelElement.

getImpactedDependency

<any> getImpactedDependency()

Getter for relation 'ModelElement->ImpactedDependency' Metamodel description: Dependencies whose source depend on this element.

getImpactedDependency

<T extends Dependency> java.util.List<T> getImpactedDependency(java.lang.Class<T> filterClass)

Filtered Getter for relation 'ModelElement->ImpactedDependency' Metamodel description: Dependencies whose source depend on this element.

getProperties

<any> getProperties()

Getter for relation 'ModelElement->Properties' Metamodel description: Owned property tables.

getProperties

<T extends PropertyTable> java.util.List<T> getProperties(java.lang.Class<T> filterClass)

Filtered Getter for relation 'ModelElement->Properties' Metamodel description: Owned property tables.

getProduct

<any> getProduct()

Getter for relation 'ModelElement->Product' Metamodel description: null

getProduct

<T extends AbstractDiagram> java.util.List<T> getProduct(java.lang.Class<T> filterClass)

Filtered Getter for relation 'ModelElement->Product' Metamodel description: null

getDescriptor

<any> getDescriptor()

Getter for relation 'ModelElement->Descriptor' Metamodel description: Notes (documentation, code, and so on) describing the ModelElement.

getDescriptor

<T extends Note> java.util.List<T> getDescriptor(java.lang.Class<T> filterClass)

Filtered Getter for relation 'ModelElement->Descriptor' Metamodel description: Notes (documentation, code, and so on) describing the ModelElement.

getMatrix

<any> getMatrix()

Getter for relation 'ModelElement->Matrix' Metamodel description: Owned matrices.

getMatrix

<T extends MatrixDefinition> java.util.List<T> getMatrix(java.lang.Class<T> filterClass)

Filtered Getter for relation 'ModelElement->Matrix' Metamodel description: Owned matrices.

getImpactImpacted

<any> getImpactImpacted()

Getter for relation 'ModelElement->impactImpacted' Metamodel description: Impact link targeting this element.

getImpactImpacted

<T extends ImpactLink> java.util.List<T> getImpactImpacted(java.lang.Class<T> filterClass)

Filtered Getter for relation 'ModelElement->impactImpacted' Metamodel description: Impact link targeting this element.

getImpactDependsOn

<any> getImpactDependsOn()

Getter for relation 'ModelElement->impactDependsOn' Metamodel description: Impact links from this element. Gives the elements this one depends on.

getImpactDependsOn

<T extends ImpactLink> java.util.List<T> getImpactDependsOn(java.lang.Class<T> filterClass)

Filtered Getter for relation 'ModelElement->impactDependsOn' Metamodel description: Impact links from this element. Gives the elements this one depends on.

getAttached

<any> getAttached()

Getter for relation 'ModelElement->Attached' Metamodel description: Attached resources

getAttached

<T extends AbstractResource> java.util.List<T> getAttached(java.lang.Class<T> filterClass)

Filtered Getter for relation 'ModelElement->Attached' Metamodel description: Attached resources