ClassifierFacade (AndroMDA UML Common Metafacades 3.5-SNAPSHOT API)

All Superinterfaces:

GeneralizableElementFacade, ModelElementFacade

All Known Subinterfaces:

ActorFacade, AssociationClassFacade, Destination, Entity, EnumerationFacade, FrontEndController, FrontEndUseCase, ManageableEntity, NamespaceFacade, NodeFacade, Queue, Role, Service, Topic, UseCaseFacade, ValueObject
```
public interface ClassifierFacade
extends GeneralizableElementFacade
```
A Classifier is a classification of instances - it describes a set of instances that have features in common. Can specify a generalization hierarchy by referencing its general classifiers. It may be a Class, DataType, PrimitiveType, Association, Collaboration, UseCase, etc. Can specify a generalization hierarchy by referencing its general classifiers. Has the capability to own collaboration uses. These collaboration uses link a collaboration with the classifier to give a description of the workings of the classifier. Classifier is defined to be a kind of templateable element so that a classifier can be parameterized. It is also defined to be a kind of parameterable element so that a classifier can be a formal template parameter. Metafacade interface to be used by AndroMDA cartridges.

Method Summary

Methods
Modifier and Type	Method and Description
`AttributeFacade`	`findAttribute(String name)` Return the attribute which name matches the parameter
`Collection<ClassifierFacade>`	`getAbstractions()` Those abstraction dependencies for which this classifier is the client.
`Collection<ClassifierFacade>`	`getAllAssociatedClasses()` Lists all classes associated to this one and any ancestor classes (through generalization).
`Collection<ModelElementFacade>`	`getAllProperties()` A collection containing all 'properties' of the classifier and its ancestors.
`Collection<ModelElementFacade>`	`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<ClassifierFacade>`	`getAssociatedClasses()` Lists the classes associated to this one, there is no repitition of classes.
`List<AssociationEndFacade>`	`getAssociationEnds()` Gets the association ends belonging to a classifier.
`List<AttributeFacade>`	`getAttributes()` Gets the attributes that belong to the classifier.
`List<AttributeFacade>`	`getAttributes(boolean follow)` Gets all attributes for the classifier and if 'follow' is true goes up the inheritance hierarchy and gets the attributes from the super classes as well.
`String`	`getFullyQualifiedArrayName()` The fully qualified name of the classifier as an array.
`Collection<OperationFacade>`	`getImplementationOperations()` Returns all those operations that could be implemented at this classifier's level.
`String`	`getImplementedInterfaceList()` A comma separated list of the fully qualified names of all implemented interfaces.
`Collection<AttributeFacade>`	`getInstanceAttributes()` Those attributes that are scoped to an instance of this class.
`List<OperationFacade>`	`getInstanceOperations()` Those operations that are scoped to an instance of this class.
`Collection<ClassifierFacade>`	`getInterfaceAbstractions()` Those interfaces that are abstractions of this classifier, this basically means this classifier realizes them.
`String`	`getJavaNewString()` A String representing a new Constructor declaration for this classifier type to be used in a Java environment.
`String`	`getJavaNullString()` A String representing the null-value for this classifier type to be used in a Java environment.
`Collection<AssociationEndFacade>`	`getNavigableConnectingEnds()` The other ends of this classifier's association ends which are navigable.
`List<AssociationEndFacade>`	`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 the model.
`String`	`getOperationCallFromAttributes()` The attributes from this classifier in the form of an operation call (this example would be in Java): '(String attributeOne, String attributeTwo).
`List<OperationFacade>`	`getOperations()` The operations owned by this classifier.
`List<ModelElementFacade>`	`getProperties()` A collection containing all 'properties' of the classifier.
`List`	`getProperties(boolean follow)` Gets all properties (attributes and navigable association ends) for the classifier and if 'follow' is true goes up the inheritance hierarchy and gets the properties from the super classes as well.
`Collection<ModelElementFacade>`	`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<AttributeFacade>`	`getStaticAttributes()` Those attributes that are scoped to the definition of this class.
`List<OperationFacade>`	`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()` True if the ClassifierFacade is an AssociationClass.
`boolean`	`isBlobType()` Returns true if this type represents a Blob type.
`boolean`	`isBooleanType()` Indicates if this type represents a boolean type or not.
`boolean`	`isCharacterType()` Indicates if this type represents a char, Character, or java.lang.Character 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`	`isDoubleType()` Indicates if this type represents a Double type or not.
`boolean`	`isEmbeddedValue()` Indicates whether or not this classifier represents an "EmbeddedValue'.
`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`	`isFloatType()` Indicates if this type represents a Float type or not.
`boolean`	`isIntegerType()` Indicates if this type represents an int or Integer or java.lang.Integer type or not.
`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`	`isLongType()` Indicates if this type represents a Long type or not.
`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.
`boolean`	`isWrappedPrimitive()` Returns true if this type is a wrapped primitive 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, getBindedFullyQualifiedName, getConstraints, getConstraints, getDocumentation, getDocumentation, getDocumentation, getFullyQualifiedName, getFullyQualifiedName, getFullyQualifiedNamePath, getId, getKeywords, getLabel, getLanguageMappings, getModel, getName, getPackage, getPackageName, getPackageName, getPackagePath, getQualifiedName, getRootPackage, getSourceDependencies, getStateMachineContext, getStereotypeNames, getStereotypes, getTaggedValues, getTargetDependencies, getTemplateParameter, getTemplateParameters, getValidationName, getValidationOwner, getVisibility, hasExactStereotype, hasKeyword, hasStereotype, initialize, isBindingDependenciesPresent, isConstraintsPresent, isDocumentationPresent, isModelElementFacadeMetaType, isReservedWord, isTemplateParametersPresent, isValidIdentifierName, translateConstraint, translateConstraints, translateConstraints, validateInvariants

- Method Detail
  - isClassifierFacadeMetaType
```
boolean isClassifierFacadeMetaType()
```
    Indicates the metafacade type (used for metafacade mappings).
    
    Returns:
    boolean always true
  - findAttribute
```
AttributeFacade findAttribute(String name)
```
    Return the attribute which name matches the parameter
    
    Parameters:
    name - String
    
    Returns:
    AttributeFacade
  - getAbstractions
```
Collection<ClassifierFacade> getAbstractions()
```
    Those abstraction dependencies for which this classifier is the client.
    
    Returns:
    Collection
  - getAllAssociatedClasses
```
Collection<ClassifierFacade> 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.
    
    Returns:
    Collection
  - getAllProperties
