de.uni_paderborn.fujaba.uml
Class UMLRole

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

public class UMLRole
extends UMLIncrement
implements FRole

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

Version:
$Revision: 1.166.2.2 $
Author:
$Author: l3_g5 $

Nested Class Summary
 
Nested classes inherited from class de.uni_paderborn.fujaba.asg.ASGElement
ASGElement.SortByNameComparator
 
Field Summary
static int ADD_METHOD
          Deprecated.  
static int REMOVE_METHOD
          Deprecated.  
 
Fields inherited from class de.uni_paderborn.fujaba.basic.BasicIncrement
dontUseAccessMethodsInThisClass
 
Fields inherited from interface de.uni_paderborn.fujaba.metamodel.FRole
ADORNMENT_PROPERTY, AGGREGATION, ASSOC_PROPERTY, ATTR_NAME_PROPERTY, CARD_PROPERTY, COMPOSITION, NONE, PARSED_PROPERTY, PARTNER_ROLE_PROPERTY, QUALIFIED, QUALIFIER_PROPERTY, REFERENCE, REV_QUALIFIED_ROLE, REV_ROLES_PROPERTY, TARGET_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
UMLRole()
          Constructor for class UMLRole
UMLRole(java.lang.String name, int adornment, UMLClass target, UMLQualifier qualifier, UMLCardinality card, int visibility, UMLAssoc revLeftRole, UMLAssoc revRightRole)
          Constructor for class UMLRole
UMLRole(java.lang.String name, UMLClass target, java.lang.String cardString)
          Constructor for class UMLRole
 
Method Summary
 boolean addToRevQualifiedRole(FQualifier value)
           
protected  java.lang.String createUnparseModuleName()
          No comment provided by developer, please add a comment to improve documentation.
 int getAdornment()
          Get the adornment attribute of the UMLRole object, one of {None, Aggregation, Composition, Reference, Qualified}
 UMLAssoc getAssoc()
          Get the assoc attribute of the UMLRole object
 UMLAttr getAssociatedAttribute()
          UMLMethod: '+ getAssociatedAttribute (): UMLAttr'.
 java.lang.String getAttrName()
          Returns an attribute name which represents this role.
 UMLCardinality getCard()
          Get the card attribute of the UMLRole object
 FAssoc getFAssoc()
          Get the fAssoc attribute of the UMLRole object
 FAttr getFAssociatedAttribute()
          Get the fAssociatedAttribute attribute of the UMLRole object
 FCardinality getFCard()
          Get the fCard attribute of the UMLRole object
 FRole getFPartnerRole()
          Get the fPartnerRole attribute of the UMLRole object
 FQualifier getFQualifier()
          Get the fQualifier attribute of the UMLRole object
 FClass getFRevRoles()
          Get the fRevRoles attribute of the UMLRole object
 FClass getFTarget()
          Get the fTarget attribute of the UMLRole object
 java.lang.String getName()
          Get the name attribute of the UMLRole object
 FElement getParentElement()
          Query the logical parent of this element (e.g. package of a class, diagram of an object).
 UMLRole getPartnerRole()
          Get the partnerRole attribute of the UMLRole object
 UMLQualifier getQualifier()
          Get the qualifier attribute of the UMLRole object
 UMLAssoc getRevLeftRole()
          Get the revLeftRole attribute of the UMLRole object
 UMLAssoc getRevRightRole()
          Get the revRightRole attribute of the UMLRole object
 UMLClass getRevRoles()
          Get the revRoles attribute of the UMLRole object
 java.lang.String getSortedComparator()
          Get the sortedComparator attribute of the UMLAssoc object
 UMLClass getTarget()
          Get the target attribute of the UMLRole object
 int getUmlVisibility()
          Get the umlVisibility attribute of the UMLRole object
 boolean hasInRevQualifiedRole(FQualifier value)
           
 boolean isParsed()
          Indicates if the role was generated from parsed source code.
 java.util.Iterator iteratorOfRevQualifiedRole()
           
 void removeAllFromRevQualifiedRole()
          No comment provided by developer, please add a comment to improve documentation.
 boolean removeFromRevQualifiedRole(FQualifier value)
           
 void removeYou()
          Isolates the object so the garbage collector can remove it.
 void setAdornment(int adornment)
          Sets the adornment attribute of the UMLRole object, one of {None, Aggregation, Composition, Reference, Qualified}
 boolean setAssociatedAttribute(UMLAttr value)
          UMLMethod: '+ setAssociatedAttribute (value: UMLAttr): Boolean'.
 void setCard(FCardinality card)
          Sets the card attribute of the UMLRole object
 void setName(java.lang.String name)
          Sets the name attribute of the UMLRole object
 void setParsed(boolean parsed)
          Indicate that the role was generated from parsed source code.
 void setQualifier(FQualifier qualifier)
          Sets the qualifier attribute of the UMLRole object
 void setRevLeftRole(FAssoc revLeftRole)
          Sets the revLeftRole attribute of the UMLRole object
 void setRevRightRole(FAssoc revRightRole)
          Sets the revRightRole attribute of the UMLRole object
 void setRevRoles(FClass target)
          Sets the revRoles attribute of the UMLRole object
 void setSortedComparator(java.lang.String comparator)
          Sets the sortedComparator attribute of the UMLAssoc object
 void setTarget(FClass target)
          Sets the target attribute of the UMLRole object
 void setUmlVisibility(int newUmlVisibility)
          Sets the umlVisibility attribute of the UMLRole object
 int sizeOfRevQualifiedRole()
           
 java.lang.String toString()
           
 
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, 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, 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, addToDiagrams, addToElementReferences, addToElementReferences, addToUserMessages, deleteTokens, entriesOfElementReferences, getFirstOOGenToken, getFromFElementReferences, getLastOOGenToken, 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

