de.uni_paderborn.fujaba.uml
Class UMLDiagram

java.lang.Object
  extended byde.uni_paderborn.fujaba.basic.BasicIncrement
      extended byde.uni_paderborn.fujaba.asg.ASGElement
          extended byde.uni_paderborn.fujaba.asg.ASGDiagram
              extended byde.uni_paderborn.fujaba.uml.UMLDiagram
All Implemented Interfaces:
java.lang.Comparable, FDiagram, FElement, FModelDiagram, de.uni_kassel.prop.InspectionAware, LogicUnparseInterface, de.tu_bs.coobra.ObjectChangeAware, de.upb.tools.pcs.PropertyChangeClient, de.upb.tools.pcs.PropertyChangeInterface, UniqueIdentifier
Direct Known Subclasses:
CFDiagram, PackageDiagram, UMLActivityDiagram, UMLClassDiagram, UMLObjectDiagram, UMLStoryPattern, UMLTransitionDiagram, ViewDiagram

public abstract class UMLDiagram
extends ASGDiagram
implements FModelDiagram

No comment provided by developer, please add a comment to improve documentation.

Version:
$Revision: 1.161.2.2 $
Author:
$Author: fklar $

Nested Class Summary
 
Nested classes inherited from class de.uni_paderborn.fujaba.asg.ASGElement
ASGElement.SortByNameComparator
 
Field Summary
static java.lang.String ELEMENTKEY
          Deprecated. the virtual items attribute will be removed - use elements instead
static java.lang.String PROPERTY_NAME
          Deprecated.  
 
Fields inherited from class de.uni_paderborn.fujaba.asg.ASGDiagram
ELEMENTS_PROPERTY_KEY, PROJECT_PROPERTY
 
Fields inherited from class de.uni_paderborn.fujaba.basic.BasicIncrement
dontUseAccessMethodsInThisClass
 
Fields inherited from interface de.uni_paderborn.fujaba.metamodel.FModelDiagram
CONSTRAINTS_PROPERTY
 
Fields inherited from interface de.uni_paderborn.fujaba.metamodel.FDiagram
ELEMENTS_PROPERTY
 
Fields inherited from interface de.uni_paderborn.fujaba.metamodel.FElement
ANNOTATIONS_PROPERTY, DIAGRAMS_PROPERTY, ELEMENT_REFERENCES_PROPERTY, GENERATED_PROPERTY, NAME_PROPERTY, TEXT_PROPERTY
 
Constructor Summary
  UMLDiagram()
          Constructor for class UMLDiagram
protected UMLDiagram(boolean coobraPersistent)
           
  UMLDiagram(java.lang.String name, UMLProject project)
          Constructor for class UMLDiagram
 
Method Summary
 boolean addToConstraints(FConstraint value)
          Access method for an one to n association.
 boolean addToElements(ASGElement element)
          Access method for an one to n association.
 void addToElements(java.util.Map.Entry entry)
          Access method for an one to n association.
 boolean addToItems(ASGElement item)
          Deprecated. the virtual items attribute will be removed - use addToElements instead
protected  void addToItems(java.util.Map.Entry entry)
          Deprecated. the virtual items attribute will be removed - use elements instead
 boolean addToViews(ViewDiagram value)
          Access method for an one to n association.
