Description Andreas Höhmann 2010-01-01 04:15:14 EST

Build Identifier: 

This feature request based on an email I wrote to the integrator-mailinglist:

I want add a legend for the qc-mylyn connector to the task list. I found the following code in the bugzilla connector:

 /**
  * Overrides getLegendElements.
  *
  * {@inheritDoc}
  * @see org.eclipse.mylyn.tasks.ui.AbstractRepositoryConnectorUi#getLegendElements()
  */
 @Override
 public List<LegendElement> getLegendElements() {
     List<LegendElement> legendItems = new ArrayList<LegendElement>();
     legendItems.add(LegendElement.createTask("blocker", BugzillaImages.OVERLAY_CRITICAL)); //$NON-NLS-1$
     legendItems.add(LegendElement.createTask("critical", BugzillaImages.OVERLAY_CRITICAL)); //$NON-NLS-1$
     legendItems.add(LegendElement.createTask("major", BugzillaImages.OVERLAY_CRITICAL)); //$NON-NLS-1$
     legendItems.add(LegendElement.createTask("normal", null)); //$NON-NLS-1$
     legendItems.add(LegendElement.createTask("minor", BugzillaImages.OVERLAY_MAJOR)); //$NON-NLS-1$
     legendItems.add(LegendElement.createTask("enhancement", BugzillaImages.OVERLAY_ENHANCEMENT)); //$NON-NLS-1$
     legendItems.add(LegendElement.createTask("trivial", BugzillaImages.OVERLAY_TRIVIAL)); //$NON-NLS-1$
     return legendItems;
 }

This looks like a "hardcoded" severity-mapping ... but in Quality Center (QC) its possible to define the severities for each project, i.e.

1 == BLOCKER and 5 is TRIVIAL
or
1 == TRIVIAL and 5 == BLOCKER
and so on.

And the number of severities is not limited (i.e. it's possible to define 10 severity levels).

Now the question, how can we provide a nice legend for our connector?
What can we do to support a Legend for each configured qc-repository?
I created a "Serverity Mapping Section" on our repo-settingspage, but how can I access these mapping-informations in the getLegendElements()?

PS: the same problem exists for the priority ... in qc it's also possible to define multiple priorities

Then frank becker wrote:

in getTaskKindOverlay you can use

try {
BugzillaRepositoryConnector connector = (BugzillaRepositoryConnector) TasksUi.getRepositoryConnector(task.getConnectorKind());
TaskRepository repository1 = TasksUi.getRepositoryManager().getRepository(task.getConnectorKind(),
task.getRepositoryUrl());
IProgressMonitor monitor = null;
RepositoryConfiguration repositoryConfiguration = connector.getRepositoryConfiguration(repository1, false,
monitor);
} catch (CoreException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}

but actual I see now way that you can extend the UILegendControl to show the values per repository or product level. I think that you should create a new view in your connector.

Then mik kersten wrote:

Rather than creating your own view for this, it would be great if you could contribute a patch to support a per-repository rendering of the legend.  If that seems like it will blow up the legend too much, consider contributing collapsible sections to it where you could put the per-repository rendering.

So here we are :)

What we need (pseudocode):

How can connectors provide the legend entries?
1a. each "RepositoryConnectorUi" can overwrite a new method 
   getLegendElements(repository)
1b. mylyn could provide a extension point for that
(this is a design decision - mik?)

2. the task list legend view must check each legend element "every time" the view become visible (I don't know if this is already implemented or if the current implementation read the legend element only one time ... but I have the sourcecode and I will find it out *g*)

3. the "new" ui layout of the legend view is currently not so clear for me ... imagine a connector supports dynamic legend entries (i.e. the qc-mylyn connector will do that) and a user configure 5 repositories ... then the legend view must have space for 5 blocks. At the moment each connector will produce only one block in the legend view. 

Maybe we can do that:
3a. if a connector doesn't support multiple legend blocks than the legend will be placed in the "common connector list"
3b. if a connect support multiple legends then a new block only for this connector will created (after the common block) and this block will contain a legend block for each (active) repository.

Please give me your feedback

Andreas

PS: And a happy new year!!! :D

Reproducible: Always