de.armax.ax.devtools.uml
Interface AXclass

All Superinterfaces:
AXclassifier, AXmodelElement
All Known Implementing Classes:
AXclassMdrImpl, AXclassNsumlImpl

public interface AXclass
extends AXclassifier

Metamodel for UML class and UML interface

Author:
Peter Wieland, ARMAX mindware GmbH

Field Summary
static java.lang.String INTERFACE
          The qualified name of this interface.
 
Method Summary
 boolean existSuperClass()
          Check weather this class has a super class.
 java.util.List getAbstractions()
          Get a List of all abstractions for this class or interface.
 java.util.List getAccessibleAssociations(boolean excludeImplemented)
          Get all associations accessible from this class.
 java.util.List getAccessibleAttributes(boolean excludeImplemented)
          Get a list of all attributes accessible from this class.
 java.util.List getAccessibleNToMAssociations(boolean includeNonNavigable, boolean excludeImplemented)
          Get all accessible N to M associations.
 java.util.List getAccessibleOperations(boolean excludeImplemented)
          Get a list of all operations accessible from this class.
 java.util.List getAccessibleXTo1Associations(boolean includeNonNavigable, boolean excludeImplemented)
          Get all accessible to 1 associations.
 java.util.List getAccessibleXToNAssociations(boolean includeNonNavigable, boolean excludeImplemented)
          Get all accessible to N associations.
 java.util.List getAssociationEnds()
          Get all association ends, this class owns.
 java.util.List getAssociations()
          Get assocaitions for all association ends, this class owns
 java.util.List getAttributes()
          Get all attributes for this class
 java.util.List getClientDependencies()
          Get a List of all dependencies for which this class is a client.
 java.util.List getExtent(boolean deep, boolean excluedNonInstantiable)
          Get the extent of this class.
 java.util.List getGeneralizations()
          Get a List of all generalizations for this class or interface.
 java.util.List getImplementedInterfaces(boolean deep)
          Get a List of implemented interfaces for this class.
 java.util.List getInheritedAssociations(boolean deep, boolean excludeImplemented)
          Get all associations this class inherits from other classes.
 java.util.List getInheritedAttributes(boolean deep, boolean excludeImplemented)
          Get a list of all attributes this class inherits from other classes.
 java.util.List getInheritedNToMAssociations(boolean includeNonNavigable, boolean deep, boolean excludeImplemented)
          Get all inherited N to M associations.
 java.util.List getInheritedOperations(boolean deep, boolean excludeImplemented)
          Get a list of all operations this class inherits from other classes.
 java.util.List getInheritedXTo1Associations(boolean includeNonNavigable, boolean deep, boolean excludeImplemented)
          Get all inherited to 1 associations.
 java.util.List getInheritedXToNAssociations(boolean includeNonNavigable, boolean deep, boolean excludeImplemented)
          Get all inherited to N associations.
 java.util.List getNToMAssociations(boolean includeNonNavigable)
          Get all associations that have both ends with multiplicity 0..N or 1..N
 java.util.List getOperations()
          Get all operations for this class
 java.util.List getRealizations()
          Get a List of all realizations for this class or interface.
 java.util.List getSpecializations()
          Get a List of all specializations for this class or interface.
 AXclass getSuperClass()
          Get the superclass for this class.
 java.util.List getSuperClasses()
          Get a List of all superclasses for this class.
 java.util.List getSupplierDependencies()
          Get a List of all dependencies for which this class is a supplier.
 java.util.List getXTo1Associations(boolean includeNonNavigable)
          Get all associations that have an other end with multiplicity 0..1 or 1
 java.util.List getXToNAssociations(boolean includeNonNavigable)
          Get all associations that have an other end with multiplicity 0..N or 1..N
 boolean isAbstract()
          Check weather this class models an abstract class.
 boolean isDependencyClient(AXclass supplier, java.lang.String stereoType, java.lang.String name)
          Check weather this class is an dependency client for a given other class.
 boolean isDependencySupplier(AXclass client, java.lang.String stereoType, java.lang.String name)
          Check weather this class is an dependency supplier for a given other class.
 boolean isInstantiable()
          Check weather this class models an instantiable class.
 boolean isInterface()
          Check weather this class models an interface.
 
Methods inherited from interface de.armax.ax.devtools.uml.AXclassifier
isNativeType, isVoidType
 
