3.1BLU AGE® stereotypes and tags
There are a number of BLU AGE® specific stereotypes and tags which should be used in the UML model. This section describes them according to their usage.
3.1.1Packages
3.1.1.1Stereotypes
| Name | UML element | Description |
| PK_BUSINESS | package | package where the « business objects » and the entities are modeled |
| PK_BUSINESS_OBJECT | package | package where the « business objects » are modeled |
| PK_ENTITY | package | package where the entities are modeled |
| PK_REPORT | package | package where the reports are modeled |
| PK_ROLES | package | package where actors’ objects are modeled |
| PK_SERVICE | package | package where services are modeled |
| PK_TARGET | package | application root package |
| PK_WEB | package | Package container where presentations objects are modeled |
| PK_APP (As of ver 3.5.0) | package | Package for dynamic validators |
3.1.1.2Tags
N/A
3.1.2Screen activity diagrams
3.1.2.1Stereotypes
| Name | UML element | Description |
| AS_EXTSCREENS | swimlane | « Swimlane » containing link to external screens. |
| AS_SERVER | swimlane | « Swimlane » containing the business rules. |
| AS_SCREEN | swimlane | « Swimlane » containing the screens. |
| AS_REPORT | swimlane | « Swimlane » containing the reports. |
| SEC_ERROR_PAGE | screen activity diagram | Diagram where the application error page is modeled. |
| LOGIN_PAGE | screen activity diagram | Diagram where the application login page is modeled. |
| GLOBAL_SCOPE | screen activity diagram | Diagram where modeled links can be used in the whole application. |
| PACKAGE_SCOPE | screen activity diagram | Diagram where modeled links can only be used on the package level. |
| COMPONENT_VIEW | screen activity diagram | Diagram where a component (part of screen) is modeled. |
| START_PAGE | screen activity diagram | Diagram where the application homepage is modeled. |
| PRE_CONTROLLER | screen activity diagram | Diagram where SMR(s) ‘Screen Managing Rules’ invoked before the screen display are modeled. |
| REPORT | behavior action | Action which leads to a report creation |
3.1.2.2Tags
| Name | UML element | Description |
| SERVICE_RETURN | MR outgoing flow | Specifies the RG execution result. |
| Exception.Message | MR outgoing flow | Specifies the error message to display when an exception occurs. |
| Exception.Exception_Type | MR outgoing flow | Specifies the type of exception. |
| REPORT.filename | Report action | Specifies the name of the file generated by the report action. |
| REPORT.format | Report action | Specifies the report type |
| REPORT.toSave | Report action | Specifies if the document must be saved on the hard disk. |
3.1.3Business services
3.1.3.1Interfaces and operations
3.1.3.1.1Stereotypes
| Name | UML element | Description |
| create | Interface/Operation | Specifies a service to insert into database a new entry of the input object. |
| create_all | Interface/Operation | Specifies a service able to insert into database new entries of the input List. |
| update | Interface/Operation | Specifies a service to update in database the entry corresponding to the input object. |
| update _all | Interface/Operation | Specifies a service able to update in database the entries corresponding to the input List. |
| delete | Interface/Operation | Specifies a service able to delete from database the entry corresponding to the input object. |
| delete_all | Interface/Operation | Specifies a service able to delete from database the entries corresponding to the input List. |
| find_by_id | Interface/Operation | Specifies a service able to search in database for the entry with the same identifier as the input object. |
| find_all | Interface/Operation | Specifies a service able to search in database for all the entries in the table. |
| find_by_properties | Interface/Operation | Specifies a service able to search in database for the entry with the same properties as the input object. |
| login | Interface/Operation | Specifies a login service. |
| logout | Interface/Operation | Specifies a logout service. |
| complex | Interface/Operation | Specifies a service described in a sequence diagram. |
| specific | Interface/Operation | Specifies a service manually implemented. |
| copy | Interface/Operation | Specifies a service for object copy. |
| ClientWebService | Interface | Specifies a service for the web service that uses the displayed web service. |
| ServerWebService | Interface | Specifies a service for the displayed web service. |
| BR | Operation | Specifies a service implemented with business rules defined in a .drl ‘DocObject Resource Locator’ file |
| hql_operation | Operation | Specifies a service executing a hql ‘Hibernate Query Language’ query. |
| process | Operation | Specifies a service described in an activity diagram. |
| validationService (As of ver 3.5.0) | Operation | Specifies a service for dynamic validation |
msgKey(As of ver 3.5.0) | Opaque action | Contains a message for the validation service |
msgBundle(As of ver 3.5.0) | Class | Contains the keys and the messages for the validation service |
| sql_operation (As of ver3.5.1) | Operation | Specifies a service executing a sql 'tagsql_query'. |
3.1.3.1.2Tags
| Name | UML element | Description |
| create_all.bo | Interface/Operation | Specifies the business object type of the list parameter. |
| create_all.clearSession | Interface/Operation | Performs a clearSession along with the create_all operation |
| create_all.refreshSession | Interface/Operation | Performs a refreshSession along with the create_all operation |
| create.clearSession | Interface/Operation | Performs a clearSession along with the create operation |
| create.refreshSession | Interface/Operation | Performs a refreshSession along with the create operation |
| delete_all.bo | Interface/Operation | Specifies the business object type of the list parameter. |
| delete_all.clearSession | Interface/Operation | Performs a clearSession along with the delete_all operation |
| delete_all.refreshSession | Interface/Operation | Performs a refreshSession along with the delete_all operation |
| delete.clearSession | Interface/Operation | Performs a clearSession along with the delete operation |
| delete.refreshSession | Interface/Operation | Performs a refreshSession along with delete operation |
| find_all.bo | Interface/Operation | Specifies business object type of the return list. |
| find_by_id.clearSession | Interface/Operation | Performs a clearSession along with the find_by_id operation |
| find_by_id.refreshSession | Interface/Operation | Performs a refreshSession along with the find_by_id operation |
| update_all.bo | Interface/Operation | Specifies business object type of the list parameter. |
| update_all.clearSession | Interface/Operation | Performs a clearSession along with the update_all operation |
| update_all.refreshSession | Interface/Operation | Performs a refreshSession along with the update _all operation |
| update.clearSession | Interface/Operation | Performs a clearSession along with the update operation |
| update.refreshSession | Interface/Operation | Performs a refreshSession along with the update operation |
| specific.implementation | Interface/Operation | Specifies the class name implementation used for the specific service |
| ClientWebService. clientPathTypeRetour | Interface | List VO package on the customer side. |
| ClientWebService. serverPathTypeRetour | Interface | List VO package on the server side |
| ClientWebService. typeRetour | Interface | VO (Value Object) type |
| ClientWebService. targetNamespace | Interface | The XML namespace of the WSDL (Web Services Description Language) |
| ClientWebService.url | Interface | URL of the web service displayed |
| ServerWebService. implementation | Interface | Class implementation of the displayed service. |
| BR.package | Operation | Defines the package location of the .drl file which describes the business rules |
| hql_operation.bo | Operation | Specifies object type of the return list. |
| hql_operation.hql_request | Operation | Specifies the hql query invoked by the service. |
| check_null.message | Parameter | Specifies the message exception thrown if the concerned parameter is null |
| brParamIn | Parameter | Specifies the parameter is IN |
| brParamOut | Parameter | Specifies the parameter is OUT |
| brParamGlobal | Parameter | Specifies the parameter is IN and OUT |
| sql_operation.bo (As of ver3.5.1) | Operation | Specifies object type of the return list. |
| sql_operation.sql_request (As of ver3.5.1) | Operation | Specifies the sql query invoked by the service. |
| sql_operation.use_entity (As of ver3.5.1) | Operation | Specifies the entity persisted of return. |
3.1.3.2Business service activity diagrams
3.1.3.2.1Stereotypes
N/A
3.1.3.2.2Tags
N/A
3.1.3.3Business service sequence diagrams
3.1.3.3.1Stereotypes
| Name | UML element | Description |
| if | message | Specifies the beginning of “if” conditional bloc. The condition must be passed as an argument |
| else | message | Specifies the beginning of “else” conditional bloc. |
| elseif | message | Specifies the beginning of “elseif” conditional bloc The condition must be passed as an argument |
| iterate | message | Specifies the beginning of a collection iteration bloc |
| end | message | Specifies the end of either a conditional or an iteration bloc |
3.1.3.3.2Tags
| Name | UML element | Description |
| item | iterate call | Specifies the name of the current iteration element |
| list | iterate call | Specifies the collection name on which the iteration is processed |
| type | iterate call | Specifies the element type of the list |
3.1.4Business objects
3.1.4.1Entities
3.1.4.1.1Stereotypes
| Name | UML element | Description |
| Entity | Class | Defines the class as an entity |
| TransientObject | Class | Defines the class as a transient entity |
| Criteria | Class | Defines the class as a criteria search class. |
| identifier | Property | Defines the attribute as an identifier. |
| password | Property | Defines the attribute as a user password. |
| Required | Property | Defines the attribute as mandatory. |
| role | Property | Defines the attribute as representing a role (actor). |
| Unique | Property | Defines the attribute as unique. |
| userid | Property | Defines the attribute as a user name. |
3.1.4.1.2Tags
| Name | UML element | Description |
| table.table | Class | Specifies the table name corresponding to the entity. |
| Entity.cache | Class | Specifies the cache strategy for the entity |
entity.cache. maxElementsInMemory | Class | Specifies the max number of cached elements |
entity.cache. overflowToDisk | Class | Specifies whether elements can be stored on the disk |
entity.cache. timeToldlSeconds | Class | Specifies an element inactivity period before cache expires. |
entity.cache. timeToLiveSeconds | Class | Specifies an element survival time before cache expires |
| entity.defaultOrder | Class | Specifies the attribute on which the default order is performed |
entity.entity. dynamicInsert | Class | Specifies whether the SQL INSERT order shall be generated during the execution or if it must only contain columns without « null » values. |
Entity.entity. dynamicUpdate | Class | Specifies whether the SQL UPDATE order must be generated during the execution or if it must only contain columns with values that have changed. |
| Entity.generator.class | Class | Defines which class is used to generate a class persistency unique identifier. |
| Entity.inheritance | Class | Defines the inheritance strategy. |
| Entity.sequence.name | Class | Specifies an existing sequence in the database. |
| Entity.version | Class | Specifies the name of the version column |
| column.index | Property | Indicates the name of an index to create on an attribute/column entity. |
| Column.length | Property | Indicates the column length (indicating the column length can produce false hibernate mappings because the datatypes depend of the database considered). |
| Column | Property | Stands for the column name. |
| comment (As of ver 3.5.2) | Class | Enable to add comments in the hibernate files. (some SGBD do not support comments) |
3.1.4.2Associations
3.1.4.2.1Stereotypes
N/A
3.1.4.2.2Tags
| Name | UML element | Description |
| table.table | Association | Specifies the table name corresponding to the entity. |
| Association.cache | Association | Specifies the cache strategy for the association |
association.cache. maxElementsInMemory | Association | Specifies the max number of cached elements |
association.cache. overflowToDisk | Association | Specifies whether elements can be stored on the disk |
association.cache. timeToldlSeconds | Association | Specifies an element inactivity period before cache expires. |
association.cache. timeToLiveSeconds | Association | Specifies an element survival time left before cache expires |
| cascade | End association | Places the association cascade attribute. |
| collectionType | End association | Indicates the collection mapping type. |
| Lazy | End association | Indicates the way an association should be loaded. |
| orderByColumns | End association | Indicates the column name used in the collection sorting out. |
| outerjoin | End association | Activates the loading through outer joins. |
| foreign.identifier | End association | Indicates whether the entity can use the foreign entity’s identifier. |
| sort.type | End association | Indicates the way collection elements may be sorted. |
| whereClause | End association | Indicates the SQL condition for data to be extracted in the collection. |
3.1.4.3Business objects
3.1.4.3.1Stereotypes
| Name | UML element | Description |
| attach | Operation | The operation is used to add an element to a list (association) |
| detach | Operation | The operation is used to remove an element from a list (association) |
| formula | Operation | The operation describes its implementation in Java or .NET. |
| Getter | Operation | The operation is used to get an object or a data type value. |
| Ocl_impl | Operation | The operation describes its implementation in OCL. |
| Sql_impl | Operation | The operation describes its implementation as a SQL request in OCL. |
| Specific_impl | Operation | The operation stands for a specific method. |
| Setter | Operation | The operation is used to change an object or a data type value. |
3.1.4.3.2Tags
| Name | UML element | Description |
| formula.binary_java | Operation | Describes the implementation in Java. |
| Formula.binary_net | Operation | Describes the implementation in .NET. |