```
Collection<ModelElementFacade> getAllProperties()
```
    A collection containing all 'properties' of the classifier and its ancestors. Properties are any attributes and navigable connecting association ends.
    
    Returns:
    Collection
  - getAllRequiredConstructorParameters
```
Collection<ModelElementFacade> 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.
    
    Returns:
    Collection
  - getArray
```
ClassifierFacade getArray()
```
    Gets the array type for this classifier. If this classifier already represents an array, it just returns itself.
    
    Returns:
    ClassifierFacade
  - getArrayName
```
String getArrayName()
```
    The name of the classifier as an array.
    
    Returns:
    String
  - getAssociatedClasses
```
Collection<ClassifierFacade> getAssociatedClasses()
```
    Lists the classes associated to this one, there is no repitition of classes. The order of the elements is predictable.
    
    Returns:
    Collection
  - getAssociationEnds
```
List<AssociationEndFacade> getAssociationEnds()
```
    Gets the association ends belonging to a classifier.
    
    Returns:
    List
  - getAttributes
```
List<AttributeFacade> getAttributes()
```
    Gets the attributes that belong to the classifier.
    
    Returns:
    List
  - getAttributes
```
List<AttributeFacade> getAttributes(boolean follow)
```
    Gets all attributes for the classifier and if 'follow' is true goes up the inheritance hierarchy and gets the attributes from the super classes as well.
    
    Parameters:
    follow - boolean
    
    Returns:
    List
  - getFullyQualifiedArrayName
```
String getFullyQualifiedArrayName()
```
    The fully qualified name of the classifier as an array.
    
    Returns:
    String
  - getImplementationOperations
```
Collection<OperationFacade> 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.
    
    Returns:
    Collection
  - getImplementedInterfaceList