Methods inherited from interface de.armax.ax.devtools.uml.AXmodelElement
equals, existTaggedValue, getModel, getName, getNameForCollectionDefine, getNameForCollectionMethod, getNameForCollectionVariable, getNameForDefine, getNameForMethod, getNameForVariable, getNamespaceName, getPackage, getQualifiedName, getRealElement, getStereotype, getSufficientlyQualifiedName, getSufficientlyQualifiedName, getTaggedValue, getTaggedValue, getTaggedValues, getTaggedValueTags, getWellKnownPackages, hasStereotype, isSameNamespace, isSameNamespace
 

Field Detail

INTERFACE

public static final java.lang.String INTERFACE

The qualified name of this interface.

See Also:
Constant Field Values
Method Detail

getGeneralizations

public java.util.List getGeneralizations()

Get a List of all generalizations for this class or interface.

The elements in the returned List are of type AXgeneralization. The returned List must not be null (but it may be empty).

Each AXgeneralization in the returned list can also be obtained by calling getSpecialization() on the parent class of the AXgeneralization

Returns:
a List containing all generalizations for this class

See Also:
getSpecializations(), getAbstractions(), getRealizations()

getSpecializations

public java.util.List getSpecializations()

Get a List of all specializations for this class or interface.

The elements in the returned List are of type AXgeneralization. The returned List must not be null (but it may be empty).

Each AXgeneralization in the returned list can also be obtained by calling getGeneralizations() on the child class of the AXgeneralization

Returns:
a List containing all generalizations for this class

See Also:
getGeneralizations(), getAbstractions(), getRealizations()

getAbstractions

public java.util.List getAbstractions()

Get a List of all abstractions for this class or interface.

The elements in the returned List are of type AXabstraction. The returned List must not be null (but it may be empty).

Each AXabstraction in the returned List must also be contained in the List obtained by calling getRealizations() on the supplier class of the AXabstraction

Returns:
a List containing all abstractions for this class
See Also:
getRealizations(), getGeneralizations(), getSpecializations()

getRealizations

public java.util.List getRealizations()

Get a List of all realizations for this class or interface.

The elements in the returned List are of type AXabstraction. The returned List must not be null (but it may be empty).

Each AXabstraction in the returned List must also be contained in the List obtained by calling getAbstractions() on the client class of the AXabstraction

Returns:
a List containing all abstractions for this class
See Also:
getRealizations(), getGeneralizations(), getSpecializations()

getClientDependencies

public java.util.List getClientDependencies()

Get a List of all dependencies for which this class is a client.

The elements in the returned List are of type AXdependency. The returned List must not be null (but it may be empty).

Each AXdependency in the returned List must also be contained in the List obtained by calling getSupplierDependencies() on the supplier class of the AXdependency

Returns:
a List containing all dependencies for which this class is client
See Also:
getSupplierDependencies()

getSupplierDependencies

public java.util.List getSupplierDependencies()

Get a List of all dependencies for which this class is a supplier.

The elements in the returned List are of type AXdependency. The returned List must not be null (but it may be empty).

Each AXdependency in the returned List must also be contained in the List obtained by calling getClientDependencies() on the client class of the AXdependency

Returns:
a List containing all dependencies for which this class is client
See Also:
getClientDependencies()

getAttributes

public java.util.List getAttributes()

Get all attributes for this class

Returns:
a List of all attributes (contains elements of type AXattribute)
See Also:
getOperations(), getInheritedAttributes(boolean, boolean)

getOperations

public java.util.List getOperations()

Get all operations for this class

Returns:
a List of all operations (contains elements of type AXoperation)
See Also:
getAttributes(), getInheritedOperations(boolean, boolean)

getExtent

public java.util.List getExtent(boolean deep,
                                boolean excluedNonInstantiable)

Get the extent of this class. I.e. all classes that inherit from this class or interface

Parameters:
deep - if false, only direct subclasses are returned, else the whole class hierarchy is scanned
excluedNonInstantiable - if true, only instantiable clases are returned
Returns:
a List of AXclasses that build the extent for this class

getImplementedInterfaces

public java.util.List getImplementedInterfaces(boolean deep)

Get a List of implemented interfaces for this class.

Parameters:
deep - if false, only interfaces that are directly implemented by this class are returned. Else, the whole class hierarchy is scanned.
Returns:
a List of AXclasses that are interfaces implemented (directly or indirectly) by this class

