org.andromda.metafacades.uml
Class UMLProfile

java.lang.Object
  org.andromda.metafacades.uml.UMLProfile

public class UMLProfile

extends Object

Contains the common UML AndroMDA profile. That is, it contains elements "common" to all AndroMDA components (tagged values, stereotypes, and datatypes).

Author:

Chad Brandon

Field Summary

static String	BLOB_TYPE_NAME Used to identify a Blob type in the model, any other type that will be identified as a Blob type must specialize this type.
static String	BOOLEAN_TYPE_NAME Used to identify a boolean type in the model, any other type that will be identified as a boolean type must specialize this type.
static String	CLOB_TYPE_NAME Used to identify a Clob type in the model, any other type that will be identified as a Clob type must specialize this type.
static String	COLLECTION_TYPE_NAME Used to identify collection types in the model, any other type that will be identified as a collection must specialize this type.
static String	DATE_TYPE_NAME Used to identify date types in the model, any other type that will be identified as a date must specialize this type.
static String	DATETIME_TYPE_NAME Used to identify datetime types in the model.
static String	FILE_TYPE_NAME Used to identify a file type in the model, any other type that will be identified as a file type must specialize this type.
static String	LIST_TYPE_NAME Used to identify a list type in the model, any other type that will be identified as a list must specialize this type.
static String	MAP_TYPE_NAME Used to identify a map type in the model, any other type that will be identified as a map type must specialize this type.
static String	OBJECT_TYPE_NAME Used to identify object types in the model, any other type that will be identified as an object must specialize this type.
static String	SET_TYPE_NAME Used to identify a set type in the model, any other type that will be identified as a set must specialize this type.
static String	STEREOTYPE_APPLICATION_EXCEPTION Represents exceptions thrown during normal application processing (such as business exceptions).
static String	STEREOTYPE_CRITERIA Represents a criteria search.
static String	STEREOTYPE_EMBEDDED_VALUE Represents an embedded value (typically embedded with an entity as an attribute).
static String	STEREOTYPE_ENTITY Represents a persistent entity.
static String	STEREOTYPE_ENUMERATION Represents an enumeration type.
static String	STEREOTYPE_EXCEPTION The base exception stereotype.
static String	STEREOTYPE_EXCEPTION_REF Represents a reference to an exception model element.
static String	STEREOTYPE_FINDER_METHOD Represents a finder method on an entity.
static String	STEREOTYPE_FRONT_END_APPLICATION Represents a "front end" use case that is the entry point to the presentation tier.
static String	STEREOTYPE_FRONT_END_EXCEPTION Represents an exception on a "front-end" view.
static String	STEREOTYPE_FRONT_END_USECASE Represents a "front end" use case (that is a use case used to model a presentation tier or "front end").
static String	STEREOTYPE_FRONT_END_VIEW Represents a "front end" view (that is it can represent a JSP page, etc).
static String	STEREOTYPE_IDENTIFIER Represents the primary key of an entity.
static String	STEREOTYPE_MANAGEABLE Represents a manageable entity.
static String	STEREOTYPE_NULLABLE Used to indicate whether or not a parameter is nullable (since parameters do NOT allow specification of multiplicity.
static String	STEREOTYPE_SERVICE Represents a service.
static String	STEREOTYPE_TRANSIENT Indicates if a persistence type's property is transient.
static String	STEREOTYPE_UNEXPECTED_EXCEPTION Represents unexpected exceptions that can occur during application processing.
static String	STEREOTYPE_UNIQUE If an attribute has this stereotype, it is considered unique.
static String	STEREOTYPE_VALUE_OBJECT Represents a value object.
static String	STEREOTYPE_WEBSERVICE Represents a web service.
static String	STEREOTYPE_WEBSERVICE_OPERATION Stereotype an operation on a service if you wish to expose the operation.
static String	STRING_TYPE_NAME Used to identify a string type in the model, any other type that will be identified as a string type must specialize this type.
static String	TAGGEDVALUE_DOCUMENTATION Represents documentation stored as a tagged value
static String	TAGGEDVALUE_EXTERNAL_HYPERLINK Represents an external hyperlink (a website outside of a model).
static String	TAGGEDVALUE_MANAGEABLE_DISPLAY_NAME The attribute to use when referencing this table from another one.
static String	TAGGEDVALUE_MANAGEABLE_MAXIMUM_LIST_SIZE The maximum number of records to load from the DB at the same time.
static String	TAGGEDVALUE_MANAGEABLE_PAGE_SIZE The maximum number of records to show at the same time.
static String	TAGGEDVALUE_MANAGEABLE_RESOLVEABLE Indicates whether or not the underlying entity keys should be resolved when referencing it.
static String	TAGGEDVALUE_MODEL_HYPERLINK Represents a model hyperlink stored as a tagged value.
static String	TAGGEDVALUE_PERSISTENCE_ASSIGNED_IDENTIFIER Used on an identifier to indicate whether or not the identifier is assigned (meaning that the identifier is manually assigned instead of generated.
static String	TAGGEDVALUE_PERSISTENCE_COLUMN Represents a relational table column name for entity persistence.
static String	TAGGEDVALUE_PERSISTENCE_COLUMN_INDEX Represents a relational table column index name.
static String	TAGGEDVALUE_PERSISTENCE_COLUMN_LENGTH Represents a relational table column length
static String	TAGGEDVALUE_PERSISTENCE_COLUMN_UNIQUE_GROUP Indicates whether or not the underlying entity keys should be resolved when referencing it.
static String	TAGGEDVALUE_PERSISTENCE_ENUMERATION_LITERAL_PARAMETERS Used on an enumeration literal to define the enumeration literal parameters.
static String	TAGGEDVALUE_PERSISTENCE_ENUMERATION_MEMBER_VARIABLE Used to assign an enumeration attribute as a member variable rather than a literal.
static String	TAGGEDVALUE_PERSISTENCE_FOREIGN_IDENTIFIER Used on an association end to indicate whether its owning entity should have its identifier also be the foreign key to the related entity.
static String	TAGGEDVALUE_PERSISTENCE_FOREIGN_KEY_CONSTRAINT_NAME Used on an association end to denote to name of the foreign key constraint to use in the database.
static String	TAGGEDVALUE_PERSISTENCE_IMMUTABLE Indicates if a persistence type is immutable.
static String	TAGGEDVALUE_PERSISTENCE_SCHEMA Represents the name of the schema for entity persistence.
static String	TAGGEDVALUE_PERSISTENCE_TABLE Represents a relational table name for entity persistence.
static String	TAGGEDVALUE_PRESENTATION_CONTROLLER_USECASE Used to assign the controller to the activity (when it can not be assigned explicity).
static String	TAGGEDVALUE_PRESENTATION_IS_TABLE Used to indicate whether or not a parameter should be considered a table (used when no table columns are specified).
static String	TAGGEDVALUE_PRESENTATION_TABLE_COLUMNS Used to assign the table columns to a collection/array type parameter representing a table.
static String	TAGGEDVALUE_PRESENTATION_USECASE_ACTIVITY Used to associate an activity to a use case (when it can not be assigned explicitly).
static String	TAGGEDVALUE_ROLE_NAME Stores the name of the role (if it's different than the name of the actor stereotyped as role)
static String	TAGGEDVALUE_SERIALVERSION_UID Stores the serial version UID to be used for a class.
static String	TAGGEDVALUE_WEBSERVICE_PROVIDER Stores the provider of the web service (RPC, EJB).
static String	TAGGEDVALUE_WEBSERVICE_STYLE Stores the style of a web service (document, wrapped, rpc).
static String	TAGGEDVALUE_WEBSERVICE_USE Stores the use of a web service (literal, encoded).
static String	TIME_TYPE_NAME Used to identify time types in the model, any other type that will be identified as a time must specialize this type.
static String	VOID_TYPE_NAME Used to identify a void type in the model, any other type that will be identified as a void type must specialize this type.

Constructor Summary

UMLProfile()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

STEREOTYPE_CRITERIA

public static final String STEREOTYPE_CRITERIA

Represents a criteria search.

STEREOTYPE_ENTITY

public static final String STEREOTYPE_ENTITY

Represents a persistent entity.

STEREOTYPE_EMBEDDED_VALUE

public static final String STEREOTYPE_EMBEDDED_VALUE

Represents an embedded value (typically embedded with an entity as an attribute).

STEREOTYPE_FINDER_METHOD

public static final String STEREOTYPE_FINDER_METHOD

Represents a finder method on an entity.

STEREOTYPE_IDENTIFIER

public static final String STEREOTYPE_IDENTIFIER

Represents the primary key of an entity.

STEREOTYPE_UNIQUE

public static final String STEREOTYPE_UNIQUE

If an attribute has this stereotype, it is considered unique.

STEREOTYPE_SERVICE

public static final String STEREOTYPE_SERVICE

Represents a service.

STEREOTYPE_VALUE_OBJECT

public static final String STEREOTYPE_VALUE_OBJECT

Represents a value object.

STEREOTYPE_WEBSERVICE

public static final String STEREOTYPE_WEBSERVICE

Represents a web service. Stereotype a class with this stereotype when you want everything on the class to be exposed as a web service.

STEREOTYPE_WEBSERVICE_OPERATION

public static final String STEREOTYPE_WEBSERVICE_OPERATION

Stereotype an operation on a service if you wish to expose the operation.

STEREOTYPE_EXCEPTION

public static final String STEREOTYPE_EXCEPTION

The base exception stereotype. If a model element is stereotyped with this (or one of its specializations), then the exception can be generated by a cartridge and a dependency to it from an operation will add a throws clause.

STEREOTYPE_ENUMERATION

public static final String STEREOTYPE_ENUMERATION

Represents an enumeration type.

STEREOTYPE_APPLICATION_EXCEPTION

public static final String STEREOTYPE_APPLICATION_EXCEPTION

Represents exceptions thrown during normal application processing (such as business exceptions). It extends the base exception stereotype.

STEREOTYPE_UNEXPECTED_EXCEPTION

public static final String STEREOTYPE_UNEXPECTED_EXCEPTION

Represents unexpected exceptions that can occur during application processing. This that a caller isn't expected to handle.

STEREOTYPE_EXCEPTION_REF

public static final String STEREOTYPE_EXCEPTION_REF

Represents a reference to an exception model element. Model dependencies to unstereotyped exception model elements can be stereotyped with this. This allows the user to create a custom exception class since the exception itself will not be generated but the references to it will be (i.e. the throws clause within an operation).

STEREOTYPE_NULLABLE

public static final String STEREOTYPE_NULLABLE

Used to indicate whether or not a parameter is nullable (since parameters do NOT allow specification of multiplicity.

STEREOTYPE_MANAGEABLE

public static final String STEREOTYPE_MANAGEABLE

Represents a manageable entity.

STEREOTYPE_TRANSIENT

public static final String STEREOTYPE_TRANSIENT

Indicates if a persistence type's property is transient.

STEREOTYPE_FRONT_END_USECASE

public static final String STEREOTYPE_FRONT_END_USECASE

Represents a "front end" use case (that is a use case used to model a presentation tier or "front end").

STEREOTYPE_FRONT_END_APPLICATION

public static final String STEREOTYPE_FRONT_END_APPLICATION

Represents a "front end" use case that is the entry point to the presentation tier.

STEREOTYPE_FRONT_END_VIEW

public static final String STEREOTYPE_FRONT_END_VIEW

Represents a "front end" view (that is it can represent a JSP page, etc).

STEREOTYPE_FRONT_END_EXCEPTION

public static final String STEREOTYPE_FRONT_END_EXCEPTION

Represents an exception on a "front-end" view.

TAGGEDVALUE_DOCUMENTATION

public static final String TAGGEDVALUE_DOCUMENTATION

Represents documentation stored as a tagged value

TAGGEDVALUE_MODEL_HYPERLINK

public static final String TAGGEDVALUE_MODEL_HYPERLINK

Represents a model hyperlink stored as a tagged value.

TAGGEDVALUE_EXTERNAL_HYPERLINK

public static final String TAGGEDVALUE_EXTERNAL_HYPERLINK

Represents an external hyperlink (a website outside of a model).

TAGGEDVALUE_PERSISTENCE_SCHEMA

public static final String TAGGEDVALUE_PERSISTENCE_SCHEMA

Represents the name of the schema for entity persistence.

TAGGEDVALUE_PERSISTENCE_TABLE

public static final String TAGGEDVALUE_PERSISTENCE_TABLE

Represents a relational table name for entity persistence.

TAGGEDVALUE_PERSISTENCE_COLUMN

public static final String TAGGEDVALUE_PERSISTENCE_COLUMN

Represents a relational table column name for entity persistence.

TAGGEDVALUE_PERSISTENCE_COLUMN_LENGTH

public static final String TAGGEDVALUE_PERSISTENCE_COLUMN_LENGTH

Represents a relational table column length

TAGGEDVALUE_PERSISTENCE_COLUMN_INDEX

public static final String TAGGEDVALUE_PERSISTENCE_COLUMN_INDEX

Represents a relational table column index name.

TAGGEDVALUE_PERSISTENCE_IMMUTABLE

public static final String TAGGEDVALUE_PERSISTENCE_IMMUTABLE

Indicates if a persistence type is immutable.

TAGGEDVALUE_PERSISTENCE_FOREIGN_IDENTIFIER

public static final String TAGGEDVALUE_PERSISTENCE_FOREIGN_IDENTIFIER

Used on an association end to indicate whether its owning entity should have its identifier also be the foreign key to the related entity.

TAGGEDVALUE_PERSISTENCE_ASSIGNED_IDENTIFIER

public static final String TAGGEDVALUE_PERSISTENCE_ASSIGNED_IDENTIFIER

Used on an identifier to indicate whether or not the identifier is assigned (meaning that the identifier is manually assigned instead of generated.

TAGGEDVALUE_PERSISTENCE_FOREIGN_KEY_CONSTRAINT_NAME

public static final String TAGGEDVALUE_PERSISTENCE_FOREIGN_KEY_CONSTRAINT_NAME

Used on an association end to denote to name of the foreign key constraint to use in the database.

TAGGEDVALUE_PERSISTENCE_ENUMERATION_MEMBER_VARIABLE

public static final String TAGGEDVALUE_PERSISTENCE_ENUMERATION_MEMBER_VARIABLE

Used to assign an enumeration attribute as a member variable rather than a literal.

TAGGEDVALUE_PERSISTENCE_ENUMERATION_LITERAL_PARAMETERS

public static final String TAGGEDVALUE_PERSISTENCE_ENUMERATION_LITERAL_PARAMETERS

Used on an enumeration literal to define the enumeration literal parameters.

TAGGEDVALUE_PRESENTATION_CONTROLLER_USECASE

public static final String TAGGEDVALUE_PRESENTATION_CONTROLLER_USECASE

Used to assign the controller to the activity (when it can not be assigned explicity).

TAGGEDVALUE_PRESENTATION_TABLE_COLUMNS

public static final String TAGGEDVALUE_PRESENTATION_TABLE_COLUMNS

Used to assign the table columns to a collection/array type parameter representing a table.

TAGGEDVALUE_PRESENTATION_IS_TABLE

public static final String TAGGEDVALUE_PRESENTATION_IS_TABLE

Used to indicate whether or not a parameter should be considered a table (used when no table columns are specified).

TAGGEDVALUE_PRESENTATION_USECASE_ACTIVITY

public static final String TAGGEDVALUE_PRESENTATION_USECASE_ACTIVITY

Used to associate an activity to a use case (when it can not be assigned explicitly).

TAGGEDVALUE_WEBSERVICE_STYLE

public static final String TAGGEDVALUE_WEBSERVICE_STYLE

Stores the style of a web service (document, wrapped, rpc).

TAGGEDVALUE_WEBSERVICE_USE

public static final String TAGGEDVALUE_WEBSERVICE_USE

Stores the use of a web service (literal, encoded).

TAGGEDVALUE_WEBSERVICE_PROVIDER

public static final String TAGGEDVALUE_WEBSERVICE_PROVIDER

Stores the provider of the web service (RPC, EJB).

TAGGEDVALUE_ROLE_NAME

public static final String TAGGEDVALUE_ROLE_NAME

Stores the name of the role (if it's different than the name of the actor stereotyped as role)

TAGGEDVALUE_SERIALVERSION_UID

public static final String TAGGEDVALUE_SERIALVERSION_UID

Stores the serial version UID to be used for a class. If not specified, it will be calculated based on the class signature.

See Also:

org.andromda.metafacades.uml14.ClassifierFacadeLogicImpl#handleGetSerialVersionUID()

TAGGEDVALUE_MANAGEABLE_DISPLAY_NAME

public static final String TAGGEDVALUE_MANAGEABLE_DISPLAY_NAME

The attribute to use when referencing this table from another one.

TAGGEDVALUE_MANAGEABLE_MAXIMUM_LIST_SIZE

public static final String TAGGEDVALUE_MANAGEABLE_MAXIMUM_LIST_SIZE

The maximum number of records to load from the DB at the same time.

TAGGEDVALUE_MANAGEABLE_PAGE_SIZE

public static final String TAGGEDVALUE_MANAGEABLE_PAGE_SIZE

The maximum number of records to show at the same time.

TAGGEDVALUE_MANAGEABLE_RESOLVEABLE

public static final String TAGGEDVALUE_MANAGEABLE_RESOLVEABLE

Indicates whether or not the underlying entity keys should be resolved when referencing it.

TAGGEDVALUE_PERSISTENCE_COLUMN_UNIQUE_GROUP

public static final String TAGGEDVALUE_PERSISTENCE_COLUMN_UNIQUE_GROUP

Indicates whether or not the underlying entity keys should be resolved when referencing it.

OBJECT_TYPE_NAME

public static final String OBJECT_TYPE_NAME

Used to identify object types in the model, any other type that will be identified as an object must specialize this type.

COLLECTION_TYPE_NAME

public static final String COLLECTION_TYPE_NAME

Used to identify collection types in the model, any other type that will be identified as a collection must specialize this type.

LIST_TYPE_NAME

public static final String LIST_TYPE_NAME

Used to identify a list type in the model, any other type that will be identified as a list must specialize this type.

SET_TYPE_NAME

public static final String SET_TYPE_NAME

Used to identify a set type in the model, any other type that will be identified as a set must specialize this type.

DATE_TYPE_NAME

public static final String DATE_TYPE_NAME

Used to identify date types in the model, any other type that will be identified as a date must specialize this type.

TIME_TYPE_NAME

public static final String TIME_TYPE_NAME

Used to identify time types in the model, any other type that will be identified as a time must specialize this type.

DATETIME_TYPE_NAME

public static final String DATETIME_TYPE_NAME

Used to identify datetime types in the model.

BOOLEAN_TYPE_NAME

public static final String BOOLEAN_TYPE_NAME

Used to identify a boolean type in the model, any other type that will be identified as a boolean type must specialize this type.

FILE_TYPE_NAME

public static final String FILE_TYPE_NAME

Used to identify a file type in the model, any other type that will be identified as a file type must specialize this type.

BLOB_TYPE_NAME

public static final String BLOB_TYPE_NAME

Used to identify a Blob type in the model, any other type that will be identified as a Blob type must specialize this type.

CLOB_TYPE_NAME

public static final String CLOB_TYPE_NAME

Used to identify a Clob type in the model, any other type that will be identified as a Clob type must specialize this type.

MAP_TYPE_NAME

public static final String MAP_TYPE_NAME

Used to identify a map type in the model, any other type that will be identified as a map type must specialize this type.

STRING_TYPE_NAME

public static final String STRING_TYPE_NAME

Used to identify a string type in the model, any other type that will be identified as a string type must specialize this type.

VOID_TYPE_NAME

public static final String VOID_TYPE_NAME

Used to identify a void type in the model, any other type that will be identified as a void type must specialize this type.

Constructor Detail

UMLProfile

public UMLProfile()