org.argouml.model
Interface CoreFactory

All Superinterfaces:

Factory

public interface CoreFactory
extends Factory

The interface to the factory for the Core.

REALIZE_STEREOTYPE

static final java.lang.String REALIZE_STEREOTYPE

The name of the stereotype for a Realization.

See Also:

Constant Field Values

createAbstraction

java.lang.Object createAbstraction()

Create an empty but initialized instance of a UML Abstraction.

Returns:

an initialized UML Abstraction instance. TODO: This needs an extra parameter to specify the model/extent where the new element should be created.

buildAbstraction

java.lang.Object buildAbstraction(java.lang.String name,
                                  java.lang.Object supplier,
                                  java.lang.Object client)

Build an empty but initialized instance of a UML Abstraction with a given name.

Parameters:

name - The name.

supplier - the supplier of the abstraction

client - the client of the abstraction

Returns:

an initialized UML Abstraction instance.

createArtifact

java.lang.Object createArtifact()

Create an empty but initialized instance of an Artifact

Returns:

an initialized Artifact instance. TODO: This needs an extra parameter to specify the model/extent where the new element should be created.

Since:

UML 1.4

createAssociation

java.lang.Object createAssociation()

Deprecated. for 0.26 by tfmorris. Use createAssociation(Object).

Create an empty but initialized instance of a UML Association.

Returns:

an initialized UML Association instance.

createAssociation

java.lang.Object createAssociation(java.lang.Object extent)

Create an empty but initialized instance of a UML Association.

Parameters:

extent - outer package (extent) in which to create new Association.

Returns:

an initialized UML Association instance.

createAssociationClass

java.lang.Object createAssociationClass()

Create an empty but initialized instance of a UML AssociationClass.

Returns:

an initialized UML AssociationClass instance. TODO: This needs an extra parameter to specify the model/extent where the new element should be created.

createAssociationEnd

java.lang.Object createAssociationEnd()

Create an empty but initialized instance of a UML AssociationEnd.

Returns:

an initialized UML AssociationEnd instance. TODO: This needs an extra parameter to specify the model/extent where the new element should be created.

createAttribute

java.lang.Object createAttribute()

Create an empty but initialized instance of a UML Attribute.

Returns:

an initialized UML Attribute instance. TODO: This needs an extra parameter to specify the model/extent where the new element should be created.

createBinding

java.lang.Object createBinding()

Create an empty but initialized instance of a UML Binding.

Returns:

an initialized UML Binding instance. TODO: This needs an extra parameter to specify the model/extent where the new element should be created.

createClass

java.lang.Object createClass()

Create an empty but initialized instance of a UML Class.

Returns:

an initialized UML Class instance. TODO: This needs an extra parameter to specify the model/extent where the new element should be created.

createComment

java.lang.Object createComment()

Create an empty but initialized instance of a UML Comment.

Returns:

an initialized UML Comment instance. TODO: This needs an extra parameter to specify the model/extent where the new element should be created.

createComponent

java.lang.Object createComponent()

Create an empty but initialized instance of a UML Component.

Returns:

an initialized UML Component instance. TODO: This needs an extra parameter to specify the model/extent where the new element should be created.

createConstraint

java.lang.Object createConstraint()

Create an empty but initialized instance of a UML Constraint.

Returns:

an initialized UML Constraint instance. TODO: This needs an extra parameter to specify the model/extent where the new element should be created.

createDataType

java.lang.Object createDataType()

Create an empty but initialized instance of a UML DataType.

Returns:

an initialized UML DataType instance. TODO: This needs an extra parameter to specify the model/extent where the new element should be created.

createDependency

java.lang.Object createDependency()

Create an empty but initialized instance of a UML Dependency.

Returns:

an initialized UML Dependency instance. TODO: This needs an extra parameter to specify the model/extent where the new element should be created.

createElementResidence

java.lang.Object createElementResidence()

Create an empty but initialized instance of a UML ElementResidence.

Returns:

an initialized UML ElementResidence instance. TODO: This needs an extra parameter to specify the model/extent where the new element should be created.

buildElementResidence

java.lang.Object buildElementResidence(java.lang.Object me,
                                       java.lang.Object component)

Parameters:

me - the modelelement

component - the component

Returns:

an initialized UML ElementResidence instance.

createEnumeration

java.lang.Object createEnumeration()

Create an Enumeration.

Returns:

Object new Enumeration

Since:

UML 1.4 TODO: This needs an extra parameter to specify the model/extent where the new element should be created.

createEnumerationLiteral