protected  java.lang.String createUnparseModuleName()
          No comment provided by developer, please add a comment to improve documentation.
 void delete()
          Deletes itself and all items of type UMLDiagramItem, that are ONLY contained in this diagram, but asks the user, if the diagram that should be deleted contains items that are ONLY contained in this diagram.
 UMLCollabStat getCollabStat()
          Get the collabStat attribute of the UMLDiagram object
 java.lang.String getElementKey()
          Deprecated. the virtual items attribute will be removed - use elements instead
 java.lang.String getName()
          Get the name attribute of the UMLDiagram object
 int getSizeOfItems()
          Deprecated. the virtual items attribute will be removed - use sizeOfElements instead
 ViewDiagram getViewByName(java.lang.String name)
          Return the view named 'name'.
 boolean hasInConstraints(FConstraint value)
          No comment provided by developer, please add a comment to improve documentation.
 boolean hasInItems(UMLDiagramItem item)
          Deprecated. the virtual items attribute will be removed - use hasInElements instead
 boolean hasInViews(ViewDiagram value)
          No comment provided by developer, please add a comment to improve documentation.
 java.util.Iterator iteratorOfConstraints()
          No comment provided by developer, please add a comment to improve documentation.
 java.util.Iterator iteratorOfItems()
          Deprecated. the virtual items attribute will be removed - use iteratorOfElements instead
 java.util.Iterator iteratorOfViews()
          No comment provided by developer, please add a comment to improve documentation.
 void removeAllFromConstraints()
          No comment provided by developer, please add a comment to improve documentation.
 void removeAllFromItems()
          Deprecated. the virtual items attribute will be removed - use removeAllFromElements instead
 void removeAllFromViews()
          No comment provided by developer, please add a comment to improve documentation.
 boolean removeFromConstraints(FConstraint value)
          No comment provided by developer, please add a comment to improve documentation.
 boolean removeFromElementsWithSideEffects(ASGElement asgElement)
          No comment provided by developer, please add a comment to improve documentation.
 boolean removeFromItems(ASGElement item)
          Deprecated. the virtual items attribute will be removed - use removeFromElements instead
 boolean removeFromItems(UMLDiagramItem item)
          Deprecated. the virtual items attribute will be removed - use removeFromElements instead
 boolean removeFromItemsWithoutIncrementAge(ASGElement asgElement)
          Deprecated. the virtual items attribute will be removed - use removeFromElementsWithSideEffects instead
 boolean removeFromViews(ViewDiagram value)
          No comment provided by developer, please add a comment to improve documentation.
 void removeYou()
          Isolates the object so the garbage collector can remove it.
 boolean setCollabStat(UMLCollabStat value)
          Sets the collabStat attribute of the UMLDiagram object
 void setName(java.lang.String name)
          Sets the name attribute of the UMLDiagram object
 int sizeOfConstraint()
          No comment provided by developer, please add a comment to improve documentation.
 int sizeOfItems()
          Deprecated. the virtual items attribute will be removed - use sizeOfElements instead
 int sizeOfViews()
          No comment provided by developer, please add a comment to improve documentation.
 
Methods inherited from class de.uni_paderborn.fujaba.asg.ASGDiagram
addToElements, addToUsages, getCurrentProject, getParentElement, getProject, getUtility, hasInElements, hasInUsages, iteratorOfElements, iteratorOfUsages, removeAllFromElements, removeAllFromUsages, removeFromElements, removeFromUsages, searchID, setCurrentProject, setProject, setUtility, sizeOfElements, sizeOfUsages
 
Methods inherited from class de.uni_paderborn.fujaba.asg.ASGElement
acknowledgeChange, addAdditionalListener, addPointToUnparseInformation, addPropertyChangeListener, addPropertyChangeListener, addToAnnotations, addToDiagrams, addToElementReferences, addToElementReferences, addToFsaObjects, addToLocations, addToLocations, addToPropertyChangeListeners, addToPropertyChangeListeners, addToUnparseInformations, addToUnparseInformations, addToUserMessages, deleteTokens, elementsOfDiagrams, entriesOfElementReferences, entriesOfFsaObjects, entriesOfUnparseInformations, fireEvent, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getCoObRAId, getFirstFromFSAObjects, getFirstOOGenToken, getFromElementReferences, getFromFElementReferences, getFromFsaObjects, getFromUnparseInformations, getFSAInterface, getLastModified, getLastOOGenToken, getPointFromUnparseInformation, getPropertyChangeSupport, getRepository, getText, getTransientElements, getUnparseModuleName, getUnparseModuleNameImpl, hasInAnnotations, hasInDiagrams, hasInElementReferences, hasInElementReferences, hasInFsaObjects, hasKeyInElementReferences, hasKeyInFsaObjects, initElementListener, initPersistency, isCoobraPersistent, isInspectableField, isInTransientMode, isPersistencyChange, isReadOnly, iteratorOfAnnotations, iteratorOfDiagrams, iteratorOfElementReferences, iteratorOfFsaObjects, iteratorOfKeyFromUnparseInformations, iteratorOfUnparseInformations, iteratorOfUserMessages, keysOfElementReferences, keysOfFsaObjects, keysOfUnparseInformations, proposeFieldValues, removeAdditionalListener, removeAllFromAnnotations, removeAllFromDiagrams, removeAllFromElementReferences, removeAllFromFsaObjects, removeAllFromUnparseInformations, removeAllFromUserMessages, removeFromAnnotations, removeFromDiagrams, removeFromElementReferences, removeFromElementReferences, removeFromFsaObjects, removeFromPropertyChangeListeners, removeFromPropertyChangeListeners, removeFromUnparseInformations, removeFromUnparseInformations, removeFromUnparseInformations, removeFromUserMessages, removeKeyFromElementReferences, removeKeyFromFsaObjects, removePropertyChangeListener, removePropertyChangeListener, saveFSAProperties, saveLocations, setCoObRAId, setCutCopyPasteParent, setFirstOOGenToken, setGenerated, setInTransientMode, setLastOOGenToken, setRepository, setUnparseModuleName, sizeOfAnnotations, sizeOfDiagrams, sizeOfElementReferences, sizeOfFsaObjects, sizeOfUserMessages, updateFSACollapsed, updateFSALocation, updateKeyInFsaObjects, writeAttributes
 
