Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.argouml.model
Class AbstractCoreHelperDecorator

java.lang.Object
  extended by org.argouml.model.AbstractCoreHelperDecorator
All Implemented Interfaces:
CoreHelper
public abstract class AbstractCoreHelperDecorator
extends java.lang.Object
implements CoreHelper

An abstract Decorator for the CoreHelper.

Constructor Summary
protected AbstractCoreHelperDecorator(CoreHelper component)
          Construct a new AbstractCoreHelperDecorator.
 
Method Summary
 void addAllStereotypes(java.lang.Object modelElement, java.util.Collection stereotypes)
          Add a collection of stereotype to a ModelElement.
 void addAnnotatedElement(java.lang.Object comment, java.lang.Object annotatedElement)
          Add an annotated element to a comment.
 void addClient(java.lang.Object handle, java.lang.Object element)
          Add a client model element to a Dependency.
 void addClientDependency(java.lang.Object handle, java.lang.Object dependency)
          Add a client Dependency to a ModelElement.
 void addComment(java.lang.Object element, java.lang.Object comment)
          Add a new comment to a ModelElement.
 void addConnection(java.lang.Object handle, int position, java.lang.Object connection)
          Add an End to a connection.
 void addConnection(java.lang.Object handle, java.lang.Object connection)
          Add an End to a connection.
 void addConstraint(java.lang.Object handle, java.lang.Object mc)
          Add a constraint to a ModelElement.
 void addDeploymentLocation(java.lang.Object handle, java.lang.Object node)
           
 void addElementResidence(java.lang.Object handle, java.lang.Object residence)
          Add an ElementResidence.
 void addFeature(java.lang.Object handle, int index, java.lang.Object f)
          Add a feature to a Classifier.
 void addFeature(java.lang.Object handle, java.lang.Object f)
          Add a feature to a Classifier.
 void addLink(java.lang.Object handle, java.lang.Object link)
          Add the given Link to the given Link or Association.
 void addLiteral(java.lang.Object handle, int index, java.lang.Object literal)
          Add an EnumerationLiteral to an Enumeration at the specified position.
 void addMethod(java.lang.Object handle, java.lang.Object m)
          Add a method to an Operation and copy the values of the Operation's visibility and scope attributes to the Method.
 void addOwnedElement(java.lang.Object handle, java.lang.Object me)
          Add a ModelElement to a Namespace.
 void addParameter(java.lang.Object handle, int index, java.lang.Object parameter)
          Add a Parameter to the given object at given location.
 void addParameter(java.lang.Object handle, java.lang.Object parameter)
          Add a Parameter to the given object.
 void addQualifier(java.lang.Object handle, int index, java.lang.Object qualifier)
           
 void addRaisedSignal(java.lang.Object handle, java.lang.Object sig)
          Add a raised Signal to a Message or Operation.
 void addSourceFlow(java.lang.Object handle, java.lang.Object flow)
          Add a source flow to a ModelElement.
 void addStereotype(java.lang.Object modelElement, java.lang.Object stereotype)
          Add a stereotype to a ModelElement.
 void addSupplier(java.lang.Object handle, java.lang.Object element)
          Add a supplier to a Dependency.
 void addSupplierDependency(java.lang.Object supplier, java.lang.Object dependency)
          Add a supplier dependency to a ModelElement.
 void addTaggedValue(java.lang.Object handle, java.lang.Object taggedValue)
          Deprecated. 
 void addTargetFlow(java.lang.Object handle, java.lang.Object flow)
          Add a target flow to a ModelElement.
 void addTemplateArgument(java.lang.Object handle, int index, java.lang.Object argument)
          Add a TemplateArgument to the given object at given location.
 void addTemplateArgument(java.lang.Object handle, java.lang.Object argument)
          Add a TemplateArgument to the given object.
 void addTemplateParameter(java.lang.Object handle, int index, java.lang.Object parameter)
          Add a TemplateParameter to the given object at given location.
 void addTemplateParameter(java.lang.Object handle, java.lang.Object parameter)
          Add a TemplateTParameter to the given object.
 void clearStereotypes(java.lang.Object modelElement)
          Remove all stereotypes from a given ModelElement.
 boolean equalsAggregationKind(java.lang.Object associationEnd, java.lang.String kindType)
           
 java.util.Collection getAllAttributes(java.lang.Object clazz)
          Return all Attributes of a Classifier and of its parents.
 java.util.Collection getAllBehavioralFeatures(java.lang.Object element)
          Return all behavioralfeatures found in this element and its children.
 java.util.Collection getAllClasses(java.lang.Object ns)
          Return all classes found in this namespace and in its children.
 java.util.Collection getAllClassifiers(java.lang.Object namespace)
          Return all classifiers found in this namespace and in its children.
 java.util.Collection getAllComponents(java.lang.Object ns)
          Return all components found in this namespace and in its children.
 java.util.Collection getAllContents(java.lang.Object clazz)
          Deprecated. 
 java.util.Collection getAllDataTypes(java.lang.Object ns)
          Return all components found in this namespace and in its children.
 java.util.Collection getAllInterfaces(java.lang.Object ns)
          Return all interfaces found in this namespace and in its children.
 java.util.Collection getAllMetaDatatypeNames()
          Returns names of all metamodel value elements including datatypes, enumerations, and primitive types.
 java.util.Collection getAllMetatypeNames()
          Returns names of all metatypes in metamodel.
 java.util.Collection getAllNodes(java.lang.Object ns)
          Return all components found in this namespace and in its children.
 java.util.Collection getAllPossibleNamespaces(java.lang.Object modelElement, java.lang.Object model)
          Return all possible namespaces that are valid owners of the given ModelElement as determined by the method isValidNamespace.
 java.util.Collection getAllRealizedInterfaces(java.lang.Object o)
          Return all interfaces that are realized by the given class or by its superclasses.
 java.util.Collection getAllSupertypes(java.lang.Object cls1)
          Return all elements of which this GeneralizableElement is a direct or indirect subtype.
 java.util.Collection getAllVisibleElements(java.lang.Object ns)
          Return a Set containing all ModelElements visible outside of the Namespace.
 java.util.Collection getAssociatedClassifiers(java.lang.Object classifier)
          Gets all classifiers that are associated to the given classifier (have an association relationship with the classifier).
 java.util.Collection getAssociateEnds(java.lang.Object classifier)
          Deprecated. 
 java.util.Collection getAssociateEndsInh(java.lang.Object classifier1)
          Return all AssociationEnds of a given Classifier plus all AssociationEnds of all of the Classifier's supertypes.
 java.lang.Object getAssociationEnd(java.lang.Object type, java.lang.Object assoc)
          Returns the associationend between a classifier and an associaton.
 java.util.Collection getAssociations(java.lang.Object classifier)
          Return all associations for a Classifier.
 java.util.Collection getAssociations(java.lang.Object from, java.lang.Object to)
          Gets the associations between the classifiers from and to.
 java.util.Collection getAttributesInh(java.lang.Object classifier)
          Return all attributes of a given Classifier, including inherited.
 java.util.List getBehavioralFeatures(java.lang.Object clazz)
          Return all behavioral features of a Classifier.
 java.lang.String getBody(java.lang.Object comment)
          Gets the body of a comment.
 java.util.Collection getChildren(java.lang.Object o)
          Return all children of a given GeneralizableElement on all levels (the complete subtree excluding the GeneralizableElement itself).
protected  CoreHelper getComponent()
          The component we are decorating.
 java.util.Collection getDependencies(java.lang.Object supplier, java.lang.Object client)
          Return the dependencies between a supplier ModelElement and a client ModelElement.
 java.lang.Object getDestination(java.lang.Object relationship)
          Returns the destination of a relation or link.
 java.util.Collection getExtendedClassifiers(java.lang.Object clazz)
          Return all classes that the given GeneralizableElement extends.
 java.util.Collection getExtendingClassifiers(java.lang.Object clazz)
          Return all classifiers that extend a Classifier.
 java.util.Collection getExtendingElements(java.lang.Object clazz)
          Return all elements that extend a Class.
 java.lang.Object getFirstSharedNamespace(java.lang.Object ns1, java.lang.Object ns2)
          Return the first namespace which two namespaces share.
 java.util.Collection getFlows(java.lang.Object source, java.lang.Object target)
          Return all flows connecting from a source ModelElement to a target ModelElement.
 java.lang.Object getGeneralization(java.lang.Object child, java.lang.Object parent)
          Gets the generalization between two GeneralizableElements.
 java.util.Collection getOperationsInh(java.lang.Object classifier)
          Return all operations of a given Classifier, including inherited.
 java.lang.Object getPackageImport(java.lang.Object supplier, java.lang.Object client)
          Return the packageImport (Permission with <<import>> or <<access>> stereotype in UML 1.4) between a supplier Package and a client Namespace, if any.
 java.util.Collection getPackageImports(java.lang.Object client)
          Return all packageImports (Permissions with <<import>> or <<access>> stereotype in UML 1.4) that this Namespace is a client of.
 java.util.Collection getParents(java.lang.Object generalizableElement)
          Return the collection of all direct parents.
 java.util.Collection getRealizedInterfaces(java.lang.Object cls)
          Return all interfaces the given class realizes.
 java.util.Collection getRelationships(java.lang.Object source, java.lang.Object dest)
          Return all relationships between the source and destination ModelElement and vice versa.
 java.util.List getReturnParameters(java.lang.Object operation)
          Return all return parameters for an Operation.
 java.lang.Object getSource(java.lang.Object relationship)
          Return the source of a relation or Link.
 java.lang.Object getSpecification(java.lang.Object object)
          Return the Operation which is the specification for a Method.
 java.util.Collection getSpecifications(java.lang.Object classifier)
          Deprecated. 
 java.util.Collection getSubtypes(java.lang.Object cls)
          Return all Classifiers of which this class is a direct supertype.
 java.util.Collection getSupertypes(java.lang.Object generalizableElement)
          Return the immediate supertypes of a GeneralizableElement.
 boolean hasCompositeEnd(java.lang.Object association)
          Determine whether an Association has at least one AssociationEnd of AggregationKind Composite.
 boolean isSubType(java.lang.Object type, java.lang.Object subType)
          Determine if a meta type is a subtype of another.
 boolean isValidNamespace(java.lang.Object mObj, java.lang.Object nsObj)
          Return true if the given ModelElement may be owned by the given namespace.
 void removeAnnotatedElement(java.lang.Object handle, java.lang.Object me)
          Remove the given ModelElement from a given comment.
 void removeClientDependency(java.lang.Object handle, java.lang.Object dep)
          Remove a dependency from a ModelElement.
 void removeConnection(java.lang.Object handle, java.lang.Object connection)
          Remove a connection between an Association & AssociationEnd or between a Link & LinkEnd.
 void removeConstraint(java.lang.Object handle, java.lang.Object cons)
          Remove the given constraint from a given ModelElement.
 void removeDeploymentLocation(java.lang.Object handle, java.lang.Object node)
          Remove a deployment location.
 void removeElementResidence(java.lang.Object handle, java.lang.Object residence)
          Remove an ElementResidence.
 void removeFeature(java.lang.Object cls, java.lang.Object feature)
          Remove a Feature from a Classifier.
 void removeLiteral(java.lang.Object enu, java.lang.Object literal)
          Remove an EnumerationLiteral from an Enumeration.
 void removeOwnedElement(java.lang.Object handle, java.lang.Object value)
          Remove an owned model element from a namespace.
 void removeParameter(java.lang.Object handle, java.lang.Object parameter)
          Remove a Parameter from an Operation.
 void removeQualifier(java.lang.Object handle, java.lang.Object parameter)
          Remove a Qualifier from a AssociationEnd.
 void removeSourceFlow(java.lang.Object handle, java.lang.Object flow)
          Remove a source flow from a ModelElement.
 void removeStereotype(java.lang.Object modelElement, java.lang.Object stereotype)
          Remove a stereotype from a ModelElement.
 void removeSupplierDependency(java.lang.Object supplier, java.lang.Object dependency)
          Add a supplier dependency to a ModelElement.
 void removeTargetFlow(java.lang.Object handle, java.lang.Object flow)
          Add a target flow to a ModelElement.
 void removeTemplateArgument(java.lang.Object handle, java.lang.Object argument)
          Remove a TemplateArgument from a Binding.
 void removeTemplateParameter(java.lang.Object handle, java.lang.Object parameter)
          Remove a TemplateParameter from a ModelElement.
 void setAbstract(java.lang.Object handle, boolean flag)
          Set the isAbstract attribute of a GeneralizableElement.
 void setActive(java.lang.Object handle, boolean active)
          Set the isActive attribute of a UML Class.
 void setAggregation(java.lang.Object handle, java.lang.Object aggregationKind)
          Set the aggregation attribute of an AssociationEnd.
 void setAnnotatedElements(java.lang.Object handle, java.util.Collection elems)
          Set the list of annotated elements for the given comment.
 void setAssociation(java.lang.Object handle, java.lang.Object association)
          Set the association of a ModelElement.
 void setAttributes(java.lang.Object classifier, java.util.List attributes)
          Replace all attributes of the given classifier by the given collection of attributes.
 void setBody(java.lang.Object handle, java.lang.Object expr)
          Sets a body of a given Method or Constraint.
 void setBody(java.lang.Object handle, java.lang.String body)
          Set the body of a comment.
 void setChangeability(java.lang.Object handle, java.lang.Object ck)
          Deprecated. 
 void setChangeable(java.lang.Object handle, boolean flag)
          Deprecated. 
 void setChild(java.lang.Object handle, java.lang.Object child)
          Set the child for a generalization.
 void setConcurrency(java.lang.Object handle, java.lang.Object concurrencyKind)
          Set the concurrency of an Operation.
 void setConnections(java.lang.Object handle, java.util.Collection elems)
          Sets the list of connections of the given association or link.
 void setContainer(java.lang.Object handle, java.lang.Object component)
          Set the Container of the given ElementResidence to the given Component.
 void setDefaultElement(java.lang.Object handle, java.lang.Object element)
          Sets the default ModelEelement of a TemplateParameter.
 void setDefaultValue(java.lang.Object handle, java.lang.Object expr)
          Set the defaultValue of a Parameter.
 void setDiscriminator(java.lang.Object handle, java.lang.String discriminator)
          Set the discriminator of a Generalization.
 void setEnumerationLiterals(java.lang.Object enumeration, java.util.List literals)
          Set the (ordered) list of literals of an Enumeration.
 void setFeature(java.lang.Object elem, int i, java.lang.Object feature)
          Set the Feature of a Classifier at the given position.
 void setFeatures(java.lang.Object handle, java.util.Collection features)
          Sets the features of a Classifier.
 void setInitialValue(java.lang.Object at, java.lang.Object expr)
          Set the initialValue of an Attribute.
 void setKind(java.lang.Object handle, java.lang.Object kind)
          Set the kind of a Parameter or the Pseudostate.
 void setLeaf(java.lang.Object handle, boolean flag)
          Set the isLeaf attribute of a GeneralizableElement.
 void setModelElementContainer(java.lang.Object handle, java.lang.Object container)
          Set the container that owns the handle.
 void setMultiplicity(java.lang.Object handle, java.lang.Object arg)
          Set the multiplicity of a ModelElement.
 void setName(java.lang.Object handle, java.lang.String name)
          Set the name of a ModelElement.
 void setNamespace(java.lang.Object handle, java.lang.Object ns)
          Set the namespace of a ModelElement.
 void setNavigable(java.lang.Object handle, boolean flag)
          Set the navigability of an AssociationEnd.
 void setOperations(java.lang.Object classifier, java.util.List operations)
          Replace all operations of the given classifier by the given list of operations.
 void setOrdering(java.lang.Object handle, java.lang.Object ok)
          Set the OrderingKind of a given AssociationEnd.
 void setOwner(java.lang.Object handle, java.lang.Object owner)
          Set the owner of a Feature or a TagDefinition.
 void setOwnerScope(java.lang.Object handle, java.lang.Object os)
          Deprecated. 
 void setParameter(java.lang.Object handle, java.lang.Object parameter)
          Set the parameter of a TemplateParameter.
 void setParameters(java.lang.Object handle, java.util.Collection parameters)
          Set the parameters of a classifier, event, objectflowstate or behavioralfeature.
 void setParent(java.lang.Object handle, java.lang.Object parent)
          Set the parent of a generalization.
 void setPowertype(java.lang.Object handle, java.lang.Object pt)
          Set the powerType of a Generalization.
 void setQualifiers(java.lang.Object handle, java.util.List elems)
          Set the qualifier attributes of an AssociationEnd.
 void setQuery(java.lang.Object handle, boolean flag)
          Sets the isQuery attribute of a BehavioralFeature.
 void setRaisedSignals(java.lang.Object handle, java.util.Collection raisedSignals)
          Set the raised signals of a BehavioralFeature.
 void setReadOnly(java.lang.Object handle, boolean isReadOnly)
          Set the isReadOnly (UML 2.x) or changeable (UML 1.x) attribute of a StructuralFeature or AssociationEnd.
 void setResident(java.lang.Object handle, java.lang.Object resident)
          Sets the ModelElement of a ElementResidence.
 void setResidents(java.lang.Object handle, java.util.Collection residents)
          Sets the residents of a NodeInstance or ComponentInstance.
 void setRoot(java.lang.Object handle, boolean flag)
          Set the isRoot attribute of a GeneralizableElement.
 void setSources(java.lang.Object handle, java.util.Collection specifications)
           
 void setSpecification(java.lang.Object handle, boolean specification)
          Set the isSpecification attribute for the ElementOwnership of a ModelElement.
 void setSpecifications(java.lang.Object handle, java.util.Collection specifications)
          Set the specifications of an AssociationEnd.
 void setStatic(java.lang.Object handle, boolean isStatic)
          Set the isStatic (UML 2.x) or ownerScope (UML 1.x) attribute of a Feature.
 void setTaggedValue(java.lang.Object handle, java.lang.String tag, java.lang.String value)
          Deprecated. 
 void setTaggedValues(java.lang.Object handle, java.util.Collection taggedValues)
          Deprecated. 
 void setTargetScope(java.lang.Object handle, java.lang.Object scopeKind)
          Deprecated. 
 void setType(java.lang.Object handle, java.lang.Object type)
          Set the type of a ModelElement.
 void setVisibility(java.lang.Object handle, java.lang.Object visibility)
          Set the visibility of a ModelElement, ElementResidence, ElementImport.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.argouml.model.CoreHelper
setSpecification, setSpecification
 

Constructor Detail

AbstractCoreHelperDecorator

protected AbstractCoreHelperDecorator(CoreHelper component)
Construct a new AbstractCoreHelperDecorator.

Parameters:
component - The component to decorate.
Method Detail

getComponent

protected CoreHelper getComponent()
The component we are decorating.

Returns:
Returns the component.

clearStereotypes

public void clearStereotypes(java.lang.Object modelElement)
Description copied from interface: CoreHelper
Remove all stereotypes from a given ModelElement.

Specified by:
clearStereotypes in interface CoreHelper
Parameters:
modelElement - model element

isSubType

public boolean isSubType(java.lang.Object type,
                         java.lang.Object subType)
Description copied from interface: CoreHelper
Determine if a meta type is a subtype of another.

Specified by:
isSubType in interface CoreHelper
Parameters:
type - The parent metatype.
subType - The metatype to test for being a subtype.
Returns:
true is subType is a sub-type of type.

getAllSupertypes

public java.util.Collection getAllSupertypes(java.lang.Object cls1)
Description copied from interface: CoreHelper
Return all elements of which this GeneralizableElement is a direct or indirect subtype.

Note: This follows the Generalizations in UML, so the results do not include Interfaces which are connected to Classes by Realizations.