java.lang.Object createEnumerationLiteral()

Create an EnumerationLiteral.

Returns:

Object new Enumeration

Since:

UML 1.4 TODO: This needs an extra parameter to specify the model/extent where the new element should be created.

createFlow

java.lang.Object createFlow()

Create an empty but initialized instance of a UML Flow.

Returns:

an initialized UML Flow instance. TODO: This needs an extra parameter to specify the model/extent where the new element should be created.

createInterface

java.lang.Object createInterface()

Create an empty but initialized instance of a UML Interface.

Returns:

an initialized UML Interface instance. TODO: This needs an extra parameter to specify the model/extent where the new element should be created.

createMethod

java.lang.Object createMethod()

Create an empty but initialized instance of a UML Method.

Returns:

an initialized UML Method instance. TODO: This needs an extra parameter to specify the model/extent where the new element should be created.

createNode

java.lang.Object createNode()

Create an empty but initialized instance of a UML Node.

Returns:

an initialized UML Node instance. TODO: This needs an extra parameter to specify the model/extent where the new element should be created.

createOperation

java.lang.Object createOperation()

Create an empty but initialized instance of a UML Operation.

Returns:

an initialized UML Operation instance. TODO: This needs an extra parameter to specify the model/extent where the new element should be created.

createParameter

java.lang.Object createParameter()

Create an empty but initialized instance of a UML Parameter.

Returns:

an initialized UML Parameter instance. TODO: This needs an extra parameter to specify the model/extent where the new element should be created.

createPermission

@Deprecated
java.lang.Object createPermission()

Deprecated. for 0.27.3 by tfmorris. Renamed in UML 2.x to PackageImport. Use createPackageImport().

Create an empty but initialized instance of a UML Permission.

Returns:

an initialized UML Permission instance. TODO: This needs an extra parameter to specify the model/extent where the new element should be created.

createPackageImport

java.lang.Object createPackageImport()

Create an empty but initialized instance of a UML Permission.

Returns:

an initialized UML Permission instance. TODO: This needs an extra parameter to specify the model/extent where the new element should be created.

createPrimitiveType

java.lang.Object createPrimitiveType()

Create a UML PrimitiveType.

Returns:

an initialized UML Primitive instance. TODO: This needs an extra parameter to specify the model/extent where the new element should be created.

Since:

UML 2.1.1

createTemplateArgument

java.lang.Object createTemplateArgument()

Create a UML TemplateArgument.

Returns:

an initialized TemplateArgument instance. TODO: This needs an extra parameter to specify the model/extent where the new element should be created.

Since:

UML 1.4

createTemplateParameter

java.lang.Object createTemplateParameter()

Create an empty but initialized instance of a UML TemplateParameter.

Returns:

an initialized UML TemplateParameter instance. TODO: This needs an extra parameter to specify the model/extent where the new element should be created.

createUsage

java.lang.Object createUsage()

Create an empty but initialized instance of a UML Usage.

Returns:

an initialized UML Usage instance. TODO: This needs an extra parameter to specify the model/extent where the new element should be created.

buildAssociation

@Deprecated
java.lang.Object buildAssociation(java.lang.Object fromClassifier,
                                             java.lang.Object aggregationKind1,
                                             java.lang.Object toClassifier,
                                             java.lang.Object aggregationKind2,
                                             java.lang.Boolean unidirectional)

Deprecated. for 0.27.3 by tfmorris. Use buildAssociation(Object, Object, Object, Object, boolean).

Builds a binary associationrole on basis of two classifierroles, navigation and aggregation.

Parameters:

fromClassifier - the first given classifier

aggregationKind1 - the first aggregationkind

toClassifier - the second given classifier

aggregationKind2 - the second aggregationkind

unidirectional - true if unidirectional

Returns:

the newly build binary associationrole

buildAssociation

java.lang.Object buildAssociation(java.lang.Object fromClassifier,
                                  java.lang.Object aggregationKind1,
                                  java.lang.Object toClassifier,
                                  java.lang.Object aggregationKind2,
                                  boolean unidirectional)

Builds a binary associationrole on basis of two classifierroles, navigation and aggregation.

Parameters:

fromClassifier - the first given classifier

aggregationKind1 - the first aggregationkind

toClassifier - the second given classifier

aggregationKind2 - the second aggregationkind

unidirectional - true if unidirectional

Returns:

the newly build binary associationrole

buildAssociation

java.lang.Object buildAssociation(java.lang.Object classifier1,
                                  java.lang.Object classifier2)

