org.argouml.model
Interface ExtensionMechanismsFactory

All Superinterfaces:
Factory

public interface ExtensionMechanismsFactory
extends Factory

The interface for the factory for ExstensionMechanisms.


Method Summary
 java.lang.Object buildStereotype(java.lang.Object theModelElementObject, java.lang.Object theName, java.lang.Object theNamespaceObject)
          Build a stereotype which has the given name and a base class which matches the type of the given model element.
 java.lang.Object buildStereotype(java.lang.Object theModelElementObject, java.lang.String theName, java.lang.Object model, java.util.Collection models)
          Builds an initialized stereotype.
 java.lang.Object buildStereotype(java.lang.String text, java.lang.Object ns)
          Builds an initialized stereotype.
 java.lang.Object buildTagDefinition(java.lang.String name, java.lang.Object stereotype, java.lang.Object namespace)
          Build an initialized instance of a TagDefinition with the default tagType of "String".
 java.lang.Object buildTagDefinition(java.lang.String name, java.lang.Object stereotype, java.lang.Object namespace, java.lang.String tagType)
          Build an initialized instance of a TagDefinition.
 java.lang.Object buildTaggedValue(java.lang.Object type, java.lang.String[] values)
          Build an initialized instance of a UML TaggedValue.
 java.lang.Object buildTaggedValue(java.lang.String tag, java.lang.String value)
          Deprecated. for 0.25.5 by tfmorris. Use buildTaggedValue(Object, String[]).
 java.lang.Object copyStereotype(java.lang.Object source, java.lang.Object ns)
          Copies a stereotype.
 java.lang.Object copyTagDefinition(java.lang.Object aTd, java.lang.Object aNs)
          Copy a TagDefinition into the given namespace or stereotype.
 void copyTaggedValues(java.lang.Object source, java.lang.Object target)
          Copy tagged value collection from one model element to another.
 java.lang.Object createStereotype()
          Create an empty Stereotype element.
 java.lang.Object createTagDefinition()
          Create a TagDefinition.
 java.lang.Object createTaggedValue()
          Create an empty but initialized instance of a UML TaggedValue.
 

Method Detail

createTaggedValue

java.lang.Object createTaggedValue()
Create an empty but initialized instance of a UML TaggedValue.

Returns:
an initialized UML TaggedValue instance.

buildStereotype

java.lang.Object buildStereotype(java.lang.Object theModelElementObject,
                                 java.lang.Object theName,
                                 java.lang.Object theNamespaceObject)
Build a stereotype which has the given name and a base class which matches the type of the given model element.

NOTE: Most users will want to find and use an existing stereotype, often from a profile, so uses of this method should be rare.

Parameters:
theModelElementObject - a Model Element that the stereotype will be applied to. The stereotype will have its BaseClass set to an appropriate value for this kind of Model Elements.
theName - the name for the stereotype
theNamespaceObject - the namespace the stereotype will be created within.
Returns:
the resulting stereotype object
Throws:
java.lang.IllegalArgumentException - if either argument is null.

buildStereotype

java.lang.Object buildStereotype(java.lang.Object theModelElementObject,
                                 java.lang.String theName,
                                 java.lang.Object model,
                                 java.util.Collection models)
Builds an initialized stereotype.

Parameters:
theModelElementObject - the baseclass for the new stereotype
theName - the name for the new stereotype
model - the current model of interest
models - all the models
Returns:
the new stereotype

buildStereotype

java.lang.Object buildStereotype(java.lang.String text,
                                 java.lang.Object ns)
Builds an initialized stereotype.

Parameters:
text - is the name of the stereotype
ns - namespace where the stereotype lives (is known)
Returns:
an initialized stereotype.

buildTaggedValue

@Deprecated
java.lang.Object buildTaggedValue(java.lang.String tag,
                                             java.lang.String value)
Deprecated. for 0.25.5 by tfmorris. Use buildTaggedValue(Object, String[]).

Build an initialized instance of a UML TaggedValue.

Parameters:
tag - is the tag name (a String).
value - a String to use as the dataValue
Returns:
an initialized UML TaggedValue instance.

buildTaggedValue

java.lang.Object buildTaggedValue(java.lang.Object type,
                                  java.lang.String[] values)
Build an initialized instance of a UML TaggedValue.

Parameters:
type - TagDefinition which defines the type of the TaggedValue
values - is an array of Strings to be used as the dataValues.
Returns:
an initialized UML TaggedValue instance.

copyTaggedValues

void copyTaggedValues(java.lang.Object source,
                      java.lang.Object target)
Copy tagged value collection from one model element to another. New copies are created of the tagged values themselves and of the dataValues they contain, but not of the referenced type or reference values.

Parameters:
source - ModelElement to copy from
target - ModelElement to copy to

copyStereotype

java.lang.Object copyStereotype(java.lang.Object source,
                                java.lang.Object ns)
Copies a stereotype.

Parameters:
source - is the stereotype to copy.
ns - is the namespace to put the copy in.
Returns:
a newly created stereotype

buildTagDefinition

java.lang.Object buildTagDefinition(java.lang.String name,
                                    java.lang.Object stereotype,
                                    java.lang.Object namespace)
Build an initialized instance of a TagDefinition with the default tagType of "String". Only one of the two parameters stereotype and namespace may be specified.

Parameters:
name - is the name of the TagDefinition
stereotype - is the optional stereotype owning the TagDefinition
namespace - is the namespace to put the TagDefinition.
Returns:
a newly created TagDefinition.

buildTagDefinition

java.lang.Object buildTagDefinition(java.lang.String name,
                                    java.lang.Object stereotype,
                                    java.lang.Object namespace,
                                    java.lang.String tagType)
Build an initialized instance of a TagDefinition. Only one of the two parameters stereotype and namespace may be specified.

Parameters:
name - is the name of the TagDefinition
stereotype - is the optional stereotype owning the TagDefinition
namespace - is the namespace to put the TagDefinition.
tagType - a string containing the name of the type for values that may be assigned to this tag. This can either be the name of a datatype (e.g. "String", "Integer" or "Boolean") or the name of a metaclass for more complex types of tagged values.
Returns:
a newly created TagDefinition.

createTagDefinition

java.lang.Object createTagDefinition()
Create a TagDefinition.

Returns:
a TagDefinition

createStereotype

java.lang.Object createStereotype()
Create an empty Stereotype element.

Returns:
a Stereotype

copyTagDefinition

java.lang.Object copyTagDefinition(java.lang.Object aTd,
                                   java.lang.Object aNs)
Copy a TagDefinition into the given namespace or stereotype.

Parameters:
aTd - The TagDefinition to copy
aNs - A Namespace or a stereotype into which place the copy
Returns:
A copy of the tagdefinition


ArgoUML © 1996-2006ArgoUML HomepageArgoUML Developers' pageArgoUML Cookbook