Specified by:
getAllSupertypes in interface CoreHelper
Parameters:
cls1 - the GeneralizableElement you want to have the parents for
Returns:
a collection of the parents, each of which is a GeneralizableElement.

getSupertypes

public java.util.Collection getSupertypes(java.lang.Object generalizableElement)
Description copied from interface: CoreHelper
Return the immediate supertypes of a GeneralizableElement.

Specified by:
getSupertypes in interface CoreHelper
Parameters:
generalizableElement - the element you want to have the parents for
Returns:
a collection of the parents, each of which is a GeneralizableElement.

getAssociateEnds

@Deprecated
public java.util.Collection getAssociateEnds(java.lang.Object classifier)
Deprecated. 

Description copied from interface: CoreHelper
Return all AssociationEnds of a given Classifier. Same as Facade.getAssociationEnds(Object).

Specified by:
getAssociateEnds in interface CoreHelper
Parameters:
classifier - the classifier for which to get the association ends
Returns:
a collection of the associationends
See Also:
Facade.getAssociationEnds(Object)

getAssociateEndsInh

public java.util.Collection getAssociateEndsInh(java.lang.Object classifier1)
Description copied from interface: CoreHelper
Return all AssociationEnds of a given Classifier plus all AssociationEnds of all of the Classifier's supertypes.