Builds a binary associations between two classifiers with default values for the association ends and the association itself.

Parameters:

classifier1 - The first classifier to connect

classifier2 - The second classifier to connect

Returns:

Association

buildAssociation

java.lang.Object buildAssociation(java.lang.Object c1,
                                  boolean nav1,
                                  java.lang.Object c2,
                                  boolean nav2,
                                  java.lang.String name)

Builds a binary association with a direction, aggregation and a given name.

Parameters:

c1 - The first classifier to connect to

nav1 - The navigability of the Associaton end

c2 - The second classifier to connect to

nav2 - The navigability of the second Associaton end

name - the given name

Returns:

association

buildAssociationClass

java.lang.Object buildAssociationClass(java.lang.Object end1,
                                       java.lang.Object end2)

Builds an associationClass between classifier end1 and end2 with a default class.

Parameters:

end1 - the first given classifier

end2 - the second given classifier

Returns:

AssociationClass

buildAssociationEnd

java.lang.Object buildAssociationEnd(java.lang.Object assoc,
                                     java.lang.String name,
                                     java.lang.Object type,
                                     java.lang.Object multi,
                                     java.lang.Object stereo,
                                     boolean navigable,
                                     java.lang.Object order,
                                     java.lang.Object aggregation,
                                     java.lang.Object scope,
                                     java.lang.Object changeable,
                                     java.lang.Object visibility)

Builds a fully configurable association end. All variables for an associationend can be given as parameter.

Parameters:

assoc - The associaton this end will be part of

name - The name of the association end

type - The type (classifier) the end will connect. The end is a connection piece between an association and a classifier

multi - The multiplicity

stereo - The stereotype

navigable - The navigability. True if this association end can be 'passed' from the other classifier.

order - Ordering of the association

aggregation - the aggregationkind

scope - the scope kind

changeable - the changeablekind

visibility - the visibilitykind

Returns:

AssociationEnd

buildAssociationEnd

java.lang.Object buildAssociationEnd(java.lang.Object type,
                                     java.lang.Object assoc)

Builds a simply configured association end.

Parameters:

type - the given classifier

assoc - the given association

Returns:

the newly build associationend

buildAttribute

java.lang.Object buildAttribute(java.lang.Object model,
                                java.lang.Object type)

Builds a default attribute.

Parameters:

model - The model the attribute belongs to.

type - The type of the attribute.

Returns:

The newly built attribute.

buildAttribute2

java.lang.Object buildAttribute2(java.lang.Object type)

Builds a default attribute.

Parameters:

type - The type of the attribute.

Returns:

The newly built attribute.

buildAttribute2

java.lang.Object buildAttribute2(java.lang.Object classifier,
                                 java.lang.Object type)

Builds an attribute of the given type owned by a classifier.

Parameters:

classifier - the classifier which will own the new attribute

type - the type

Returns:

the newly built attribute

buildClass

java.lang.Object buildClass()

Builds a default implementation for a class. The class is not owned by any model element by default. Users should not forget to add ownership.

Returns:

newly created Class TODO: This needs an extra parameter to specify the model/extent where the new element should be created.

buildClass

java.lang.Object buildClass(java.lang.Object owner)

Builds a class with a given namespace.

Parameters:

owner - the namespace

Returns:

Class

See Also:

buildClass()

buildClass

java.lang.Object buildClass(java.lang.String name)

Builds a class with a given name.

Parameters:

name - the given name

Returns:

Class

See Also:

TODO: This needs an extra parameter to specify the model/extent where the new element should be created.

buildClass

java.lang.Object buildClass(java.lang.String name,
                            java.lang.Object owner)

Builds a class with a given name and namespace.

Parameters:

name - the given name

owner - the namespace

Returns:

Class

See Also:

buildClass()

buildInterface

java.lang.Object buildInterface()

Builds a default implementation for an interface. The interface is not owned by any model element by default. Users should not forget to add ownership.

Returns:

Interface TODO: This needs an extra parameter to specify the model/extent where the new element should be created.

buildInterface

java.lang.Object buildInterface(java.lang.Object owner)

Builds an interface with a given namespace.

Parameters:

owner - is the owner

Returns:

Interface

buildInterface

java.lang.Object buildInterface(java.lang.String name)

Builds an interface with a given name.

Parameters:

name - is the given name.

Returns:

Interface TODO: This needs an extra parameter to specify the model/extent where the new element should be created.

buildInterface

java.lang.Object buildInterface(java.lang.String name,
                                java.lang.Object owner)

