Public Member Functions

de.fraunhofer.isst.axbench.axlang.api.IAXLangElement Interface Reference

Interface for every aXLang element. More...

List of all members.

Public Member Functions

void addChild (IAXLangElement newChild, Role theRole) throws AXLException
 Adds the given child.
void addElement (IAXLangElement newElement, ReferenceKind theKind, Role theRole) throws AXLException
 Adds the given element with its kind and role.
void addReference (IAXLangElement theReferencedElement, Role theRole) throws AXLException
 Adds the given reference.
void cleanAfterClone ()
 Performs cleaning steps after a clone operation.
IAXLangElement clone ()
 Makes a deep copy of the element w.r.t. the parent-children hierarchy; references are only copied if the referenced element is an ancestor of the cloned element.
int compareTo (IAXLangElement axlOther)
 Define sorting order.
void delete ()
 deletes the element from the model
boolean detachChild (IAXLangElement child, Role role)
 detaches a child of this element
boolean detachFromParent (Role role)
 detaches an element from its parent
boolean equals (Object other)
 Defines equality.
boolean equals (Object other, boolean isNamespaceDependent)
 Defines equality with special flags.
IAXLangElement getChild (String sIdentifier)
 Returns the child with the given identifier.
IAXLangElement getChild (Role theRole)
 Returns the first child with the given role.
Map< Role, Collection
< IAXLangElement > > 
getChildren ()
 Returns a map of the direct children of the element.
Collection<?extends
IAXLangElement
getChildren (Role theRole)
 Returns an ordered collection of the direct children of the element with the given role.
String getClassName ()
 Returns the class name of this element.
IAXLangElement getClone ()
 Returns the elements clone.
