de.uni_paderborn.fujaba.uml
Class UMLTypeList

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.UMLTypeList
All Implemented Interfaces:
java.lang.Comparable, FElement, FIncrement, FTypeList, de.uni_kassel.prop.InspectionAware, LogicUnparseInterface, de.tu_bs.coobra.ObjectChangeAware, de.upb.tools.pcs.PropertyChangeClient, de.upb.tools.pcs.PropertyChangeInterface, UniqueIdentifier

public class UMLTypeList
extends UMLIncrement
implements FTypeList

Associations

             +------+ 1                 1
 UMLTypeList | name +--------------------- UMLType
             +------+ revTypes      types
 

Version:
$Revision: 1.66.2.4 $
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.basic.BasicIncrement
dontUseAccessMethodsInThisClass
 
Fields inherited from interface de.uni_paderborn.fujaba.metamodel.FTypeList
TYPES_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
UMLTypeList()
          Constructor for class UMLTypeList
UMLTypeList(UMLProject project)
          Constructor for class UMLTypeList
 
Method Summary
 boolean addToTypes(FType obj)
          Access method for an one to n association.
 void addToTypes(KeyValuePair pair)
          Access method for type
this method is needed only for loading do not use it in other cases
 void addToTypes(java.lang.String key, FType value)
          add a key-value-pair to types
this method is needed only for loading do not use it in other cases
 UMLTypeList createNewInstance()
          returns a new empty list.
protected  java.lang.String createUnparseModuleName()
          No comment provided by developer, please add a comment to improve documentation.
 java.util.Iterator entriesOfTypes()
          No comment provided by developer, please add a comment to improve documentation.
 FType getFromFTypes(java.lang.String key)
          Get the fromFTypes attribute of the UMLTypeList object
 UMLType getFromTypes(java.lang.String key)
          Get the fromTypes attribute of the UMLTypeList object
protected  java.lang.Object getKeyForTypes(FType type)
          Get the keyForTypes attribute of the UMLTypeList object
 FElement getParentElement()
          Query the logical parent of this element (e.g. package of a class, diagram of an object).
 UMLProject getProject()
          Get the project attribute of the UMLTypeList object
 java.util.List getSortedTypeList()
          Get the sortedTypeList attribute of the UMLTypeList object
 boolean hasInTypes(FType obj)
          No comment provided by developer, please add a comment to improve documentation.
 boolean hasKeyInTypes(java.lang.String key)
          No comment provided by developer, please add a comment to improve documentation.
 java.util.Iterator iteratorOfTypes()
          No comment provided by developer, please add a comment to improve documentation.
 void keyChangedInTypes(java.lang.String oldKey, FType value)
          Use this function to inform UMLTypeList, that the key for a FType has changed.
 java.util.Iterator keysOfTypes()
          No comment provided by developer, please add a comment to improve documentation.
 FType provideFType(java.lang.String key)
          No comment provided by developer, please add a comment to improve documentation.
 UMLType provideType(java.lang.String key)
          No comment provided by developer, please add a comment to improve documentation.
 void removeAllFromTypes()
          No comment provided by developer, please add a comment to improve documentation.
 boolean removeFromTypes(FType obj)
          No comment provided by developer, please add a comment to improve documentation.
 boolean removeKeyFromTypes(java.lang.String key)
          No comment provided by developer, please add a comment to improve documentation.
 void removeYou()
          Isolates the object so the garbage collector can remove it.
 ASGElement searchID(java.lang.String id)
          Searches the ASG tree for a given id
 void setProject(UMLProject project)
          Sets the project attribute of the UMLTypeList object
 int sizeOfTypes()
          No comment provided by developer, please add a comment to improve documentation.
 java.util.Iterator sortedIteratorOfTypes()
          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, 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, 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, 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, toString, 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, addToDiagrams, 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

UMLTypeList

public UMLTypeList()
Constructor for class UMLTypeList


UMLTypeList

public UMLTypeList(UMLProject project)
Constructor for class UMLTypeList

Parameters:
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

searchID

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

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

createNewInstance

public UMLTypeList createNewInstance()
returns a new empty list. All PropertyChangeListeners are added to the new list.

Returns:
No description provided

getSortedTypeList

public java.util.List getSortedTypeList()
Get the sortedTypeList attribute of the UMLTypeList object

Returns:
The sortedTypeList value

sortedIteratorOfTypes

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

Returns:
No description provided

addToTypes

public boolean addToTypes(FType obj)
Access method for an one to n association.

Specified by:
addToTypes in interface FTypeList
Parameters:
obj - The object added.
Returns:
No description provided

getKeyForTypes

protected java.lang.Object getKeyForTypes(FType type)
Get the keyForTypes attribute of the UMLTypeList object

Parameters:
type - No description provided
Returns:
The keyForTypes value

hasInTypes

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

Specified by:
hasInTypes in interface FTypeList
Parameters:
obj - No description provided
Returns:
No description provided

hasKeyInTypes

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

Specified by:
hasKeyInTypes in interface FTypeList
Parameters:
key - No description provided
Returns:
No description provided

keyChangedInTypes

public void keyChangedInTypes(java.lang.String oldKey,
                              FType value)
Use this function to inform UMLTypeList, that the key for a FType has changed.

Parameters:
oldKey - The old key used for the FType
value - The FType whose key has changed

iteratorOfTypes

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

Specified by:
iteratorOfTypes in interface FTypeList
Returns:
No description provided

keysOfTypes

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

Specified by:
keysOfTypes in interface FTypeList
Returns:
No description provided

entriesOfTypes

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

Specified by:
entriesOfTypes in interface FTypeList
Returns:
No description provided

sizeOfTypes

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

Specified by:
sizeOfTypes in interface FTypeList
Returns:
No description provided

getFromTypes

public UMLType getFromTypes(java.lang.String key)
Get the fromTypes attribute of the UMLTypeList object

Parameters:
key - No description provided
Returns:
The fromTypes value

getFromFTypes

public FType getFromFTypes(java.lang.String key)
Get the fromFTypes attribute of the UMLTypeList object

Specified by:
getFromFTypes in interface FTypeList
Parameters:
key - No description provided
Returns:
The fromFTypes value

removeFromTypes

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

Specified by:
removeFromTypes in interface FTypeList
Parameters:
obj - No description provided
Returns:
No description provided

removeKeyFromTypes

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

Specified by:
removeKeyFromTypes in interface FTypeList
Parameters:
key - No description provided
Returns:
No description provided

removeAllFromTypes

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

Specified by:
removeAllFromTypes in interface FTypeList

addToTypes

public void addToTypes(KeyValuePair pair)
Access method for type
this method is needed only for loading do not use it in other cases

Specified by:
addToTypes in interface FTypeList
Parameters:
pair - The object added.

addToTypes

public void addToTypes(java.lang.String key,
                       FType value)
add a key-value-pair to types
this method is needed only for loading do not use it in other cases

Specified by:
addToTypes in interface FTypeList
Parameters:
key - key for
value - new value

provideType

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

Parameters:
key - No description provided
Returns:
No description provided

provideFType

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

Specified by:
provideFType in interface FTypeList
Parameters:
key - No description provided
Returns:
No description provided

getProject

public UMLProject getProject()
Get the project attribute of the UMLTypeList object

Returns:
The project value

setProject

public void setProject(UMLProject project)
Sets the project attribute of the UMLTypeList object

Parameters:
project - The new project 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 UMLIncrement

getParentElement

public FElement getParentElement()
Query the logical parent of this element (e.g. package of a class, diagram of an object).

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