de.uni_paderborn.fujaba.metamodel
Interface FRole

All Superinterfaces:
java.lang.Comparable, FElement, FIncrement, de.uni_kassel.prop.InspectionAware, LogicUnparseInterface, de.tu_bs.coobra.ObjectChangeAware, de.upb.tools.pcs.PropertyChangeClient, de.upb.tools.pcs.PropertyChangeInterface, UniqueIdentifier
All Known Implementing Classes:
UMLRole

public interface FRole
extends FIncrement

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

Version:
$Revision: 1.4 $ $Date: 2005/03/14 13:49:49 $
Author:
$Author: lowende $

Field Summary
static java.lang.String ADORNMENT_PROPERTY
          No comment provided by developer, please add a comment to improve documentation.
static int AGGREGATION
          No comment provided by developer, please add a comment to improve documentation.
static java.lang.String ASSOC_PROPERTY
          No comment provided by developer, please add a comment to improve documentation.
static java.lang.String ATTR_NAME_PROPERTY
          No comment provided by developer, please add a comment to improve documentation.
static java.lang.String CARD_PROPERTY
          No comment provided by developer, please add a comment to improve documentation.
static int COMPOSITION
          No comment provided by developer, please add a comment to improve documentation.
static int NONE
          No comment provided by developer, please add a comment to improve documentation.
static java.lang.String PARSED_PROPERTY
          No comment provided by developer, please add a comment to improve documentation.
static java.lang.String PARTNER_ROLE_PROPERTY
          No comment provided by developer, please add a comment to improve documentation.
static int QUALIFIED
          No comment provided by developer, please add a comment to improve documentation.
static java.lang.String QUALIFIER_PROPERTY
          No comment provided by developer, please add a comment to improve documentation.
static int REFERENCE
          No comment provided by developer, please add a comment to improve documentation.
static java.lang.String REV_QUALIFIED_ROLE
          No comment provided by developer, please add a comment to improve documentation.
static java.lang.String REV_ROLES_PROPERTY
          No comment provided by developer, please add a comment to improve documentation.
static java.lang.String TARGET_PROPERTY
          No comment provided by developer, please add a comment to improve documentation.
 
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
 
Method Summary
 boolean addToRevQualifiedRole(FQualifier value)
           
 int getAdornment()
          Get the adornment attribute of the UMLRole object, one of {None, Aggregation, Composition, Reference, Qualified}
 java.lang.String getAttrName()
          Returns an attribute name which represents this role.
 FAssoc getFAssoc()
          Get the assoc attribute of the UMLRole object
 FAttr getFAssociatedAttribute()
          Deprecated.  
 FCardinality getFCard()
          Get the card attribute of the UMLRole object
 FRole getFPartnerRole()
          Get the partnerRole attribute of the UMLRole object
 FQualifier getFQualifier()
          Get the qualifier attribute of the UMLRole object
 FClass getFRevRoles()
          Get the revRoles attribute of the UMLRole object
 FClass getFTarget()
          Get the target attribute of the UMLRole object
 java.lang.String getSortedComparator()
          Deprecated.  
 int getUmlVisibility()
          Deprecated.  
 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 setAdornment(int adornment)
          Sets the adornment attribute of the UMLRole object, one of {None, Aggregation, Composition, Reference, Qualified}
 void setCard(FCardinality card)
          Sets the card 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 setRevRoles(FClass target)
          Sets the revRoles attribute of the UMLRole object
 void setTarget(FClass target)
          Sets the target attribute of the UMLRole object
 void setUmlVisibility(int value)
          Deprecated.  
 int sizeOfRevQualifiedRole()
           
 
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, getParentElement, getText, hasInAnnotations, hasInDiagrams, hasInElementReferences, hasInElementReferences, hasKeyInElementReferences, isCoobraPersistent, isGenerated, iteratorOfAnnotations, iteratorOfDiagrams, iteratorOfElementReferences, iteratorOfUserMessages, keysOfElementReferences, removeAllFromAnnotations, removeAllFromDiagrams, removeAllFromElementReferences, removeAllFromUserMessages, removeFromAnnotations, removeFromDiagrams, removeFromElementReferences, removeFromElementReferences, removeFromUserMessages, removeKeyFromElementReferences, removeYou, 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
 

Field Detail

NONE

public static final int NONE
No comment provided by developer, please add a comment to improve documentation.

See Also:
Constant Field Values

AGGREGATION