```
String getImplementedInterfaceList()
```
    A comma separated list of the fully qualified names of all implemented interfaces.
    
    Returns:
    String
  - getInstanceAttributes
```
Collection<AttributeFacade> getInstanceAttributes()
```
    Those attributes that are scoped to an instance of this class.
    
    Returns:
    Collection
  - getInstanceOperations
```
List<OperationFacade> getInstanceOperations()
```
    Those operations that are scoped to an instance of this class.
    
    Returns:
    List
  - getInterfaceAbstractions
```
Collection<ClassifierFacade> getInterfaceAbstractions()
```
    Those interfaces that are abstractions of this classifier, this basically means this classifier realizes them.
    
    Returns:
    Collection
  - getJavaNewString
```
String getJavaNewString()
```
    A String representing a new Constructor declaration for this classifier type to be used in a Java environment.
    
    Returns:
    String
  - getJavaNullString
```
String getJavaNullString()
```
    A String representing the null-value for this classifier type to be used in a Java environment.
    
    Returns:
    String
  - getNavigableConnectingEnds
```
Collection<AssociationEndFacade> getNavigableConnectingEnds()
```
    The other ends of this classifier's association ends which are navigable.
    
    Returns:
    Collection
  - getNavigableConnectingEnds
```
List<AssociationEndFacade> 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.
    
    Parameters:
    follow - boolean
    
    Returns:
    List
  - getNonArray
```
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.
    
    Returns:
    ClassifierFacade
  - getOperationCallFromAttributes
```
String getOperationCallFromAttributes()
```
    The attributes from this classifier in the form of an operation call (this example would be in Java): '(String attributeOne, String attributeTwo). If there were no attributes on the classifier, the result would be an empty '()'.
    
    Returns:
    String
  - getOperations
```
List<OperationFacade> getOperations()
```
    The operations owned by this classifier.
    
    Returns:
    List
  - getProperties
```
List<ModelElementFacade> getProperties()
```
    A collection containing all 'properties' of the classifier. Properties are any attributes and navigable connecting association ends.
    
    Returns:
    List
  - getProperties
```
List getProperties(boolean follow)
```
    Gets all properties (attributes and navigable association ends) for the classifier and if 'follow' is true goes up the inheritance hierarchy and gets the properties from the super classes as well.
    
    Parameters:
    follow - boolean
    
    Returns:
    List
  - getRequiredConstructorParameters
```
Collection<ModelElementFacade> getRequiredConstructorParameters()
```
    A collection containing all required and/or read-only 'properties' of the classifier. Properties are any attributes and navigable connecting association ends.
    
    Returns:
    Collection
  - getSerialVersionUID
```
long getSerialVersionUID()
```
    Returns the serial version UID of the underlying model element.
    
    Returns:
    long
  - getStaticAttributes
```
Collection<AttributeFacade> getStaticAttributes()
```
    Those attributes that are scoped to the definition of this class.
    
    Returns:
    Collection
  - getStaticOperations
```
List<OperationFacade> getStaticOperations()
```
    Those operations that are scoped to the definition of this class.
    
    Returns:
    List
  - getSuperClass
```
ClassifierFacade getSuperClass()
```
    This class' superclass, returns the generalization if it is a ClassifierFacade, null otherwise.
    
    Returns:
    ClassifierFacade
  - getWrapperName