Note: Until 0.24 this was documented as returning the opposite ends, but the implementation has returned the near ends since at least beginning of the MDR implementation (0.18).

Specified by:
getAssociateEndsInh in interface CoreHelper
Parameters:
classifier1 - the classifier for which to get the association ends
Returns:
a collection of the AssociationEnds

removeFeature

public void removeFeature(java.lang.Object cls,
                          java.lang.Object feature)
Description copied from interface: CoreHelper
Remove a Feature from a Classifier.

Specified by:
removeFeature in interface CoreHelper
Parameters:
cls - the classifier
feature - the feature to be removed

removeLiteral

public void removeLiteral(java.lang.Object enu,
                          java.lang.Object literal)
Description copied from interface: CoreHelper
Remove an EnumerationLiteral from an Enumeration.

Specified by:
removeLiteral in interface CoreHelper
Parameters:
enu - the enumeration
literal - the literal to be removed

setOperations

public void setOperations(java.lang.Object classifier,
                          java.util.List operations)
Description copied from interface: CoreHelper
Replace all operations of the given classifier by the given list of operations.

Specified by:
setOperations in interface CoreHelper
Parameters:
classifier - the given classifier
operations - the new operations

setAttributes

public void setAttributes(java.lang.Object classifier,
                          java.util.List attributes)
