org.andromda.metafacades.uml14

Class EnumerationFacadeLogic

java.lang.Object

org.andromda.core.metafacade.MetafacadeBase

org.andromda.metafacades.uml14.ModelElementFacadeLogic

org.andromda.metafacades.uml14.ModelElementFacadeLogicImpl

org.andromda.metafacades.uml14.GeneralizableElementFacadeLogic

org.andromda.metafacades.uml14.GeneralizableElementFacadeLogicImpl

org.andromda.metafacades.uml14.ClassifierFacadeLogic

org.andromda.metafacades.uml14.ClassifierFacadeLogicImpl

org.andromda.metafacades.uml14.EnumerationFacadeLogic

All Implemented Interfaces:

Serializable, Comparable, ClassifierFacade, EnumerationFacade, GeneralizableElementFacade, ModelElementFacade

Direct Known Subclasses:

EnumerationFacadeLogicImpl

public abstract class EnumerationFacadeLogic
extends ClassifierFacadeLogicImpl
implements EnumerationFacade

Represents an enumeration. A data type whose values are enumerated in the model as enumeration literals. May also be a Classifier with Stereotype Enumeration. MetafacadeLogic for EnumerationFacade

See Also:

EnumerationFacade, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Object	metaObject The underlying UML object

Fields inherited from class org.andromda.core.metafacade.MetafacadeBase

contextRoot

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EnumerationFacadeLogic(Object metaObjectIn, String context) Create Metafacade implementation instance using the MetafacadeFactory from the context

Method Summary

Methods

Modifier and Type	Method and Description
String	getFromOperationName() The 'from' operation name.
String	getFromOperationSignature() The 'from' operation signature.
Collection<AttributeFacade>	getLiterals() If the attribute is an enumeration literal this represents the owning enumeration.
ClassifierFacade	getLiteralType() Represents an enumeration.
Collection<AttributeFacade>	getMemberVariables() Represents an enumeration.
protected abstract String	handleGetFromOperationName()
protected abstract String	handleGetFromOperationSignature()
protected abstract Collection	handleGetLiterals() UML Specific type is returned in Collection, transformed by shieldedElements to AndroMDA Metafacade type
protected abstract Object	handleGetLiteralType() UML Specific type is transformed by shieldedElements to AndroMDA Metafacade type
protected abstract Collection	handleGetMemberVariables() UML Specific type is returned in Collection, transformed by shieldedElements to AndroMDA Metafacade type
protected abstract boolean	handleIsTypeSafe()
boolean	isEnumerationFacadeMetaType()
boolean	isTypeSafe() Indicates whether the enumeration must be generated using a Java 5 type-safe enum or a traditional enumeration-pattern class.
void	resetMetafacadeContext(String context) Reset context only for non-root metafacades
void	validateInvariants(Collection<ModelValidationMessage> validationMessages) Constraint: org::andromda::metafacades::uml::EnumerationFacade::enumerations must have at least one literal value

Methods inherited from class org.andromda.metafacades.uml14.ClassifierFacadeLogicImpl

getOwner, getWrapperMappings, handleFindAttribute, handleGetAbstractions, handleGetAllAssociatedClasses, handleGetAllProperties, handleGetAllRequiredConstructorParameters, handleGetArray, handleGetArrayName, handleGetAssociatedClasses, handleGetAssociationEnds, handleGetAttributes, handleGetAttributes, handleGetFullyQualifiedArrayName, handleGetImplementationOperations, handleGetImplementedInterfaceList, handleGetInstanceAttributes, handleGetInstanceOperations, handleGetInterfaceAbstractions, handleGetJavaNewString, handleGetJavaNullString, handleGetName, handleGetNavigableConnectingEnds, handleGetNavigableConnectingEnds, handleGetNonArray, handleGetOperationCallFromAttributes, handleGetOperations, handleGetProperties, handleGetProperties, handleGetRequiredConstructorParameters, handleGetSerialVersionUID, handleGetStaticAttributes, handleGetStaticOperations, handleGetSuperClass, handleGetWrapperName, handleIsAbstract, handleIsArrayType, handleIsAssociationClass, handleIsBlobType, handleIsBooleanType, handleIsCharacterType, handleIsClobType, handleIsCollectionType, handleIsDataType, handleIsDateType, handleIsDoubleType, handleIsEmbeddedValue, handleIsEnumeration, handleIsFileType, handleIsFloatType, handleIsIntegerType, handleIsInterface, handleIsLeaf, handleIsListType, handleIsLongType, handleIsMapType, handleIsPrimitive, handleIsSetType, handleIsStringType, handleIsTimeType, handleIsWrappedPrimitive

