public interface UmlObject
Methods never return a null value, but rather empty string or empty collection.
Modifier and Type | Method and Description |
---|---|
java.lang.String |
addTaggedValue(java.lang.String name,
java.lang.String value)
Adds the UML tagged value (
name , value pair) to this UML object, as
defined in the UML model. |
java.lang.String |
getAlias()
Returns the alias of this UML object, as defined in the UML model, empty string if not
defined.
|
TextDescription |
getDescription()
Returns the raw text description for this UML object, as defined in the UML model.
|
TextDescription |
getHtmlDescription()
Returns the formatted description for this UML object, as defined in the UML model.
|
java.lang.Integer |
getId()
Returns the local ID of this UML object.
|
UmlKind |
getKind()
Returns kind of this UML object, as assigned by the application.
|
java.lang.String |
getName()
Returns the name of this UML object, as defined in the UML model.
|
Namespace |
getNamespace()
Returns the namespace of this UML object, based on tagged values in the UML model and when
missing, calculated by the application.
|
Nature |
getNature()
Returns the nature of this UML object, which determines the validation rules to apply, and
sometimes document generation formats.
|
OwningWg |
getOwner()
Returns the IEC working group owning this UML object, as calculated by the application based
on the UML model structure.
|
java.util.Set<java.lang.String> |
getPredefinedTagNames()
Returns allowed tag names, as expected to be found in the UML model.
|
java.lang.String |
getQualifiedName()
Returns the name of this UML object combined with some container-related information (e.g.,
packageName.className, or containingPackageName.packageName).
|
java.lang.String |
getSince()
Returns the version of the model in which this UML object has been introduced, as defined in
the UML model.
|
UmlStereotype |
getStereotype()
Returns the stereotype of this UML object, as defined in the UML model.
|
java.util.Map<java.lang.String,java.lang.String> |
getTaggedValues()
Returns all the tagged values of this UML object, as defined in the UML model.
|
java.util.Set<java.lang.String> |
getUnallowedTagNames()
Returns actual tag names defined for this object, but not found in
getPredefinedTagNames() . |
java.lang.String |
getUuid()
Returns the universally unique ID of this UML object.
|
UmlVisibility |
getVisibility()
Returns visibility of this UML object, as defined in the UML model.
|
boolean |
isDeprecated()
Returns whether this UML object is deprecated; this may be defined directly on this object
with the stereotype
UmlStereotype.DEPRECATED , or derived (for instance, for
association ends of an association). |
boolean |
isInformative()
Returns whether this UML object is informative (and thus should be ignored when generating
official IEC documents).
|
java.lang.String |
toShortString(boolean includeId,
boolean isNameQualified)
Returns the context as string, for logging purposes:
|
java.lang.Integer getId()
In case of EA, this is an integer, assigned per EA type of tables (i.e., it's a counter) that cannot be changed and is a real persistent identifier for the given scope, so the application should be using this number to ensure uniqueness. However, some EA objects do not have this identifier at all, and the application is free to assign any number, assuming that that kind of UML object will not be cached on its own (but rather accessed from its container).
java.lang.String getUuid()
In case of EA, this is the UUID used for manipulating diagram objects (in contrast to everythin else) and when manipulating XMI, but it can be stripped off on model import/export so it cannot be considered as persistent. In case there is not UUID assigned within the model, the application should assign a valid UUID.
java.lang.String getSince()
OwningWg getOwner()
Namespace getNamespace()
Nature getNature()
boolean isInformative()
UmlVisibility getVisibility()
UmlKind getKind()
java.lang.String getName()
java.lang.String getAlias()
java.lang.String getQualifiedName()
java.lang.String toShortString(boolean includeId, boolean isNameQualified)
owner nature [inf] [visibility] [qualifier] kind [stereotype] [q]name;
includeId
- whether to print IDisNameQualified
- whether to print qualified nameTextDescription getDescription()
getHtmlDescription()
.TextDescription getHtmlDescription()
getDescription()
.UmlStereotype getStereotype()
boolean isDeprecated()
UmlStereotype.DEPRECATED
, or derived (for instance, for
association ends of an association).java.util.Set<java.lang.String> getPredefinedTagNames()
java.util.Set<java.lang.String> getUnallowedTagNames()
getPredefinedTagNames()
.java.lang.String addTaggedValue(java.lang.String name, java.lang.String value) throws InvalidTagException
name
, value
pair) to this UML object, as
defined in the UML model.name
- tag name.value
- tag value.name
is a new tag, otherwise old value for name
thas has been overwritten with value
.InvalidTagException
- if either name
or value
is invalid.java.util.Map<java.lang.String,java.lang.String> getTaggedValues()
Copyright 2009-2016 Tatjana (Tanja) Kostic