3

I need to draw a component diagram for an Eclipse plugin, but I'm not sure how to do that.

I found this diagram. I think I could draw something similar using the UML 2 notation for my plugin, replacing "Your tool" with the name of my plugin and "Their tool" with the name(s) of the plugin(s) my plugin uses.

What do you think? Thank you very much!

PD: Yes, I have read about component diagrams, but I'm really lost here.

Edit: for example: I'm developing a plugin using Xtext and Xpand and MySQL, so I guess my components would be: MyPlugin, Xtext, Xpand, MySQL and Eclipse itself. Is it correct?

Now, what would be a Xtext or Eclipse interface to connect to other components?

RAM
  • 2,257
  • 2
  • 19
  • 41
Rafael Angarita
  • 777
  • 10
  • 27
  • 1
    The figure you referenced is rather generic. I'd expect your component diagram to show the relation to the Dependencies and used Extensions of your plugin. Can you clarify what the diagram you have to provide will be used for? – Volker Stolz Aug 10 '11 at 17:00
  • 1
    It's a requirement from my client, even though he does not know much about UML. He just think it is safe to have some documentation. Maybe too much detail will only confuse him. – Rafael Angarita Aug 10 '11 at 17:22
  • Could you be more specific about what makes you uncertain? If you have Eclipse Plugin, know about its dependencies (ports and interfaces) and composition (parts and artifacts), and know how to depict them using UML, just try doing that. If you have a problem expressing something, let us know:) – Gabriel Ščerbák Aug 10 '11 at 17:33
  • If the diagram shouldn't serve your client directly and he asks for documentation, most probably he wants to ensure the plugin could be easily mantained in the future. For a future developer of the eclipse plugin provided metadata should suffice (e.g. MANIFEST.MF, plugin.xml and build.xml). Try explaining that to your client. If you cannot, use information from that sources to draw the diagram. – Gabriel Ščerbák Aug 10 '11 at 17:47

1 Answers1

1

It seems that you are not an UML expert therefore you could try UMLet. This is very very basic as well as simple and would create component diagrams in few minutes. For more advance needs I would recommend to use a tool having not only a graphical editor but also an UML model such as Topcased or Papyrus. For very advanced needs I would recommend RSA IBM. Omondo is recommended if you have the need for the class diagram and java code generation.

UML GURU
  • 1,452
  • 1
  • 9
  • 7