Description copied from interface: CoreHelper
Replace all attributes of the given classifier by the given collection of attributes.

Specified by:
setAttributes in interface CoreHelper
Parameters:
classifier - the classifier
attributes - an ordered list of new attributes

getAttributesInh

public java.util.Collection getAttributesInh(java.lang.Object classifier)
Description copied from interface: CoreHelper
Return all attributes of a given Classifier, including inherited.

Specified by:
getAttributesInh in interface CoreHelper
Parameters:
classifier - the classifier you want to have the attributes for
Returns:
a collection of the attributes

getOperationsInh

public java.util.Collection getOperationsInh(java.lang.Object classifier)
Description copied from interface: CoreHelper
Return all operations of a given Classifier, including inherited.

Specified by:
getOperationsInh in interface CoreHelper
Parameters:
classifier - the classifier you want to have the operations for
Returns:
a collection of the operations

getParents

public java.util.Collection getParents(java.lang.Object generalizableElement)
Description copied from interface: CoreHelper
Return the collection of all direct parents.

This function is additional operation number 1 for a GeneralizableElement from the UML1.4 standard.

Specified by:
getParents in interface CoreHelper
Parameters:
generalizableElement - the given element
Returns:
a collection of GeneralizableElement

getReturnParameters

public java.util.List getReturnParameters(java.lang.Object operation)
Description copied from interface: CoreHelper
Return all return parameters for an Operation.

Specified by:
getReturnParameters in interface CoreHelper
Parameters:
operation - is the operation.
Returns:
List of parameters of with direction kind of Return.

getSpecification

public java.lang.Object getSpecification(java.lang.Object object)
Description copied from interface: CoreHelper
Return the Operation which is the specification for a Method.

There is also a method in the Facade interface with the same name which may be what you want if you are looking for the specification of something other than a Method.

Specified by:
getSpecification in interface CoreHelper
Parameters:
object - the method you want the realized operation of.
Returns:
an operation, or null.
See Also:
Facade.getSpecification(Object)

getSpecifications

@Deprecated
public java.util.Collection getSpecifications(java.lang.Object classifier)
Deprecated. 

Description copied from interface: CoreHelper
Return all Interfaces of which this class is a realization.

Specified by:
getSpecifications in interface CoreHelper
Parameters:
classifier - the class you want to have the interfaces for
Returns:
a collection of the Interfaces

getSubtypes

public java.util.Collection getSubtypes(java.lang.Object cls)
Description copied from interface: CoreHelper
Return all Classifiers of which this class is a direct supertype.

Specified by:
getSubtypes in interface CoreHelper
Parameters:
cls - the class you want to have the children for
Returns:
a collection of the children, each of which is a GeneralizableElement.

getAllBehavioralFeatures

public java.util.Collection getAllBehavioralFeatures(java.lang.Object element)
Description copied from interface: CoreHelper
Return all behavioralfeatures found in this element and its children.

Specified by:
getAllBehavioralFeatures in interface CoreHelper
Parameters:
element - is the element
Returns:
Collection

getBehavioralFeatures

public java.util.List getBehavioralFeatures(java.lang.Object clazz)
Description copied from interface: CoreHelper
Return all behavioral features of a Classifier.

Specified by:
getBehavioralFeatures in interface CoreHelper
Parameters:
clazz - The classifier
Returns:
the list with all behavioral features of the classifier

getAllInterfaces

public java.util.Collection getAllInterfaces(java.lang.Object ns)
Description copied from interface: CoreHelper
Return all interfaces found in this namespace and in its children.

Specified by:
getAllInterfaces in interface CoreHelper
Parameters:
ns - the given namespace
Returns:
Collection with all interfaces found

getAllClasses

public java.util.Collection getAllClasses(java.lang.Object ns)
Description copied from interface: CoreHelper
Return all classes found in this namespace and in its children.

Specified by:
getAllClasses in interface CoreHelper
Parameters:
ns - is the namespace.
Returns:
Collection

getRealizedInterfaces

public java.util.Collection getRealizedInterfaces(java.lang.Object cls)
Description copied from interface: CoreHelper
Return all interfaces the given class realizes.

Specified by:
getRealizedInterfaces in interface CoreHelper
Parameters:
cls - the classifier
Returns:
Collection

getExtendedClassifiers

public java.util.Collection getExtendedClassifiers(java.lang.Object clazz)
Description copied from interface: CoreHelper
Return all classes that the given GeneralizableElement extends.

Specified by:
getExtendedClassifiers in interface CoreHelper
Parameters:
clazz - is the GeneralizableElement
Returns:
Collection

getGeneralization