Methods inherited from class org.andromda.metafacades.uml14.ClassifierFacadeLogic

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, isClassifierFacadeMetaType, isClobType, isCollectionType, isDataType, isDateType, isDoubleType, isEmbeddedValue, isEnumeration, isFileType, isFloatType, isIntegerType, isInterface, isLeaf, isListType, isLongType, isMapType, isPrimitive, isSetType, isStringType, isTimeType, isWrappedPrimitive

Methods inherited from class org.andromda.metafacades.uml14.GeneralizableElementFacadeLogicImpl

handleFindTaggedValue, handleGetAllGeneralizations, handleGetAllSpecializations, handleGetGeneralization, handleGetGeneralizationLinks, handleGetGeneralizationList, handleGetGeneralizationRoot, handleGetGeneralizations, handleGetSpecializations

Methods inherited from class org.andromda.metafacades.uml14.GeneralizableElementFacadeLogic

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

Methods inherited from class org.andromda.metafacades.uml14.ModelElementFacadeLogicImpl

getArraySuffix, getValidationName, handleCopyTaggedValues, handleFindTaggedValue, handleFindTaggedValues, handleGetBindedFullyQualifiedName, handleGetConstraints, handleGetConstraints, handleGetDocumentation, handleGetDocumentation, handleGetDocumentation, handleGetFullyQualifiedName, handleGetFullyQualifiedName, handleGetFullyQualifiedNamePath, handleGetId, handleGetKeywords, handleGetLabel, handleGetLanguageMappings, handleGetModel, handleGetOwnedElements, handleGetOwner, handleGetPackage, handleGetPackageName, handleGetPackageName, handleGetPackagePath, handleGetQualifiedName, handleGetRootPackage, handleGetSourceDependencies, handleGetStateMachineContext, handleGetStereotypeNames, handleGetStereotypes, handleGetTaggedValues, handleGetTargetDependencies, handleGetTemplateParameter, handleGetTemplateParameters, handleGetVisibility, handleHasExactStereotype, handleHasKeyword, handleHasStereotype, handleIsBindingDependenciesPresent, handleIsConstraintsPresent, handleIsDocumentationPresent, handleIsReservedWord, handleIsTemplateParametersPresent, handleIsValidIdentifierName, handleTranslateConstraint, handleTranslateConstraints, handleTranslateConstraints

Methods inherited from class org.andromda.metafacades.uml14.ModelElementFacadeLogic

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, getVisibility, hasExactStereotype, hasKeyword, hasStereotype, isBindingDependenciesPresent, isConstraintsPresent, isDocumentationPresent, isModelElementFacadeMetaType, isReservedWord, isTemplateParametersPresent, isValidIdentifierName, toString, translateConstraint, translateConstraints, translateConstraints

Methods inherited from class org.andromda.core.metafacade.MetafacadeBase

compareTo, equals, getConfiguredProperty, getDebug, getMetafacadeContext, getMetaObject, getValidationOwner, hashCode, initialize, isConfiguredProperty, isMetafacadePropertyCachingEnabled, setMetafacadeContext, setProperty, shieldedElement, shieldedElements, THIS, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

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, isClassifierFacadeMetaType, isClobType, isCollectionType, isDataType, isDateType, isDoubleType, isEmbeddedValue, isEnumeration, isFileType, isFloatType, isIntegerType, isInterface, isLeaf, isListType, isLongType, isMapType, isPrimitive, isSetType, isStringType, isTimeType, isWrappedPrimitive

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

Field Detail

metaObject

protected Object metaObject

The underlying UML object

See Also:

Object

Constructor Detail

EnumerationFacadeLogic

