de.uni_paderborn.fujaba.metamodel
Interface FElement

All Superinterfaces:
java.lang.Comparable, de.uni_kassel.prop.InspectionAware, LogicUnparseInterface, de.tu_bs.coobra.ObjectChangeAware, de.upb.tools.pcs.PropertyChangeClient, de.upb.tools.pcs.PropertyChangeInterface, UniqueIdentifier
All Known Subinterfaces:
FAnnotation, FArray, FAssoc, FAttr, FBaseTypes, FCardinality, FClass, FClassDiagram, FCommentary, FConnection, FConstraint, FDeclaration, FDiagram, FDiagramItem, FElementRef, FFile, FGeneralization, FIncrement, FMethod, FModelDiagram, FPackage, FParam, FProject, FQualifier, FRole, FStereotype, FType, FTypeList, UMLType
All Known Implementing Classes:
AccessedElementRef, ASGAnnotation, ASGDiagram, ASGElement, ASGElementRef, GeneratedMethodRef, UMLArray, UMLAssoc, UMLAttr, UMLBaseTypes, UMLCardinality, UMLClass, UMLClassDiagram, UMLCommentary, UMLConnection, UMLConstraint, UMLDeclaration, UMLDiagram, UMLDiagramItem, UMLFile, UMLGeneralization, UMLIncrement, UMLMethod, UMLPackage, UMLParam, UMLProject, UMLQualifier, UMLRole, UMLStereotype, UMLTypeList

public interface FElement
extends java.lang.Comparable, UniqueIdentifier, LogicUnparseInterface, de.upb.tools.pcs.PropertyChangeClient, de.tu_bs.coobra.ObjectChangeAware, de.uni_kassel.prop.InspectionAware

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

Version:
$Revision: 1.4 $ $Date: 2005/02/14 14:28:11 $
Author:
$Author: cschneid $

Field Summary
static java.lang.String ANNOTATIONS_PROPERTY
          No comment provided by developer, please add a comment to improve documentation.
static java.lang.String DIAGRAMS_PROPERTY
          No comment provided by developer, please add a comment to improve documentation.
static java.lang.String ELEMENT_REFERENCES_PROPERTY
          No comment provided by developer, please add a comment to improve documentation.
static java.lang.String GENERATED_PROPERTY
          No comment provided by developer, please add a comment to improve documentation.
static java.lang.String NAME_PROPERTY
          No comment provided by developer, please add a comment to improve documentation.
static java.lang.String TEXT_PROPERTY
          No comment provided by developer, please add a comment to improve documentation.
 
