Author: kinow
Date: Fri Mar 31 23:09:00 2017
New Revision: 1789762
URL: http://svn.apache.org/viewvc?rev=1789762&view=rev
Log:
JENA-1314 updating Eclipse build instructions
Added:
jena/site/trunk/content/tutorials/figures/using_jena_with_eclipse-001.png
(with props)
jena/site/trunk/content/tutorials/figures/using_jena_with_eclipse-002.png
(with props)
jena/site/trunk/content/tutorials/figures/using_jena_with_eclipse-003.png
(with props)
jena/site/trunk/content/tutorials/figures/using_jena_with_eclipse-004.png
(with props)
jena/site/trunk/content/tutorials/figures/using_jena_with_eclipse-005.png
(with props)
jena/site/trunk/content/tutorials/figures/using_jena_with_eclipse-006.png
(with props)
jena/site/trunk/content/tutorials/figures/using_jena_with_eclipse-007.png
(with props)
jena/site/trunk/content/tutorials/figures/using_jena_with_eclipse-008.png
(with props)
jena/site/trunk/content/tutorials/figures/using_jena_with_eclipse-009.png
(with props)
jena/site/trunk/content/tutorials/figures/using_jena_with_eclipse-010.png
(with props)
jena/site/trunk/content/tutorials/figures/using_jena_with_eclipse-011.png
(with props)
jena/site/trunk/content/tutorials/figures/using_jena_with_eclipse-012.png
(with props)
Modified:
jena/site/trunk/content/tutorials/using_jena_with_eclipse.mdtext
Added: jena/site/trunk/content/tutorials/figures/using_jena_with_eclipse-001.png
URL:
http://svn.apache.org/viewvc/jena/site/trunk/content/tutorials/figures/using_jena_with_eclipse-001.png?rev=1789762&view=auto
==============================================================================
Binary file - no diff available.
Propchange:
jena/site/trunk/content/tutorials/figures/using_jena_with_eclipse-001.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: jena/site/trunk/content/tutorials/figures/using_jena_with_eclipse-002.png
URL:
http://svn.apache.org/viewvc/jena/site/trunk/content/tutorials/figures/using_jena_with_eclipse-002.png?rev=1789762&view=auto
==============================================================================
Binary file - no diff available.
Propchange:
jena/site/trunk/content/tutorials/figures/using_jena_with_eclipse-002.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: jena/site/trunk/content/tutorials/figures/using_jena_with_eclipse-003.png
URL:
http://svn.apache.org/viewvc/jena/site/trunk/content/tutorials/figures/using_jena_with_eclipse-003.png?rev=1789762&view=auto
==============================================================================
Binary file - no diff available.
Propchange:
jena/site/trunk/content/tutorials/figures/using_jena_with_eclipse-003.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: jena/site/trunk/content/tutorials/figures/using_jena_with_eclipse-004.png
URL:
http://svn.apache.org/viewvc/jena/site/trunk/content/tutorials/figures/using_jena_with_eclipse-004.png?rev=1789762&view=auto
==============================================================================
Binary file - no diff available.
Propchange:
jena/site/trunk/content/tutorials/figures/using_jena_with_eclipse-004.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: jena/site/trunk/content/tutorials/figures/using_jena_with_eclipse-005.png
URL:
http://svn.apache.org/viewvc/jena/site/trunk/content/tutorials/figures/using_jena_with_eclipse-005.png?rev=1789762&view=auto
==============================================================================
Binary file - no diff available.
Propchange:
jena/site/trunk/content/tutorials/figures/using_jena_with_eclipse-005.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: jena/site/trunk/content/tutorials/figures/using_jena_with_eclipse-006.png
URL:
http://svn.apache.org/viewvc/jena/site/trunk/content/tutorials/figures/using_jena_with_eclipse-006.png?rev=1789762&view=auto
==============================================================================
Binary file - no diff available.
Propchange:
jena/site/trunk/content/tutorials/figures/using_jena_with_eclipse-006.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: jena/site/trunk/content/tutorials/figures/using_jena_with_eclipse-007.png
URL:
http://svn.apache.org/viewvc/jena/site/trunk/content/tutorials/figures/using_jena_with_eclipse-007.png?rev=1789762&view=auto
==============================================================================
Binary file - no diff available.
Propchange:
jena/site/trunk/content/tutorials/figures/using_jena_with_eclipse-007.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: jena/site/trunk/content/tutorials/figures/using_jena_with_eclipse-008.png
URL:
http://svn.apache.org/viewvc/jena/site/trunk/content/tutorials/figures/using_jena_with_eclipse-008.png?rev=1789762&view=auto
==============================================================================
Binary file - no diff available.
Propchange:
jena/site/trunk/content/tutorials/figures/using_jena_with_eclipse-008.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: jena/site/trunk/content/tutorials/figures/using_jena_with_eclipse-009.png
URL:
http://svn.apache.org/viewvc/jena/site/trunk/content/tutorials/figures/using_jena_with_eclipse-009.png?rev=1789762&view=auto
==============================================================================
Binary file - no diff available.
Propchange:
jena/site/trunk/content/tutorials/figures/using_jena_with_eclipse-009.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: jena/site/trunk/content/tutorials/figures/using_jena_with_eclipse-010.png
URL:
http://svn.apache.org/viewvc/jena/site/trunk/content/tutorials/figures/using_jena_with_eclipse-010.png?rev=1789762&view=auto
==============================================================================
Binary file - no diff available.
Propchange:
jena/site/trunk/content/tutorials/figures/using_jena_with_eclipse-010.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: jena/site/trunk/content/tutorials/figures/using_jena_with_eclipse-011.png
URL:
http://svn.apache.org/viewvc/jena/site/trunk/content/tutorials/figures/using_jena_with_eclipse-011.png?rev=1789762&view=auto
==============================================================================
Binary file - no diff available.
Propchange:
jena/site/trunk/content/tutorials/figures/using_jena_with_eclipse-011.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: jena/site/trunk/content/tutorials/figures/using_jena_with_eclipse-012.png
URL:
http://svn.apache.org/viewvc/jena/site/trunk/content/tutorials/figures/using_jena_with_eclipse-012.png?rev=1789762&view=auto
==============================================================================
Binary file - no diff available.
Propchange:
jena/site/trunk/content/tutorials/figures/using_jena_with_eclipse-012.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Modified: jena/site/trunk/content/tutorials/using_jena_with_eclipse.mdtext
URL:
http://svn.apache.org/viewvc/jena/site/trunk/content/tutorials/using_jena_with_eclipse.mdtext?rev=1789762&r1=1789761&r2=1789762&view=diff
==============================================================================
--- jena/site/trunk/content/tutorials/using_jena_with_eclipse.mdtext (original)
+++ jena/site/trunk/content/tutorials/using_jena_with_eclipse.mdtext Fri Mar 31
23:09:00 2017
@@ -1,4 +1,120 @@
Title: Using Jena with Eclipse
-Revised version coming soon. In the meantime, please see
-[the old
version](http://www.iandickinson.me.uk/articles/jena-eclipse-helloworld/).
+This tutorial will guide you to set up Jena on your Eclipse. At the time of
writing, the
+latest version of Eclipse is 4.7.0. The version of Java used for this tutorial
was Java
+1.8.0_121. The operational system should not be a problem, so the only
requirements are
+Eclipse, Java 1.8.x, and git to checkout the Jena source code.
+
+## Setting up your environment
+
+The first thing you will need to install is a Java JDK 1.8.x. The installation
instructions
+vary depending on the operating system, and will not be covered in this
tutorial.
+
+Once you have Java installed, you can proceed installing Eclipse. You can
either download
+an Eclipse distribution, or download the installer and choose one amongst the
available
+packages. For this tutorial, you will see instructions and screenshots taken
from an
+Eclipse IDE for Java Developers.
+
+Eclipse comes with a bundled Apache Maven, but you may prefer to install it to
another
+directory and customize your local settings. As this is not a must have
requirement, this
+will not be covered in this tutorial.
+
+## Getting the source code
+
+Follow the instructions from our [Getting involved in Apache
Jena](/getting_involved/index.html)
+page to check out the code from the Git repository. Most developers will check
out the code into
+their Eclipse workspace folder. But you should be able to import it into
Eclipse from a
+different folder too, as will be shown in the next sections.
+
+Do not forget to run `mvn clean install` as instructed, so that Eclipse will
be able to
+find all local artifacts with no issues.
+
+## Importing the source code into Eclipse
+
+Eclipse comes, by default, with Maven integration. In the past you would have
to install
+and configure a plug-in for that. But assuming you followed the instructions
from the previous
+sections, you should be ready to import the source code.
+
+<img src="figures/using_jena_with_eclipse-001.png" class="img-responsive"
alt="Eclipse workspace">
+
+In the previous picture, you can see an empty Eclipse workspace. The view was
configured to
+display working sets, and there is a Jena working set already created. This is
not necessary
+for this tutorial, but you may find it useful if you work on separate projects
at the same
+time (e.g. working on Apache Commons RDF and Apache Jena projects
simultaneously).
+
+Eclipse keeps, by default, your projects on the left hand side panel. Right
click somewhere
+on that panel and choose <i>Import</i>. Alternatively, you can navigate using
the top menu
+to <i>File</i> / <i>Import</i>.
+
+<img src="figures/using_jena_with_eclipse-002.png" class="img-responsive"
alt="Import project context menu">
+
+That will open a menu dialog, where you should find several types of projects
to
+import into your workspace. For Jena, you must select import <i>Existing Maven
Projects</i>,
+under the <i>Maven</i> project category.
+
+<img src="figures/using_jena_with_eclipse-003.png" class="img-responsive"
alt="Import existing Maven project">
+
+Clicking <i>Next</i> will bring you to another screen where you can choose the
location
+of Jena source code. Point it to the folder where you checked out the Jena
source code
+in the previous section of this tutorial.
+
+<img src="figures/using_jena_with_eclipse-004.png" class="img-responsive"
alt="Choosing source code location">
+
+Click <i>Finish</i> and Eclipse will start importing your project. This may
take
+a few minutes, depending on your computer resources. You can keep an eye at
the <i>Progress</i>
+tab, in the bottom panel, to see what is the status of the import process.
+
+Once the project has been imported into your workspace, you should see
something similar to the
+following screenshot.
+
+<img src="figures/using_jena_with_eclipse-005.png" class="img-responsive"
alt="Jena in Eclipse">
+
+<!-- this can be removed when we fix shading guava -->
+
+After the import process is complete, Eclipse will start building the project
+automatically if you have it configured with the default settings, or you may
have to
+click on <i>Project</i> / <i>Build All</i>.
+
+Eclipse will display a red icon on the project folders with build problems. We
will see now how
+to fix these build problems, so Eclipse can successfully build and run the
project.
+
+<img src="figures/using_jena_with_eclipse-006.png" class="img-responsive"
alt="Eclipse build problems">
+
+The build problems are related to a known
+[issue due to how the project shade Google Guava
classes](http://jena.markmail.org/thread/hdu22kg6qtgsfpn6#query:+page:1+mid:tl3tfxtmfa3hh734+state:results).
+
+The workaround is to make sure the jena-shaded-guava Maven module remains
closed
+in Eclipse. You can simply right click on the project, and choose Close. Its
icon should
+change, indicating it has been closed.
+
+<img src="figures/using_jena_with_eclipse-007.png" class="img-responsive"
alt="Close jena-shaded-maven module">
+
+After doing that, it is good to trigger a <i>Clean</i> on all projects, so that
+Eclipse can clean and re-build everything.
+
+<img src="figures/using_jena_with_eclipse-008.png" class="img-responsive"
alt="Clean all Eclipse projects">
+
+You may also need to update the Maven project settings, so that Eclipse
+is aware that the project is closed and it will use a local artifact, rather
than the
+module in the workspace.
+
+<img src="figures/using_jena_with_eclipse-009.png" class="img-responsive"
alt="Update Maven projects settings">
+
+If you followed all steps, and there is nothing else running in your Eclipse
+(check the Progress tab) then your Jena project should have been built with
success.
+
+<img src="figures/using_jena_with_eclipse-009.png" class="img-responsive"
alt="Jena built in Eclipse">
+
+If you would like to test Fuseki now, you can expand the
<i>jena-fuseki-core</i>
+Maven module, navigate to the <i>org.apache.jena.fuseki.cmd</i> package, and
run
+<i>FusekiCmd</i> as a Java Application.
+
+<img src="figures/using_jena_with_eclipse-010.png" class="img-responsive"
alt="Run Fuseki in Eclipse">
+
+That should initialize Fuseki, and have it listening on
<i>http://localhost:3030</i>.
+
+<img src="figures/using_jena_with_eclipse-011.png" class="img-responsive"
alt="Fuseki running in Eclipse">
+
+Now you should also be able to debug Jena, modify the source code and build the
+project again, or import or create other projects into your workspace, and use
them
+with Jena.
