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.

Metafacade interface to be used by AndroMDA cartridges.

Method Summary

java.lang.Object	findTaggedValue(java.lang.String name, boolean follow) Searches the given feature for the specified tag.
java.lang.String	getDefaultValue() The default value of the attribute.
EnumerationFacade	getEnumeration() If the attribute is an enumeration literal this represents the owning enumeration.
java.lang.String	getEnumerationLiteralParameters() Returns the enumeration literal parameters defined by tagged value as a comma separated list.
java.lang.String	getEnumerationValue() The value for this attribute if it is an enumeration literal, null otherwise.
java.lang.String	getGetterName() The name of the accessor operation that would retrieve this attribute's value.
java.lang.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
ClassifierFacade	getOwner() Gets the classifer who is the owner of the attributes.
java.lang.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 *)
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	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	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.

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

isAttributeFacadeMetaType

boolean isAttributeFacadeMetaType()

Indicates the metafacade type (used for metafacade mappings).

Returns:

always true

findTaggedValue

java.lang.Object findTaggedValue(java.lang.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 hiearchy.

getDefaultValue

java.lang.String getDefaultValue()

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

getEnumeration

EnumerationFacade getEnumeration()

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

getEnumerationLiteralParameters

java.lang.String getEnumerationLiteralParameters()

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

getEnumerationValue

java.lang.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.

getGetterName

java.lang.String getGetterName()

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

getGetterSetterTypeName

java.lang.String getGetterSetterTypeName()

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

getLower

int getLower()

the lower value for the multiplicity

-only applicable for UML2

getOwner

ClassifierFacade getOwner()

Gets the classifer who is the owner of the attributes.

getSetterName

java.lang.String getSetterName()

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

getType

ClassifierFacade getType()

The classifier owning this attribute.

getUpper

int getUpper()

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

-only applicable for UML2

isAddOnly

boolean isAddOnly()

True if this attribute can only be set.

isChangeable

boolean isChangeable()

True if this attribute can be modified.

isDefaultValuePresent

boolean isDefaultValuePresent()

Indicates if the default value is present.

isEnumerationLiteral

boolean isEnumerationLiteral()

True if this attribute is owned by an enumeration.

isEnumerationLiteralParametersExist

boolean isEnumerationLiteralParametersExist()

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

isEnumerationMember

boolean isEnumerationMember()

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

isMany

boolean isMany()

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

isOrdered

boolean isOrdered()

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

isReadOnly

boolean isReadOnly()

Whether or not this attribute can be modified.

isRequired

boolean isRequired()

Whether or not the multiplicity of this attribute is 1.

isStatic

boolean isStatic()

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