ADD_METHOD

public static final int ADD_METHOD
Deprecated.  

See Also:
Constant Field Values

REMOVE_METHOD

public static final int REMOVE_METHOD
Deprecated.  

See Also:
Constant Field Values
Constructor Detail

UMLRole

public UMLRole()
Constructor for class UMLRole


UMLRole

public UMLRole(java.lang.String name,
               UMLClass target,
               java.lang.String cardString)
Constructor for class UMLRole

Parameters:
name - No description provided
target - No description provided
cardString - No description provided

UMLRole

public UMLRole(java.lang.String name,
               int adornment,
               UMLClass target,
               UMLQualifier qualifier,
               UMLCardinality card,
               int visibility,
               UMLAssoc revLeftRole,
               UMLAssoc revRightRole)
Constructor for class UMLRole

Parameters:
name - No description provided
adornment - No description provided
target - No description provided
qualifier - No description provided
card - No description provided
visibility - No description provided
revLeftRole - No description provided
revRightRole - 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 UMLRole 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 UMLRole object

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

getUmlVisibility

public int getUmlVisibility()
Get the umlVisibility attribute of the UMLRole object

Specified by:
getUmlVisibility in interface FRole
Returns:
The umlVisibility value

setUmlVisibility

public void setUmlVisibility(int newUmlVisibility)
Sets the umlVisibility attribute of the UMLRole object

Specified by:
setUmlVisibility in interface FRole
Parameters:
newUmlVisibility - The new umlVisibility value

getAdornment

public int getAdornment()
Get the adornment attribute of the UMLRole object, one of {None, Aggregation, Composition, Reference, Qualified}

Specified by:
getAdornment in interface FRole
Returns:
The adornment value
See Also:
FRole.NONE, FRole.AGGREGATION, FRole.COMPOSITION, FRole.REFERENCE, FRole.QUALIFIED

setAdornment

public void setAdornment(int adornment)
Sets the adornment attribute of the UMLRole object, one of {None, Aggregation, Composition, Reference, Qualified}

Specified by:
setAdornment in interface FRole
Parameters:
adornment - The new adornment value
See Also:
FRole.NONE, FRole.AGGREGATION, FRole.COMPOSITION, FRole.REFERENCE, FRole.QUALIFIED

setParsed

public void setParsed(boolean parsed)
Indicate that the role was generated from parsed source code. If it is set to true, there will be no code generated for the role, since access methods already exist in the parsed code.

Specified by:
setParsed in interface FRole
Parameters:
parsed - true, if the role was generated from parsed source code

isParsed

public boolean isParsed()
Indicates if the role was generated from parsed source code. If it is true, there will be no code generated for the role, since access methods already exist in the parsed code.

Specified by:
isParsed in interface FRole
Returns:
true, if the role was generated from parsed source code

getTarget

public UMLClass getTarget()
Get the target attribute of the UMLRole object

Returns:
The target value

getFTarget

public FClass getFTarget()
Get the fTarget attribute of the UMLRole object

Specified by:
getFTarget in interface FRole
Returns:
The fTarget value

setTarget

public void setTarget(FClass target)
Sets the target attribute of the UMLRole object

Specified by:
setTarget in interface FRole
Parameters:
target - The new target value

setRevRoles

public void setRevRoles(FClass target)
Sets the revRoles attribute of the UMLRole object

Specified by:
setRevRoles in interface FRole
Parameters:
target - The new revRoles value

getRevRoles

public UMLClass getRevRoles()
Get the revRoles attribute of the UMLRole object

Returns:
The revRoles value

getFRevRoles

public FClass getFRevRoles()
Get the fRevRoles attribute of the UMLRole object

Specified by:
getFRevRoles in interface FRole
Returns:
The fRevRoles value

getRevLeftRole

