UIMA project logo
Quick Start for working with Source Code
Apache UIMA

Search the site

 Do the one-time-setup

To work with the source code, start by doing the one-time setups.

 Checkout and Build UIMA SDK

To build all of the Apache UIMA Java SDK (including the docbooks and the binary assembly) and install these artifacts to your local maven repository, do the following:

  • svn checkout https://svn.apache.org/repos/asf/uima/uimaj/trunk /myWorkingCopy
  • cd /myWorkingCopy/uimaj
  • mvn install

Note: if you're using windows, change the directory separator to backslash (but keep it forward for the url).

If you're looking for the lib containing all the built Jars, cd ../uimaj-distr/target and unzip/untar the binary distribution artifact, named something like uimaj-[version]-bin.zip or uimaj-[version]-bin.tar.gz. Then, look inside the unpacked result for a lib directory - it will have the Jars that were built.

 Checkout and Build UIMA-AS

The build for UIMA-AS depends on the UIMA SDK, so build that first, following the directions above.

Then, to build UIMA-AS (including the docbooks and the binary assembly) and install these artifacts to your local maven repository, do the following:

  • svn checkout https://svn.apache.org/repos/asf/uima/uima-as/trunk /myWorkingCopyAS
  • cd /myWorkingCopyAS/uima-as
  • mvn install

 Checkout and Build an Addons (Sandbox) project

  • svn checkout https://svn.apache.org/repos/asf/uima/addons/trunk /myWorkingCopyAddons
  • cd /myWorkingCopyAddons
  • mvn install

To check out just one of the addons and build it, say, the WhitespaceTokenizer, do: