public class UmlDiagram extends AbstractUmlObject
Design note: We could have had two subclasses, but it would have been an overkill at this point in time.
Modifier and Type | Class and Description |
---|---|
static class |
UmlDiagram.Data
Data from the UML model repository specific to
UmlDiagram . |
static class |
UmlDiagram.Kind
Kind of diagram, as given by EA.
|
Modifier and Type | Field and Description |
---|---|
private UmlStructure |
_container |
private UmlDiagram.Data |
_data |
private boolean |
_forPackage |
private boolean |
_isBlankPic |
private static org.apache.log4j.Logger |
_logger |
private java.io.File |
_pic |
static java.util.List<java.lang.String> |
STEREOTYPES
Allowed stereotypes for UML diagrams.
|
CLASS_SEPARATOR, NULL_OBJ_NAME, PACKAGE_SEPARATOR
Constructor and Description |
---|
UmlDiagram(UmlStructure container,
java.io.File pic,
UmlObjectData objData,
UmlDiagram.Data data)
Intended to be called by
UmlStructure and tests only. |
Modifier and Type | Method and Description |
---|---|
(package private) static UmlDiagram |
basic(UmlStructure container,
java.lang.String name)
Constructs minimal instance - useful for testing.
|
UmlStructure |
getContainer()
Returns the containing structure (class or package).
|
UmlKind |
getKind()
Returns kind of this UML object, as assigned by the application.
|
static java.util.List<UmlKind> |
getKinds(Nature nature)
Returns all available classifications (kinds) for diagrams.
|
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.io.File |
getPic()
Returns the file where the image has been stored; in case the application failed or did not
need to store the real image, the file is the default and
isBlankPic() returns true. |
java.lang.String |
getQualifiedName()
Returns the name of this UML object combined with some container-related information (e.g.,
packageName.className, or containingPackageName.packageName).
|
boolean |
isBlankPic()
Returns true in case the application failed or did not need to store the real image.
|
boolean |
isForPackage()
Returns whether the containing structure for this diagram is a package.
|
boolean |
isInformative()
Returns whether this UML object is informative (and thus should be ignored when generating
official IEC documents).
|
boolean |
isPortrait()
Returns whether the page format is portrait.
|
boolean |
isSupportsTags()
Returns whether tagged values are allowed.
|
java.lang.String |
toString() |
protected void |
validateTag(java.lang.String name,
java.lang.String value)
Subclasses should overwride this method in case some validation about the tagged value is
needed before adding it.
|
addTaggedValue, classifyPerScope, classifyPerScopePerTag, classifyPerTag, collectDuplicateDescriptions, collectDuplicateNames, collectForScope, collectNames, collectQNames, findWithSameUuidAndLog, getAlias, getDescription, getHtmlDescription, getId, getName, getPredefinedTagNames, getSince, getStereotype, getTaggedValues, getUnallowedTagNames, getUuid, getVisibility, isDeprecated, saveTags, toShortString, toShortString
private static final org.apache.log4j.Logger _logger
public static final java.util.List<java.lang.String> STEREOTYPES
private final UmlDiagram.Data _data
private final UmlStructure _container
private final java.io.File _pic
private final boolean _isBlankPic
private final boolean _forPackage
UmlDiagram(UmlStructure container, java.io.File pic, UmlObjectData objData, UmlDiagram.Data data)
UmlStructure
and tests only.public static java.util.List<UmlKind> getKinds(Nature nature)
nature
- ignored in this methodstatic UmlDiagram basic(UmlStructure container, java.lang.String name)
public UmlStructure getContainer()
public boolean isForPackage()
public java.io.File getPic()
isBlankPic()
returns true.public boolean isBlankPic()
public boolean isPortrait()
public boolean isSupportsTags()
public OwningWg getOwner()
UmlObject
getOwner
in interface UmlObject
getOwner
in class AbstractUmlObject
public boolean isInformative()
UmlObject
isInformative
in interface UmlObject
isInformative
in class AbstractUmlObject
public Nature getNature()
UmlObject
getNature
in interface UmlObject
getNature
in class AbstractUmlObject
public UmlKind getKind()
UmlObject
getKind
in interface UmlObject
getKind
in class AbstractUmlObject
public java.lang.String getQualifiedName()
UmlObject
getQualifiedName
in interface UmlObject
getQualifiedName
in class AbstractUmlObject
protected void validateTag(java.lang.String name, java.lang.String value)
AbstractUmlObject
validateTag
in class AbstractUmlObject
public java.lang.String toString()
toString
in class java.lang.Object
Copyright 2009-2015 Tatjana (Tanja) Kostic