CompileProtege5InEclipseWithMaven - Revision history

TaniaTudorache at 09:23, December 4, 2015

2015-12-04T09:23:27Z

TaniaTudorache at 09:18, December 4, 2015

2015-12-04T09:18:02Z

Amattpearson: /* Note on some other errors */ note for removal when code is fixed

2015-04-17T00:02:38Z

‎Note on some other errors: note for removal when code is fixed

Amattpearson: /* Import Eclipse projects */ added a note for missing google-collections and guava packages

2015-04-16T23:58:39Z

‎Import Eclipse projects: added a note for missing google-collections and guava packages

Amattpearson: /* Run Protege with OSGi Framework launcher */ typo fix

2015-04-16T23:41:50Z

‎Run Protege with OSGi Framework launcher: typo fix

JenniferVendetti: /* Import Eclipse projects */ incremental save

2013-12-03T02:04:06Z

‎Import Eclipse projects: incremental save

JenniferVendetti: /* Create Eclipse workspace */ incremental save

2013-12-03T01:49:07Z

‎Create Eclipse workspace: incremental save

JenniferVendetti: /* Create Eclipse workspace */ incremental save

2013-12-03T01:20:51Z

‎Create Eclipse workspace: incremental save

JenniferVendetti: /* Configuring Eclipse */ adding more section headers for clarity

2013-12-03T00:44:03Z

‎Configuring Eclipse: adding more section headers for clarity

JenniferVendetti: /* Configure Eclipse with Protege sources */ incremental save

2013-12-03T00:35:03Z

‎Configure Eclipse with Protege sources: incremental save

