org.andromda.metafacades.uml

Interface AttributeFacade

All Superinterfaces:

ModelElementFacade

All Known Subinterfaces:

EntityAttribute, ManageableEntityAttribute

public interface AttributeFacade
extends ModelElementFacade

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. Metafacade interface to be used by AndroMDA cartridges.

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() If the attribute is an enumeration literal this represents the owning enumeration.
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 classifier who is the owner of the attributes.
String	getSetterName() The name of the mutator operation that would retrieve this attribute's value.
ClassifierFacade	getType() The classifier owning this attribute.
int	getUpper() the upper value for the multiplicity (will be -1 for *) -only applicable for UML2
boolean	isAddOnly() True if this attribute can only be set.
boolean	isAttributeFacadeMetaType() Indicates the metafacade type (used for metafacade mappings).
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.

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

isAttributeFacadeMetaType

boolean isAttributeFacadeMetaType()

Indicates the metafacade type (used for metafacade mappings).

Returns:

boolean always true

findTaggedValue

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.

Parameters:

name - String

follow - boolean

Returns:

Object

getDefaultValue

String getDefaultValue()

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

Returns:

String

getEnumeration

EnumerationFacade getEnumeration()

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

Returns:

EnumerationFacade

getEnumerationLiteralParameters

String getEnumerationLiteralParameters()

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

Returns:

String

getEnumerationValue

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.

Returns:

String

getGetterName

String getGetterName()

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

Returns:

String

getGetterSetterTypeName

String getGetterSetterTypeName()

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

Returns:

String

getLower

int getLower()

the lower value for the multiplicity -only applicable for UML2

Returns:

int

getOwner

ClassifierFacade getOwner()

Gets the classifier who is the owner of the attributes.

Returns:

ClassifierFacade

getSetterName

String getSetterName()

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

Returns:

String

getType

ClassifierFacade getType()

The classifier owning this attribute.

Returns:

ClassifierFacade

getUpper

int getUpper()

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

Returns:

int

isAddOnly

boolean isAddOnly()

True if this attribute can only be set.

Returns:

boolean

isChangeable

boolean isChangeable()

True if this attribute can be modified.

Returns:

boolean

isDefaultValuePresent

boolean isDefaultValuePresent()

Indicates if the default value is present.

Returns:

boolean

isDerived

boolean isDerived()

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

Returns:

boolean

isEnumerationLiteral

boolean isEnumerationLiteral()

True if this attribute is owned by an enumeration.

Returns:

boolean

isEnumerationLiteralParametersExist

boolean isEnumerationLiteralParametersExist()

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

Returns:

boolean

isEnumerationMember

boolean isEnumerationMember()

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

Returns:

boolean

isLeaf

boolean isLeaf()

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

Returns:

boolean

isMany

boolean isMany()

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

Returns:

boolean

isOrdered

boolean isOrdered()

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

Returns:

boolean

isReadOnly

boolean isReadOnly()

Whether or not this attribute can be modified.

Returns:

boolean

isRequired

boolean isRequired()

Whether or not the multiplicity of this attribute is 1.

Returns:

boolean

isStatic

boolean isStatic()

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

Returns:

boolean

isUnique

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.

Returns:

boolean