getSuperClasses

public java.util.List getSuperClasses()

Get a List of all superclasses for this class. I.e all classes this class inherits directly from.

Returns:
a List of AXclasses that are super classes for this class

See Also:
getSuperClass(), existSuperClass()

getSuperClass

public AXclass getSuperClass()

Get the superclass for this class.

If there is more than one superclass, this method returns one of them. There is no rule which one should be returned. Use getSuperClasses() instead, if there may be more than one superclass

Returns:
a superclass for this class or null if there is no superclass.
See Also:
getSuperClasses(), existSuperClass()

existSuperClass

public boolean existSuperClass()

Check weather this class has a super class.

Returns:
true if and only if this class has at least one super class.
See Also:
getSuperClass(), getSuperClasses()

getInheritedAttributes

public java.util.List getInheritedAttributes(boolean deep,
                                             boolean excludeImplemented)

Get a list of all attributes this class inherits from other classes.

Parameters:
deep - if true, scan the whole class hierarchy, else scan only direct superclasses and directly implemented interfaces
excludeImplemented - if true, only return attributes inherited from non instantiable types, else return all inherited attributes
Returns:
a List of attributes inherited from other classes (containing AXattributes)
See Also:
getAttributes()

getAccessibleAttributes

public java.util.List getAccessibleAttributes(boolean excludeImplemented)

Get a list of all attributes accessible from this class.

Parameters:
excludeImplemented - if true, only return attributes inherited from non instantiable types, else return all inherited attributes
Returns:
a List of attributes inherited from other classes (containing AXattributes)
See Also:
getAttributes()

getInheritedOperations

public java.util.List getInheritedOperations(boolean deep,
                                             boolean excludeImplemented)

Get a list of all operations this class inherits from other classes.

Parameters:
deep - if true, scan the whole class hierarchy, else scan only direct superclasses and directly implemented interfaces
excludeImplemented - if true, only return operations inherited from non instantiable types, else return all inherited attributes
Returns:
a List of operations inherited from other classes (containing AXoperations)
See Also:
getOperations()

getAccessibleOperations

public java.util.List getAccessibleOperations(boolean excludeImplemented)

Get a list of all operations accessible from this class.

Parameters:
excludeImplemented - if true, only return operations inherited from non instantiable types, else return all inherited attributes
Returns:
a List of operations inherited from other classes (containing AXoperations)
See Also:
getOperations()

getAssociationEnds

public java.util.List getAssociationEnds()

Get all association ends, this class owns.


getAssociations

public java.util.List getAssociations()

Get assocaitions for all association ends, this class owns

See Also:
getInheritedAssociations(boolean, boolean), getXTo1Associations(boolean), getXToNAssociations(boolean), getNToMAssociations(boolean)

getXTo1Associations

public java.util.List getXTo1Associations(boolean includeNonNavigable)

Get all associations that have an other end with multiplicity 0..1 or 1

Parameters:
includeNonNavigable - if false, associations whos other ends are not navigable are excluded.
See Also:
getInheritedXTo1Associations(boolean, boolean, boolean), getAssociations(), getXToNAssociations(boolean), getNToMAssociations(boolean)

getXToNAssociations

public java.util.List getXToNAssociations(boolean includeNonNavigable)

Get all associations that have an other end with multiplicity 0..N or 1..N

Parameters:
includeNonNavigable - if false, associations whos other ends are not navigable are excluded.
See Also:
getInheritedXToNAssociations(boolean, boolean, boolean), getAssociations(), getXTo1Associations(boolean), getNToMAssociations(boolean)

getNToMAssociations

public java.util.List getNToMAssociations(boolean includeNonNavigable)

Get all associations that have both ends with multiplicity 0..N or 1..N

Parameters:
includeNonNavigable - if false, associations whos other ends are not navigable are excluded.
See Also:
getInheritedNToMAssociations(boolean, boolean, boolean), getAssociations(), getXTo1Associations(boolean), getXToNAssociations(boolean)

getInheritedAssociations

public java.util.List getInheritedAssociations(boolean deep,
                                               boolean excludeImplemented)

Get all associations this class inherits from other classes.

Parameters:
deep - if true, scan the whole class hierarchy, else scan only direct superclasses and directly implemented interfaces
excludeImplemented - if true only non instantiable classes are considered, abstract classes and interfaces are ignored
See Also:
getAssociations()

