de.uni_paderborn.fujaba.uml
Class UMLClassDiagram

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
                  extended byde.uni_paderborn.fujaba.uml.UMLClassDiagram
All Implemented Interfaces:
java.lang.Comparable, FClassDiagram, 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

public class UMLClassDiagram
extends UMLDiagram
implements FClassDiagram

Version:
$Revision: 1.80 $
Author:
$Author: fklar $

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.uml.UMLDiagram
ELEMENTKEY, PROPERTY_NAME
 
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.FClassDiagram
CLASSES_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
 
Fields inherited from interface de.uni_paderborn.fujaba.metamodel.FModelDiagram
CONSTRAINTS_PROPERTY
 
Constructor Summary
UMLClassDiagram()
          Constructor for class UMLClassDiagram
UMLClassDiagram(java.lang.String name, UMLProject project)
          Constructor for class UMLClassDiagram
 
Method Summary
 void deleteUnboundReferencedClasses()
          Deletes all unbound classes which are declared as referenced but aren't referenced by any other class in the diagram.
 de.upb.tools.fca.FLinkedList getAllClassItems()
          Call this function to get all contained classes of the diagram.
 UMLClass getFromClasses(java.lang.String className)
          Get the first class in this diagram that matches the given name.
 UMLClass getFromClasses(java.lang.String className, java.lang.String packageName)
          Get the specified class from this diagram, including the classes packagename.
 FClass getFromFClasses(java.lang.String className)
          Get the fromFClasses attribute of the UMLClassDiagram object
 boolean hasInClasses(java.lang.String className)
          Does the specified class exists in this diagram?
 boolean hasInClasses(java.lang.String className, java.lang.String packageName)
          Does the specified class exists in this diagram?
 UMLClass provideClass(java.lang.String className, java.lang.String packageName, boolean reuse)
          Returns a class with the full qualified name className.
 FClass provideFClass(java.lang.String className, java.lang.String packageName, boolean reuse)
          No comment provided by developer, please add a comment to improve documentation.
 void removeYou()
          Isolates the object so the garbage collector can remove it.
 java.lang.String toString()
          Returns a correct name for the tree.
 
Methods inherited from class de.uni_paderborn.fujaba.uml.UMLDiagram
addToConstraints, addToElements, addToElements, addToItems, addToItems, addToViews, createUnparseModuleName, delete, getCollabStat, getElementKey, getName, getSizeOfItems, getViewByName, hasInConstraints, hasInItems, hasInViews, iteratorOfConstraints, iteratorOfItems, iteratorOfViews, removeAllFromConstraints, removeAllFromItems, removeAllFromViews, removeFromConstraints, removeFromElementsWithSideEffects, removeFromItems, removeFromItems, removeFromItemsWithoutIncrementAge, removeFromViews, setCollabStat, setName, sizeOfConstraint, sizeOfItems, sizeOfViews
 
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, wait, wait, wait
 
Methods inherited from interface de.uni_paderborn.fujaba.metamodel.FDiagram
addToElements, 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, getName, 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, 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

UMLClassDiagram

public UMLClassDiagram()
Constructor for class UMLClassDiagram


UMLClassDiagram

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

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

provideClass

public UMLClass provideClass(java.lang.String className,
                             java.lang.String packageName,
                             boolean reuse)
Returns a class with the full qualified name className. If the class can not be found, a new one is created within the given package. If packageName is empty or null, the default package will be used.

Parameters:
className - Full qualified class name.
reuse - If true, method tries to reuse existing classes from another class diagram.
packageName - Name of the package className should be placed into.
Returns:
If successful a UMLClass, null otherwise.

provideFClass

public FClass provideFClass(java.lang.String className,
                            java.lang.String packageName,
                            boolean reuse)
No comment provided by developer, please add a comment to improve documentation.

Specified by:
provideFClass in interface FClassDiagram
Parameters:
className - No description provided
packageName - No description provided
reuse - No description provided
Returns:
No description provided

hasInClasses

public boolean hasInClasses(java.lang.String className)
Does the specified class exists in this diagram?

Specified by:
hasInClasses in interface FClassDiagram
Parameters:
className - The name of the class to be searched for.
Returns:
A boolean value specifying whether the class exists in this diagram.

hasInClasses

public boolean hasInClasses(java.lang.String className,
                            java.lang.String packageName)
Does the specified class exists in this diagram?

Parameters:
className - The name of the class to be searched for.
packageName - The package in which the class is located.
Returns:
A boolean value specifying whether the class exists in this diagram.

getFromClasses

public UMLClass getFromClasses(java.lang.String className)
Get the first class in this diagram that matches the given name. NOTE that there could be multiple classes with the same name which are in different packages. If you want to get a class that is located in special package use UMLClassDiagram#getFromClasses(java.lang.String, java.lang.String) instead.

Parameters:
className - The name of the class to be searched for
Returns:
If the specified class exists in this diagram it is returned, otherwise null is returned.

getFromFClasses

public FClass getFromFClasses(java.lang.String className)
Get the fromFClasses attribute of the UMLClassDiagram object

Specified by:
getFromFClasses in interface FClassDiagram
Parameters:
className - No description provided
Returns:
The fromFClasses value

getFromClasses

public UMLClass getFromClasses(java.lang.String className,
                               java.lang.String packageName)
Get the specified class from this diagram, including the classes packagename.

Parameters:
className - Classname to search for.
packageName - Name of the package in which the class is located.
Returns:
If the specified class exists in this diagram it is returned, otherwise null is returned.

getAllClassItems

public de.upb.tools.fca.FLinkedList getAllClassItems()
Call this function to get all contained classes of the diagram.

Returns:
An array of all classes, which are displayed on the diagram.

deleteUnboundReferencedClasses

public void deleteUnboundReferencedClasses()
Deletes all unbound classes which are declared as referenced but aren't referenced by any other class in the diagram.


toString

public java.lang.String toString()
Returns a correct name for the tree.

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 UMLDiagram