Method Summary
 boolean addToAnnotations(java.lang.String key, FAnnotation value)
          Access method for an one to n association.
 void addToDiagrams(FDiagram diagram)
          Access method for an one to n association.
 boolean addToElementReferences(java.util.Map.Entry entry)
          Access method for an one to n association.
 boolean addToElementReferences(java.lang.String key, FElementRef value)
          Access method for an one to n association.
 boolean addToUserMessages(Message value)
          Stick a user message onto this element.
 void deleteTokens()
          Deprecated.  
 java.util.Iterator entriesOfElementReferences()
          No comment provided by developer, please add a comment to improve documentation.
 OOGenToken getFirstOOGenToken()
          Get the firstOOGenToken attribute of the ASGElement object
 FElementRef getFromFElementReferences(java.lang.String key)
          Get the fromReferences attribute of the ASGElement object
 OOGenToken getLastOOGenToken()
          Get the lastOOGenToken attribute of the ASGElement object
 java.lang.String getName()
          Get the name attribute of the ASGElement object
 FElement getParentElement()
          Query the logical parent of this element (e.g. package of a class, diagram of an object).
 java.lang.String getText()
          Get the text attribute of the ASGElement object
 boolean hasInAnnotations(FAnnotation value)
          No comment provided by developer, please add a comment to improve documentation.
 boolean hasInDiagrams(FDiagram diagram)
          No comment provided by developer, please add a comment to improve documentation.
 boolean hasInElementReferences(FElementRef value)
          No comment provided by developer, please add a comment to improve documentation.
 boolean hasInElementReferences(java.lang.String key, FElementRef value)
          No comment provided by developer, please add a comment to improve documentation.
 boolean hasKeyInElementReferences(java.lang.String key)
          No comment provided by developer, please add a comment to improve documentation.
 boolean isCoobraPersistent()
          Deprecated.  
 boolean isGenerated()
          Get the generated attribute of the BasicIncrement object
 java.util.Iterator iteratorOfAnnotations()
          No comment provided by developer, please add a comment to improve documentation.
 java.util.Iterator iteratorOfDiagrams()
          No comment provided by developer, please add a comment to improve documentation.
 java.util.Iterator iteratorOfElementReferences()
          No comment provided by developer, please add a comment to improve documentation.
 java.util.Iterator iteratorOfUserMessages()
          Iterate through all user messages this element if context of.
 java.util.Iterator keysOfElementReferences()
          No comment provided by developer, please add a comment to improve documentation.
 void removeAllFromAnnotations()
          No comment provided by developer, please add a comment to improve documentation.
 void removeAllFromDiagrams()
          No comment provided by developer, please add a comment to improve documentation.
 void removeAllFromElementReferences()
          No comment provided by developer, please add a comment to improve documentation.
 void removeAllFromUserMessages()
          remove this element from all message contexts.
 boolean removeFromAnnotations(java.lang.String key, FAnnotation value)
          No comment provided by developer, please add a comment to improve documentation.
 void removeFromDiagrams(FDiagram diagram)
          No comment provided by developer, please add a comment to improve documentation.
 boolean removeFromElementReferences(FElementRef value)
          No comment provided by developer, please add a comment to improve documentation.
 boolean removeFromElementReferences(java.lang.String key, FElementRef value)
          No comment provided by developer, please add a comment to improve documentation.
 boolean removeFromUserMessages(Message value)
          Remove this element from the context of the message.
 boolean removeKeyFromElementReferences(java.lang.String key)
          No comment provided by developer, please add a comment to improve documentation.
 void removeYou()
          No comment provided by developer, please add a comment to improve documentation.
 void setCutCopyPasteParent(FElement parent)
          Deprecated.  
 boolean setFirstOOGenToken(OOGenToken value)
          Sets the firstOOGenToken attribute of the ASGElement object
 void setGenerated(boolean value)
          Sets the generated attribute of the BasicIncrement object
 boolean setLastOOGenToken(OOGenToken value)
          Sets the lastOOGenToken attribute of the ASGElement object
 void setName(java.lang.String newName)
          Sets the name attribute of the ASGElement object
 int sizeOfAnnotations()
          No comment provided by developer, please add a comment to improve documentation.
 int sizeOfDiagrams()
          No comment provided by developer, please add a comment to improve documentation.
 int sizeOfElementReferences()
          No comment provided by developer, please add a comment to improve documentation.
 int 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

NAME_PROPERTY

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

See Also:
Constant Field Values

GENERATED_PROPERTY

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

See Also:
Constant Field Values

TEXT_PROPERTY

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

See Also:
Constant Field Values

DIAGRAMS_PROPERTY

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

See Also:
Constant Field Values

ELEMENT_REFERENCES_PROPERTY

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

See Also:
Constant Field Values

ANNOTATIONS_PROPERTY

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

See Also:
Constant Field Values
Method Detail

getName

public java.lang.String getName()
Get the name attribute of the ASGElement object

Returns:
The name value

setName

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

Parameters:
newName - The new name value

setGenerated

public void setGenerated(boolean value)
Sets the generated attribute of the BasicIncrement object

Parameters:
value - The new generated value

isGenerated

public boolean isGenerated()
Get the generated attribute of the BasicIncrement object

Returns:
The generated value

