Skip to content

Prerequisites

Jump to bottom Edit New page
anacmendes edited this page Jan 9, 2013 · 2 revisions
  • (hw0) pp. (7-12)
  • (hw1) pp. 1 directory structure make sure to note that descriptors/input/etc. resides in the resources dir
  • (Installing UIMA SDK (hw1)) pp. 9

Installing JDK

If you have the latest JDK 6 installed, you could skip this task.

  1. Visit Java SE Downloads page, and choose the platform you are using to download JDK 6 SE35.

  2. Install JDK from the executable file if available, and set PATH manually (if you are using a Windows machine). The Java installation page at http://www.oracle.com/technetwork/java/javase/index-137561.html might be useful to you.

Installing Git

If you have Git installed, you can skip this task.

You will not need Git (specifically, execute Git goals from command line) in most cases, because we will have EGit (the Git plug-in for Eclipse) installed. But sadly, there is a case you have to install the Git, when the Maven plug-in for Eclipse (aka m2e) does need Git (not EGit) and the SCM URI you specified to execute Git commands. (Don’t know what SCM is? Probably you need to go back to the previous task.)

  1. Visit http://git-scm.com/downloads to download Git.

  2. You can refer to the Pro Git book for how to install Git for different platforms (at http://git-scm.com/book/en/Getting-Started-Installing-Git), and how to set up Git (at http://git-scm.com/book/en/Getting-Started-First-Time-Git-Setup).

Maven

If you have Maven installed, you can skip this task. Similar to the Git installation, you will not need a standalone (as opposed to the m2e plug-in) Maven most of time, since m2e has an embedded Maven runtime by default. But we (and some other developpers) found that in some environments, m2e could not find the correct installation path of the embedded runtime to execute certain goals (e.g., deploy, release:prepare, release:perform). If you find a feasible solution to get rid of this, please let us know.

  1. Download Maven 3.0.4 (Binary, either tar.gz or zip) from http://maven.apache.org/download.html.

  2. Follow the installation instructions (for difference platforms) at the bottom of the page to install Maven. The first note from the instruction is:

Maven is a Java tool, so you must have Java installed in order to proceed. More precisely, you need a Java Development Kit (JDK), the Java Runtime Environment (JRE) is not sufficient.

Eclipse (Git, Maven plug-ins integrated)

If you have an Eclipse IDE for Java Developers with version 3.7, you could probably skip this task. But if you are stuck in a situation where you were told Eclipse is missing a plug-in, you might want to return to this section. If you have other packages (Eclipse Classic or Eclipse for Java EE Developers), please do not skip this task.

  1. Download Eclipse IDE for Java Developers 4.2 at http://www.eclipse.org/downloads/packages/eclipse-ide-java-developers/junor.

  2. Install Eclipse by simply uncompressing the downloaded package.

  3. Use the default workspace path or create your own workspace, as shown in Figure 2.1. And finally, we could see the Eclipse Welcome view at the end of workspace initialization. See Figure 2.2.

That’s the start of your developement. From now on, everthing will become less platform specific, and we will show you how to configure the workspace, create your Maven project and release it in the rest of the homework

Installing UIMA SDK

Similar to the installation processes you have gone through for Git and Maven, you will install the UIMA binaries and a UIMA Eclipse plug-in. Different from the installation instruction you have learned from class or the official tutorial, you DO NOT need to download the UIMA SDK, uncompress and copy the archive into the Eclipse installation path. In fact, UIMA SDK will be handled by the Maven archetype hw1-archetype that we built for you for this task, and the Eclipse plug-in for UIMA can be installed with the Eclipse Install New Software function, which is basically the same as described in the official tutorial, plus one tiny additional action you have to perform to solve the dependency problem during installation.

  1. As mentioned in the class and the official UIMA tutorial, you should install Eclipse EMF plug-in, but if you strictly followed the instruction from last homework, then EMF should have been installed as it is a default component of Eclipse Juno for Java Developers. Otherwise, you should install it by yourself.

  2. Follow the instruction in subsection 3.1.21 of the Overview & Setup section of UIMA Manuals and Guides by adding the UIMA Eclipse Plug-in Update site (http://www.apache.org/dist/uima/eclipse-update-site)

  3. But, you might encounter a “Cannot satisfy dependency” issue like shown in Figure 3.1. You can apply a workaround for this year-long bug2 by only selecting the “Apache UIMA Eclipse tooling and runtime support” and unselecting the “Apache UIMA-AS (Asynchronous Scaleout) Eclipse tooling” (as shown in Figure 3.2), where the latter tool will not be used for this course.

  4. After installation, you are able to create or edit UIMA descriptors with a nice GUI.

A Little Configuration

Letting m2e know your password

  1. Click Edit (or Window depending on your OS) > Preferences, and choose Maven > User Settings, and find the default Maven setting path for your system. See Figure 2.3.

  2. Create the settings.xml file at the given directory, and copy the text in Listing 2.1 into the file, which will store your ID and passwords. Remember to replace ID and PASSWORD with your personal Maven project repository account we provide you, and also don’t upload this file to any remote repository or share it with others.

  3. Go back to Edit (or Window) > Preferences, and choose Maven > User Settings again, you will see the plugin could find the setting file you specified (see Figure 2.4).

Importing Apache UIMA code style template

To development a software as a team, members should always adopt the same code conventions to improve the readability and maintainability of the project. We suggest you to view the Code Conventions for the Java Programming Language at http://www.oracle.com/technetwork/java/codeconv-138413.html, which was published from Oracle. For our course homeworks, you are required to adopt a set of more specific coding conventions from Apache UIMA project. Details can be found at http://uima.apache.org/codeConventions.html. At the bottom of the page, you could find a link to download the Eclipse code style template3.

  1. Download the template and save it in your local filesystem.

  2. Click Window > Preferences, then go to Java > Code Style > Formatter, and click Import.

Remember before you finish editing a Java file, press Ctrl+Shift+F to perform an automatic code formation. Another optional but useful tool for you to check your code style is the Eclipse Checkstyle plug-in. You can learn how to download and install the plug-in at http://eclipse-cs.sourceforge.net/.

Add a custom footer
Add a custom sidebar
Clone this wiki locally