Apollo for Eclipse : User Guide - Gentleware

59 Pages·2007·1.15 MB·English

Apollo for Eclipse
User Guide
Apollo for Eclipse: User Guide
Copyright © 2007 Gentleware AG

Table of Contents
1. About Gentleware and Apollo for Eclipse ........................................................................... 1
About Gentleware and Apollo for Eclipse ....................................................................... 1
Contact ............................................................................................................. 1
Features in Version 3.x ............................................................................................... 2
About This Document ................................................................................................. 2
2. Installation and First Start ................................................................................................ 3
Prerequisites .............................................................................................................. 3
Installing the Rich Client Platform ................................................................................ 3
Installing as an Eclipse Extension .................................................................................. 3
Install Eclipse Components through Update Services ................................................. 3
Eclipse Europa ................................................................................................... 6
Install Eclipse Components Manually ................................................................... 11
Troubleshooting ........................................................................................................ 12
3. Keys and Registration .................................................................................................... 17
Types and Terminology ............................................................................................. 17
License Manager ...................................................................................................... 17
License Manager Help ....................................................................................... 18
Licensing Apollo for Eclipse ...................................................................................... 19
4. Getting Started .............................................................................................................. 23
Diagrams in Apollo for Eclipse ................................................................................... 23
Canonical Package Diagrams .............................................................................. 23
Non-Canonical Class Diagrams ........................................................................... 23
Models in Apollo for Eclipse ...................................................................................... 24
Model File Storage ........................................................................................... 24
Create a First Project ................................................................................................. 25
5. Working with Apollo for Eclipse ..................................................................................... 29
The Diagrams .......................................................................................................... 29
Display Canonical Package Diagram .................................................................... 29
Create Non-Canonical Class Diagram ................................................................... 30
Adding and Removing Elements .......................................................................... 32
Navigation ....................................................................................................... 33
Rapid Buttons .................................................................................................. 33
Editing Elements .............................................................................................. 34
Filtering .......................................................................................................... 37
Elements ................................................................................................................. 38
Associations and Multi-Valued Attributes .............................................................. 38
Referenced Packages ......................................................................................... 39
Open the Source Code in a Diagram Editor ................................................................... 39
View the Source Code in the Diagram View .................................................................. 40
Linking Views and Editors ................................................................................. 42
Create Java Source Code from the Diagram ................................................................... 43
Reverse Engineer .jar Files ......................................................................................... 44
A. Glossary ..................................................................................................................... 45
B. Hypersonic SQL Group Database Engine License Agreement ............................................... 53
iv
List of Tables
2.1. Minimum Eclipse features required for Apollo for Eclipse .................................................. 11
5.1. ............................................................................................................................... 38
v
Chapter 1. About Gentleware and
Apollo for Eclipse
About Gentleware and Apollo for Eclipse
Contact
We are always very happy to get feedback on our tools and services. If you want to contact us, there are
several ways to get in touch.
Email
The easiest way to contact us is via the web form. We offer addresses for different purposes.
General information, feature requests, or suggestions:
http://www.gentleware.com/contact.html
Customer support (for license holders*):
Please keep in mind that our customer support is available during our normal working hours - Monday
through Friday, 9 am to 6 pm Central European Time. Consider checking the forums and the FAQ to
answer your question first.
http://www.gentleware.com/supportreq.html
Questions on purchase process, quotes, or volume sales:
[email protected] [mailto:[email protected]]
* Unlicensed edition users are encouraged to use our forum for support questions.
http://www.gentleware.com/fileadmin/forum.html
Web Site
For general discussion we have installed an open forum [http://www.gentleware.com/fileadmin/
forum.html] in which users of Apollo for Eclipse can freely discuss topics related to our tools. Typically
these are questions on how to do something, discussions on what other features would be nice, or comments
on what people like or dislike about our tool. Our staff is actively taking part in these discussions, but you
might also get a response from other users.
To order our products you can use the online shop [http://www.gentleware.com/shop0.html], which
requires a credit card. If you do not have a credit card or you hesitate to use it over the web, send us an
email at [email protected] [mailto:[email protected]].
Phone
Our preferred payment method is credit card. However, if you do not have a credit card or you
hesitate to use it over the web, you can also send a fax, send email to [email protected]
[mailto:[email protected]] or call us.
There is a fax order sheet provided on our web site. Begin the order process as usual, then select 'Order by
Fax' at the bottom of the Checkout page. Our fax number is [phone].
1
About Gentleware and
Apollo for Eclipse
Please try to find an answer to your question on our web pages [http://www.gentleware.com/support.html]
or the FAQ list [http://www.gentleware.com/faq.html].
Regular Mail
To send us mail or to visit us in person, our address is:
Gentleware AG
Ludwigstraße 12
20357 Hamburg
Germany
Features in Version 3.x
Feature list includes:
• Forward, reverse, and roundtrip engineering
• Support for Java 5
• Support for UML 2.1
• Superior class diagram handling
• Available as a standalone RCP or as an extension to Eclipse
• GMF 2.0 and Eclipse 3.3
• Array dimension support for attributes
• Configurable location of model files
About This Document
This document describes Apollo for Eclipse and how to use it. It is intended as a user guide. It is not a
book about UML, Java, or Eclipse. Basic knowledge about UML, Java, and Eclipse is assumed.
We are working hard to make Apollo for Eclipse as intuitive as possible. You should be able to open up
Apollo for Eclipse and start using it without looking into this documentation. However, you will find it
useful to read through this document to get you up to speed faster and discover useful features earlier.
2
Chapter 2. Installation and First Start
Prerequisites
Apollo for Eclipse is platform-independent. It runs on almost any modern personal computer. To
successfully start and run Apollo for Eclipse, you need the following:
• J2SE 5.0 Java Runtime Environment
• A computer with reasonable memory and CPU power. For memory, 512 MB is recommended, more is
helpful. For CPU, a Pentium III or equivalent is the recommended minimum.
Installing the Rich Client Platform
The easiest way to get started with Apollo for Eclipse is to use the Rich Client Platform (RCP). Download
the RCP zip file (e.g. for Windows: Apollo_RCP_3.0.0_win32.win32.x86.zip) from the
Gentleware web site, unpack the file to the desired directory, and run Apollo for UML from this directory.
Installing as an Eclipse Extension
Apollo for Eclipse may also be added as an extension to the Eclipse IDE. It requires some features to be
installed to Eclipse in addition to the Apollo for Eclipse extension. The simplest way to do this is using
Eclipse Europa, although you may also choose to install each part manually.
Additionally, you will need to consult the Eclipse documentation for the prerequisites that match your
usage scenario and computer setup. The exact list of requirements for running Apollo for Eclipse as an
extension can be found later in the section the section called “Install Eclipse Components Manually”.
Install Eclipse Components through Update Services
This is the standard Eclipse way of installing features, and is also an easy way to complete the installation.
Gentleware recommends using this method of installation.
1. If it is not already installed, install the Eclipse SDK 3.3.x (the current version as of the publication of
this document is 3.3.0).
3
Installation and First Start
2. Start Eclipse. From the Help menu, select Software Updates -> Find and Install...
3. Select 'Search for new features to install' and click 'Next'.
4. If it does not appear already, add the Apollo for Eclipse Update Site as a New Remote Site:
-> New Remote Site
-> Name = "Apollo for Eclipse Update Site"
-> URL = "http://apollo.gentleware.com/updatesite/"
5. There are 5 different versions of Eclipse 3.3 Europa: Eclipse IDE for Java Developers, Eclipse IDE for
Java EE Developers, Eclipse IDE for C/C++ Developers, Eclipse for RCP/Plug-in Developers, and
Eclipse Classic.
If you are using the RCP/Plug-in Developers or Eclipse Classic, select "Apollo for Eclipse Update
Site" and "Europa Discovery Site".
If you are using one of the IDE versions, you must also install the org.eclipse.sdk feature via
The Eclipse Project Update. Check "The Eclipse Project Update" in addition to "Apollo
for Eclipse Update Site" and "Europa Discovery Site".
Check the remote site, check "Ignore features not applicable for this environment", and uncheck
"Automatically select mirrors". Click "Finish".
4
Installation and First Start
Note
Some of the mirrors for Eclipse plug-ins don't offer the same content as the original update
site. Please be sure to use the original site: http://apollo.gentleware.com/updatesite/
6. Open Apollo for Eclipse Update Site -> Apollo for Eclipse -> Apollo 3.0.
7. Click "Select Required", then click "Next".
8. Carefully read the license texts, then accept the licenses. Click "Next".
5