Plug-in Usage
Below are a set of instructions on the usage of the system, including
installation, editing viewable metrics data and information on changing and adding
preferences.
Installation
To be detailed...
Metric Overlay View
A view is provided to coordinate the displayed metrics data and the appropriate
augmentations. Instructions on its use are detailed below.
- To access the view, click Window → Show View → Other. Then, open
the Metric Overlay Views folder, select the Metric Overlay view,
with the icon (
). Then click OK.
- The view contains a table of the mappings that are currently declared or active. If
you have mappings in either of these states and they are not visible, make a change and
save the current source file document.
- Table Usage
- The table contains six columns. Each row provides a representation of a single
mapping. Each of the columns can be reordered by dragging the header to the desired
location.
- The ! column of check boxes toggles the active status of the declared
mappings.
- The Mapping, Augmentation and Metric columns detail the name
of each of these elements for a defined mapping. The settings for each of these columns
can be adjusted by clicking on the appropriate cell. This will highlight the cell green
and display an edit button. Click the button to open the appropriate preference window.
- The # column displays the number of instances of the relevant metric that
appear in this document. This gives a useful indication of how important each row is.
- The X column allows each mapping to be removed from the table. This
sets the state of the mapping to undeclared, it does NOT delete it. The icon you can
click is a red square with a black cross (
).
- View Toolbar
- The tool bar provides functionality for modifying the table, toggling the display
on/off, access to help and preferences.
- This provides a global toggle for toggling on/off
all mappings with an active state.
- The ability to add undeclared mappings to the
view by changing their state to declared. Currently this implementation brings up
a popup list to select from.
- The ability to remove the selected mappings from
the table. This is achieved by setting all declared/active mappings to undeclared.
- Clears all mappings from the table.
- Opens the preference page.
- Opens the help dialog for the application.
Setting Preferences
It is easy to add and change the way metrics are displayed. In Eclipse, either
click Window → Preferences → Metrics Overlay. Or, if you have the Metrics Overlay
view open, you can access it using the Preferences button.
Check out these pages for more detailed descriptions:
Augmentations - Change settings of the augmentations,
the actual display technique.
Mappings - Change the settings of a mapping,
the connection between augmentations and metrics.
Metrics - Change the metrics information
and the range that data falls under.