org.andromda.metafacades.uml
Interface ClassifierFacade

All Superinterfaces:

GeneralizableElementFacade, ModelElementFacade

All Known Subinterfaces:

ActorFacade, AssociationClassFacade, Entity, EnumerationFacade, FrontEndController, FrontEndUseCase, ManageableEntity, NamespaceFacade, Role, Service, UseCaseFacade, ValueObject

public interface ClassifierFacade

extends GeneralizableElementFacade

Represents a Classifier model element

Metafacade interface to be used by AndroMDA cartridges.

Method Summary

AttributeFacade	findAttribute(String name) Return the attribute which name matches the parameter
Collection	getAbstractions() Those abstraction dependencies for which this classifier is the client.
Collection	getAllAssociatedClasses() Lists all classes associated to this one and any ancestor classes (through generalization).
Collection	getAllProperties() A collection containing all 'properties' of the classifier and its ancestors.
Collection	getAllRequiredConstructorParameters() A collection containing all required and/or read-only 'properties' of the classifier and its ancestors.
ClassifierFacade	getArray() Gets the array type for this classifier.
String	getArrayName() The name of the classifier as an array.
Collection	getAssociatedClasses() Lists the classes associated to this one, there is no repitition of classes.
List	getAssociationEnds() Gets the association ends belonging to a classifier.
Collection	getAttributes() Gets the attributes that belong to the classifier.
Collection	getAttributes(boolean follow) Gets all attributes for the classifier and if 'follow' is true goes up the inheritance hierachy and gets the attributes from the super classes as well.
String	getFullyQualifiedArrayName() The fully qualified name of the classifier as an array.
Collection	getImplementationOperations() Returns all those operations that could be implemented at this classifier's level.
String	getImplementedInterfaceList() A comma seperated list of the fully qualified names of all implemented interfaces.
Collection	getInstanceAttributes() Those attributes that are scoped to an instance of this class.
Collection	getInstanceOperations() Those operations that are scoped to an instance of this class.
Collection	getInterfaceAbstractions() Those interfaces that are abstractions of this classifier, this basically means this classifier realizes them.
String	getJavaNullString() A String representing the null-value for this classifier type to be used in a Java environment.
Collection	getNavigableConnectingEnds() The other ends of this classifier's association ends which are navigable.
Collection	getNavigableConnectingEnds(boolean follow) Get the other ends of this classifier's association ends which are navigable and if 'follow' is true goes up the inheritance hierarchy and gets the super association ends as well.
ClassifierFacade	getNonArray() Assuming that the classifier is an array, this will return the non array type of the classifier from
String	getOperationCallFromAttributes() The attributes from this classifier in the form of an operation call (this example would be in Java): '(java.lang.String attributeOne, java.lang.String attributeTwo).
Collection	getOperations() The operations owned by this classifier.
Collection	getProperties() A collection containing all 'properties' of the classifier.
Collection	getProperties(boolean follow) Gets all properties (attributes and navigable association ends) for the classifier and if 'follow' is true goes up the inheritance hierachy and gets the properties from the super classes as well.
Collection	getRequiredConstructorParameters() A collection containing all required and/or read-only 'properties' of the classifier.
Long	getSerialVersionUID() Returns the serial version UID of the underlying model element.
Collection	getStaticAttributes() Those attributes that are scoped to the definition of this class.
Collection	getStaticOperations() Those operations that are scoped to the definition of this class.
ClassifierFacade	getSuperClass() This class' superclass, returns the generalization if it is a ClassifierFacade, null otherwise.
String	getWrapperName() The wrapper name for this classifier if a mapped type has a defined wrapper class (ie.
boolean	isAbstract() Indicates if this classifier is 'abstract'.
boolean	isArrayType() True if this classifier represents an array type.
boolean	isAssociationClass()
boolean	isBlobType() Returns true if this type represents a Blob type.
boolean	isBooleanType() Indicates if this type represents a boolean type or not.
boolean	isClassifierFacadeMetaType() Indicates the metafacade type (used for metafacade mappings).
boolean	isClobType() Returns true if this type represents a Clob type.
boolean	isCollectionType() True if this classifier represents a collection type.
boolean	isDataType() True/false depending on whether or not this classifier represents a datatype.
boolean	isDateType() True when this classifier is a date type.
boolean	isEnumeration() True if this classifier is in fact marked as an enumeration.
boolean	isFileType() Returns true if this type represents a 'file' type.
boolean	isInterface() True/false depending on whether or not this Classifier represents an interface.
boolean	isLeaf() True if this classifier cannot be extended and represent a leaf in the inheritance tree.
boolean	isListType() True if this classifier represents a list type.
boolean	isMapType() Indicates whether or not this classifier represents a Map type.
boolean	isPrimitive() Indicates whether or not this classifier represents a primitive type.
boolean	isSetType() True if this classifier represents a set type.
boolean	isStringType() Indicates whether or not this classifier represents a string type.
boolean	isTimeType() Indicates whether or not this classifier represents a time type.

Methods inherited from interface org.andromda.metafacades.uml.GeneralizableElementFacade

findTaggedValue, getAllGeneralizations, getAllSpecializations, getGeneralization, getGeneralizationLinks, getGeneralizationList, getGeneralizationRoot, getGeneralizations, getSpecializations, isGeneralizableElementFacadeMetaType

Methods inherited from interface org.andromda.metafacades.uml.ModelElementFacade

copyTaggedValues, findTaggedValue, findTaggedValues, getConstraints, getConstraints, getDocumentation, getDocumentation, getDocumentation, getFullyQualifiedName, getFullyQualifiedName, getFullyQualifiedNamePath, getId, getLanguageMappings, getModel, getName, getPackage, getPackageName, getPackageName, getPackagePath, getRootPackage, getSourceDependencies, getStateMachineContext, getStereotypeNames, getStereotypes, getTaggedValues, getTargetDependencies, getTemplateParameter, getTemplateParameters, getValidationName, getValidationOwner, getVisibility, hasExactStereotype, hasStereotype, initialize, isBindingDependenciesPresent, isConstraintsPresent, isModelElementFacadeMetaType, isTemplateParametersPresent, translateConstraint, translateConstraints, translateConstraints, validateInvariants

Method Detail

isClassifierFacadeMetaType

public boolean isClassifierFacadeMetaType()

Indicates the metafacade type (used for metafacade mappings).

Returns:

always true

findAttribute

public AttributeFacade findAttribute(String name)

Return the attribute which name matches the parameter

getAbstractions

public Collection getAbstractions()

Those abstraction dependencies for which this classifier is the client.

getAllAssociatedClasses

public Collection getAllAssociatedClasses()

Lists all classes associated to this one and any ancestor classes (through generalization). There will be no duplicates. The order of the elements is predictable.

getAllProperties

public Collection getAllProperties()

A collection containing all 'properties' of the classifier and its ancestors. Properties are any attributes and navigable connecting association ends.

getAllRequiredConstructorParameters

public Collection getAllRequiredConstructorParameters()

A collection containing all required and/or read-only 'properties' of the classifier and its ancestors. Properties are any attributes and navigable connecting association ends.

getArray

public ClassifierFacade getArray()

Gets the array type for this classifier. If this classifier already represents an array, it just returns itself.

getArrayName

public String getArrayName()

The name of the classifier as an array.

getAssociatedClasses

public Collection getAssociatedClasses()

Lists the classes associated to this one, there is no repitition of classes. The order of the elements is predictable.

getAssociationEnds

public List getAssociationEnds()

Gets the association ends belonging to a classifier.

getAttributes

public Collection getAttributes()

Gets the attributes that belong to the classifier.

getAttributes

public Collection getAttributes(boolean follow)

Gets all attributes for the classifier and if 'follow' is true goes up the inheritance hierachy and gets the attributes from the super classes as well.

getFullyQualifiedArrayName

public String getFullyQualifiedArrayName()

The fully qualified name of the classifier as an array.

getImplementationOperations

public Collection getImplementationOperations()

Returns all those operations that could be implemented at this classifier's level. This means the operations owned by this classifier as well as any realized interface's operations (recursively) in case this classifier itself is not already an interface, or generalized when this classifier is an interface.

getImplementedInterfaceList

public String getImplementedInterfaceList()

A comma seperated list of the fully qualified names of all implemented interfaces.

getInstanceAttributes

public Collection getInstanceAttributes()

Those attributes that are scoped to an instance of this class.

getInstanceOperations

public Collection getInstanceOperations()

Those operations that are scoped to an instance of this class.

getInterfaceAbstractions

public Collection getInterfaceAbstractions()

Those interfaces that are abstractions of this classifier, this basically means this classifier realizes them.

getJavaNullString

public String getJavaNullString()

A String representing the null-value for this classifier type to be used in a Java environment.

getNavigableConnectingEnds

public Collection getNavigableConnectingEnds()

The other ends of this classifier's association ends which are navigable.

getNavigableConnectingEnds

public Collection getNavigableConnectingEnds(boolean follow)

Get the other ends of this classifier's association ends which are navigable and if 'follow' is true goes up the inheritance hierarchy and gets the super association ends as well.

getNonArray

public ClassifierFacade getNonArray()

Assuming that the classifier is an array, this will return the non array type of the classifier from

the model. If the classifier is NOT an array, it will just return itself.

getOperationCallFromAttributes

public String getOperationCallFromAttributes()

The attributes from this classifier in the form of an operation call (this example would be in Java): '(java.lang.String attributeOne, java.lang.String attributeTwo). If there were no attributes on the classifier, the result would be an empty '()'.

getOperations

public Collection getOperations()

The operations owned by this classifier.

getProperties

public Collection getProperties()

A collection containing all 'properties' of the classifier. Properties are any attributes and navigable connecting association ends.

getProperties

public Collection getProperties(boolean follow)

Gets all properties (attributes and navigable association ends) for the classifier and if 'follow' is true goes up the inheritance hierachy and gets the properties from the super classes as well.

getRequiredConstructorParameters

public Collection getRequiredConstructorParameters()

A collection containing all required and/or read-only 'properties' of the classifier. Properties are any attributes and navigable connecting association ends.

getSerialVersionUID

public Long getSerialVersionUID()

Returns the serial version UID of the underlying model element.

getStaticAttributes

public Collection getStaticAttributes()

Those attributes that are scoped to the definition of this class.

getStaticOperations

public Collection getStaticOperations()

Those operations that are scoped to the definition of this class.

getSuperClass

public ClassifierFacade getSuperClass()

This class' superclass, returns the generalization if it is a ClassifierFacade, null otherwise.

getWrapperName

public String getWrapperName()

The wrapper name for this classifier if a mapped type has a defined wrapper class (ie. 'long' maps to 'Long'). If the classifier doesn't have a wrapper defined for it, this method will return a null. Note that wrapper mappings must be defined for the namespace by defining the 'wrapperMappingsUri', this property must point to the location of the mappings file which maps the primitives to wrapper types.

isAbstract

public boolean isAbstract()

Indicates if this classifier is 'abstract'.

isArrayType

public boolean isArrayType()

True if this classifier represents an array type. False otherwise.

isAssociationClass

public boolean isAssociationClass()

isBlobType

public boolean isBlobType()

Returns true if this type represents a Blob type.

isBooleanType

public boolean isBooleanType()

Indicates if this type represents a boolean type or not.

isClobType

public boolean isClobType()

Returns true if this type represents a Clob type.

isCollectionType

public boolean isCollectionType()

True if this classifier represents a collection type. False otherwise.

isDataType

public boolean isDataType()

True/false depending on whether or not this classifier represents a datatype.

isDateType

public boolean isDateType()

True when this classifier is a date type.

isEnumeration

public boolean isEnumeration()

True if this classifier is in fact marked as an enumeration.

isFileType

public boolean isFileType()

Returns true if this type represents a 'file' type.

isInterface

public boolean isInterface()

True/false depending on whether or not this Classifier represents an interface.

isLeaf

public boolean isLeaf()

True if this classifier cannot be extended and represent a leaf in the inheritance tree.

isListType

public boolean isListType()

True if this classifier represents a list type. False otherwise.

isMapType

public boolean isMapType()

Indicates whether or not this classifier represents a Map type.

isPrimitive

public boolean isPrimitive()

Indicates whether or not this classifier represents a primitive type.

isSetType

public boolean isSetType()

True if this classifier represents a set type. False otherwise.

isStringType

public boolean isStringType()

Indicates whether or not this classifier represents a string type.

isTimeType

public boolean isTimeType()

Indicates whether or not this classifier represents a time type.