de.uni_paderborn.fujaba.uml
Class UMLDiagramItem

java.lang.Object
  extended byde.uni_paderborn.fujaba.basic.BasicIncrement
      extended byde.uni_paderborn.fujaba.asg.ASGElement
          extended byde.uni_paderborn.fujaba.uml.UMLIncrement
              extended byde.uni_paderborn.fujaba.uml.UMLDiagramItem
All Implemented Interfaces:
java.lang.Comparable, FDiagramItem, FElement, FIncrement, 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:
CFNode, DiagramUsage, UMLAction, UMLActivity, UMLAttrExprPair, UMLCollabStat, UMLConnection, UMLConstraint, UMLDeclaration, UMLObject, UMLStatement, UMLTransitionGuard

public abstract class UMLDiagramItem
extends UMLIncrement
implements FDiagramItem

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

Version:
$Revision: 1.114.2.1 $
Author:
$Author: l3_g5 $

Nested Class Summary
 
Nested classes inherited from class de.uni_paderborn.fujaba.asg.ASGElement
ASGElement.SortByNameComparator
 
Field Summary
 
Fields inherited from class de.uni_paderborn.fujaba.basic.BasicIncrement
dontUseAccessMethodsInThisClass
 
Fields inherited from interface de.uni_paderborn.fujaba.metamodel.FDiagramItem
REV_ADDITIONAL_ITEMS_PROPERTY, REV_ITEMS_PROPERTY, VIEW_DEFINITIONS_PROPERTY
 
Fields inherited from interface de.uni_paderborn.fujaba.metamodel.FIncrement
ASSERT_IN_UNIT_TEST_PROPERTY, COMMENT_PROPERTY, CONSTRAINTS_PROPERTY, STEREOTYPES_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
  UMLDiagramItem()
          Constructor for class UMLDiagramItem