Map< Role, Collection
< IAXLangElement > > 
getDescendants ()
 Returns a map of the descendants (children, children's children, etc.) of the element.
Collection< IAXLangElementgetDescendants (Role theRole)
 Returns a collection of the descendants (children, children's children, etc.) of the element with the given role.
IAXLangElement getElement (ReferenceKind theKind, String sIdentifier)
 Returns the (first) element with the given role and identifier.
IAXLangElement getElement (ReferenceKind theKind, Role theRole)
 Returns the (first) element with the given kind and role.
IAXLangElement getElement (ReferenceKind theKind, List< String > lstIdentifiers)
 Returns the element described by the list of identifiers.
Map< ReferenceKind, Map< Role,
Collection< IAXLangElement > > > 
getElements ()
 Returns the elements of the element.
Map< Role, Collection
< IAXLangElement > > 
getElements (ReferenceKind theKind)
 Returns a map of the elements of the element.
Collection< IAXLangElementgetElements (ReferenceKind theKind, Role theRole)
 Returns an ordered collection of the elements of the element with the given kind and role.
MetaInformation getMetaInformation ()
 Returns the meta information.
Model getModel ()
 Returns the aXLang model.
Collection< ElementWithMessagegetNonValidElements ()
 Computes the non-valid elements beginning from and including this element to it's children, children's children etc.
IAXLangElement getOrigin ()
 Returns the elements origin.
IAXLangElement getParent ()
 Returns the parent element.
IAXLangElement getReference (Role theRole)
 Returns the (first) reference with the given role.
Map< Role, Collection
< IAXLangElement > > 
getReferences ()
 Returns a map of the references of the element.
Collection<?extends
IAXLangElement
getReferences (Role theRole)
 Returns an ordered collection of the references of the element with the given role.
Map< Role, Collection
< IAXLangElement > > 
getReferencingElements ()
 Returns all elements referencing this element with their role.
Collection< IAXLangElementgetReferencingElements (Role theRole)
 Returns all elements referencing this element with the given role.
Collection< IAXLangElementgetTheChildren ()
 Returns an ordered collection of the direct children of the element.
String getUID ()
 Returns UID for the element.
String getUnusedChildName (String thePlannedName, String theSuffix)
 Returns a new unused name for the child, usind the given name and adding suffixes as often as needed.
String getUUID ()
 Returns UUID for the element.
Collection< ValidTypegetValidElementTypes (ReferenceKind theKind)
 Returns the collection of valid element types.
int hashCode ()
 Yields a hashCode.
int hashCode (boolean isNamespaceDependent)
 Yields a hashCode with special flags.
boolean isApplicationModelElement ()
 indicates whether the element belongs to an application model
boolean isCalculated ()
boolean isNecessary (IAXLangElement axlElement)
 checks whether an element is necessary according to the cardinality of its reference kind and role
boolean isResourceModelElement ()
 indicates whether the element belongs to a resource model
boolean isValid ()
 Returns if the element is valid.
boolean removeChild (IAXLangElement oldElement, Role theRole)
 Removes the given child from this element.
boolean removeElement (IAXLangElement oldElement, ReferenceKind theKind)
 Removes the given element from this element (role will be guessed).
boolean removeElement (IAXLangElement oldElement, ReferenceKind theKind, Role theRole)
 Removes the given element from this element.
boolean removeFromElementMap (ReferenceKind referenceKind, Role role, IAXLangElement element)
 removes an element from the elements map
boolean removeReference (IAXLangElement oldElement, Role theRole)
 Removes the given reference from this element.
void replaceBy (IAXLangElement theReplacement)
 Replaces this element by the given replacement.
void setCalculated (boolean set)
 to mark a calculated element.
void setOrigin (IAXLangElement newOrigin)
 Sets the elements origin.
void setUUID (String newUUID)
 Sets UUID for the element.
void setValidElementTypes (ReferenceKind theKind, ValidType...theTypes)
 Sets the valid element types.

Detailed Description

Interface for every aXLang element.

This interface defines the methods and attributes of every aXLang element.

Parent

The parent element is the hierarchical parent of the element in the aXLang model tree.

Children

The children are the direct child elements of this element.

References

The references are the referenced elements of this element, they are no children.

Valid child and references types

The valid types are for checks when adding or checking the validity of an element.

Meta Information

Every element contains meta information about its origin.

Author:
ekleinod
cknoppek
Version:
0.9.0
Since:
0.5.0

Member Function Documentation

void de.fraunhofer.isst.axbench.axlang.api.IAXLangElement.addChild ( IAXLangElement  newChild,
Role  theRole 
) throws AXLException

Adds the given child.

Parameters:
newChild child to be added
theRole role of the child
Exceptions:
AXLException if child could not be added

Implemented in de.fraunhofer.isst.axbench.axlang.api.AbstractAXLangElement.

void de.fraunhofer.isst.axbench.axlang.api.IAXLangElement.addElement ( IAXLangElement  newElement,
ReferenceKind  theKind,
Role  theRole 
) throws AXLException

Adds the given element with its kind and role.

Parameters:
newElement element to be added
theKind kind of the element
theRole role of the element
Exceptions:
AXLException if element could not be added

Implemented in de.fraunhofer.isst.axbench.axlang.api.AbstractAXLangElement, and de.fraunhofer.isst.axbench.axlang.elements.architecturemodel.XORComponent.

void de.fraunhofer.isst.axbench.axlang.api.IAXLangElement.addReference ( IAXLangElement  theReferencedElement,
Role  theRole 
) throws AXLException

Adds the given reference.

Parameters:
theReferencedElement reference to be added
theRole role
Exceptions:
AXLException if child could not be added

Implemented in de.fraunhofer.isst.axbench.axlang.api.AbstractAXLangElement.

void de.fraunhofer.isst.axbench.axlang.api.IAXLangElement.cleanAfterClone (  ) 

Performs cleaning steps after a clone operation.

Normally, this operation does nothing, it is needed for special elements, such as de.fraunhofer.isst.axbench.axlang.elements.architecturemodel.XORComponent.

Implemented in de.fraunhofer.isst.axbench.axlang.api.AbstractAXLangElement.

IAXLangElement de.fraunhofer.isst.axbench.axlang.api.IAXLangElement.clone (  ) 

Makes a deep copy of the element w.r.t. the parent-children hierarchy; references are only copied if the referenced element is an ancestor of the cloned element.

Returns:
clone of the element

Implemented in de.fraunhofer.isst.axbench.axlang.api.AbstractAXLangElement, and de.fraunhofer.isst.axbench.axlang.utilities.ElementPath.

int de.fraunhofer.isst.axbench.axlang.api.IAXLangElement.compareTo ( IAXLangElement  axlOther  ) 
void de.fraunhofer.isst.axbench.axlang.api.IAXLangElement.delete (  ) 

deletes the element from the model

Implemented in de.fraunhofer.isst.axbench.axlang.api.AbstractAXLangElement.

boolean de.fraunhofer.isst.axbench.axlang.api.IAXLangElement.detachChild ( IAXLangElement  child,
Role  role 
)

detaches a child of this element

As opposed to "removeChild" the method detachChild does not delete the child (including its children and references). Instead, the child is retained, only the child-relation to this element is cut.

Parameters:
role the role of the child
Returns:
true if the element was child of calling element in the given role, ie. removal was successful, else false

Implemented in de.fraunhofer.isst.axbench.axlang.api.AbstractAXLangElement.

boolean de.fraunhofer.isst.axbench.axlang.api.IAXLangElement.detachFromParent ( Role  role  ) 

detaches an element from its parent

As opposed to "remove" the method detach does not delete the element (including its children and references). Instead, the element is retained, only the relation to its parent is cut.

Parameters:
role the role the element plays for its parent
Returns:
true if the element was child of parent in the given role, ie. removal was successful, else false

Implemented in de.fraunhofer.isst.axbench.axlang.api.AbstractAXLangElement.

boolean de.fraunhofer.isst.axbench.axlang.api.IAXLangElement.equals ( Object  other  ) 

Defines equality.

Elements are equal if:

  1. they are the same object (==)
  2. and
    1. their namespaces are equal
    2. their attributes are equal
      1. if the identifier is not generated, the identifiers have to be equal too
    3. their elements are equal
Parameters:
other other object
Returns:
are the objects equal?
Return values:
true objects are equal
false objects are not equal

Implemented in de.fraunhofer.isst.axbench.axlang.api.AbstractAXLangElement, de.fraunhofer.isst.axbench.axlang.utilities.ElementPath, and de.fraunhofer.isst.axbench.operations.checker.utilities.DataFlowElement.

boolean de.fraunhofer.isst.axbench.axlang.api.IAXLangElement.equals ( Object  other,
boolean  isNamespaceDependent 
)

Defines equality with special flags.

This method is needed in order to encapsulate the different equality types. Therefore this method has arguments in order to implement different equality types, the java equal method has to be overwritten only if a different equals method is needed, but most of the code can be reused.

The switches are:

  • switch on/off namespace identity

Every switch has to be considered in hashCode too.

Parameters:
other other object
isNamespaceDependent defines if the namespace has to be considered (true) or not (false)
Returns:
are the objects equal?
Return values:
true objects are equal
false objects are not equal

Implemented in de.fraunhofer.isst.axbench.axlang.api.AbstractAXLangElement.

IAXLangElement de.fraunhofer.isst.axbench.axlang.api.IAXLangElement.getChild ( String  sIdentifier  ) 

Returns the child with the given identifier.

Parameters:
sIdentifier identifier of the child
Returns:
child with the given identifier
Return values:
null no child with the identifier exists

Implemented in de.fraunhofer.isst.axbench.axlang.api.AbstractAXLangElement.

IAXLangElement de.fraunhofer.isst.axbench.axlang.api.IAXLangElement.getChild ( Role  theRole  ) 

Returns the first child with the given role.

Parameters:
theRole role of the child
Returns:
child with the given role
Return values:
null no child with the role exists

Implemented in de.fraunhofer.isst.axbench.axlang.api.AbstractAXLangElement.

Map<Role, Collection<IAXLangElement> > de.fraunhofer.isst.axbench.axlang.api.IAXLangElement.getChildren (  ) 

Returns a map of the direct children of the element.

Returns:
direct children of the element
Return values:
empty collection if there are none

Implemented in de.fraunhofer.isst.axbench.axlang.api.AbstractAXLangElement.

Collection<? extends IAXLangElement> de.fraunhofer.isst.axbench.axlang.api.IAXLangElement.getChildren ( Role  theRole  ) 

Returns an ordered collection of the direct children of the element with the given role.

Parameters:
theRole role of the children
Returns:
direct children of the element (ordered collection)
Return values:
empty collection if there are none

Implemented in de.fraunhofer.isst.axbench.axlang.api.AbstractAXLangElement.

String de.fraunhofer.isst.axbench.axlang.api.IAXLangElement.getClassName (  ) 

Returns the class name of this element.

Returns:
class name

Implemented in de.fraunhofer.isst.axbench.axlang.api.AbstractAXLangElement.

IAXLangElement de.fraunhofer.isst.axbench.axlang.api.IAXLangElement.getClone (  ) 

Returns the elements clone.

The clone is set only if the element was cloned, during the cloning process.

Returns:
clone of the element
Return values:
null if the element was not cloned, or out of cloning process

Implemented in de.fraunhofer.isst.axbench.axlang.api.AbstractAXLangElement, and de.fraunhofer.isst.axbench.axlang.elements.featuremodel.Feature.

Map<Role, Collection<IAXLangElement> > de.fraunhofer.isst.axbench.axlang.api.IAXLangElement.getDescendants (  ) 

Returns a map of the descendants (children, children's children, etc.) of the element.

Returns:
descendants of the element
Return values:
empty map if there are none

Implemented in de.fraunhofer.isst.axbench.axlang.api.AbstractAXLangElement.

Collection<IAXLangElement> de.fraunhofer.isst.axbench.axlang.api.IAXLangElement.getDescendants ( Role  theRole  ) 

Returns a collection of the descendants (children, children's children, etc.) of the element with the given role.

Parameters:
theRole role of the children
Returns:
descendants of the element with the given role
Return values:
empty collection if there are none

Implemented in de.fraunhofer.isst.axbench.axlang.api.AbstractAXLangElement.

IAXLangElement de.fraunhofer.isst.axbench.axlang.api.IAXLangElement.getElement ( ReferenceKind  theKind,
String  sIdentifier 
)

Returns the (first) element with the given role and identifier.

If two elements with the same identifier exist, the first one found will be returned.

Parameters:
theKind kind of the element
sIdentifier identifier of the element
Returns:
element with the given identifier
Return values:
null no element with the identifier exists

Implemented in de.fraunhofer.isst.axbench.axlang.api.AbstractAXLangElement.

IAXLangElement de.fraunhofer.isst.axbench.axlang.api.IAXLangElement.getElement ( ReferenceKind  theKind,
Role  theRole 
)

Returns the (first) element with the given kind and role.

If two elements with the same role exist, the first one found will be returned.

Parameters:
theKind kind of the element
theRole role of the element
Returns:
found element with the role
Return values:
null no element with this role found

Implemented in de.fraunhofer.isst.axbench.axlang.api.AbstractAXLangElement.

IAXLangElement de.fraunhofer.isst.axbench.axlang.api.IAXLangElement.getElement ( ReferenceKind  theKind,
List< String >  lstIdentifiers 
)

Returns the element described by the list of identifiers.

Parameters:
theKind kind of the element
lstIdentifiers list of identifiers of the element
Returns:
element with the given list of identifiers
Return values:
null no such element exists

Implemented in de.fraunhofer.isst.axbench.axlang.api.AbstractAXLangElement.

Map<ReferenceKind, Map<Role, Collection<IAXLangElement> > > de.fraunhofer.isst.axbench.axlang.api.IAXLangElement.getElements (  ) 

Returns the elements of the element.

Returns:
elements of the element
Return values:
empty map if there are none

Implemented in de.fraunhofer.isst.axbench.axlang.api.AbstractAXLangElement.

Map<Role, Collection<IAXLangElement> > de.fraunhofer.isst.axbench.axlang.api.IAXLangElement.getElements ( ReferenceKind  theKind  ) 

Returns a map of the elements of the element.

Parameters:
theKind kind of the element
Returns:
elements of the element
Return values:
empty map if there are none

Implemented in de.fraunhofer.isst.axbench.axlang.api.AbstractAXLangElement.

Collection<IAXLangElement> de.fraunhofer.isst.axbench.axlang.api.IAXLangElement.getElements ( ReferenceKind  theKind,
Role  theRole 
)

Returns an ordered collection of the elements of the element with the given kind and role.

Parameters:
theKind kind of the element
theRole role of the element
Returns:
direct elements of the element (ordered collection)
Return values:
empty collection if there are none

Implemented in de.fraunhofer.isst.axbench.axlang.api.AbstractAXLangElement.

MetaInformation de.fraunhofer.isst.axbench.axlang.api.IAXLangElement.getMetaInformation (  ) 
Model de.fraunhofer.isst.axbench.axlang.api.IAXLangElement.getModel (  ) 

Returns the aXLang model.

Returns:
aXLang model

Implemented in de.fraunhofer.isst.axbench.axlang.api.AbstractAXLangElement.

Collection<ElementWithMessage> de.fraunhofer.isst.axbench.axlang.api.IAXLangElement.getNonValidElements (  ) 
IAXLangElement de.fraunhofer.isst.axbench.axlang.api.IAXLangElement.getOrigin (  ) 

Returns the elements origin.

The origin is the element, from which this element was cloned, if the element was cloned.

Returns:
origin of the element
Return values:
null if the element was not cloned

Implemented in de.fraunhofer.isst.axbench.axlang.api.AbstractAXLangElement, and de.fraunhofer.isst.axbench.axlang.elements.featuremodel.Feature.

IAXLangElement de.fraunhofer.isst.axbench.axlang.api.IAXLangElement.getParent (  ) 
IAXLangElement de.fraunhofer.isst.axbench.axlang.api.IAXLangElement.getReference ( Role  theRole  ) 

Returns the (first) reference with the given role.

If two references with the same role exist, the first one found will be returned.

Parameters:
theRole role of the reference
Returns:
found reference with the role
Return values:
null no reference with this role found

Implemented in de.fraunhofer.isst.axbench.axlang.api.AbstractAXLangElement.

Map<Role, Collection<IAXLangElement> > de.fraunhofer.isst.axbench.axlang.api.IAXLangElement.getReferences (  ) 

Returns a map of the references of the element.

Returns:
references of the element
Return values:
empty map if there are none

Implemented in de.fraunhofer.isst.axbench.axlang.api.AbstractAXLangElement.

Collection<? extends IAXLangElement> de.fraunhofer.isst.axbench.axlang.api.IAXLangElement.getReferences ( Role  theRole  ) 

Returns an ordered collection of the references of the element with the given role.

Parameters:
theRole role of the references
Returns:
references of the element (ordered collection)
Return values:
empty collection if there are none

Implemented in de.fraunhofer.isst.axbench.axlang.api.AbstractAXLangElement.

Map<Role, Collection<IAXLangElement> > de.fraunhofer.isst.axbench.axlang.api.IAXLangElement.getReferencingElements (  ) 

Returns all elements referencing this element with their role.

Returns:
elements referencing this element with their role

Implemented in de.fraunhofer.isst.axbench.axlang.api.AbstractAXLangElement.

Collection<IAXLangElement> de.fraunhofer.isst.axbench.axlang.api.IAXLangElement.getReferencingElements ( Role  theRole  ) 

Returns all elements referencing this element with the given role.

Parameters:
theRole role of referencing elements
Returns:
elements referencing this element with the given role

Implemented in de.fraunhofer.isst.axbench.axlang.api.AbstractAXLangElement.

Collection<IAXLangElement> de.fraunhofer.isst.axbench.axlang.api.IAXLangElement.getTheChildren (  ) 

Returns an ordered collection of the direct children of the element.

Todo:
check if this method is needed
Returns:
direct children of the element (ordered collection)
Return values:
empty collection if there are none

Implemented in de.fraunhofer.isst.axbench.axlang.api.AbstractAXLangElement.

String de.fraunhofer.isst.axbench.axlang.api.IAXLangElement.getUID (  ) 

Returns UID for the element.

The UID is a unique id for the element, per default generated from it's identifier and it's parent's identifier.

Returns:
UID of the element.

Implemented in de.fraunhofer.isst.axbench.axlang.api.AbstractAXLangElement, and de.fraunhofer.isst.axbench.operations.checker.solver.utilities.AxlElementPath.

String de.fraunhofer.isst.axbench.axlang.api.IAXLangElement.getUnusedChildName ( String  thePlannedName,
String  theSuffix 
)

Returns a new unused name for the child, usind the given name and adding suffixes as often as needed.

Parameters:
thePlannedName planned name
theSuffix suffix
Returns:
new unused name

Implemented in de.fraunhofer.isst.axbench.axlang.api.AbstractAXLangElement.

String de.fraunhofer.isst.axbench.axlang.api.IAXLangElement.getUUID (  ) 

Returns UUID for the element.

The UID is a unique id for the element throughout it's whole life, including storing and reading operations.

Returns:
UUID of the element.

Implemented in de.fraunhofer.isst.axbench.axlang.api.AbstractAXLangElement.

Collection<ValidType> de.fraunhofer.isst.axbench.axlang.api.IAXLangElement.getValidElementTypes ( ReferenceKind  theKind  ) 

Returns the collection of valid element types.

Parameters:
theKind kind of referenced element
Returns:
valid element types
Return values:
empty collection if there are none

Implemented in de.fraunhofer.isst.axbench.axlang.api.AbstractAXLangElement.

int de.fraunhofer.isst.axbench.axlang.api.IAXLangElement.hashCode (  ) 

Yields a hashCode.

In order to be consistent with equals() the following parts of an element are used for the computation of the hashCode:

Implemented in de.fraunhofer.isst.axbench.axlang.api.AbstractAXLangElement, de.fraunhofer.isst.axbench.axlang.utilities.ElementPath, and de.fraunhofer.isst.axbench.operations.checker.utilities.DataFlowElement.

int de.fraunhofer.isst.axbench.axlang.api.IAXLangElement.hashCode ( boolean  isNamespaceDependent  ) 

Yields a hashCode with special flags.

This method is needed in order to encapsulate the different hashcode types. Therefore this method has arguments in order to implement different hashcode types, the java equal method has to be overwritten only if a different hashcode method is needed, but most of the code can be reused.

The switches are:

  • switch on/off namespace identity

Every switch has to be considered in equals too.

Parameters:
isNamespaceDependent defines if the namespace has to be considered (true) or not (false)
Returns:
hashCode

Implemented in de.fraunhofer.isst.axbench.axlang.api.AbstractAXLangElement.

boolean de.fraunhofer.isst.axbench.axlang.api.IAXLangElement.isApplicationModelElement (  ) 

indicates whether the element belongs to an application model

Returns:
true if the element belongs to an application model, else false
boolean de.fraunhofer.isst.axbench.axlang.api.IAXLangElement.isCalculated (  ) 
Returns:
Return values:
true the element is calculated, no text editor representation
true the element is not calculated, text editor representation

Implemented in de.fraunhofer.isst.axbench.axlang.api.AbstractAXLangElement.

boolean de.fraunhofer.isst.axbench.axlang.api.IAXLangElement.isNecessary ( IAXLangElement  axlElement  ) 

checks whether an element is necessary according to the cardinality of its reference kind and role

Parameters:
axlElement the element in question
Returns:
true if the minimum number of elements of this kind in this role is reached, else false

Implemented in de.fraunhofer.isst.axbench.axlang.api.AbstractAXLangElement, and de.fraunhofer.isst.axbench.axlang.elements.statements.Assignment.

boolean de.fraunhofer.isst.axbench.axlang.api.IAXLangElement.isResourceModelElement (  ) 

indicates whether the element belongs to a resource model

Returns:
true if the element belongs to a resource model, else false
boolean de.fraunhofer.isst.axbench.axlang.api.IAXLangElement.isValid (  ) 

Returns if the element is valid.

The implementation relies on getNonValidElements()

Returns:
validity of the element
Return values:
true the element is valid
false the element is not valid

Implemented in de.fraunhofer.isst.axbench.axlang.api.AbstractAXLangElement.

boolean de.fraunhofer.isst.axbench.axlang.api.IAXLangElement.removeChild ( IAXLangElement  oldElement,
Role  theRole 
)

Removes the given child from this element.

Parameters:
oldElement child to be removed
theRole role of the element
Returns:
remove success
Return values:
true child was removed, or child was null
false child was not removed, or given element was null, or given element was no child

Implemented in de.fraunhofer.isst.axbench.axlang.api.AbstractAXLangElement.

boolean de.fraunhofer.isst.axbench.axlang.api.IAXLangElement.removeElement ( IAXLangElement  oldElement,
ReferenceKind  theKind 
)

Removes the given element from this element (role will be guessed).

The first role, the element is stored under, will be taken for role.

Parameters:
oldElement element to be removed
theKind kind of the element
Returns:
remove success
Return values:
true element was removed or element was null
false element was not removed

Implemented in de.fraunhofer.isst.axbench.axlang.api.AbstractAXLangElement.

boolean de.fraunhofer.isst.axbench.axlang.api.IAXLangElement.removeElement ( IAXLangElement  oldElement,
ReferenceKind  theKind,
Role  theRole 
)

Removes the given element from this element.

Parameters:
oldElement element to be removed
theKind kind of the element
theRole role of the element
Returns:
remove success
Return values:
true element was removed or element was null
false element was not removed

Implemented in de.fraunhofer.isst.axbench.axlang.api.AbstractAXLangElement.

boolean de.fraunhofer.isst.axbench.axlang.api.IAXLangElement.removeFromElementMap ( ReferenceKind  referenceKind,
Role  role,
IAXLangElement  element 
)

removes an element from the elements map

Parameters:
referenceKind the kind in which the element is referenced (child, reference, or path)
role the role the element plays
element the element that shall be removed
Returns:
true if the element belonged in the given reference kind and role to this element, ie. removal was successful, else false

Implemented in de.fraunhofer.isst.axbench.axlang.api.AbstractAXLangElement.

boolean de.fraunhofer.isst.axbench.axlang.api.IAXLangElement.removeReference ( IAXLangElement  oldElement,
Role  theRole 
)

Removes the given reference from this element.

Parameters:
oldElement reference to be removed
theRole role of the reference
Returns:
remove success
Return values:
true reference was removed, or reference was null
false reference was not removed

Implemented in de.fraunhofer.isst.axbench.axlang.api.AbstractAXLangElement.

void de.fraunhofer.isst.axbench.axlang.api.IAXLangElement.replaceBy ( IAXLangElement  theReplacement  ) 

Replaces this element by the given replacement.

Parameters:
theReplacement replacement for this element

Implemented in de.fraunhofer.isst.axbench.axlang.api.AbstractAXLangElement.

void de.fraunhofer.isst.axbench.axlang.api.IAXLangElement.setCalculated ( boolean  set  ) 

to mark a calculated element.

Parameters:
set 
Returns:

Implemented in de.fraunhofer.isst.axbench.axlang.api.AbstractAXLangElement.

void de.fraunhofer.isst.axbench.axlang.api.IAXLangElement.setOrigin ( IAXLangElement  newOrigin  ) 

Sets the elements origin.

Usually the origin is only set within the clone method, and denotes the element from which the present element has been cloned. The setOrigin method is used by the Configurator, for instance, who creates a copy of an xor-component without using the clone method.

Parameters:
newOrigin the new origin element

Implemented in de.fraunhofer.isst.axbench.axlang.api.AbstractAXLangElement.

void de.fraunhofer.isst.axbench.axlang.api.IAXLangElement.setUUID ( String  newUUID  ) 

Sets UUID for the element.

The UID is a unique id for the element throughout it's whole life, including storing and reading operations.

Parameters:
newUUID new UUID for the element

Implemented in de.fraunhofer.isst.axbench.axlang.api.AbstractAXLangElement.

void de.fraunhofer.isst.axbench.axlang.api.IAXLangElement.setValidElementTypes ( ReferenceKind  theKind,
ValidType...  theTypes 
)

Sets the valid element types.

Parameters:
theKind kind of referenced element
theTypes valid element types

Implemented in de.fraunhofer.isst.axbench.axlang.api.AbstractAXLangElement.