getAccessibleAssociations

public java.util.List getAccessibleAssociations(boolean excludeImplemented)

Get all associations accessible from this class.

Parameters:
excludeImplemented - if true only non instantiable classes are considered, abstract classes and interfaces are ignored
See Also:
getAssociations()

getInheritedXTo1Associations

public java.util.List getInheritedXTo1Associations(boolean includeNonNavigable,
                                                   boolean deep,
                                                   boolean excludeImplemented)

Get all inherited to 1 associations.

Parameters:
includeNonNavigable - if false, associations whos other ends are not navigable are excluded.
deep - if true, scan the whole class hierarchy, else scan only direct superclasses and directly implemented interfaces
excludeImplemented - if true only non instantiable classes are considered, abstract classes and interfaces are ignored
See Also:
getXTo1Associations(boolean)

getAccessibleXTo1Associations

public java.util.List getAccessibleXTo1Associations(boolean includeNonNavigable,
                                                    boolean excludeImplemented)

Get all accessible to 1 associations.

Parameters:
includeNonNavigable - if false, associations whos other ends are not navigable are excluded.
excludeImplemented - if true only non instantiable classes are considered, abstract classes and interfaces are ignored
See Also:
getXTo1Associations(boolean)

getInheritedXToNAssociations

public java.util.List getInheritedXToNAssociations(boolean includeNonNavigable,
                                                   boolean deep,
                                                   boolean excludeImplemented)

Get all inherited to N associations.

Parameters:
includeNonNavigable - if false, associations whos other ends are not navigable are excluded.
deep - if true, scan the whole class hierarchy, else scan only direct superclasses and directly implemented interfaces
excludeImplemented - if true only non instantiable classes are considered, abstract classes and interfaces are ignored
See Also:
getXToNAssociations(boolean)

getAccessibleXToNAssociations

public java.util.List getAccessibleXToNAssociations(boolean includeNonNavigable,
                                                    boolean excludeImplemented)

Get all accessible to N associations.

Parameters:
includeNonNavigable - if false, associations whos other ends are not navigable are excluded.
excludeImplemented - if true only non instantiable classes are considered, abstract classes and interfaces are ignored
See Also:
getXToNAssociations(boolean)

getInheritedNToMAssociations

public java.util.List getInheritedNToMAssociations(boolean includeNonNavigable,
                                                   boolean deep,
                                                   boolean excludeImplemented)

Get all inherited N to M associations.

Parameters:
includeNonNavigable - if false, associations whos other ends are not navigable are excluded.
deep - if true, scan the whole class hierarchy, else scan only direct superclasses and directly implemented interfaces
excludeImplemented - if true only non instantiable classes are considered, abstract classes and interfaces are ignored
See Also:
getNToMAssociations(boolean)

getAccessibleNToMAssociations

public java.util.List getAccessibleNToMAssociations(boolean includeNonNavigable,
                                                    boolean excludeImplemented)

Get all accessible N to M associations.

Parameters:
includeNonNavigable - if false, associations whos other ends are not navigable are excluded.
excludeImplemented - if true only non instantiable classes are considered, abstract classes and interfaces are ignored
See Also:
getNToMAssociations(boolean)

isInterface

public boolean isInterface()

Check weather this class models an interface.


isAbstract

public boolean isAbstract()

Check weather this class models an abstract class. (An interface is not an abstract class)


isInstantiable

public boolean isInstantiable()

Check weather this class models an instantiable class.


isDependencySupplier

public boolean isDependencySupplier(AXclass client,
                                    java.lang.String stereoType,
                                    java.lang.String name)

Check weather this class is an dependency supplier for a given other class.

This scans the supplier dependencies for this class and returns true if a dependency is found, who's client is the argument client and that has a stereotpye that matches the argument stereotype and a name that matches the argument name


isDependencyClient

public boolean isDependencyClient(AXclass supplier,
                                  java.lang.String stereoType,
                                  java.lang.String name)

Check weather this class is an dependency client for a given other class.

This scans the client dependencies for this class and returns true if a dependency is found, who's supplier is the argument supplier and that has a stereotpye that matches the argument stereotype and a name that matches the argument name



Copyright © 2003 ARMAX mindware GmbH. All Rights Reserved.