public static final int AGGREGATION
No comment provided by developer, please add a comment to improve documentation.

See Also:
Constant Field Values

COMPOSITION

public static final int COMPOSITION
No comment provided by developer, please add a comment to improve documentation.

See Also:
Constant Field Values

REFERENCE

public static final int REFERENCE
No comment provided by developer, please add a comment to improve documentation.

See Also:
Constant Field Values

QUALIFIED

public static final int QUALIFIED
No comment provided by developer, please add a comment to improve documentation.

See Also:
Constant Field Values

ADORNMENT_PROPERTY

public static final java.lang.String ADORNMENT_PROPERTY
No comment provided by developer, please add a comment to improve documentation.

See Also:
Constant Field Values

PARSED_PROPERTY

public static final java.lang.String PARSED_PROPERTY
No comment provided by developer, please add a comment to improve documentation.

See Also:
Constant Field Values

TARGET_PROPERTY

public static final java.lang.String TARGET_PROPERTY
No comment provided by developer, please add a comment to improve documentation.

See Also:
Constant Field Values

REV_ROLES_PROPERTY

public static final java.lang.String REV_ROLES_PROPERTY
No comment provided by developer, please add a comment to improve documentation.

See Also:
Constant Field Values

CARD_PROPERTY

public static final java.lang.String CARD_PROPERTY
No comment provided by developer, please add a comment to improve documentation.

See Also:
Constant Field Values

QUALIFIER_PROPERTY

public static final java.lang.String QUALIFIER_PROPERTY
No comment provided by developer, please add a comment to improve documentation.

See Also:
Constant Field Values

REV_QUALIFIED_ROLE

public static final java.lang.String REV_QUALIFIED_ROLE
No comment provided by developer, please add a comment to improve documentation.

See Also:
Constant Field Values

ASSOC_PROPERTY

public static final java.lang.String ASSOC_PROPERTY
No comment provided by developer, please add a comment to improve documentation.

See Also:
Constant Field Values

PARTNER_ROLE_PROPERTY

public static final java.lang.String PARTNER_ROLE_PROPERTY
No comment provided by developer, please add a comment to improve documentation.

See Also:
Constant Field Values

ATTR_NAME_PROPERTY

public static final java.lang.String ATTR_NAME_PROPERTY
No comment provided by developer, please add a comment to improve documentation.

See Also:
Constant Field Values
Method Detail

getAdornment

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

Returns:
The adornment value

setAdornment

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

Parameters:
adornment - The new adornment value

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.

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.

Returns:
true, if the role was generated from parsed source code

getFTarget

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

Returns:
The target value

setTarget

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

Parameters:
target - The new target value

setRevRoles

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

Parameters:
target - The new revRoles value

getFRevRoles

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

Returns:
The revRoles value

getFCard

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

Returns:
The card value

setCard

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

Parameters:
card - The new card value

getFQualifier

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

Returns:
The qualifier value

setQualifier

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

Parameters:
qualifier - The new qualifier value

hasInRevQualifiedRole

public boolean hasInRevQualifiedRole(FQualifier value)
Parameters:
value - No description provided
Returns:
No description provided

iteratorOfRevQualifiedRole

public java.util.Iterator iteratorOfRevQualifiedRole()
Returns:
No description provided

sizeOfRevQualifiedRole

public int sizeOfRevQualifiedRole()
Returns:
No description provided

addToRevQualifiedRole

public boolean addToRevQualifiedRole(FQualifier value)
Parameters:
value - The object added.
Returns:
No description provided

removeFromRevQualifiedRole

public boolean removeFromRevQualifiedRole(FQualifier value)
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.


getFAssoc

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

Returns:
The assoc value

getFPartnerRole

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

Returns:
The partnerRole 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.

Returns:
The attribute name as a string.

getSortedComparator

public java.lang.String getSortedComparator()
Deprecated.  

Get the sortedComparator attribute of the UMLAssoc object

Returns:
The sortedComparator value

getFAssociatedAttribute

public FAttr getFAssociatedAttribute()
Deprecated.  

UMLMethod: '+ getAssociatedAttribute (): UMLAttr'.

Returns:
The associatedAttribute value

getUmlVisibility

public int getUmlVisibility()
Deprecated.  

Get the umlVisibility attribute of the UMLRole object

Returns:
The umlVisibility value

setUmlVisibility

public void setUmlVisibility(int value)
Deprecated.  

Parameters:
value - The new umlVisibility value