Scrolling through the metamodel

Defining the scrolling methods

To make a J method available as a scrolling method on a document item, the method must have:

· A set type return parameter, whatever the type of the set (Class[], Attribute[], etc.)

· The {template} tagged value

The methods provided are those corresponding to the criteria previously defined on the document template's UML profile and parent UML profiles.

The creation of new scrolling methods allows a document item to only scroll through a set of model elements. For example, it is possible to create document items that only scroll through public methods, or String type attributes, ….

It is necessary to indicate that it is possible to scroll through a set of model elements, either by creating a new scrolling method, or by using a filter method.

Translating scrolling methods

The metamodel scrolling methods available in the "Described association" scrolling list of a document item can be translated. The complete name of the J method (metaclass name, UML profile name, method name) then no longer appears. This translation allows users who may not be familiar with the metamodel to easily get to know the model elements processed by the document item.

Messages must be defined in the info.us file stored in the $OBJING_PATH/res directory.

The identifier of this message is:

<Class>_<PointOfView>_<Name>

Note: The '#' character defined in the UML profile name must be replaced by the '_' character.

Example:

Class_default_external_Documentation_MyProf_publicAttrs:

Public attributes

end Class_default_external_Documentation_MyProf_publicAttrs