org.andromda.metafacades.uml14

Class AttributeFacadeLogic

java.lang.Object

org.andromda.core.metafacade.MetafacadeBase

org.andromda.metafacades.uml14.ModelElementFacadeLogic

org.andromda.metafacades.uml14.ModelElementFacadeLogicImpl

org.andromda.metafacades.uml14.AttributeFacadeLogic

All Implemented Interfaces:

Serializable, Comparable, AttributeFacade, ModelElementFacade

Direct Known Subclasses:

AttributeFacadeLogicImpl

public abstract class AttributeFacadeLogic
extends ModelElementFacadeLogicImpl
implements AttributeFacade

Represents an attribute on a classifier. UML2 maps both Attributes and AssociationEnds to Property. A property is a structural feature of a classifier that characterizes instances of the classifier. A property related by ownedAttribute to a classifier (other than an association) represents an attribute and might also represent an association end. It relates an instance of the class to a value or set of values of the type of the attribute. A property represents a set of instances that are owned by a containing classifier instance. Property represents a declared state of one or more instances in terms of a named relationship to a value or values. When a property is an attribute of a classifier, the value or values are related to the instance of the classifier by being held in slots of the instance. The range of valid values represented by the property can be controlled by setting the property's type. MetafacadeLogic for AttributeFacade

See Also:

AttributeFacade, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected org.omg.uml.foundation.core.Attribute	metaObject The underlying UML object

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

contextRoot

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AttributeFacadeLogic(org.omg.uml.foundation.core.Attribute metaObjectIn, String context) Create Metafacade implementation instance using the MetafacadeFactory from the context

Method Summary

Methods

Modifier and Type	Method and Description
Object	findTaggedValue(String name, boolean follow) Searches the given feature for the specified tag.
String	getDefaultValue() The default value of the attribute.
EnumerationFacade	getEnumeration() This enumeration's literals.
String	getEnumerationLiteralParameters() Returns the enumeration literal parameters defined by tagged value as a comma separated list.
String	getEnumerationValue() The value for this attribute if it is an enumeration literal, null otherwise.
String	getGetterName() The name of the accessor operation that would retrieve this attribute's value.
String	getGetterSetterTypeName() The name of the type that is returned on the accessor and mutator operations, determined in part by the multiplicity.
int	getLower() the lower value for the multiplicity -only applicable for UML2
ClassifierFacade	getOwner() Gets the attributes that belong to the classifier.
String	getSetterName() The name of the mutator operation that would retrieve this attribute's value.
ClassifierFacade	getType() Represents an attribute on a classifier.
int	getUpper() the upper value for the multiplicity (will be -1 for *) -only applicable for UML2
protected abstract Object	handleFindTaggedValue(String name, boolean follow) Method to be implemented in descendants Searches the given feature for the specified tag.
protected abstract String	handleGetDefaultValue()
protected abstract Object	handleGetEnumeration() UML Specific type is transformed by shieldedElements to AndroMDA Metafacade type
protected abstract String	handleGetEnumerationLiteralParameters()
protected abstract String	handleGetEnumerationValue()
protected abstract String	handleGetGetterName()
protected abstract String	handleGetGetterSetterTypeName()
protected abstract int	handleGetLower()
protected abstract Object	handleGetOwner() UML Specific type is transformed by shieldedElements to AndroMDA Metafacade type
protected abstract String	handleGetSetterName()
protected abstract Object	handleGetType() UML Specific type is transformed by shieldedElements to AndroMDA Metafacade type
protected abstract int	handleGetUpper()
protected abstract boolean	handleIsAddOnly()
protected abstract boolean	handleIsChangeable()
protected abstract boolean	handleIsDefaultValuePresent()
protected abstract boolean	handleIsDerived()
protected abstract boolean	handleIsEnumerationLiteral()
protected abstract boolean	handleIsEnumerationLiteralParametersExist()
protected abstract boolean	handleIsEnumerationMember()
protected abstract boolean	handleIsLeaf()
protected abstract boolean	handleIsMany()
protected abstract boolean	handleIsOrdered()
protected abstract boolean	handleIsReadOnly()
protected abstract boolean	handleIsRequired()
protected abstract boolean	handleIsStatic()
protected abstract boolean	handleIsUnique()
boolean	isAddOnly() True if this attribute can only be set.
boolean	isAttributeFacadeMetaType()
boolean	isChangeable() True if this attribute can be modified.
boolean	isDefaultValuePresent() Indicates if the default value is present.
boolean	isDerived() If the attribute is derived (its value is computed).
boolean	isEnumerationLiteral() True if this attribute is owned by an enumeration.
boolean	isEnumerationLiteralParametersExist() Returns true if enumeration literal parameters exist (defined by tagged value) for the literal.
boolean	isEnumerationMember() True if this attribute is owned by an enumeration but is defined as a member variable (NOT a literal).
boolean	isLeaf() IsLeaf property in the operation.
boolean	isMany() Whether or not this attribute has a multiplicity greater than 1.
boolean	isOrdered() Indicates whether or not the attributes are ordered (if multiplicity is greater than 1).
boolean	isReadOnly() Whether or not this attribute can be modified.
boolean	isRequired() Whether or not the multiplicity of this attribute is 1.
boolean	isStatic() Indicates if this attribute is 'static', meaning it has a classifier scope.
boolean	isUnique() If the attribute is unique within the Collection type.
void	resetMetafacadeContext(String context) Reset context only for non-root metafacades
void	validateInvariants(Collection<ModelValidationMessage> validationMessages) Constraint: org::andromda::metafacades::uml::AttributeFacade::attribute needs a type

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, handleGetName, handleGetOwnedElements, 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.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 org.omg.uml.foundation.core.Attribute metaObject

The underlying UML object

See Also:

Attribute

Constructor Detail

AttributeFacadeLogic

protected AttributeFacadeLogic(org.omg.uml.foundation.core.Attribute 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 ModelElementFacadeLogic

Parameters:

context -

isAttributeFacadeMetaType

public boolean isAttributeFacadeMetaType()

Specified by:

isAttributeFacadeMetaType in interface AttributeFacade

Returns:

boolean true always

See Also:

AttributeFacade

handleGetGetterName

protected abstract String handleGetGetterName()

Returns:

String

See Also:

AttributeFacade.getGetterName()

getGetterName

public final String getGetterName()

The name of the accessor operation that would retrieve this attribute's value.

Specified by:

getGetterName in interface AttributeFacade

Returns:

(String)handleGetGetterName()

handleGetSetterName

protected abstract String handleGetSetterName()

Returns:

String

See Also:

AttributeFacade.getSetterName()

getSetterName

public final String getSetterName()

The name of the mutator operation that would retrieve this attribute's value.

Specified by:

getSetterName in interface AttributeFacade

Returns:

(String)handleGetSetterName()

handleIsReadOnly

protected abstract boolean handleIsReadOnly()

Returns:

boolean

See Also:

AttributeFacade.isReadOnly()

isReadOnly

public final boolean isReadOnly()

Whether or not this attribute can be modified.

Specified by:

isReadOnly in interface AttributeFacade

Returns:

(boolean)handleIsReadOnly()

handleGetDefaultValue

protected abstract String handleGetDefaultValue()

Returns:

String

See Also:

AttributeFacade.getDefaultValue()

getDefaultValue

public final String getDefaultValue()

The default value of the attribute. This is the value given if no value is defined.

Specified by:

getDefaultValue in interface AttributeFacade

Returns:

(String)handleGetDefaultValue()

handleIsStatic

protected abstract boolean handleIsStatic()

Returns:

boolean

See Also:

AttributeFacade.isStatic()

isStatic

public final boolean isStatic()

Indicates if this attribute is 'static', meaning it has a classifier scope.

Specified by:

isStatic in interface AttributeFacade

Returns:

(boolean)handleIsStatic()

handleIsRequired

protected abstract boolean handleIsRequired()

Returns:

boolean

See Also:

AttributeFacade.isRequired()

isRequired

public final boolean isRequired()

Whether or not the multiplicity of this attribute is 1.

Specified by:

isRequired in interface AttributeFacade

Returns:

(boolean)handleIsRequired()

handleIsMany

protected abstract boolean handleIsMany()

Returns:

boolean

See Also:

AttributeFacade.isMany()

isMany

public final boolean isMany()

Whether or not this attribute has a multiplicity greater than 1.

Specified by:

isMany in interface AttributeFacade

Returns:

(boolean)handleIsMany()

handleIsChangeable

protected abstract boolean handleIsChangeable()

Returns:

boolean

See Also:

AttributeFacade.isChangeable()

isChangeable

public final boolean isChangeable()

True if this attribute can be modified.

Specified by:

isChangeable in interface AttributeFacade

Returns:

(boolean)handleIsChangeable()

handleIsAddOnly

protected abstract boolean handleIsAddOnly()

Returns:

boolean

See Also:

AttributeFacade.isAddOnly()

isAddOnly

public final boolean isAddOnly()

True if this attribute can only be set.

Specified by:

isAddOnly in interface AttributeFacade

Returns:

(boolean)handleIsAddOnly()

handleIsEnumerationLiteral

protected abstract boolean handleIsEnumerationLiteral()

Returns:

boolean

See Also:

AttributeFacade.isEnumerationLiteral()

isEnumerationLiteral

public final boolean isEnumerationLiteral()

True if this attribute is owned by an enumeration.

Specified by:

isEnumerationLiteral in interface AttributeFacade

Returns:

(boolean)handleIsEnumerationLiteral()

handleGetEnumerationValue

protected abstract String handleGetEnumerationValue()

Returns:

String

See Also:

AttributeFacade.getEnumerationValue()

getEnumerationValue

public final String getEnumerationValue()

The value for this attribute if it is an enumeration literal, null otherwise. The default value is returned as a String if it has been specified, if it's not specified this attribute's name is assumed.

Specified by:

getEnumerationValue in interface AttributeFacade

Returns:

(String)handleGetEnumerationValue()

handleGetGetterSetterTypeName

protected abstract String handleGetGetterSetterTypeName()

Returns:

String

See Also:

AttributeFacade.getGetterSetterTypeName()

getGetterSetterTypeName

public final String getGetterSetterTypeName()

The name of the type that is returned on the accessor and mutator operations, determined in part by the multiplicity.

Specified by:

getGetterSetterTypeName in interface AttributeFacade

Returns:

(String)handleGetGetterSetterTypeName()

handleIsOrdered

protected abstract boolean handleIsOrdered()

Returns:

boolean

See Also:

AttributeFacade.isOrdered()

isOrdered

public final boolean isOrdered()

Indicates whether or not the attributes are ordered (if multiplicity is greater than 1).

Specified by:

isOrdered in interface AttributeFacade

Returns:

(boolean)handleIsOrdered()

handleIsDefaultValuePresent

protected abstract boolean handleIsDefaultValuePresent()

Returns:

boolean

See Also:

AttributeFacade.isDefaultValuePresent()

isDefaultValuePresent

public final boolean isDefaultValuePresent()

Indicates if the default value is present.

Specified by:

isDefaultValuePresent in interface AttributeFacade

Returns:

(boolean)handleIsDefaultValuePresent()

handleGetUpper

protected abstract int handleGetUpper()

Returns:

int

See Also:

AttributeFacade.getUpper()

getUpper

public final int getUpper()

the upper value for the multiplicity (will be -1 for *) -only applicable for UML2

Specified by:

getUpper in interface AttributeFacade

Returns:

(int)handleGetUpper()

handleGetLower

protected abstract int handleGetLower()

Returns:

int

See Also:

AttributeFacade.getLower()

getLower

public final int getLower()

the lower value for the multiplicity -only applicable for UML2

Specified by:

getLower in interface AttributeFacade

Returns:

(int)handleGetLower()

handleIsEnumerationMember

protected abstract boolean handleIsEnumerationMember()

Returns:

boolean

See Also:

AttributeFacade.isEnumerationMember()

isEnumerationMember

public final boolean isEnumerationMember()

True if this attribute is owned by an enumeration but is defined as a member variable (NOT a literal).

Specified by:

isEnumerationMember in interface AttributeFacade

Returns:

(boolean)handleIsEnumerationMember()

handleGetEnumerationLiteralParameters

protected abstract String handleGetEnumerationLiteralParameters()

Returns:

String

See Also:

AttributeFacade.getEnumerationLiteralParameters()

getEnumerationLiteralParameters

public final String getEnumerationLiteralParameters()

Returns the enumeration literal parameters defined by tagged value as a comma separated list.

Specified by:

getEnumerationLiteralParameters in interface AttributeFacade

Returns:

(String)handleGetEnumerationLiteralParameters()

handleIsEnumerationLiteralParametersExist

protected abstract boolean handleIsEnumerationLiteralParametersExist()

Returns:

boolean

See Also:

AttributeFacade.isEnumerationLiteralParametersExist()

isEnumerationLiteralParametersExist

public final boolean isEnumerationLiteralParametersExist()

Returns true if enumeration literal parameters exist (defined by tagged value) for the literal.

Specified by:

isEnumerationLiteralParametersExist in interface AttributeFacade

Returns:

(boolean)handleIsEnumerationLiteralParametersExist()

handleIsUnique

protected abstract boolean handleIsUnique()

Returns:

boolean

See Also:

AttributeFacade.isUnique()

isUnique

public final boolean isUnique()

If the attribute is unique within the Collection type. UML2 only. UML14 always returns false. Unique+Ordered determines the implementation Collection type. Default=false.

Specified by:

isUnique in interface AttributeFacade

Returns:

(boolean)handleIsUnique()

handleIsLeaf

protected abstract boolean handleIsLeaf()

Returns:

boolean

See Also:

AttributeFacade.isLeaf()

isLeaf

public final boolean isLeaf()

IsLeaf property in the operation. If true, operation is final, cannot be extended or implemented by a descendant.

Specified by:

isLeaf in interface AttributeFacade

Returns:

(boolean)handleIsLeaf()

handleIsDerived

protected abstract boolean handleIsDerived()

Returns:

boolean

See Also:

AttributeFacade.isDerived()

isDerived

public final boolean isDerived()

If the attribute is derived (its value is computed). UML2 only. UML14 always returns false. Default=false.

Specified by:

isDerived in interface AttributeFacade

Returns:

(boolean)handleIsDerived()

handleFindTaggedValue

protected abstract Object handleFindTaggedValue(String name,
                           boolean follow)

Method to be implemented in descendants Searches the given feature for the specified tag. If the follow boolean is set to true then the search will continue from the class attribute to the class itself and then up the class hierarchy.

Parameters:

name -

follow -

Returns:

Object

findTaggedValue

public Object findTaggedValue(String name,
                     boolean follow)

Searches the given feature for the specified tag. If the follow boolean is set to true then the search will continue from the class attribute to the class itself and then up the class hierarchy.

Specified by:

findTaggedValue in interface AttributeFacade

Parameters:

name - String The name of the tagged value to find.

follow - boolean If true search should 'follow' the inheritance hierarchy, false otherwise.

Returns:

handleFindTaggedValue(name, follow)

getType

public final ClassifierFacade getType()

Represents an attribute on a classifier. UML2 maps both Attributes and AssociationEnds to Property. A property is a structural feature of a classifier that characterizes instances of the classifier. A property related by ownedAttribute to a classifier (other than an association) represents an attribute and might also represent an association end. It relates an instance of the class to a value or set of values of the type of the attribute. A property represents a set of instances that are owned by a containing classifier instance. Property represents a declared state of one or more instances in terms of a named relationship to a value or values. When a property is an attribute of a classifier, the value or values are related to the instance of the classifier by being held in slots of the instance. The range of valid values represented by the property can be controlled by setting the property's type.

Specified by:

getType in interface AttributeFacade

Returns:

(ClassifierFacade)handleGetType()

handleGetType

protected abstract Object handleGetType()

UML Specific type is transformed by shieldedElements to AndroMDA Metafacade type

Returns:

Object

getEnumeration

public final EnumerationFacade getEnumeration()

This enumeration's literals.

Specified by:

getEnumeration in interface AttributeFacade

Returns:

(EnumerationFacade)handleGetEnumeration()

handleGetEnumeration

protected abstract Object handleGetEnumeration()

UML Specific type is transformed by shieldedElements to AndroMDA Metafacade type

Returns:

Object

getOwner

public final ClassifierFacade getOwner()

Gets the attributes that belong to the classifier.

Specified by:

getOwner in interface AttributeFacade

Returns:

(ClassifierFacade)handleGetOwner()

handleGetOwner

protected abstract Object handleGetOwner()

UML Specific type is transformed by shieldedElements to AndroMDA Metafacade type

Overrides:

handleGetOwner in class ModelElementFacadeLogicImpl

Returns:

Object

See Also:

ModelElementFacade.getPackage()

validateInvariants

public void validateInvariants(Collection<ModelValidationMessage> validationMessages)

Constraint: org::andromda::metafacades::uml::AttributeFacade::attribute needs a type

Error: Each attribute needs a type, you cannot leave the type unspecified.

OCL: context AttributeFacade inv: type.name->notEmpty()

Constraint: org::andromda::metafacades::uml::AttributeFacade::attribute must have a name

Error: Each attribute must have a non-empty name.

OCL: context AttributeFacade inv: name -> notEmpty()

Constraint: org::andromda::metafacades::uml::AttributeFacade::primitive attribute must be required

Error: Primitive attributes must have a multiplicity lower bound > 0 (must be required). Use a wrapped type, or change the multiplicity.

OCL: context AttributeFacade inv: type.primitive implies (lower > 0)

Constraint: org::andromda::metafacades::uml::AttributeFacade::primitive attribute cannot be used in Collection

Error: Primitive attributes cannot be used in Collections (multiplicity > 1). Use the wrapped type instead.

OCL: context AttributeFacade inv: type.primitive implies (many = false)

Constraint: org::andromda::metafacades::uml::AttributeFacade::wrapped primitive attribute should not be required

Error: Wrapped primitive attributes must have a multiplicity lower bound = 0 (must be optional). Use the unwrapped type, or change the multiplicity.

OCL: context AttributeFacade inv: type.wrappedPrimitive and many = false implies (lower = 0)

Specified by:

validateInvariants in interface ModelElementFacade

Overrides:

validateInvariants in class ModelElementFacadeLogic

Parameters:

validationMessages - Collection

See Also:

ModelElementFacadeLogic.validateInvariants(Collection validationMessages)