View source for CompileProtege4InEclipse

<span style="font-size:22px; font-weight:bold; color:#DC7317;">Compile and Run Protege 4.0 Alpha from Eclipse</span>
<br /><br />

To follow is some documentation for compiling and running Protege 4.0 alpha from the [http://www.eclipse.org/ Eclipse development environment].  This documentation takes the approach of creating a '''separate Eclipse project for each OSGi bundle''' in the Protege 4 source tree.

Please note that:

* These instructions are only valid for the 4.0 alpha version of Protege. If you want to compile and run the 3.x versions of Protege, we have separate instructions [http://protege.cim3.net/cgi-bin/wiki.pl?CompileProtegeSourcesInIDE#nid9EM available elsewhere].
* This is only one of several possible ways of compiling and running Protege 4 from Eclipse.  This particular page is not meant to be exhaustive.<br /><br />

__TOC__

== Create the <code>org.protege.common</code> project ==
Go to the SVN Repository Exploring perspective and navigate to <code>protege4/protege-standalone/trunk/plugins/org.protege.common</code>.  This step assumes that you have Subversion support installed for the Eclipse IDE and that you have already connected to the Protege Subversion repository.  If you have not done this, we have [[ProtegeDevDocsGeneral#Connect_to_the_Protege_Subversion_respository_from_Eclipse|instructions for doing so]] on our Wiki.

Right-click on the <code>org.protege.common</code> folder and choose Checkout...  In the resulting "Checkout from SVN" dialog, leave all of the default settings (as shown below) and click Finish.<br /><br />

[[Image:Checkout-dialog.jpg]]<br /><br />

In the "New Project" dialog, choose Plug-in Project and click Next >.<br /><br />

[[Image:New-project-dialog.jpg]]<br /><br />

In the "New Plug-in Project" dialog, type <code>org.protege.common</code> in the Project name text box.  Leave the default settings in the Project Settings and Target Platform sections.  For this documentation, we will also use the default location for the project.  Click the Next > button.<br /><br />

[[Image:New-plugin-project-dialog.jpg]]<br /><br />

For the Plug-in Content section, uncheck both of the checkboxes in the Plug-in Options section and leave all other default settings.<br /><br />

[[Image:Plugin-content-dialog2.jpg]]<br /><br />

If you are curious about what any of these settings mean, you can click the question mark (help) icon in the lower-left corner of the New Project Plug-in dialog and browse the Eclipse documentation.

Click the Finish button.  At this point, Eclipse will ask you if you want to use the Plug-in Development perspective for your project:<br /><br />

[[Image:Associated-perspective-dialog.jpg]]<br /><br />

Check the "Remember my decision" checkbox and click the Yes button.  Then, click OK on the "Confirm Overwrite" dialog.  Eclipse will now begin checking out the source code for the <code>org.protege.common</code> bundle.  Your Package Explorer will look something like the following after the checkout is complete:<br /><br />

[[Image:Protege-common-explorer.jpg]]<br /><br />

If you have Project | Build Automatically turned on, you will notice compiler errors after checking out the source code.  To fix them, right-click on the <code>org.protege.common</code> project and bring up the Properties dialog.  Go to the Libraries tab in the Java Build Path section.  Click the Add Jars... button and add all the JAR files that are in the <code>org.protege.common/lib</code> directory:<br /><br />

[[Image:Protege-common-build-path.jpg]]<br /><br />

The project will now build successfully.  The steps for creating projects for the remaining three bundles are largely the same.<br /><br />

== Create the <code>org.protege.editor.core.application</code> project ==
To create a project for the <code>org.protege.editor.core.application</code> bundle:

* Right-click on the <code>protege4/protege-standalone/trunk/plugins/org.protege.editor.core.application</code> folder in the SVN Repository Exploring perspective and choose Checkout...
* Click Finish on the Checkout from SVN dialog without changing any of the default settings.
* Choose Plug-in Project in the New Project dialog and click Next >.
* Enter <code>org.protege.editor.core.application</code> in the Project name text box and click Next >.
* Uncheck both checkboxes in the the Plug-in Options section and click Finish.
* Click OK on the Confirm Overwrite dialog.
* After the checkout completes, right-click on the <code>org.protege.editor.core.application</code> project in the Package Explorer and bring up the Properties dialog.
* On the Libraries tab in the Java Build Path section, click the Add Jars... button.
* Add all of the JAR files from the <code>org.protege.editor.core.application/lib</code> and <code>org.protege.common/lib</code> directories:<br /><br />

[[Image:Core-application-build-path.jpg]]<br /><br />

* Click OK and the project will now build successfully.<br /><br />

== Create the <code>org.semanticweb.owl.owlapi</code> project ==
To create a project for the <code>org.semanticweb.owl.owlapi</code> bundle:

* Right-click on the <code>protege4/protege-standalone/trunk/plugins/org.semanticweb.owl.owlapi</code> folder in the SVN Repository Exploring perspective and choose Checkout...
* Click Finish on the Checkout from SVN dialog without changing any of the default settings.
* Choose Plug-in Project in the New Project dialog and click Next >.
* Enter <code>org.semanticweb.owl.owlapi</code> in the Project name text box and click Next >.
* Uncheck both checkboxes in the the Plug-in Options section and click Finish.
* Click OK on the Confirm Overwrite dialog.
* After the checkout completes, right-click on the <code>org.semanticweb.owl.owlapi</code> project in the Package Explorer and bring up the Properties dialog.
* On the Libraries tab in the Java Build Path section, click the Add Jars... button.
* Add all of the JAR files from the <code>org.semanticweb.owl.owlapi/lib</code> directory:<br /><br />

[[Image:Owlapi-build-path.jpg]]<br /><br />

* Click OK and the project will now build successfully.<br /><br />

== Create the <code>org.protege.editor.owl</code> project ==
To create a project for the <code>org.protege.editor.owl</code> bundle:

* Right-click on the <code>protege4/protege-standalone/trunk/plugins/org.protege.editor.owl</code> folder in the SVN Repository Exploring perspective and choose Checkout...
* Click Finish on the Checkout from SVN dialog without changing any of the default settings.
* Choose Plug-in Project in the New Project dialog and click Next >.
* Enter <code>org.protege.editor.owl</code> in the Project name text box and click Next >.
* Uncheck both checkboxes in the the Plug-in Options section and click Finish.
* Click OK on the Confirm Overwrite dialog.
* After the checkout completes, right-click on the <code>org.protege.editor.owl</code> project in the Package Explorer and bring up the Properties dialog.
* On the Libraries tab in the Java Build Path section, click the Add Jars... button.
* Add all of the JAR files from the following directories:
** <code>org.protege.editor.owl/lib</code>
** <code>org.semanticweb.owl.owlapi/lib</code>
** <code>org.protege.editor.core.application/lib</code>
** <code>org.protege.common/lib</code><br /><br />

[[Image:Owleditor-build-path.jpg]]<br /><br />

* Click OK and the project will now build successfully.