jCleanCim-02v00
org.tanjakostic.jcleancim.model

Interface UmlObject

    • Method Summary

      Methods 
      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.
      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:
    • Method Detail

      • getId

        java.lang.Integer getId()
        Returns the local ID of this UML object.

        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).

      • getUuid

        java.lang.String getUuid()
        Returns the universally unique ID of this UML object.

        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.

      • getSince

        java.lang.String getSince()
        Returns the version of the model in which this UML object has been introduced, as defined in the UML model.
      • getOwner

        OwningWg getOwner()
        Returns the IEC working group owning this UML object, as calculated by the application based on the UML model structure.
      • getNature

        Nature getNature()
        Returns the nature of this UML object, which determines the validation rules to apply, and sometimes document generation formats.
      • isInformative

        boolean isInformative()
        Returns whether this UML object is informative (and thus should be ignored when generating official IEC documents).
      • getVisibility

        UmlVisibility getVisibility()
        Returns visibility of this UML object, as defined in the UML model.
      • getKind

        UmlKind getKind()
        Returns kind of this UML object, as assigned by the application.
      • getName

        java.lang.String getName()
        Returns the name of this UML object, as defined in the UML model.
      • getAlias

        java.lang.String getAlias()
        Returns the alias of this UML object, as defined in the UML model, empty string if not defined. Typically used for a "pretty print" name of an UML object, as required for documentation generation.
      • getQualifiedName

        java.lang.String getQualifiedName()
        Returns the name of this UML object combined with some container-related information (e.g., packageName.className, or containingPackageName.packageName). This is meant to be used for displaying purposes, to facilitate locating UML objects.
      • toShortString

        java.lang.String toShortString(boolean includeId,
                                     boolean isNameQualified)
        Returns the context as string, for logging purposes:
         owner nature [inf] [visibility] [qualifier] kind [stereotype] [q]name;
         
        Parameters:
        includeId - whether to print ID
        isNameQualified - whether to print qualified name
      • getDescription

        TextDescription getDescription()
        Returns the raw text description for this UML object, as defined in the UML model. For formatted description, use getHtmlDescription().
      • getHtmlDescription

        TextDescription getHtmlDescription()
        Returns the formatted description for this UML object, as defined in the UML model. For raw text description, use getDescription().
      • getStereotype

        UmlStereotype getStereotype()
        Returns the stereotype of this UML object, as defined in the UML model.
      • isDeprecated

        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).
      • getPredefinedTagNames

        java.util.Set<java.lang.String> getPredefinedTagNames()
        Returns allowed tag names, as expected to be found in the UML model.
      • getUnallowedTagNames

        java.util.Set<java.lang.String> getUnallowedTagNames()
        Returns actual tag names defined for this object, but not found in getPredefinedTagNames().
      • addTaggedValue

        java.lang.String addTaggedValue(java.lang.String name,
                                      java.lang.String value)
                                        throws InvalidTagException
        Adds the UML tagged value (name, value pair) to this UML object, as defined in the UML model.
        Parameters:
        name - tag name.
        value - tag value.
        Returns:
        null if the name is a new tag, otherwise old value for name thas has been overwritten with value.
        Throws:
        InvalidTagException - if either name or value is invalid.
      • getTaggedValues

        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.

Copyright 2009-2015 Tatjana (Tanja) Kostic