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 AbstractExtensionMechanismsHelperDecorator

java.lang.Object
  extended byorg.argouml.model.AbstractExtensionMechanismsHelperDecorator
All Implemented Interfaces:
ExtensionMechanismsHelper
Direct Known Subclasses:
UndoExtensionMechanismsHelperDecorator
public abstract class AbstractExtensionMechanismsHelperDecorator
extends Object
implements ExtensionMechanismsHelper

An abstract Decorator for the ExtensionMechanismsHelper.

Method Summary
 void addBaseClass(Object handle, Object baseClass)
          Add a baseclass to some stereotype.
 void addCopyStereotype(Object modelElement, Object stereotype)
          Sets the stereotype of some modelelement.
 void addExtendedElement(Object handle, Object extendedElement)
          Add an extended element to a stereotype.
 void addTaggedValue(Object handle, Object taggedValue)
          Add a tagged value.
 Collection getAllPossibleStereotypes(Collection models, Object modelElement)
          Returns all possible stereotypes for some modelelement.
protected  ExtensionMechanismsHelper getComponent()
          The component we are decorating.
 String getMetaModelName(Object m)
           
 Object getStereotype(Collection models, Object stereo)
          Searches for a stereotype just like the given stereotype in all given models.
 Object getStereotype(Object ns, Object stereo)
          Finds a stereotype in some namespace, but not in its subnamespaces.
 Collection getStereotypes(Collection models)
          Get all stereotypes from all Models in the list.
 Collection getStereotypes(Object ns)
          Returns all stereotypes in a namespace, but not those in a subnamespace.
 boolean hasStereoType(Object handle, String name)
          Returns true if the given object has a stereotype with the given name.
 boolean isStereotype(Object object, String name, String base)
          Tests if a stereotype is a stereotype with some name and base class.
 boolean isStereotypeInh(Object object, String name, String base)
          Tests if a stereotype is or inherits from a stereotype with some name and base class.
 boolean isValidStereoType(Object theModelElement, Object theStereotype)
          Returns true if the given stereotype has a baseclass that equals the baseclass of the given modelelement or one of the superclasses of the given modelelement.
 void removeBaseClass(Object handle, Object baseClass)
          Remove baseclass from some stereotype.
 void removeTaggedValue(Object handle, Object taggedValue)
          Remove a tagged value.
 void setIcon(Object handle, Object icon)
          Set the icon for a stereotype.
 void setTag(Object handle, Object tag)
          Set the Tag of a TaggedValue.
 void setTaggedValue(Object handle, Collection taggedValues)
          Se the list of tagged values for a model element.
 void setType(Object handle, Object type)
          Set the type of a taggedvalue.
 void setValueOfTag(Object handle, String value)
          Sets a value of some taggedValue.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getComponent

protected ExtensionMechanismsHelper getComponent()
The component we are decorating.

Returns:
Returns the component.

getStereotypes

public Collection getStereotypes(Object ns)
Description copied from interface: ExtensionMechanismsHelper
Returns all stereotypes in a namespace, but not those in a subnamespace.

Specified by:
getStereotypes in interface ExtensionMechanismsHelper
Parameters:
ns - is the namespace.
Returns:
a Collection with the stereotypes.

getStereotype

public Object getStereotype(Object ns,
                            Object stereo)
Description copied from interface: ExtensionMechanismsHelper
Finds a stereotype in some namespace, but not in its subnamespaces. Returns null if no such stereotype is found. TODO: What if stereo.getName() or stereo.getBaseClass() is null? Then you know immediately that none will be found, but is that the correct answer?

Specified by:
getStereotype in interface ExtensionMechanismsHelper
Parameters:
ns - is the namespace.
stereo - is the stereotype.
Returns:
the stereotype found or null.

getStereotype

public Object getStereotype(Collection models,
                            Object stereo)
Description copied from interface: ExtensionMechanismsHelper
Searches for a stereotype just like the given stereotype in all given models. The given stereotype can not have its namespace set yet; otherwise it will be returned itself! TODO: Should it only search for stereotypes owned by the Model object?

Specified by:
getStereotype in interface ExtensionMechanismsHelper
Parameters:
models - a collection of models
stereo - is the given stereotype
Returns:
Stereotype

getMetaModelName

public String getMetaModelName(Object m)
Specified by:
getMetaModelName in interface ExtensionMechanismsHelper
Parameters:
m - the ModelElement
Returns:
the meta name of the ModelElement

getAllPossibleStereotypes

public Collection getAllPossibleStereotypes(Collection models,
                                            Object modelElement)
Description copied from interface: ExtensionMechanismsHelper
Returns all possible stereotypes for some modelelement. Possible stereotypes are those stereotypes that are owned by the same namespace the modelelement is owned by and that have a baseclass that is the same as the metamodelelement name of the modelelement.

Specified by:
getAllPossibleStereotypes in interface ExtensionMechanismsHelper
Parameters:
modelElement - is the model element
models - the models to search in
Returns:
Collection

isValidStereoType

public boolean isValidStereoType(Object theModelElement,
                                 Object theStereotype)
Description copied from interface: ExtensionMechanismsHelper
Returns true if the given stereotype has a baseclass that equals the baseclass of the given modelelement or one of the superclasses of the given modelelement.