public UMLAssoc getRevLeftRole()
Get the revLeftRole attribute of the UMLRole object

Returns:
The revLeftRole value

setRevLeftRole

public void setRevLeftRole(FAssoc revLeftRole)
Sets the revLeftRole attribute of the UMLRole object

Parameters:
revLeftRole - The new revLeftRole value

getRevRightRole

public UMLAssoc getRevRightRole()
Get the revRightRole attribute of the UMLRole object

Returns:
The revRightRole value

setRevRightRole

public void setRevRightRole(FAssoc revRightRole)
Sets the revRightRole attribute of the UMLRole object

Parameters:
revRightRole - The new revRightRole value

getCard

public UMLCardinality getCard()
Get the card attribute of the UMLRole object

Returns:
The card value

getFCard

public FCardinality getFCard()
Get the fCard attribute of the UMLRole object

Specified by:
getFCard in interface FRole
Returns:
The fCard value

setCard

public void setCard(FCardinality card)
Sets the card attribute of the UMLRole object

Specified by:
setCard in interface FRole
Parameters:
card - The new card value

getQualifier

public UMLQualifier getQualifier()
Get the qualifier attribute of the UMLRole object

Returns:
The qualifier value

getFQualifier

public FQualifier getFQualifier()
Get the fQualifier attribute of the UMLRole object

Specified by:
getFQualifier in interface FRole
Returns:
The fQualifier value

setQualifier

public void setQualifier(FQualifier qualifier)
Sets the qualifier attribute of the UMLRole object

Specified by:
setQualifier in interface FRole
Parameters:
qualifier - The new qualifier value

hasInRevQualifiedRole

public boolean hasInRevQualifiedRole(FQualifier value)
Specified by:
hasInRevQualifiedRole in interface FRole
Parameters:
value - No description provided
Returns:
No description provided

iteratorOfRevQualifiedRole

public java.util.Iterator iteratorOfRevQualifiedRole()
Specified by:
iteratorOfRevQualifiedRole in interface FRole
Returns:
No description provided

sizeOfRevQualifiedRole

public int sizeOfRevQualifiedRole()
Specified by:
sizeOfRevQualifiedRole in interface FRole
Returns:
No description provided

addToRevQualifiedRole

public boolean addToRevQualifiedRole(FQualifier value)
Specified by:
addToRevQualifiedRole in interface FRole
Parameters:
value - The object added.
Returns:
No description provided

removeFromRevQualifiedRole

public boolean removeFromRevQualifiedRole(FQualifier value)
Specified by:
removeFromRevQualifiedRole in interface FRole
Parameters:
value - No description provided
Returns:
No description provided

removeAllFromRevQualifiedRole

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

Specified by:
removeAllFromRevQualifiedRole in interface FRole

getAssoc

public UMLAssoc getAssoc()
Get the assoc attribute of the UMLRole object

Returns:
The assoc value

getFAssoc

public FAssoc getFAssoc()
Get the fAssoc attribute of the UMLRole object

Specified by:
getFAssoc in interface FRole
Returns:
The fAssoc value

getPartnerRole

public UMLRole getPartnerRole()
Get the partnerRole attribute of the UMLRole object

Returns:
The partnerRole value

getFPartnerRole

public FRole getFPartnerRole()
Get the fPartnerRole attribute of the UMLRole object

Specified by:
getFPartnerRole in interface FRole
Returns:
The fPartnerRole value

getAttrName

public java.lang.String getAttrName()
Returns an attribute name which represents this role. If this role has already a name, this name will be returned. If this role does not have a name but has a target class, a default name will be created. If this role does not have a name and no target class, the return value is null.

Specified by:
getAttrName in interface FRole
Returns:
The attribute name as a string.

getSortedComparator

public java.lang.String getSortedComparator()
Get the sortedComparator attribute of the UMLAssoc object

Specified by:
getSortedComparator in interface FRole
Returns:
The sortedComparator value

setSortedComparator

public void setSortedComparator(java.lang.String comparator)
Sets the sortedComparator attribute of the UMLAssoc object

Parameters:
comparator - The new sortedComparator 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)

toString

public java.lang.String toString()
Returns:
short string representation of current object

setAssociatedAttribute

public boolean setAssociatedAttribute(UMLAttr value)
UMLMethod: '+ setAssociatedAttribute (value: UMLAttr): Boolean'.

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

getAssociatedAttribute

public UMLAttr getAssociatedAttribute()
UMLMethod: '+ getAssociatedAttribute (): UMLAttr'.

Returns:
The associatedAttribute value

getFAssociatedAttribute

public FAttr getFAssociatedAttribute()
Get the fAssociatedAttribute attribute of the UMLRole object

Specified by:
getFAssociatedAttribute in interface FRole
Returns:
The fAssociatedAttribute value