getText

public java.lang.String getText()
Get the text attribute of the ASGElement object

Returns:
The text value

sizeOfDiagrams

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

Returns:
No description provided

hasInDiagrams

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

Parameters:
diagram - No description provided
Returns:
No description provided

iteratorOfDiagrams

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

Returns:
No description provided

addToDiagrams

public void addToDiagrams(FDiagram diagram)
Access method for an one to n association.

Parameters:
diagram - The object added.

removeFromDiagrams

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

Parameters:
diagram - No description provided

removeAllFromDiagrams

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


hasInElementReferences

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

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

hasInElementReferences

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

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

hasKeyInElementReferences

public boolean hasKeyInElementReferences(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

iteratorOfElementReferences

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

Returns:
No description provided

keysOfElementReferences

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

Returns:
No description provided

entriesOfElementReferences

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

Returns:
No description provided

sizeOfElementReferences

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

Returns:
No description provided

getFromFElementReferences

public FElementRef getFromFElementReferences(java.lang.String key)
Get the fromReferences attribute of the ASGElement object

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

addToElementReferences

public boolean addToElementReferences(java.lang.String key,
                                      FElementRef value)
Access method for an one to n association.

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

addToElementReferences

public boolean addToElementReferences(java.util.Map.Entry entry)
Access method for an one to n association.

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

removeFromElementReferences

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

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

removeFromElementReferences

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

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

removeKeyFromElementReferences

public boolean removeKeyFromElementReferences(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

removeAllFromElementReferences

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


addToAnnotations

public boolean addToAnnotations(java.lang.String key,
                                FAnnotation value)
Access method for an one to n association.

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

iteratorOfAnnotations

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

Returns:
No description provided

hasInAnnotations

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

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

sizeOfAnnotations

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

Returns:
No description provided

removeFromAnnotations

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

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

removeAllFromAnnotations

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


removeYou

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

Specified by:
removeYou in interface de.tu_bs.coobra.ObjectChangeAware

setFirstOOGenToken

public boolean setFirstOOGenToken(OOGenToken value)
Sets the firstOOGenToken attribute of the ASGElement object

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

getFirstOOGenToken

public OOGenToken getFirstOOGenToken()
Get the firstOOGenToken attribute of the ASGElement object

Returns:
The firstOOGenToken value

setLastOOGenToken

public boolean setLastOOGenToken(OOGenToken value)
Sets the lastOOGenToken attribute of the ASGElement object

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

getLastOOGenToken

public OOGenToken getLastOOGenToken()
Get the lastOOGenToken attribute of the ASGElement object

Returns:
The lastOOGenToken value

deleteTokens

public void deleteTokens()
Deprecated.  

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


setCutCopyPasteParent

public void setCutCopyPasteParent(FElement parent)
Deprecated.  

Hangs the current ASGElement into the ASG-tree. Needed for cut'n'paste.

Parameters:
parent -

isCoobraPersistent

public boolean isCoobraPersistent()
Deprecated.  

Returns:
The coobraPersistent value

addToUserMessages

public boolean addToUserMessages(Message value)
Stick a user message onto this element. This element will become part of the context of the message.

Parameters:
value - new message
Returns:
true if something was changed

iteratorOfUserMessages

public java.util.Iterator iteratorOfUserMessages()
Iterate through all user messages this element if context of.

Returns:
iterator through Messages

removeAllFromUserMessages

public void removeAllFromUserMessages()
remove this element from all message contexts.


removeFromUserMessages

public boolean removeFromUserMessages(Message value)
Remove this element from the context of the message.

Parameters:
value - which message
Returns:
true if something was changed

sizeOfUserMessages

public int sizeOfUserMessages()
Returns:
number of messages this element is context of.

getParentElement

public FElement getParentElement()
Query the logical parent of this element (e.g. package of a class, diagram of an object). This method allows to navigate in direction of the model root (project) from any element within a project.

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