Methods inherited from class de.uni_paderborn.fujaba.basic.BasicIncrement
compareTo, getID, getUniqueID, getUniqueID, isGenerated, lessUniqueId, readAttributes, readAttributes, readFromStringTokenizer, readFromStringTokenizer, readFromStringTokenizer, readFromStringTokenizer, readFromStringTokenizer, readFromStringTokenizer, readFromStringTokenizer, readFromStringTokenizer, readFromStringTokenizer, readFromStringTokenizer, readFromStringTokenizer, readFromStringTokenizer, readFromStringTokenizer, readFromStringTokenizer, resetClassInfos, resetFieldWriteMethods, setAttribValue, setAttribValue, setID, setUniqueId, writeClassToStringBuffer, writeClassToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface de.uni_paderborn.fujaba.metamodel.FDiagram
addToElements, hasInElements, iteratorOfElements, removeAllFromElements, removeFromElements, sizeOfElements
 
Methods inherited from interface de.uni_paderborn.fujaba.metamodel.FElement
addToAnnotations, addToDiagrams, addToElementReferences, addToElementReferences, addToUserMessages, deleteTokens, entriesOfElementReferences, getFirstOOGenToken, getFromFElementReferences, getLastOOGenToken, getParentElement, getText, hasInAnnotations, hasInDiagrams, hasInElementReferences, hasInElementReferences, hasKeyInElementReferences, isCoobraPersistent, isGenerated, iteratorOfAnnotations, iteratorOfDiagrams, iteratorOfElementReferences, iteratorOfUserMessages, keysOfElementReferences, removeAllFromAnnotations, removeAllFromDiagrams, removeAllFromElementReferences, removeAllFromUserMessages, removeFromAnnotations, removeFromDiagrams, removeFromElementReferences, removeFromElementReferences, removeFromUserMessages, removeKeyFromElementReferences, setCutCopyPasteParent, setFirstOOGenToken, setGenerated, setLastOOGenToken, sizeOfAnnotations, sizeOfDiagrams, sizeOfElementReferences, sizeOfUserMessages
 
Methods inherited from interface java.lang.Comparable
compareTo
 
Methods inherited from interface de.uni_paderborn.fujaba.basic.UniqueIdentifier
getID
 
Methods inherited from interface de.uni_paderborn.fujaba.fsa.unparse.LogicUnparseInterface
getFSAInterface, getUnparseModuleName
 
Methods inherited from interface de.upb.tools.pcs.PropertyChangeInterface
getPropertyChangeSupport
 
Methods inherited from interface de.upb.tools.pcs.PropertyChangeClient
addPropertyChangeListener, addPropertyChangeListener, removePropertyChangeListener, removePropertyChangeListener
 
Methods inherited from interface de.tu_bs.coobra.ObjectChangeAware
acknowledgeChange, getCoObRAId, getRepository, setCoObRAId, setRepository
 
Methods inherited from interface de.uni_kassel.prop.InspectionAware
isInspectableField, proposeFieldValues
 

Field Detail

ELEMENTKEY

public static final java.lang.String ELEMENTKEY
Deprecated. the virtual items attribute will be removed - use elements instead

See Also:
Constant Field Values

PROPERTY_NAME

public static final java.lang.String PROPERTY_NAME
Deprecated.  

No comment provided by developer, please add a comment to improve documentation.

See Also:
Constant Field Values
Constructor Detail

UMLDiagram

public UMLDiagram()
Constructor for class UMLDiagram


UMLDiagram

protected UMLDiagram(boolean coobraPersistent)
Parameters:
coobraPersistent -

UMLDiagram

public UMLDiagram(java.lang.String name,
                  UMLProject project)
Constructor for class UMLDiagram

Parameters:
name - No description provided
project - No description provided
Method Detail

createUnparseModuleName

protected java.lang.String createUnparseModuleName()
No comment provided by developer, please add a comment to improve documentation.

Overrides:
createUnparseModuleName in class ASGElement
Returns:
No description provided

getName

public java.lang.String getName()
Get the name attribute of the UMLDiagram object

Specified by:
getName in interface FElement
Overrides:
getName in class ASGElement
Returns:
The name value

setName

public void setName(java.lang.String name)
Sets the name attribute of the UMLDiagram object

Specified by:
setName in interface FElement
Overrides:
setName in class ASGElement
Parameters:
name - The new name value

getSizeOfItems

public int getSizeOfItems()
Deprecated. the virtual items attribute will be removed - use sizeOfElements instead

Get the sizeOfItems attribute of the UMLDiagram object

Returns:
The sizeOfItems value

sizeOfItems

public int sizeOfItems()
Deprecated. the virtual items attribute will be removed - use sizeOfElements instead

No comment provided by developer, please add a comment to improve documentation.

Returns:
No description provided

hasInItems

public boolean hasInItems(UMLDiagramItem item)
Deprecated. the virtual items attribute will be removed - use hasInElements instead

No comment provided by developer, please add a comment to improve documentation.

Parameters:
item - No description provided
Returns:
No description provided

iteratorOfItems

public java.util.Iterator iteratorOfItems()
Deprecated. the virtual items attribute will be removed - use iteratorOfElements instead

No comment provided by developer, please add a comment to improve documentation.

Returns:
No description provided

removeFromItems

public boolean removeFromItems(ASGElement item)
Deprecated. the virtual items attribute will be removed - use removeFromElements instead

This method is needed for the versioning mechanism as ASGDiagram.addToElements(FElement) fires property changes with getElementKey(), for a UMLDiagram this returns "items". FIXME: This method should be deleted if the elements of a UMLDiagram are only UMLDiagramItems again.
Do not use it as default accessor.

Parameters:
item - what to remove from the elements.
Returns:
removeFromElements ( item )

addToElements

public boolean addToElements(ASGElement element)
Access method for an one to n association.

Parameters:
element - The object added.
Returns:
No description provided

addToItems

public boolean addToItems(ASGElement item)
Deprecated. the virtual items attribute will be removed - use addToElements instead

This method is needed for the versioning mechanism as ASGDiagram.addToElements(de.uni_paderborn.fujaba.metamodel.FElement) fires property changes with getElementKey(), for a UMLDiagram this returns "items". UMLDiagramItems again.
Do not use it as default accessor.

Parameters:
item - what to add to the elements.
Returns:
addToElements ( item )

addToElements

public void addToElements(java.util.Map.Entry entry)
Access method for an one to n association.

Specified by:
addToElements in interface FDiagram
Overrides:
addToElements in class ASGDiagram
Parameters:
entry - The object added.

addToItems

protected void addToItems(java.util.Map.Entry entry)
Deprecated. the virtual items attribute will be removed - use elements instead

Parameters:
entry - The object added.

removeFromItems

public boolean removeFromItems(UMLDiagramItem item)
Deprecated. the virtual items attribute will be removed - use removeFromElements instead

No comment provided by developer, please add a comment to improve documentation.

Parameters:
item - No description provided
Returns:
No description provided

removeAllFromItems