Builds an interface with a given name and namespace.

Parameters:

name - is the given name

owner - is the namespace

Returns:

Interface

buildDataType

java.lang.Object buildDataType(java.lang.String name,
                               java.lang.Object owner)

Builds a datatype with a given name and namespace.

Parameters:

name - is the name

owner - is the namespace

Returns:

an initialized UML DataType instance.

buildEnumeration

java.lang.Object buildEnumeration(java.lang.String name,
                                  java.lang.Object owner)

Parameters:

name - is the name

owner - is the namespace

Returns:

an initialized UML Enumeration instance

Since:

UML 1.4

buildEnumerationLiteral

java.lang.Object buildEnumerationLiteral(java.lang.String name,
                                         java.lang.Object enumeration)

Parameters:

name - is the name

enumeration - is the enumeration of the literal

Returns:

an initialized UML EnumerationLiteral instance

Since:

UML 1.4

buildDependency

java.lang.Object buildDependency(java.lang.Object clientObj,
                                 java.lang.Object supplierObj)

Builds a modelelement dependency between two modelelements.

Parameters:

clientObj - is the client

supplierObj - is the supplier

Returns:

Dependency

buildPackageImport

java.lang.Object buildPackageImport(java.lang.Object client,
                                    java.lang.Object supplier)

Build an import Permission between a Namespace and a Package. All model elements in the supplier namespace will be added to the client namespace. The Permission will be placed in the client namespace.

UML 1.4 spec - "Import is a stereotyped permission dependency between two namespaces, denoting that the public contents of the target package are added to the namespace of the source package."

NOTE: For compatibility with UML 2.x, we adopt the slightly stricter requirement that the target namespace must be a Package.

Parameters:

client - is the client Namespace

supplier - is the supplier Package

Returns:

Permission

buildPackageAccess

java.lang.Object buildPackageAccess(java.lang.Object client,
                                    java.lang.Object supplier)

Build an access Permission between a Namespace and a Package. All model elements in the supplier namespace will be accessible from the client namespace, but they are not added to the client namespace. The Permission will be placed in the client namespace.

UML 1.4 spec - "Access is a stereotyped permission dependency between two namespaces, denoting that the public contents of the target namespace are accessible to the namespace of the source package."

NOTE: For compatibility with UML 2.x, we adopt the slightly stricter requirement that the target namespace must be a Package. In UML 2.x, this translates to a packageImport with non-public visibility.

Parameters:

client - is the client Namespace

supplier - is the supplier Package

Returns:

Permission

buildGeneralization

java.lang.Object buildGeneralization(java.lang.Object child,
                                     java.lang.Object parent)

Builds a generalization between a parent and a child. Does not check if multiple inheritance is allowed for the current notation.

Parameters:

child - is the child

parent - is the parent

Returns:

Generalization

buildMethod

java.lang.Object buildMethod(java.lang.String name)

Builds a method with a given name.

Parameters:

name - is the given name

Returns:

method TODO: This needs an extra parameter to specify the model/extent where the new element should be created.

buildOperation

java.lang.Object buildOperation(java.lang.Object classifier,
                                java.lang.Object returnType)

Builds an operation for a classifier.

Parameters:

classifier - is the given classifier

returnType - the type of the return parameter

Returns:

the operation

buildOperation2

java.lang.Object buildOperation2(java.lang.Object cls,
                                 java.lang.Object returnType,
                                 java.lang.String name)

Builds an operation with a given name for classifier.

NOTE: This is given a new method name so there won't be a name clash for the case where the old 3-param method was called with null arguments.

Parameters:

cls - is the classifier that shall own the operation

returnType - the type of the return parameter

name - the given name for the operation

Returns:

the operation

buildParameter

java.lang.Object buildParameter(java.lang.Object o,
                                java.lang.Object type)

Adds a parameter initialized to default values to a given event or behavioral feature.

Parameters:

o - an event or behavioral feature

type - the type of the parameter

Returns:

the parameter

buildRealization

java.lang.Object buildRealization(java.lang.Object client,
                                  java.lang.Object supplier,
                                  java.lang.Object namespace)

Builds a realization between some supplier (for example an interface in Java) and a client who implements the realization.

Parameters:

client - is the client

supplier - is the supplier

namespace - the namespace to use if client and supplier are of different namespace

Returns:

Object the created abstraction

buildTemplateArgument

java.lang.Object buildTemplateArgument(java.lang.Object element)

Build a TemplateArgument which has the given element as its modelElement.

