de.uni_paderborn.fujaba.usecase
Class UsecaseDiagram

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.usecase.UsecaseDiagram
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

public class UsecaseDiagram
extends UMLDiagram

A Use Case Diagram. You can add Actors and Use Cases to it and let the Actors use the Use Cases. Every Use Case Diagram contains a System-box. All Use Cases are placed therein.

Version:
$Revision: 1.25 $
Author:
$Author: schneider $
See Also:
Usecase, UsecaseActor, UsecaseUsage, UsecaseSystem

Nested Class Summary
 
Nested classes inherited from class de.uni_paderborn.fujaba.asg.ASGElement
ASGElement.SortByNameComparator
 
Field Summary
private  de.upb.tools.fca.FPropHashSet usecases
           n usecases 0..1 Usecase ------------------------------------ UsecaseDiagram usecases parentUsecaseDiagram
 
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.asg.ASGElement
 
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
UsecaseDiagram()
          Constructor for class UsecaseDiagram
UsecaseDiagram(java.lang.String name, UMLProject project)
          Constructor for class UsecaseDiagram
 
Method Summary
 boolean addToUsecases(Usecase value)
          Access method for an one to n association.
 UsecaseSystem getUsecaseSystem()
          Returns this diagram's System-box.
 boolean hasInUsecases(Usecase value)
          No comment provided by developer, please add a comment to improve documentation.
 boolean hasOnlyNewDisplayStructures()
          No comment provided by developer, please add a comment to improve documentation.
 void init()
          No comment provided by developer, please add a comment to improve documentation.
 java.util.Iterator iteratorOfUsecases()
          No comment provided by developer, please add a comment to improve documentation.
 void removeAllFromUsecases()
          No comment provided by developer, please add a comment to improve documentation.
 boolean removeFromUsecases(Usecase value)
          No comment provided by developer, please add a comment to improve documentation.
 void removeYou()
          UMLMethod: '+ removeYou () : Void'
 ASGElement searchID(java.lang.String id)
          Searches the ASG tree for a given id
 void setName(java.lang.String name)
          Sets the name attribute of the UsecaseDiagram object
 int sizeOfUsecases()
          No comment provided by developer, please add a comment to improve documentation.
 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, addToUsages, addToViews, createUnparseModuleName, delete, getCollabStat, getElementKey, getName, getSizeOfItems, getViewByName, hasInConstraints, hasInItems, hasInUsages, hasInViews, isCyclic, iteratorOfConstraints, iteratorOfItems, iteratorOfUsages, iteratorOfViews, removeAllFromConstraints, removeAllFromItems, removeAllFromUsages, removeAllFromViews, removeFromConstraints, removeFromElementsWithSideEffects, removeFromItems, removeFromItems, removeFromItemsWithoutIncrementAge, removeFromUsages, removeFromViews, setCollabStat, sizeOfConstraint, sizeOfItems, sizeOfUsages, sizeOfViews
 
Methods inherited from class de.uni_paderborn.fujaba.asg.ASGDiagram
addToElements, getCurrentProject, getParentElement, getProject, getUtility, hasInElements, iteratorOfElements, removeAllFromElements, removeFromElements, setCurrentProject, setProject, setUtility, sizeOfElements
 
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, initPersistency, isCoobraPersistent, isInspectableField, isInTransientMode, 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, 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

usecases

private de.upb.tools.fca.FPropHashSet usecases
          n          usecases           0..1
 Usecase ------------------------------------ UsecaseDiagram
          usecases      parentUsecaseDiagram
 

Constructor Detail

UsecaseDiagram

public UsecaseDiagram()
Constructor for class UsecaseDiagram


UsecaseDiagram

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

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

init

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


toString

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

Returns:
No description provided

setName

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

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

getUsecaseSystem

public UsecaseSystem getUsecaseSystem()
Returns this diagram's System-box.

Returns:
this diagram's UsecaseSystem.

sizeOfUsecases

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

Returns:
No description provided

removeFromUsecases

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

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

removeAllFromUsecases

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


iteratorOfUsecases

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

Returns:
No description provided

hasInUsecases

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

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

addToUsecases

public boolean addToUsecases(Usecase value)
Access method for an one to n association.

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

hasOnlyNewDisplayStructures

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

Returns:
No description provided

removeYou

public void removeYou()
UMLMethod: '+ removeYou () : Void'

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

searchID

public ASGElement searchID(java.lang.String id)
Searches the ASG tree for a given id

Overrides:
searchID in class ASGDiagram
Parameters:
id - The id to search for.
Returns:
The Element with the given id, null if not found.