Eclipse Community Forums: UML2 Tools

Help

Home

Home » Modeling » UML2 Tools » Annotations

Show: Today's Messages :: Show Polls :: Message Navigator

Annotations [message #475785]

Thu, 09 October 2008 13:46

Adam Flinton

Messages: 32
Registered: July 2009

Member

Dear All,

I am playing with the UML2tools to see if they will fit our needs.

One need we have is to annotate classes with rich text etc. We have a
rich text/XHTML WYSIWYG component (using TinyMCE but I've also played
with wrapping FCKEditor).

My problem is that last time I looked I seem to remember that there was
a slot in the properties of a given class etc for plain text
annotations....& in the latest this seems to have disappeared.

How do I annotate a given class (or other UML artefact)?

Adam

Report message to a moderator

Re: Annotations [message #475787 is a reply to message #475785]

Thu, 09 October 2008 17:56

Tatiana Fesenko

Messages: 530
Registered: July 2009

Senior Member

Hello Adam,

UML specification doesn't provide any annotation or description property
for the element, therefore such properties are not available in UML2Tools
by default.
But you can get needed functionality after several simple actions. The idea
of the changes is to create a stereotype 'ElementWithAnnotation' and extend
existing UML elements by applying stereotype.

Step by step it will look like:

1) Create a stereotype
Create Profile diagram with name 'AnnotationProfile'.
Create a Stereotype in the diagram, name it 'AnnotatedElement'. Create String
Attribute named 'Annotation'.
Create Metaclass element, in label-inplace of newly created metaclass select
'Class'.
Create Extends link from the stereotype and Metaclass.
Define profile using 'Profile->Define' actions in the context menu of the
diagram.

Profile should be created just once.

2) Apply Profile.
Create Class diagram.
Load 'AnnotationProfile' or register it using UML2 profile registry (see
bug #230963). If you decided to use registry, then profile should be registered
just once, you can skip this step on other diagrams. Now needed profile will
be available in the list of profiles in 'Apply Profile' action.
Apply Profile using 'Apply Profile->AnnotationProfile' action in the context
menu of the diagram.

Profile is applied once for the given diagram.

3) Apply stereotype
Create Class.
In the context menu choose 'Apply Stereotype->AnnotatedElement' action.

Now you'll see 'Annotation' field in 'TaggedValues' tab of property sheets.
This sequence is really simple, it just requires some experience of working
with UML profiles.
Does it meets your requirements, Adam?

Rich text cell editor can be applied in UMLStereotypePropertySection class.

Besides, description property sheet itself, and Rich Text editor particularly,
will be available in commercial version of UML2 Tools provided by Borland.

Best wishes,
Tanya.

> Dear All,
>
> I am playing with the UML2tools to see if they will fit our needs.
>
> One need we have is to annotate classes with rich text etc. We have a
> rich text/XHTML WYSIWYG component (using TinyMCE but I've also played
> with wrapping FCKEditor).
>
> My problem is that last time I looked I seem to remember that there
> was a slot in the properties of a given class etc for plain text
> annotations....& in the latest this seems to have disappeared.
>
> How do I annotate a given class (or other UML artefact)?
>
> Adam
>

Report message to a moderator

Re: Annotations [message #475789 is a reply to message #475787]

Fri, 10 October 2008 12:42

Adam Flinton

Messages: 32
Registered: July 2009

Member

Thanks. I will be looking at this in the next few days.

Wrt the borland /rich text etc we have specific needs in that it must be
XHTML & we'd like it to be available to a wide range of potential users
as open source.

Adam

Tatiana Fesenko wrote:
> Hello Adam,
>
> UML specification doesn't provide any annotation or description property
> for the element, therefore such properties are not available in
> UML2Tools by default.
> But you can get needed functionality after several simple actions. The
> idea of the changes is to create a stereotype 'ElementWithAnnotation'
> and extend existing UML elements by applying stereotype.
>
> Step by step it will look like:
>
> 1) Create a stereotype
> Create Profile diagram with name 'AnnotationProfile'.
> Create a Stereotype in the diagram, name it 'AnnotatedElement'. Create
> String Attribute named 'Annotation'.
> Create Metaclass element, in label-inplace of newly created metaclass
> select 'Class'. Create Extends link from the stereotype and Metaclass.
> Define profile using 'Profile->Define' actions in the context menu of
> the diagram.
>
> Profile should be created just once.
>
> 2) Apply Profile.
> Create Class diagram. Load 'AnnotationProfile' or register it using UML2
> profile registry (see bug #230963). If you decided to use registry, then
> profile should be registered just once, you can skip this step on other
> diagrams. Now needed profile will be available in the list of profiles
> in 'Apply Profile' action.
> Apply Profile using 'Apply Profile->AnnotationProfile' action in the
> context menu of the diagram.
>
> Profile is applied once for the given diagram.
>
> 3) Apply stereotype
> Create Class.
> In the context menu choose 'Apply Stereotype->AnnotatedElement' action.
>
> Now you'll see 'Annotation' field in 'TaggedValues' tab of property
> sheets. This sequence is really simple, it just requires some experience
> of working with UML profiles. Does it meets your requirements, Adam?
>
> Rich text cell editor can be applied in UMLStereotypePropertySection class.
>
> Besides, description property sheet itself, and Rich Text editor
> particularly, will be available in commercial version of UML2 Tools
> provided by Borland.
> Best wishes,
> Tanya.
>
>> Dear All,
>>
>> I am playing with the UML2tools to see if they will fit our needs.
>>
>> One need we have is to annotate classes with rich text etc. We have a
>> rich text/XHTML WYSIWYG component (using TinyMCE but I've also played
>> with wrapping FCKEditor).
>>
>> My problem is that last time I looked I seem to remember that there
>> was a slot in the properties of a given class etc for plain text
>> annotations....& in the latest this seems to have disappeared.
>>
>> How do I annotate a given class (or other UML artefact)?
>>
>> Adam
>>
>
>

Report message to a moderator