public java.lang.Object getGeneralization(java.lang.Object child,
                                          java.lang.Object parent)
Description copied from interface: CoreHelper
Gets the generalization between two GeneralizableElements. Returns null if there is none.

Specified by:
getGeneralization in interface CoreHelper
Parameters:
child - is the child GeneralizableElement.
parent - is the parent GeneralizableElement.
Returns:
Generalization

getBody

public java.lang.String getBody(java.lang.Object comment)
Description copied from interface: CoreHelper
Gets the body of a comment.

Specified by:
getBody in interface CoreHelper
Parameters:
comment - the comment
Returns:
the body of the comment

getFlows

public java.util.Collection getFlows(java.lang.Object source,
                                     java.lang.Object target)
Description copied from interface: CoreHelper
Return all flows connecting from a source ModelElement to a target ModelElement.

Specified by:
getFlows in interface CoreHelper
Parameters:
source - is the source model element.
target - is the target model element.
Returns:
Collection

getExtendingElements

public java.util.Collection getExtendingElements(java.lang.Object clazz)
Description copied from interface: CoreHelper
Return all elements that extend a Class.

Specified by:
getExtendingElements in interface CoreHelper
Parameters:
clazz - is the class (a GeneralizableElement)
Returns:
Collection

getExtendingClassifiers

public java.util.Collection getExtendingClassifiers(java.lang.Object clazz)
Description copied from interface: CoreHelper
Return all classifiers that extend a Classifier.

Specified by:
getExtendingClassifiers in interface CoreHelper
Parameters:
clazz - is the classifier.
Returns:
Collection

getAllComponents

public java.util.Collection getAllComponents(java.lang.Object ns)
Description copied from interface: CoreHelper
Return all components found in this namespace and in its children.

Specified by:
getAllComponents in interface CoreHelper
Parameters:
ns - is the namespace.
Returns:
Collection

getAllDataTypes

public java.util.Collection getAllDataTypes(java.lang.Object ns)
Description copied from interface: CoreHelper
Return all components found in this namespace and in its children.

Specified by:
getAllDataTypes in interface CoreHelper
Parameters:
ns - is the namespace
Returns:
Collection

getAllNodes

public java.util.Collection getAllNodes(java.lang.Object ns)
Description copied from interface: CoreHelper
Return all components found in this namespace and in its children.

Specified by:
getAllNodes in interface CoreHelper
Parameters:
ns - is the namespace
Returns:
Collection

getAssociatedClassifiers

public java.util.Collection getAssociatedClassifiers(java.lang.Object classifier)
Description copied from interface: CoreHelper
Gets all classifiers that are associated to the given classifier (have an association relationship with the classifier).

Specified by:
getAssociatedClassifiers in interface CoreHelper
Parameters:
classifier - an Classifier
Returns:
Collection

getAssociations

public java.util.Collection getAssociations(java.lang.Object from,
                                            java.lang.Object to)
Description copied from interface: CoreHelper
Gets the associations between the classifiers from and to. Returns an empty collection if no Associations are found.

Specified by:
getAssociations in interface CoreHelper
Parameters:
from - a classifier
to - a classifier
Returns:
a Collection with Associations

getAllClassifiers

public java.util.Collection getAllClassifiers(java.lang.Object namespace)
Description copied from interface: CoreHelper
Return all classifiers found in this namespace and in its children.

Specified by:
getAllClassifiers in interface CoreHelper
Parameters:
namespace - the given namespace
Returns:
Collection the collection of all classifiers found in the namespace

getAssociations

public java.util.Collection getAssociations(java.lang.Object classifier)
Description copied from interface: CoreHelper
Return all associations for a Classifier.

Specified by:
getAssociations in interface CoreHelper
Parameters:
classifier - the given classifier
Returns:
Collection all associations for the given classifier

getAssociationEnd

public java.lang.Object getAssociationEnd(java.lang.Object type,
                                          java.lang.Object assoc)
Description copied from interface: CoreHelper
Returns the associationend between a classifier and an associaton.

Specified by:
getAssociationEnd in interface CoreHelper
Parameters:
type - is the classifier
assoc - is the association
Returns:
An AssociationEnd.

getAllContents

@Deprecated
public java.util.Collection getAllContents(java.lang.Object clazz)
Deprecated. 

Description copied from interface: CoreHelper
Returns the contents (owned elements) of this Namespace and all its parents as specified in section 2.5.3.8 of the UML 1.3 spec.

Specified by:
getAllContents in interface CoreHelper
Parameters:
clazz - is the classifier
Returns:
Collection

getAllAttributes