← Older revision		Revision as of 09:23, December 4, 2015
Line 1:		Line 1:
	{{Outdated}}		{{Outdated}}
		+
		+	<div style="background: #FFCCCC; border: 1px solid #AE5B08; padding: 10px 15px 10px 20px; margin: 0 0 1em 0; ">
		+	The updated page has been moved to [https://github.com/protegeproject/protege/wiki/Setup-in-Eclipse Github].
		+	</div>

	__TOC__<br />		__TOC__<br />

← Older revision		Revision as of 09:18, December 4, 2015
Line 1:		Line 1:
		+	{{Outdated}}
		+
	__TOC__<br />		__TOC__<br />
	== Building with Eclipse ==		== Building with Eclipse ==

@@ Line 105: / Line 105: @@
 This error appears to be harmless and can be ignored.
-===== Note on some other errors =====
+===== Note on some other errors (*) =====
 If you are getting errors about com.google.common.collect.* or com.google.common.base.* missing (will lead to lots of errors like "HashMultimap cannot be resolved" or "Optional cannot be resolved", then you can manually add missing jars to the corresponding module. On the Package Explorer, go to module's "Referenced Libraries" and right click -> Build Path -> Configure build path. Select add external jars, add .\m2\repository\com\google\collections\google-collections\1.0\google-collections-1.0.jar for com.google.common.collect.* package, and add .m2\repository\com\google\guava\guava\18.0\guava-18.0.jar for com.google.common.base.* package.
 ==== Configure Eclipse without Protege sources ====

← Older revision		Revision as of 23:58, April 16, 2015
Line 104:		Line 104:

	This error appears to be harmless and can be ignored.		This error appears to be harmless and can be ignored.
		+
		+	===== Note on some other errors =====
		+	If you are getting errors about com.google.common.collect.* or com.google.common.base.* missing (will lead to lots of errors like "HashMultimap cannot be resolved" or "Optional cannot be resolved", then you can manually add missing jars to the corresponding module. On the Package Explorer, go to module's "Referenced Libraries" and right click -> Build Path -> Configure build path. Select add external jars, add .\m2\repository\com\google\collections\google-collections\1.0\google-collections-1.0.jar for com.google.common.collect.* package, and add .m2\repository\com\google\guava\guava\18.0\guava-18.0.jar for com.google.common.base.* package.

	==== Configure Eclipse without Protege sources ====		==== Configure Eclipse without Protege sources ====

← Older revision		Revision as of 23:41, April 16, 2015
Line 117:		Line 117:
	==== Run Protege with OSGi Framework launcher ====		==== Run Protege with OSGi Framework launcher ====

−	This is the easiest type of runnable to create, run and debug. But there are two issues with this approach. First, if you are running mac os x, it won't work. The Mac has some long standing problems with java and eclipse and there appear to be troubles. But it works just fine on linux and windows. Second, this type of runnable may hide or change issues that would occur when the plugin is run in a true Protege deployment. I don't know exactly what eclipse does to make this type of runnable work but suffice it to say that eclipse is being a bit tricky. It is a good idea to at least occasionally the runnable in a more Protege-like environment such as is created by runnable that I describe in the next section.	+	This is the easiest type of runnable to create, run and debug. But there are two issues with this approach. First, if you are running mac os x, it won't work. The Mac has some long standing problems with java and eclipse and there appear to be troubles. But it works just fine on linux and windows. Second, this type of runnable may hide or change issues that would occur when the plugin is run in a true Protege deployment. I don't know exactly what eclipse does to make this type of runnable work but suffice it to say that eclipse is being a bit tricky. It is a good idea to at least occasionally test the runnable in a more Protege-like environment such as is created by runnable that I describe in the next section.

@@ Line 85: / Line 85: @@
 ===== Import Eclipse projects =====
-Now we can import the eclipse projects from the protege5 directory. From the file menu click Import, select General/Existing Projects into Workspace, and click next:
+Now that we've created and configured our new workspace, we're ready to import our Eclipse projects from the "protege" directory.  Select File -> Import..., and choose General -> Existing Projects into Workspace:
 [[File:MavenEclipseImportExisting1.png]]
-[[File:MavenEclipseImportExisting2.png]]
+Click Next and select "protege" as the root directory:
 <pre>
-Access restriction: The method render() from the type RDFRendererBase is not accessible due to restriction on required library org.semanticweb.owl.owlapi/owlapi-distribution.jar
+    Access restriction: The method render() from the type RDFRendererBase is not accessible due to restriction on required library org.semanticweb.owl.owlapi/owlapi-distribution-3.4.5.jar
 </pre>
-I don't know what this error means yet but it appears to be harmless.
 ==== Configure Eclipse without Protege sources ====

@@ Line 57: / Line 57: @@
-First you need to import the owl api as an eclipse plugin project.  Click on File->Import... and select Plug-in Development->Plug-ins and Fragments.
+Click OK to finish creating the new path variable, and OK again to exit the Preferences dialog.
 [[File:MavenEclipseImportOWLapi1.png]]
-In the next screen you can set the directory to import from to be
 <pre>
-            protege5/protege-distribution/target/protege-distribution-5.0.0.beta-04-bin/Protege/plugins.
+    <path-to-your-local-maven-repository>/net/sourceforge/owlapi/owlapi-distribution/3.4.5
 </pre>
-[[File:MavenEclipseImportOWLapi3.png]]
+Please note that at the time this guide was written, Protege is using version 3.4.5 of the OWL API.  These steps should be adjusted to import later versions of the OWL API as Protege migrates to newer releases.  Protege prints the version of the OWL API it uses to the console window each time the application is launched.
 Now we can import the eclipse projects from the protege5 directory. From the file menu click Import, select General/Existing Projects into Workspace, and click next:

@@ Line 47: / Line 47: @@
 ===== Create Eclipse workspace =====
-Now we start eclipse to create a workspace.  This step can actually be done while the maven install step abbove is running.  In my example, I created the workspace in a separate directory, protege5-workspace that is at the same level as the protege5 directory that I just created.
+Launch Eclipse and create a new workspace called "protege-desktop", or any name of your choice.  We recommend creating the workspace in a separate but parallel directory to the "protege" directory that contains the Protege source code.  This ensures that changes to Eclipse workspace files don't show up as modifications to the Protege source tree.
-When I first set up eclipse this way, I decided to have the Protege source tree be in a separate but parallel directory to the eclipse workspace.  I decided that I like this arrangement because, as you will see, it ensures that the eclipse workspace files don't show up as modifications to the Protege source tree sources.
+With the new Eclipse workspace open, we need to do some minor configuration steps before importing our projects.
 [[File:MavenEclipseSetREPO.png]]
 First you need to import the owl api as an eclipse plugin project.  Click on File->Import... and select Plug-in Development->Plug-ins and Fragments.

@@ Line 16: / Line 16: @@
 ==== Configure Eclipse with Protege sources ====
 Clone the Protege source code to your local machine:
@@ Line 23: / Line 25: @@
 </pre>
-Next, build Protege with Maven:
+===== Build with Maven =====
 <pre>
      cd protege
@@ Line 35: / Line 39: @@
 </pre>
 At completion of the Maven build, all generated source directories needed by Eclipse are present.
 Now we can move forward with setting up the Eclipse projects.  Rather than asking developers to do this manually, we provide a ZIP file with a preconfigured set of Eclipse projects.  The ZIP file is called "eclipse-by-tim.zip", and is located in the protege/ide directory.  Unzip the file to the top-level protege directory.  This will add the necessary .project, .classpath, and META-INF/MANIFEST.MF files to the relevant subdirectories.
 Now we start eclipse to create a workspace.  This step can actually be done while the maven install step abbove is running.  In my example, I created the workspace in a separate directory, protege5-workspace that is at the same level as the protege5 directory that I just created.

@@ Line 17: / Line 17: @@
 ==== Configure Eclipse with Protege sources ====
-When I first set up eclipse this way, I decided to have the Protege source tree be in a separate but parallel directory to the eclipse workspace.  I decided that I like this arrangement because, as you will see, it ensures that the eclipse workspace files don't show up as modifications to the Protege source tree sources.
+Clone the Protege source code to your local machine:
 <pre>
-            git clone https://github.com/protegeproject/protege protege5
+    git clone https://github.com/protegeproject/protege.git protege
 </pre>
-Now we build Protege using the maven command:
 <pre>
-     cd protege5
+     cd protege
      mvn clean install
 </pre>
-Now we can set up the projects for eclipse.  To do this first download a zip file that contains the eclipse information.  This zip file can be found [http://protege.stanford.edu/fileshare/tredmond/maven-eclipse-projects.zip here].
+Building with Maven results in a fully functional copy of Protege in the protege-distribution/target subdirectory.  The directory name will be something like:
-Unzip this file into the protege5 directory.  Note that in addition to including the usual .project and .classpath files, this zip file also contains the META-INF/MANIFEST.MF files.  These manifest files are duplicates of the manifest files that are included in the bundles that are created by the mvn build scripts.  On windows machines you might see messages that various directories already exist (e.g. org.protege.common) and asking if you want to merge the contents.  This is far from an error in this case and actually may mean that you are putting the files in the right places.
-Now we start eclipse to create a workspace.  This step can actually be done while the maven install step abbove is running.  In my example, I created the workspace in a separate directory, protege5-workspace that is at the same level as the protege5 directory that I just created.  In this first run of eclipse, all that I plan to do is to setup a parameter that points to the local maven repository.  To do this, click on ''Window->Preferences'' (''Eclipse->Preferences'' on a mac), select ''General->Workspace->Linked Resources'' and click on the button that defines a new path variable.
+In this first run of eclipse, all that I plan to do is to setup a parameter that points to the local maven repository.  To do this, click on ''Window->Preferences'' (''Eclipse->Preferences'' on a mac), select ''General->Workspace->Linked Resources'' and click on the button that defines a new path variable.
 [[File:MavenEclipseSetREPO.png]]