protected EnumerationFacadeLogic(Object metaObjectIn,
                      String context)

Create Metafacade implementation instance using the MetafacadeFactory from the context

Parameters:

metaObjectIn -

context -

Method Detail

resetMetafacadeContext

public void resetMetafacadeContext(String context)

Reset context only for non-root metafacades

Overrides:

resetMetafacadeContext in class ClassifierFacadeLogic

Parameters:

context -

isEnumerationFacadeMetaType

public boolean isEnumerationFacadeMetaType()

Specified by:

isEnumerationFacadeMetaType in interface EnumerationFacade

Returns:

boolean true always

See Also:

EnumerationFacade

handleGetFromOperationSignature

protected abstract String handleGetFromOperationSignature()

Returns:

String

See Also:

EnumerationFacade.getFromOperationSignature()

getFromOperationSignature

public final String getFromOperationSignature()

The 'from' operation signature. This is the signature that takes the actual literal value and allows a new enumeration to be constructed.

Specified by:

getFromOperationSignature in interface EnumerationFacade

Returns:

(String)handleGetFromOperationSignature()

handleGetFromOperationName

protected abstract String handleGetFromOperationName()

Returns:

String

See Also:

EnumerationFacade.getFromOperationName()

getFromOperationName

public final String getFromOperationName()

The 'from' operation name. This is the name of the operation that takes the actual literal value and allows a new enumeration to be constructed.

Specified by:

getFromOperationName in interface EnumerationFacade

Returns:

(String)handleGetFromOperationName()

handleIsTypeSafe

protected abstract boolean handleIsTypeSafe()

Returns:

boolean

See Also:

EnumerationFacade.isTypeSafe()

isTypeSafe

public final boolean isTypeSafe()

Indicates whether the enumeration must be generated using a Java 5 type-safe enum or a traditional enumeration-pattern class.

Specified by:

isTypeSafe in interface EnumerationFacade

Returns:

(boolean)handleIsTypeSafe()

getLiteralType

public final ClassifierFacade getLiteralType()

Represents an enumeration. A data type whose values are enumerated in the model as enumeration literals. May also be a Classifier with Stereotype Enumeration.

Specified by:

getLiteralType in interface EnumerationFacade

Returns:

(ClassifierFacade)handleGetLiteralType()

handleGetLiteralType

protected abstract Object handleGetLiteralType()

UML Specific type is transformed by shieldedElements to AndroMDA Metafacade type

Returns:

Object

getLiterals

public final Collection<AttributeFacade> getLiterals()

If the attribute is an enumeration literal this represents the owning enumeration. Can be empty.

Specified by:

getLiterals in interface EnumerationFacade

Returns:

(Collection)handleGetLiterals()

handleGetLiterals

protected abstract Collection handleGetLiterals()

UML Specific type is returned in Collection, transformed by shieldedElements to AndroMDA Metafacade type

Returns:

Collection

getMemberVariables

public final Collection<AttributeFacade> getMemberVariables()

Represents an enumeration. A data type whose values are enumerated in the model as enumeration literals. May also be a Classifier with Stereotype Enumeration.

Specified by:

getMemberVariables in interface EnumerationFacade

Returns:

(Collection)handleGetMemberVariables()

handleGetMemberVariables

protected abstract Collection handleGetMemberVariables()

UML Specific type is returned in Collection, transformed by shieldedElements to AndroMDA Metafacade type

Returns:

Collection

validateInvariants

public void validateInvariants(Collection<ModelValidationMessage> validationMessages)

Constraint: org::andromda::metafacades::uml::EnumerationFacade::enumerations must have at least one literal value

Error: An enumeration must have at least one literal modeled.

OCL: context EnumerationFacade inv: literals -> notEmpty()

Constraint: org::andromda::metafacades::uml::EnumerationFacade::name must be a valid identifier

Error: Model Element name cannot be a reserved word

OCL: context EnumerationFacade inv: validIdentifierName=true

Specified by:

validateInvariants in interface ModelElementFacade

Overrides:

validateInvariants in class ClassifierFacadeLogic

Parameters:

validationMessages - Collection

See Also:

ClassifierFacadeLogic.validateInvariants(Collection validationMessages)