Annotating a package

 

Notes on a package

The notes used to annotate packages are presented in the following table:

 

The ... note type

is used to...

sqlBefore

define the SQL code which will be added at the beginning of the .SQL file associated with the modeled package.

sqlAfter

indicate the SQL code which will be added to the end of the .SQL file associated with the modeled package.

 

 

Stereotypes on a package

The stereotypes used to annotate packages are presented in the following table:

 

The ... stereotype

is used to...

<<schema>>

indicate that the package is a schema.

<<database>>

indicate that the package is a database.

<<sqlPhysicalModel>>

indicate that the package is a physical model.

 

 

The <<schema>> stereotype

The <<schema>> stereotype indicates that the package is a schema in which classes stereotyped <<table>> or <<view>> will be defined.

 

In a physical model, a <<schema>> can only be found on a package stereotyped <<sqlPhysicalModel>> or <<database>>.

 

 

The <<database>> stereotype

The <<database>> stereotype indicates that the package is a database.

 

A <<database>> can only be found on a package stereotyped <<sqlPhysicalModel>>.

 

 

The <<sqlPhysicalModel>> stereotype

The <<sqlPhysicalModel>> stereotype indicates that the package is a physical model.  It can contain packages stereotyped <<database>> or <<schema>>, or classes stereotyped <<table>>, <<view>> or <<procedureClass>>.