protected UMLDiagramItem(boolean coobraPersistent)
           
 
Method Summary
 void addToDiagrams(FDiagram diagram)
          ensures that only UMLDiagrams can be added to the set of diagrams.
 boolean addToRevAdditionalItems(ViewDiagram value)
          Access method for an one to n association.
 boolean addToRevItems(ViewDefinition value)
          Access method for an one to n association.
 boolean addToViewDefinitions(ViewDefinition 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.
 UMLDiagram getCurrentActiveDiagram()
          Returns the current active diagram of the item and works as follows: - Iterate over all display increments of this item. - Select the item, which method getCanvas().getPanel() returns not null it indicates that the display item is actually shown on the screen.
 FDiagram getFCurrentActiveDiagram()
          Get the fCurrentActiveDiagram attribute of the UMLDiagramItem object
 FDiagram getFFirstFromDiagrams()
          Get the fFirstFromDiagrams attribute of the UMLDiagramItem object
 UMLDiagram getFirstFromDiagrams()
          returns the first diagram in the set of diagrams.
 FElement getParentElement()
          Query the logical parent of this element (e.g. package of a class, diagram of an object).
 boolean hasInRevAdditionalItems(ViewDiagram value)
          No comment provided by developer, please add a comment to improve documentation.
 boolean hasInRevItems(ViewDefinition value)
          No comment provided by developer, please add a comment to improve documentation.
 boolean hasInViewDefinitions(ViewDefinition value)
          No comment provided by developer, please add a comment to improve documentation.
 java.util.Iterator iteratorOfRevAdditionalItems()
          No comment provided by developer, please add a comment to improve documentation.
 java.util.Iterator iteratorOfRevItems()
          No comment provided by developer, please add a comment to improve documentation.
 java.util.Iterator iteratorOfViewDefinitions()
          No comment provided by developer, please add a comment to improve documentation.
 void removeAllFromRevAdditionalItems()
          No comment provided by developer, please add a comment to improve documentation.
 void removeAllFromRevItems()
          No comment provided by developer, please add a comment to improve documentation.
 void removeAllFromViewDefinitions()
          No comment provided by developer, please add a comment to improve documentation.
 boolean removeFromRevAdditionalItems(ViewDiagram value)
          No comment provided by developer, please add a comment to improve documentation.
 boolean removeFromRevItems(ViewDefinition value)
          No comment provided by developer, please add a comment to improve documentation.
 boolean removeFromViewDefinitions(ViewDefinition 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.
 int sizeOfRevAdditionalItems()
          No comment provided by developer, please add a comment to improve documentation.
 int sizeOfRevItems()
          No comment provided by developer, please add a comment to improve documentation.
 int sizeOfViewDefinitions()
          No comment provided by developer, please add a comment to improve documentation.
 java.lang.String toString()
          No comment provided by developer, please add a comment to improve documentation.
 
Methods inherited from class de.uni_paderborn.fujaba.uml.UMLIncrement
addToConstraints, addToStereotypes, addToStereotypes, elementsOfAllChildren, entriesOfStereotypes, getComment, getFComment, getFromFStereotypes, getFromStereotypes, getFromStereotypes, hasInConstraints, hasInStereotypes, hasKeyInStereotypes, isAssertInUnitTest, iteratorOfConstraints, iteratorOfStereotypes, keysOfStereotypes, removeAllFromConstraints, removeAllFromStereotypes, removeFromConstraints, removeFromStereotypes, removeKeyFromStereotypes, setAssertInUnitTest, setComment, setStereotype, sizeOfConstraint, sizeOfStereotypes
 
Methods inherited from class de.uni_paderborn.fujaba.asg.ASGElement
acknowledgeChange, addAdditionalListener, addPointToUnparseInformation, addPropertyChangeListener, addPropertyChangeListener, addToAnnotations, 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, getName, 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, searchID, setCoObRAId, setCutCopyPasteParent, setFirstOOGenToken, setGenerated, setInTransientMode, setLastOOGenToken, setName, 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, wait, wait, wait
 
Methods inherited from interface de.uni_paderborn.fujaba.metamodel.FIncrement
addToConstraints, addToStereotypes, entriesOfStereotypes, getFComment, getFromFStereotypes, hasInConstraints, hasInStereotypes, hasKeyInStereotypes, isAssertInUnitTest, iteratorOfConstraints, iteratorOfStereotypes, keysOfStereotypes, removeAllFromConstraints, removeAllFromStereotypes, removeFromConstraints, removeFromStereotypes, removeKeyFromStereotypes, setAssertInUnitTest, setComment, sizeOfStereotypes
 
Methods inherited from interface de.uni_paderborn.fujaba.metamodel.FElement
addToAnnotations, addToElementReferences, addToElementReferences, addToUserMessages, deleteTokens, entriesOfElementReferences, getFirstOOGenToken, getFromFElementReferences, getLastOOGenToken, getName, 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, setName, 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
 

Constructor Detail

UMLDiagramItem

public UMLDiagramItem()
Constructor for class UMLDiagramItem


UMLDiagramItem

protected UMLDiagramItem(boolean coobraPersistent)
Parameters:
coobraPersistent -
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

getFirstFromDiagrams

public UMLDiagram getFirstFromDiagrams()
returns the first diagram in the set of diagrams.

Returns:
The firstFromDiagrams value

addToDiagrams

public void addToDiagrams(FDiagram diagram)
ensures that only UMLDiagrams can be added to the set of diagrams.

Specified by:
addToDiagrams in interface FElement
Overrides:
addToDiagrams in class ASGElement
Parameters:
diagram - The object added.

getCurrentActiveDiagram

public UMLDiagram getCurrentActiveDiagram()
Returns the current active diagram of the item and works as follows: - Iterate over all display increments of this item. - Select the item, which method getCanvas().getPanel() returns not null it indicates that the display item is actually shown on the screen. (Visibility is not taken into account!!!!!!) - Climb up the parent link until a display object corresponding to an UMLDiagram is found. - This diagram is returned.

Returns:
The currentActiveDiagram value

addToViewDefinitions

public boolean addToViewDefinitions(ViewDefinition value)
Access method for an one to n association.

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

hasInViewDefinitions

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

Specified by:
hasInViewDefinitions in interface FDiagramItem
Parameters:
value - No description provided
Returns:
No description provided

iteratorOfViewDefinitions

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

Specified by:
iteratorOfViewDefinitions in interface FDiagramItem
Returns:
No description provided

sizeOfViewDefinitions

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

Specified by:
sizeOfViewDefinitions in interface FDiagramItem
Returns:
No description provided

removeFromViewDefinitions

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

Specified by:
removeFromViewDefinitions in interface FDiagramItem
Parameters:
value - No description provided
Returns:
No description provided

removeAllFromViewDefinitions

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

Specified by:
removeAllFromViewDefinitions in interface FDiagramItem

addToRevItems

public boolean addToRevItems(ViewDefinition value)
Access method for an one to n association.

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

hasInRevItems

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

Specified by:
hasInRevItems in interface FDiagramItem
Parameters:
value - No description provided
Returns:
No description provided

iteratorOfRevItems

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

Specified by:
iteratorOfRevItems in interface FDiagramItem
Returns:
No description provided

sizeOfRevItems

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

Specified by:
sizeOfRevItems in interface FDiagramItem
Returns:
No description provided

removeFromRevItems

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

Specified by:
removeFromRevItems in interface FDiagramItem
Parameters:
value - No description provided
Returns:
No description provided

removeAllFromRevItems

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

Specified by:
removeAllFromRevItems in interface FDiagramItem

addToRevAdditionalItems

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

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

hasInRevAdditionalItems

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

Specified by:
hasInRevAdditionalItems in interface FDiagramItem
Parameters:
value - No description provided
Returns:
No description provided

iteratorOfRevAdditionalItems

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

Specified by:
iteratorOfRevAdditionalItems in interface FDiagramItem
Returns:
No description provided

sizeOfRevAdditionalItems

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

Specified by:
sizeOfRevAdditionalItems in interface FDiagramItem
Returns:
No description provided

removeFromRevAdditionalItems

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

Specified by:
removeFromRevAdditionalItems in interface FDiagramItem
Parameters:
value - No description provided
Returns:
No description provided

removeAllFromRevAdditionalItems

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

Specified by:
removeAllFromRevAdditionalItems in interface FDiagramItem

toString

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

Returns:
No description provided

removeYou

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

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

getParentElement

public FElement getParentElement()
Query the logical parent of this element (e.g. package of a class, diagram of an object). This method allows to navigate in direction of the model root (project) from any element within a project.

Specified by:
getParentElement in interface FElement
Overrides:
getParentElement in class ASGElement
Returns:
the logical parent of this element, may not return null unless this is the top level node (project) or is not contained in any parent yet

getFFirstFromDiagrams

public FDiagram getFFirstFromDiagrams()
Get the fFirstFromDiagrams attribute of the UMLDiagramItem object

Specified by:
getFFirstFromDiagrams in interface FDiagramItem
Returns:
The fFirstFromDiagrams value

getFCurrentActiveDiagram

public FDiagram getFCurrentActiveDiagram()
Get the fCurrentActiveDiagram attribute of the UMLDiagramItem object

Specified by:
getFCurrentActiveDiagram in interface FDiagramItem
Returns:
The fCurrentActiveDiagram value