Specified by:
isValidStereoType in interface ExtensionMechanismsHelper
Parameters:
theModelElement - is the model element
theStereotype - is the stereotype
Returns:
boolean

getStereotypes

public Collection getStereotypes(Collection models)
Description copied from interface: ExtensionMechanismsHelper
Get all stereotypes from all Models in the list. Finds only stereotypes owned by the Model objects themselves.

Specified by:
getStereotypes in interface ExtensionMechanismsHelper
Parameters:
models - the models to search
Returns:
the collection of stereotypes in all models in the current project

addCopyStereotype

public void addCopyStereotype(Object modelElement,
                              Object stereotype)
Description copied from interface: ExtensionMechanismsHelper
Sets the stereotype of some modelelement. The method also copies a stereotype that is not a part of the current model to the current model.

Specified by:
addCopyStereotype in interface ExtensionMechanismsHelper
Parameters:
modelElement - is the model element
stereotype - is the stereotype

isStereotype

public boolean isStereotype(Object object,
                            String name,
                            String base)
Description copied from interface: ExtensionMechanismsHelper
Tests if a stereotype is a stereotype with some name and base class.

Specified by:
isStereotype in interface ExtensionMechanismsHelper
Parameters:
object - is the stereotype.
name - is the name of the stereotype.
base - is the base class of the stereotype.
Returns:
true if object is a stereotype with the desired characteristics.

isStereotypeInh

public boolean isStereotypeInh(Object object,
                               String name,
                               String base)
Description copied from interface: ExtensionMechanismsHelper
Tests if a stereotype is or inherits from a stereotype with some name and base class.

Specified by:
isStereotypeInh in interface ExtensionMechanismsHelper
Parameters:
object - is the stereotype.
name - is the name of the stereotype.
base - is the base class of the stereotype.
Returns:
true if object is a (descendant of a) stereotype with the desired characteristics.

addExtendedElement

public void addExtendedElement(Object handle,
                               Object extendedElement)
Description copied from interface: ExtensionMechanismsHelper
Add an extended element to a stereotype.

Specified by:
addExtendedElement in interface ExtensionMechanismsHelper
Parameters:
handle - Stereotype
extendedElement - ExtensionPoint

addBaseClass

public void addBaseClass(Object handle,
                         Object baseClass)
Description copied from interface: ExtensionMechanismsHelper
Add a baseclass to some stereotype.

Specified by:
addBaseClass in interface ExtensionMechanismsHelper
Parameters:
handle - the stereotype
baseClass - the baseclass to add

removeBaseClass

public void removeBaseClass(Object handle,
                            Object baseClass)
Description copied from interface: ExtensionMechanismsHelper
Remove baseclass from some stereotype.

Specified by:
removeBaseClass in interface ExtensionMechanismsHelper
Parameters:
handle - the stereotype
baseClass - the baseclass to remove

setIcon

public void setIcon(Object handle,
                    Object icon)
Description copied from interface: ExtensionMechanismsHelper
Set the icon for a stereotype.

Specified by:
setIcon in interface ExtensionMechanismsHelper
Parameters:
handle - Stereotype
icon - String

setTag

public void setTag(Object handle,
                   Object tag)
Description copied from interface: ExtensionMechanismsHelper
Set the Tag of a TaggedValue.

Specified by:
setTag in interface ExtensionMechanismsHelper
Parameters:
handle - TaggedValue
tag - String

setType

public void setType(Object handle,
                    Object type)
Description copied from interface: ExtensionMechanismsHelper
Set the type of a taggedvalue.

Specified by:
setType in interface ExtensionMechanismsHelper
Parameters:
handle - the taggedValue
type - the tagDefinition

setValueOfTag

public void setValueOfTag(Object handle,
                          String value)
Description copied from interface: ExtensionMechanismsHelper
Sets a value of some taggedValue.

Specified by:
setValueOfTag in interface ExtensionMechanismsHelper
Parameters:
handle - is the tagged value
value - is the value

addTaggedValue

public void addTaggedValue(Object handle,
                           Object taggedValue)
Description copied from interface: ExtensionMechanismsHelper
Add a tagged value.

Specified by:
addTaggedValue in interface ExtensionMechanismsHelper
Parameters:
handle - The model element to add to.
taggedValue - The tagged value to add.

removeTaggedValue

public void removeTaggedValue(Object handle,
                              Object taggedValue)
Description copied from interface: ExtensionMechanismsHelper
Remove a tagged value.

Specified by:
removeTaggedValue in interface ExtensionMechanismsHelper
Parameters:
handle - The model element to remove from.
taggedValue - The tagged value to remove.

setTaggedValue

public void setTaggedValue(Object handle,
                           Collection taggedValues)
Description copied from interface: ExtensionMechanismsHelper
Se the list of tagged values for a model element.

Specified by:
setTaggedValue in interface ExtensionMechanismsHelper
Parameters:
handle - The model element to set for.
taggedValues - A Collection of tagged values.

hasStereoType

public boolean hasStereoType(Object handle,
                             String name)
Description copied from interface: ExtensionMechanismsHelper
Returns true if the given object has a stereotype with the given name.

Specified by:
hasStereoType in interface ExtensionMechanismsHelper
Parameters:
handle - the given object
name - the given name
Returns:
true if there is such a stereotype
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
ArgoUML © 1996-2006ArgoUML HomepageArgoUML Developers' pageArgoUML Cookbook