```
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.
    
    Returns:
    String
  - isAbstract
```
boolean isAbstract()
```
    Indicates if this classifier is 'abstract'.
    
    Returns:
    boolean
  - isArrayType
```
boolean isArrayType()
```
    True if this classifier represents an array type. False otherwise.
    
    Returns:
    boolean
  - isAssociationClass
```
boolean isAssociationClass()
```
    True if the ClassifierFacade is an AssociationClass.
    
    Returns:
    boolean
  - isBlobType
```
boolean isBlobType()
```
    Returns true if this type represents a Blob type.
    
    Returns:
    boolean
  - isBooleanType
```
boolean isBooleanType()
```
    Indicates if this type represents a boolean type or not.
    
    Returns:
    boolean
  - isCharacterType
```
boolean isCharacterType()
```
    Indicates if this type represents a char, Character, or java.lang.Character type or not.
    
    Returns:
    boolean
  - isClobType
```
boolean isClobType()
```
    Returns true if this type represents a Clob type.
    
    Returns:
    boolean
  - isCollectionType
```
boolean isCollectionType()
```
    True if this classifier represents a collection type. False otherwise.
    
    Returns:
    boolean
  - isDataType
```
boolean isDataType()
```
    True/false depending on whether or not this classifier represents a datatype. A data type is a type whose instances are identified only by their value. A data type may contain attributes to support the modeling of structured data types.
    
    Returns:
    boolean
  - isDateType
```
boolean isDateType()
```
    True when this classifier is a date type.
    
    Returns:
    boolean
  - isDoubleType
```
boolean isDoubleType()
```
    Indicates if this type represents a Double type or not.
    
    Returns:
    boolean
  - isEmbeddedValue
```
boolean isEmbeddedValue()
```
    Indicates whether or not this classifier represents an "EmbeddedValue'.
    
    Returns:
    boolean
  - isEnumeration
```
boolean isEnumeration()
```
    True if this classifier is in fact marked as an enumeration.
    
    Returns:
    boolean
  - isFileType
```
boolean isFileType()
```
    Returns true if this type represents a 'file' type.
    
    Returns:
    boolean
  - isFloatType
```
boolean isFloatType()
```
    Indicates if this type represents a Float type or not.
    
    Returns:
    boolean
  - isIntegerType
```
boolean isIntegerType()
```
    Indicates if this type represents an int or Integer or java.lang.Integer type or not.
    
    Returns:
    boolean
  - isInterface
```
boolean isInterface()
```
    True/false depending on whether or not this Classifier represents an interface.
    
    Returns:
    boolean
  - isLeaf
```
boolean isLeaf()
```
    True if this classifier cannot be extended and represent a leaf in the inheritance tree.
    
    Returns:
    boolean
  - isListType
```
boolean isListType()
```
    True if this classifier represents a list type. False otherwise.
    
    Returns:
    boolean
  - isLongType
```
boolean isLongType()
```
    Indicates if this type represents a Long type or not.
    
    Returns:
    boolean
  - isMapType
```
boolean isMapType()
```
    Indicates whether or not this classifier represents a Map type.
    
    Returns:
    boolean
  - isPrimitive
```
boolean isPrimitive()
```
    Indicates whether or not this classifier represents a primitive type.
    
    Returns:
    boolean
  - isSetType
```
boolean isSetType()
```
    True if this classifier represents a set type. False otherwise.
    
    Returns:
    boolean
  - isStringType
```
boolean isStringType()
```
    Indicates whether or not this classifier represents a string type.
    
    Returns:
    boolean
  - isTimeType
```
boolean isTimeType()
```
    Indicates whether or not this classifier represents a time type.
    
    Returns:
    boolean
  - isWrappedPrimitive
```
boolean isWrappedPrimitive()
```
    Returns true if this type is a wrapped primitive type.
    
    Returns:
    boolean

Interface ClassifierFacade

Method Summary

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

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

Method Detail

isClassifierFacadeMetaType

findAttribute

getAbstractions

getAllAssociatedClasses

getAllProperties

getAllRequiredConstructorParameters

getArray

getArrayName

getAssociatedClasses

getAssociationEnds

getAttributes

getAttributes

getFullyQualifiedArrayName

getImplementationOperations

getImplementedInterfaceList

getInstanceAttributes

getInstanceOperations

getInterfaceAbstractions

getJavaNewString

getJavaNullString

getNavigableConnectingEnds

getNavigableConnectingEnds

getNonArray

getOperationCallFromAttributes

getOperations

getProperties

getProperties

getRequiredConstructorParameters

getSerialVersionUID

getStaticAttributes

getStaticOperations

getSuperClass

getWrapperName

isAbstract

isArrayType

isAssociationClass

isBlobType

isBooleanType

isCharacterType

isClobType

isCollectionType

isDataType

isDateType

isDoubleType

isEmbeddedValue

isEnumeration

isFileType

isFloatType

isIntegerType

isInterface

isLeaf

isListType

isLongType

isMapType

isPrimitive

isSetType

isStringType

isTimeType

isWrappedPrimitive