public java.util.Collection getAllAttributes(java.lang.Object clazz)
Description copied from interface: CoreHelper
Return all Attributes of a Classifier and of its parents.

Specified by:
getAllAttributes in interface CoreHelper
Parameters:
clazz - is the classifier
Returns:
Collection

getAllVisibleElements

public java.util.Collection getAllVisibleElements(java.lang.Object ns)
Description copied from interface: CoreHelper
Return a Set containing all ModelElements visible outside of the Namespace. This is an "Additional Operation" from the UML spec.

Specified by:
getAllVisibleElements in interface CoreHelper
Parameters:
ns - the given namespace
Returns:
the collection with ModelElements

getSource

public java.lang.Object getSource(java.lang.Object relationship)
Description copied from interface: CoreHelper
Return the source of a relation or Link. The source of a relation is defined as the ModelElement that propagates this relation. If there are more then 1 sources, only the first is returned. If there is no source, null is returned. Examples of sources include classifiers that are types to associationends, usecases that are bases to extend and include relations and so on. A source is always the start from the arrow in the fig, the destination the end.

TODO: move this method to a generic ModelHelper

Specified by:
getSource in interface CoreHelper
Parameters:
relationship - is the relation
Returns:
Object

getDestination

public java.lang.Object getDestination(java.lang.Object relationship)
Description copied from interface: CoreHelper
Returns the destination of a relation or link. The destination of a relation is defined as the ModelElement that receives this relation. If there are more then 1 destinations, only the first is returned. If there is no destination, null is returned. Examples of sources include classifiers that are types to associationends, usecases that are bases to extend and include relations and so on. In the case of an association, the destination is defined as the type of the second element in the connections list.

TODO: move this method to a generic ModelHelper

Specified by:
getDestination in interface CoreHelper
Parameters:
relationship - is the relation
Returns:
object

getDependencies

public java.util.Collection getDependencies(java.lang.Object supplier,
                                            java.lang.Object client)
Description copied from interface: CoreHelper
Return the dependencies between a supplier ModelElement and a client ModelElement. Does not return the inverse relationship (dependency 'from client to supplier').

Specified by:
getDependencies in interface CoreHelper
Parameters:
supplier - a ModelElement
client - a ModelElement
Returns:
Collection

getPackageImport

public java.lang.Object getPackageImport(java.lang.Object supplier,
                                         java.lang.Object client)
Description copied from interface: CoreHelper
Return the packageImport (Permission with <<import>> or <<access>> stereotype in UML 1.4) between a supplier Package and a client Namespace, if any.

Specified by:
getPackageImport in interface CoreHelper
Parameters:
supplier - a Package
client - a Namespace
Returns:
the import or null

getPackageImports

public java.util.Collection getPackageImports(java.lang.Object client)
Description copied from interface: CoreHelper
Return all packageImports (Permissions with <<import>> or <<access>> stereotype in UML 1.4) that this Namespace is a client of.

Specified by:
getPackageImports in interface CoreHelper
Parameters:
client - a Namespace
Returns:
Collection of imports

getRelationships

public java.util.Collection getRelationships(java.lang.Object source,
                                             java.lang.Object dest)
Description copied from interface: CoreHelper
Return all relationships between the source and destination ModelElement and vice versa.

Specified by:
getRelationships in interface CoreHelper
Parameters:
source - is the source model element
dest - is the destination model element
Returns:
Collection

isValidNamespace

public boolean isValidNamespace(java.lang.Object mObj,
                                java.lang.Object nsObj)
Description copied from interface: CoreHelper
Return true if the given ModelElement may be owned by the given namespace.

Simply returns false if the parameters are not the expected UML elements - any Object is accepted.

Specified by:
isValidNamespace in interface CoreHelper
Parameters:
mObj - a ModelElement
nsObj - a Namespace
Returns:
boolean

getFirstSharedNamespace

public java.lang.Object getFirstSharedNamespace(java.lang.Object ns1,
                                                java.lang.Object ns2)
Description copied from interface: CoreHelper
Return the first namespace which two namespaces share. That is: it returns the first namespace that owns the given namespaces themselves or an owner of the given namespaces.

Specified by:
getFirstSharedNamespace in interface CoreHelper
Parameters:
ns1 - is the first name space
ns2 - is the second name space
Returns:
The Namespace.

getAllPossibleNamespaces

public java.util.Collection getAllPossibleNamespaces(java.lang.Object modelElement,
                                                     java.lang.Object model)
Description copied from interface: CoreHelper
Return all possible namespaces that are valid owners of the given ModelElement as determined by the method isValidNamespace.

Specified by: