AndroMDA UML Common Metafacades Profile

This profile contains all elements that can be applied on the model used as the MDA transformation process. These elements are specific to the AndroMDA UML Common Metafacades component.

Data Types
@TODO: write the documentation for 'Data Types' profile element group !!!
Stereotypes
Stereotypes are the names you sometimes see appear in UML diagrams, they typically look like <<MyStereotype>> and can be applied on any type of UML model element.
Tagged Values
Sometimes it happens you want to add information to the model but there is no clean way of doing it. In those cases you may want to resort to tagged values, but these cases should be considered with caution. A tagged value is something extra, something optional, and the application should run fine without them.

Criteria(Back to Stereotypes)
Applied on: class
Specifies this class's attributes are to be used in criteria queries.
Entity(Back to Stereotypes)
Applied on: class
Denotes this class is to be treated as a persistable entity.
Service(Back to Stereotypes)
Applied on: class
Denotes this class represents a service that is implemented using the facade pattern.
FinderMethod(Back to Stereotypes)
Applied on: Entity operation
Denotes this operation to perform a query on the underlying collection of entities, rather than execute business logic.
Identifier(Back to Stereotypes)
Applied on: Entity attribute
Explicitly specifies this attribute to make up the entity's identifier (primary key)
Unique(Back to Stereotypes)
Applied on: Entity attribute
Denotes an attribute to be unique among all possible instances of the underlying entity. In UML2, the attribute 'Unique' property=true has the same effect. Deprecated: Use UML2 unique flag instead.
ValueObject(Back to Stereotypes)
Applied on: class
Denotes a class to be a simple class that is only holding values and providing accessors to them.
Exception(Back to Stereotypes)
Applied on: class
This class will instruct the generation of an exception class.
ApplicationException(Back to Stereotypes)
Applied on: class
This class will instruct the generation of a checked exception class.
UnexpectedException(Back to Stereotypes)
Applied on: class
This class will instruct the generation of an unchecked exception class.
ExceptionRef(Back to Stereotypes)
Applied on: dependency
Indicates that the target is an exception which is thrown by the method. Deprecated: In UML2, design the operation to throw the declared exceptions instead of drawing a dependency.
Enumeration(Back to Stereotypes)
Applied on: class
This class will instruct the generation of a type-safe enumeration class. Deprecated: Use UML Enumeration types instead of the stereotype. Deprecated: Use UML Enumeration instead.
WebService(Back to Stereotypes)
Applied on: class
Denotes a class to represent a collection of web service operations, similar behavior as a normal Service.
WebServiceOperation(Back to Stereotypes)
Applied on: WebService operation
Denotes an operation to be exposed as a web service.
WebFault(Back to Stereotypes)
Applied on: class
Denotes an exception thrown by a CXF or JAX-WS webservice operation.
XmlSchema(Back to Stereotypes)
Applied on: Package
Denotes a package whose contents will be output as an XML Schema file. Used by XML and WebService cartridges.
Nullable(Back to Stereotypes)
Applied on: Service operation parameter
Indicates a service operation argument may be left unspecified (eg. Java null). Deprecated: Use the parameter multiplicity lowerBound=0 instead.
Transient(Back to Stereotypes)
Applied on: Attribute or AssociationEnd
Indicates the attribute or association end should not be persisted/serialized.
Manageable(Back to Stereotypes)
Applied on: class
Only makes sense when there already is an Entity stereotype. Add this one to manage this entity through all 3 tiers.
EmbeddedValue(Back to Stereotypes)
No documentation available
FrontEndException(Back to Stereotypes)
Applied on: Transition
Modeled on a transition within a front-end process, it designates an exception occurring while processing an action.
FrontEndView(Back to Stereotypes)
Applied on: action state
This stereotype is modeled on an action state to denote it is representing a view on a front end (such as a JSP page).
FrontEndUseCase(Back to Stereotypes)
Applied on: use-case
A use-case that participates in the front-end (or presentation-tier) processes.
FrontEndApplication(Back to Stereotypes)
Applied on: use-case
The use-case flagged with this stereotype will be the application's starting point, you can only use this stereotype in combination with the <<FrontEndUseCase>> stereotype.
Queue(Back to Stereotypes)
Applied on: Node
The node flagged with this stereotype represents a Queue message destination (i.e. JMS, etc).
Topic(Back to Stereotypes)
Applied on: Node
The node flagged with this stereotype represents a Topic message destination (i.e. JMS, etc).
DocOnly(Back to Stereotypes)
Applied on: Class, Operation, Attribute, Package
Modeled component is for documentation only. Do not generate code.
Future(Back to Stereotypes)
Applied on: Class, Operation, Attribute, Package
Modeled component will be developed in the Future. Do not generate code.
Ignore(Back to Stereotypes)
Applied on: Class, Operation, Attribute, Package
Modeled component should be ignored. Do not generate code.
analysis(Back to Stereotypes)
Applied on: Package
Modeled component is part of an RUP analysis package. Do not generate code.
perspective(Back to Stereotypes)
Applied on: Package
Modeled component is part of an RUP perspective package. Do not generate code.
documentation(Back to Tagged Values)
No documentation available
hyperlinkModel(Back to Tagged Values)
Represents a hyperlink within a model
hyperlinkTextActive(Back to Tagged Values)
Represents an external hyperlink (i.e. to an external website for example).
andromda_persistence_schema(Back to Tagged Values)
Applied on: Any <<Entity>> stereotyped class
The name of the persistence schema that contains the table.
Allowed values for this element:
  • A string representing the name of the database schema where the entity will be persisted
andromda_persistence_table(Back to Tagged Values)
The name of the table corresponding to this entity in the persistent store. If unspecified, the table name is the upper-underscore version of the Entity name.
andromda_persistence_column(Back to Tagged Values)
The name of the column corresponding to this property in the persistent store. If unspecified, the column name is the upper-underscore version of the Entity property name.
andromda_persistence_column_length(Back to Tagged Values)
Default if unspecified = 25. Applies to String values only.
andromda_persistence_column_index(Back to Tagged Values)
The index to create on the property column
andromda_persistence_column_uniqueGroup(Back to Tagged Values)
The name of the unique constraint group to which this unique attribute belongs
andromda_persistence_foreign_identifier(Back to Tagged Values)
Default=false. If true, the same Entity identifier values for this FK will also be used for the associated Entity PK
andromda_persistence_assigned_identifier(Back to Tagged Values)
Default=true: Create an assigned identifier attribute for the entity if no attributes are designated as identifier attributes.
andromda_persistence_foreignkey_constraint(Back to Tagged Values)
The name of the foreign key corresponding to this relation in the persistent store.
andromda_persistence_immutable(Back to Tagged Values)
Denotes this entity's property can only be set at construction time.
andromda_persistence_joincolumn_order(Back to Tagged Values)
Applied on: Entities
For ManyToOne associations, the order of the @JoinColumn annotations in the composite PK MUST match the order of the columns in the FK definition. The JoinColumn order should be the same as the order of columns in the Primary Key of the Entity.
Allowed values for this element:
  • An associationEnd of this entity
andromda_persistence_enumeration_member_variable (Back to Tagged Values)
Applied on: Enumeration Attribute
Specifies whether the enumeration attribute is defined as a member variable rather than a literal. This should only be set if the attribute is NOT a literal. Deprecated: Use UML Enumerations instead.
Allowed values for this element:
  • true
  • false
andromda_persistence_enumeration_literal_parameters (Back to Tagged Values)
Applied on: Enumeration Literal
Specifies the enumeration literal parameters which are passed to the appropriate constructor when created. The parameters are comma separated. Deprecated: Use UML Enumerations instead.
andromda_persistence_associationEnd_primary (Back to Tagged Values)
Applied on: AssociationEnd
Indicates whether or not the association end is considered "primary", to indicate which side of a one-to-one or many-to-many association should get the foreign key (be the relationship owner).
andromda_persistence_associationEnd_uniqueGroup(Back to Tagged Values)
The name of the unique constraint group to which this unique association end belongs
andromda_presentation_controller_usecase(Back to Tagged Values)
The value should correspond to the use-case holding the activity graph which has this controller as its context. This is used when deferring operations to the controller. Please note that if your CASE tool supports setting the context of an activity graph you will not need to explicitly set this tagged value. This feature has been provided to support tool such as Poseidon that have only limited UML support. If you are a MagicDraw user you will not need to use this tagged value, instead assign the controller by right clicking on it and selecting "Assign...".
andromda_presentation_usecase_activity(Back to Tagged Values)
For tools that do not allow the placement of activity graphs inside of a use-case you can use this tagged value to point to an activity graph, this will link them and denotes that the graphs specifies this use-case.
andromda_presentation_view_table_columns(Back to Tagged Values)
Applied on: A collection type parameter going into an action state carrying the <<FrontEndView>> stereotype
The collection will be displayed in scrollable tabular format. Each column in this table will be mapped to a property of the object type contained in the collection. So you will need to make sure all objects have accessor methods for the property you list in this tagged value. Properties are separated using a comma ','. More than one value maybe be assigned to this tag, all properties will correctly be resolved.
Allowed values for this element:
  • Comma-separated list of column names
andromda_presentation_view_table(Back to Tagged Values)
Applied on: A collection type parameter going into an action state carrying the <<FrontEndView>> stereotype
A flag indicating whether or not a parameter should be considered a table. This must be set to true when you wish to display a list of simple types (such as strings) within a table.
Allowed values for this element:
  • true
  • false (default)
andromda_webservice_style(Back to Tagged Values)
No documentation available
andromda_webservice_use(Back to Tagged Values)
No documentation available
andromda_webservice_provider(Back to Tagged Values)
No documentation available
andromda_role_name(Back to Tagged Values)
No documentation available
andromda_serialVersionUID(Back to Tagged Values)
The serialVersionUID value to put on an Entity
andromda_manageable_table_displayname(Back to Tagged Values)
Applied on: A class with the <<Manageable>> stereotype
The column representing this entity,by default the first <<Unique>> attribute found is taken but you might want to specify another column yourself. This value is used when one entity has a foreign key to another one and you want to select the value of this foreign key from a combo-box and you would like to see a more meaningful label for each option, if no <<Unique>> attribute is found the identifier is used, which isn't very helpful.
Allowed values for this element:
  • any column name present in this entity
  • the name of the identifier column (default)
datatype::Object(Back to Data Types)
No documentation available
datatype::Collection(Back to Data Types)
Deprecated: Use UML2 unordered non-unique 1:M relationship instead
datatype::List(Back to Data Types)
Deprecated: Use UML2 ordered non-unique 1:M relationship instead
datatype::Set(Back to Data Types)
Deprecated: Use UML2 unordered unique 1:M relationship instead
datatype::SortedSet(Back to Data Types)
Deprecated: Use UML2 ordered unique 1:M relationship instead
datatype::Map(Back to Data Types)
No documentation available
datatype::SortedMap(Back to Data Types)
No documentation available
datatype::ArrayList(Back to Data Types)
No documentation available
datatype::ArrayList(Back to Data Types)
No documentation available
datatype::HashSet(Back to Data Types)
No documentation available
datatype::TreeSet(Back to Data Types)
No documentation available
datatype::HashMap(Back to Data Types)
No documentation available
datatype::TreeMap(Back to Data Types)
No documentation available
datatype::Date(Back to Data Types)
No documentation available
datatype::Time(Back to Data Types)
No documentation available
datatype::DateTime(Back to Data Types)
No documentation available
datatype::boolean(Back to Data Types)
No documentation available
datatype::Character(Back to Data Types)
No documentation available
datatype::File(Back to Data Types)
No documentation available
datatype::Blob(Back to Data Types)
No documentation available
datatype::Clob(Back to Data Types)
No documentation available
datatype::Double(Back to Data Types)
No documentation available
datatype::Float(Back to Data Types)
No documentation available
datatype::Integer(Back to Data Types)
No documentation available
datatype::Long(Back to Data Types)
No documentation available
datatype::String(Back to Data Types)
No documentation available
datatype::void(Back to Data Types)
No documentation available