public void removeAllFromItems()
Deprecated. the virtual items attribute will be removed - use removeAllFromElements instead

No comment provided by developer, please add a comment to improve documentation.


getElementKey

public java.lang.String getElementKey()
Deprecated. the virtual items attribute will be removed - use elements instead

Get the elementKey attribute of the UMLDiagram object

Overrides:
getElementKey in class ASGDiagram
Returns:
The elementKey value

removeFromItemsWithoutIncrementAge

public boolean removeFromItemsWithoutIncrementAge(ASGElement asgElement)
Deprecated. the virtual items attribute will be removed - use removeFromElementsWithSideEffects instead

No comment provided by developer, please add a comment to improve documentation.

Parameters:
asgElement - No description provided
Returns:
No description provided

removeFromElementsWithSideEffects

public boolean removeFromElementsWithSideEffects(ASGElement asgElement)
No comment provided by developer, please add a comment to improve documentation.

Parameters:
asgElement - No description provided
Returns:
No description provided

hasInConstraints

public boolean hasInConstraints(FConstraint value)
No comment provided by developer, please add a comment to improve documentation.

Specified by:
hasInConstraints in interface FModelDiagram
Parameters:
value - No description provided
Returns:
No description provided

iteratorOfConstraints

public java.util.Iterator iteratorOfConstraints()
No comment provided by developer, please add a comment to improve documentation.

Specified by:
iteratorOfConstraints in interface FModelDiagram
Returns:
No description provided

sizeOfConstraint

public int sizeOfConstraint()
No comment provided by developer, please add a comment to improve documentation.

Specified by:
sizeOfConstraint in interface FModelDiagram
Returns:
No description provided

addToConstraints

public boolean addToConstraints(FConstraint value)
Access method for an one to n association.

Specified by:
addToConstraints in interface FModelDiagram
Parameters:
value - The object added.
Returns:
No description provided

removeFromConstraints

public boolean removeFromConstraints(FConstraint value)
No comment provided by developer, please add a comment to improve documentation.

Specified by:
removeFromConstraints in interface FModelDiagram
Parameters:
value - No description provided
Returns:
No description provided

removeAllFromConstraints

public void removeAllFromConstraints()
No comment provided by developer, please add a comment to improve documentation.

Specified by:
removeAllFromConstraints in interface FModelDiagram

setCollabStat

public boolean setCollabStat(UMLCollabStat value)
Sets the collabStat attribute of the UMLDiagram object

Parameters:
value - The new collabStat value
Returns:
No description provided

getCollabStat

public UMLCollabStat getCollabStat()
Get the collabStat attribute of the UMLDiagram object

Returns:
The collabStat value

removeYou

public void removeYou()
Isolates the object so the garbage collector can remove it.

Specified by:
removeYou in interface FElement
Overrides:
removeYou in class ASGDiagram

addToViews

public boolean addToViews(ViewDiagram value)
Access method for an one to n association.

Parameters:
value - The object added.
Returns:
No description provided

hasInViews

public boolean hasInViews(ViewDiagram value)
No comment provided by developer, please add a comment to improve documentation.

Parameters:
value - No description provided
Returns:
No description provided

iteratorOfViews

public java.util.Iterator iteratorOfViews()
No comment provided by developer, please add a comment to improve documentation.

Returns:
No description provided

sizeOfViews

public int sizeOfViews()
No comment provided by developer, please add a comment to improve documentation.

Returns:
No description provided

removeFromViews

public boolean removeFromViews(ViewDiagram value)
No comment provided by developer, please add a comment to improve documentation.

Parameters:
value - No description provided
Returns:
No description provided

removeAllFromViews

public void removeAllFromViews()
No comment provided by developer, please add a comment to improve documentation.


getViewByName

public ViewDiagram getViewByName(java.lang.String name)
Return the view named 'name'.

Parameters:
name - The name of the view to search for.
Returns:
A view named 'name' or null, if no such view exists.

delete

public void delete()
Deletes itself and all items of type UMLDiagramItem, that are ONLY contained in this diagram, but asks the user, if the diagram that should be deleted contains items that are ONLY contained in this diagram.

Overrides:
delete in class ASGDiagram
See Also:
DeleteDiagramAction