NOTE: Although it's not shown in the UML 1.4 spec, a TemplateArgument is a value (like MultiplicityRange), not a ModelElement and can not be reused in multiple instances. The UML diagrams don't show it as a composition, but it effectively is.

Parameters:

element - ModelElement to be used as argument

Returns:

newly created TemplateArgument

buildTemplateArgument

java.lang.Object buildTemplateArgument(java.lang.Object binding,
                                       java.lang.Object argument)

Build a TemplateArgument which has the given element as its modelElement.

NOTE: Although it's not shown in the UML 1.4 spec, a TemplateArgument is a value (like MultiplicityRange), not a ModelElement and can not be reused in multiple instances. The UML diagrams don't show it as a composition, but it effectively is.

Parameters:

binding - Binding which will own this Template Argument

argument - ModelElement to be used as argument

Returns:

newly created TemplateArgument

buildTemplateParameter

java.lang.Object buildTemplateParameter(java.lang.Object template,
                                        java.lang.Object parameter,
                                        java.lang.Object defaultElement)

Build a TemplateParameter which has the given template and parameter and

Parameters:

template - ModelElement which will be template

parameter - ModelElement which will be parameter. The only two two things of significance are its type and name

defaultElement - an optional default Model Element which will be used if not value is given in a Binding. Null if not used.

element - ModelElement to be used as argument

Returns:

newly created TemplateParameter

buildUsage

java.lang.Object buildUsage(java.lang.Object client,
                            java.lang.Object supplier)

Builds a usage between some client and a supplier. If client and supplier do not have the same model, an IllegalArgumentException is thrown.

Parameters:

client - is the client

supplier - is the supplier

Returns:

Usage

buildComment

java.lang.Object buildComment(java.lang.Object element,
                              java.lang.Object model)

Builds a comment inluding a reference to the given modelelement to comment. If the element is null, the comment is still build since it is not mandatory to have an annotated element in the comment.

Parameters:

element - is the model element

model - the namespace for the comment

Returns:

MComment

buildConstraint

java.lang.Object buildConstraint(java.lang.Object constrElement)

Builds a constraint that constraints the given modelelement. The namespace of the constraint will be the same as the namespace of the given modelelement.

Parameters:

constrElement - The constrained element.

Returns:

Constraint

buildConstraint

java.lang.Object buildConstraint(java.lang.String name,
                                 java.lang.Object bexpr)

Builds a constraint with a given name and boolean expression.

Parameters:

name - is the given name

bexpr - boolean expression

Returns:

constraint

buildBinding

java.lang.Object buildBinding(java.lang.Object client,
                              java.lang.Object supplier,
                              java.util.List arguments)

Build binding between a supplier template element and its parameterized client using the given list or arguments to fill the template.

Parameters:

client - ModelElement to become client. A given ModelElement may only participate as a client in a single Binding.

supplier - template ModelElement to be parameterized

arguments - list of argument used to fill the parameters. Number, order, and type must match those of the TemplateParameters for the supplier. A null may be passed to not create arguments at build time.

Returns:

the newly created Binding

copyClass

java.lang.Object copyClass(java.lang.Object source,
                           java.lang.Object ns)

Copies a class, and it's features. This may also require other classifiers to be copied.

Parameters:

source - is the class to copy.

ns - is the namespace to put the copy in.

Returns:

a newly created class.

copyFeature

java.lang.Object copyFeature(java.lang.Object source,
                             java.lang.Object classifier)

Copies a feature from one classifier to another.

Parameters:

source - is the feature to copy.

classifier - is the classifier to put the copy in.

Returns:

a newly created feature.

copyDataType

java.lang.Object copyDataType(java.lang.Object source,
                              java.lang.Object ns)

Copies a datatype, and it's features. This may also require other classifiers to be copied.

Parameters:

source - is the datatype to copy.

ns - is the namespace to put the copy in.

Returns:

a newly created data type.

copyInterface

java.lang.Object copyInterface(java.lang.Object source,
                               java.lang.Object ns)

Copies an interface, and it's features. This may also require other classifiers to be copied.

Parameters:

source - is the interface to copy.

ns - is the namespace to put the copy in.

Returns:

a newly created interface.

createGeneralization

java.lang.Object createGeneralization()

Deprecated. for 0.26 by tfmorris. Use createGeneralization(Object).

Additional support for generalization.

Returns:

A generalization.

createGeneralization

java.lang.Object createGeneralization(java.lang.Object extent)

Create a generalization in the given extent.

Parameters:

extent - the extent in which the generalization should be created

Returns:

A generalization.