| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "https://www.w3.org/TR/html4/loose.dtd"> |
| |
| |
| <!-- ====================================================================== --> |
| <!-- GENERATED FILE, DO NOT EDIT, EDIT THE XML FILE IN xdocs INSTEAD! --> |
| <!-- ====================================================================== --> |
| <html> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/> |
| <style type="text/css">@import "stylesheets/base.css";</style> |
| <meta name="author" value=" |
| Apache UIMA Documentation Team"> |
| <meta name="email" value="dev@uima.apache.org"> |
| |
| |
| |
| <title>Apache UIMA - Quick Start for working with Source Code</title> |
| |
| <!-- Begin Cookie Consent plugin by Silktide - https://silktide.com/cookieconsent --> |
| <!-- Commented out because implied consent is not compatible with GDPR --> |
| <!-- |
| <script type="text/javascript"> |
| window.cookieconsent_options = {"message":"This website uses cookies to ensure you get the best experience on our website","dismiss":"Got it!","learnMore":"More info","link":"https://uima.apache.org/privacy-policy.html","theme":"dark-bottom"}; |
| </script> |
| |
| <script type="text/javascript" src="/cookieconsent2/cookieconsent.min.js"></script> |
| --> |
| <!-- End Cookie Consent plugin --> |
| |
| <!-- Begin Google Analytics --> |
| <!-- Commented out because GA requires consent according to GDPR --> |
| <!-- |
| <script> |
| (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ |
| (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), |
| m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) |
| })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); |
| |
| ga('create', 'UA-70846351-1', 'auto'); |
| ga('set', 'anonymizeIp', true); |
| ga('send', 'pageview'); |
| |
| </script> |
| --> |
| <!-- End Google Analytics --> |
| </head> |
| |
| <body> |
| <div class="topLogos"> |
| <table border="0" width="100%" cellspacing="0"> |
| <!-- TOP IMAGE --> |
| <tr> |
| <td align='LEFT'> |
| <a href="index.html"> |
| <img style="border: 1px solid black;" src="./images/UIMA_banner2tlpTm.png" alt="UIMA project logo" border="0"/> |
| </a> |
| </td> |
| <td align='CENTER'> |
| <div class="pageBanner">Quick Start for working with Source Code</div> |
| </td> |
| <td align='RIGHT'> |
| <a href="https://www.apache.org"> |
| <img src="./images/asf-logo-on-white-smallTm.png" alt="Apache UIMA" border="0"/> |
| </a> |
| </td> |
| </tr> |
| </table> |
| <hr noshade="" size="1"/> |
| </div> |
| <table border="0" width="100%" cellspacing="4"> |
| <tr> |
| <td align='RIGHT' colspan="2"> |
| <form method="get" action="https://www.google.com/search"> |
| Search the site |
| <input type="text" name="q" size="25" maxlength="255" value="" /> |
| <input type="hidden" name="sitesearch" value="https://uima.apache.org/" /> |
| <input name="Search" value="Search Site" type="submit"/> |
| </form> |
| </td> |
| </tr> |
| <tr> <!-- LEFT SIDE NAVIGATION --> |
| <td width="20%" valign="top"> |
| |
| |
| |
| |
| |
| |
| <!-- regular menu --> |
| <div class="navBar"> |
| <br/> |
| <div class="navBarItem"> <div class="navPartHeading">General</div> |
| </div> |
| <div class="navBar"> |
| <div class="navBarItem"> <a href="./index.html">Home</a> |
| </div> |
| <div class="navBarItem"> <a href="./downloads.cgi">Downloads</a> |
| </div> |
| <div class="navBarItem"> <a href="./documentation.html">Documentation</a> |
| </div> |
| <div class="navBarItem"> <a href="./news.html">News</a> |
| </div> |
| <div class="navBarItem"> <a href="./publications.html">Publications</a> |
| </div> |
| <br style="line-height: .5em"/> |
| <div class="navBarItem"> <a href="https://issues.apache.org/jira/browse/uima" target="_blank" rel="noopener">Issue tracker <img src="images/offsitelink.png"/></a> |
| </div> |
| <div class="navBarItem"> <a href="https://cwiki.apache.org/confluence/display/UIMA/" target="_blank" rel="noopener">Wiki <img src="images/offsitelink.png"/></a> |
| </div> |
| <br style="line-height: .5em"/> |
| <div class="navBarItem"> <a href="https://cwiki.apache.org/confluence/display/UIMA/Powered+by+Apache+UIMA" target="_blank" rel="noopener">Powered By UIMA <img src="images/offsitelink.png"/></a> |
| </div> |
| </div> |
| <br/> |
| <div class="navBarItem"> <div class="navPartHeading">Community</div> |
| </div> |
| <div class="navBar"> |
| <div class="navBarItem"> <a href="./get-involved.html">Get Involved</a> |
| </div> |
| <div class="navBarItem"> <a href="./mail-lists.html">Mailing Lists</a> |
| </div> |
| <div class="navBarItem"> <a href="./contribution-policy.html">Contribution Policies</a> |
| </div> |
| <div class="navBarItem"> <a href="./faq.html">FAQ</a> |
| </div> |
| <div class="navBarItem"> <a href="./project-guidelines.html">Project Guidelines</a> |
| </div> |
| </div> |
| <br/> |
| <div class="navBarItem"> <div class="navPartHeading">Scaleout Frameworks</div> |
| </div> |
| <div class="navBar"> |
| <div class="navBarItem"> <a href="./doc-uimaas-what.html">UIMA-AS</a> |
| </div> |
| <div class="navBarItem"> <a href="./doc-uimaducc-whatitam.html">UIMA-DUCC</a> |
| </div> |
| <div class="navBarItem"> <a href="./doc-uimaducc-demo.html">..Demo Page</a> |
| </div> |
| <div class="navBarItem"> <a href="http://uima-ducc-demo.apache.org:42133" target="_blank" rel="noopener">..Demo Live <img src="images/offsitelink.png"/></a> |
| </div> |
| </div> |
| <br/> |
| <div class="navBarItem"> <div class="navPartHeading">Components & Tools</div> |
| </div> |
| <div class="navBar"> |
| <div class="navBarItem"> <a href="./sandbox.html#uima-addons-annotators">Annotators</a> |
| </div> |
| <div class="navBarItem"> <a href="./toolsServers.html">Tools & Servers</a> |
| </div> |
| <div class="navBarItem"> <a href="./sandbox.html">Addons and Sandbox</a> |
| </div> |
| <div class="navBarItem"> <a href="./ruta.html">UIMA Ruta</a> |
| </div> |
| <div class="navBarItem"> <a href="./uimafit.html">uimaFIT</a> |
| </div> |
| <div class="navBarItem"> <a href="./external-resources.html">External Resources</a> |
| </div> |
| </div> |
| <br/> |
| <div class="navBarItem"> <div class="navPartHeading">Development</div> |
| </div> |
| <div class="navBar"> |
| <div class="navBarItem"> <a href="./dev-quick.html">Quick Start: building</a> |
| </div> |
| <div class="navBarItem"> <a href="./building-uima.html">Building from Source</a> |
| </div> |
| <div class="navBarItem"> <a href="./one-time-setup.html">One-time setups</a> |
| </div> |
| <div class="navBarItem"> <a href="./svn.html">Source Code</a> |
| </div> |
| <div class="navBarItem"> <a href="./release.html">Doing a UIMA release</a> |
| </div> |
| <div class="navBarItem"> <a href="https://www.apache.org/security/committers.html" target="_blank" rel="noopener">Doing a CVE (Apache) <img src="images/offsitelink.png"/></a> |
| </div> |
| <div class="navBarItem"> <a href="./eclipse-update-site.html">Eclipse Update Sites</a> |
| </div> |
| <div class="navBarItem"> <a href="./git.html">GIT</a> |
| </div> |
| <div class="navBarItem"> <a href="./codeConventions.html">Code Conventions</a> |
| </div> |
| <div class="navBarItem"> <a href="./uima-specification.html">UIMA Specification (OASIS)</a> |
| </div> |
| <div class="navBarItem"> <a href="./team-list.html">Project Team</a> |
| </div> |
| <div class="navBarItem"> <a href="./maven-design.html">Maven Use</a> |
| </div> |
| <div class="navBarItem"> <a href="./updating-website.html">Updating this Website</a> |
| </div> |
| </div> |
| <br/> |
| <div class="navBarItem"> <div class="navPartHeading">Events and Conferences</div> |
| </div> |
| <div class="navBar"> |
| <div class="navBarItem"> <a href="./coling14.html">COLING 2014</a> |
| </div> |
| <div class="navBarItem"> <a href="./gscl13.html">GSCL 2013</a> |
| </div> |
| <div class="navBarItem"> <a href="./iks09.html">IKS 2009</a> |
| </div> |
| <div class="navBarItem"> <a href="./gscl09.html">GSCL 2009</a> |
| </div> |
| <div class="navBarItem"> <a href="./lsm09.html">LSM 2009</a> |
| </div> |
| <div class="navBarItem"> <a href="./lrec08.html">LREC 2008</a> |
| </div> |
| <div class="navBarItem"> <a href="./gldv07.html">GLDV 2007</a> |
| </div> |
| </div> |
| <br/> |
| <div class="navBarItem"> <div class="navPartHeading">ASF</div> |
| </div> |
| <div class="navBar"> |
| <div class="navBarItem"> <a href="https://www.apache.org/licenses/" target="_blank" rel="noopener">License <img src="images/offsitelink.png"/></a> |
| </div> |
| <div class="navBarItem"> <a href="https://www.apache.org/foundation/thanks.html" target="_blank" rel="noopener">ASF Sponsors <img src="images/offsitelink.png"/></a> |
| </div> |
| <div class="navBarItem"> <a href="https://www.apache.org/foundation/sponsorship.html" target="_blank" rel="noopener">ASF Sponsorship <img src="images/offsitelink.png"/></a> |
| </div> |
| <div class="navBarItem"> <a href="./security_report">Security</a> |
| </div> |
| </div> |
| </div> |
| </td> |
| <td width="80%" align="left" valign="top"> |
| <div class="sectionTable"> |
| <table class="sectionTable"> |
| <tr><td> |
| <a name="Do the one-time-setup"><h1><img src="images/UIMA_4sq50tightCropSolid.png"/> Do the one-time-setup</h1></a> |
| </td></tr> |
| <tr><td> |
| <blockquote class="sectionBody"> |
| <p>To work with the source code, start by doing the |
| <a href="one-time-setup.html">one-time setups</a>. |
| </p> |
| </blockquote> |
| </p> |
| </td></tr> |
| </table> |
| <div class="sectionTable"> |
| <table class="sectionTable"> |
| <tr><td> |
| <a name="Checkout and Build UIMA SDK"><h1><img src="images/UIMA_4sq50tightCropSolid.png"/> Checkout and Build UIMA SDK</h1></a> |
| </td></tr> |
| <tr><td> |
| <blockquote class="sectionBody"> |
| <p>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 commands. We'll assume |
| you want to do this work in a local disk directory on your build machine. |
| </p> |
| <p>First, as an example, create the local build directory by using whatever your operating system's |
| commands are for creating this. For instance, in Windows, you might pick "myWorkingCopy" |
| as the name of your local build directory, and create it at the top level, using the command: |
| </p> |
| <ul> |
| <lil><code>mkdir \myWorkingCopy</code></lil> |
| </ul> |
| <p>UIMA has several projects. The main, core project, is the Java SDK. This is named "uimaj" - |
| the last letter, "j" stands for "Java". Here are sample commands that check out the "trunk" |
| (most current) version |
| into a subdirectory of <code>\myWorkingCopy</code> |
| and build it using: |
| <ul> |
| <li>cd \myWorkingCopy</li> |
| <li><code>svn checkout https://svn.apache.org/repos/asf/uima/uimaj/trunk uimaj</code></li> |
| <li><code>cd uimaj</code></li> |
| <li><code>mvn install</code></li> |
| </ul> |
| </p> |
| <p class="note">Note: if you're using Linux or MacOS, |
| change the directory separator character to a forward slash ( "/" ).</p> |
| <p class="note">Note: to build a particular release. instead of the most current (and possibly, not working) |
| version under development, replace "trunk" with "tags/" + the svn name |
| of that release, |
| such as "tags/uimaj-2.9.0".</p> |
| <p>If you're looking for the lib containing all the built Jars, <code>cd \myWorkingCopy\uimaj\target</code> |
| and unzip/untar the binary distribution artifact, named something like |
| <code>uimaj-[version]-bin.zip or uimaj-[version]-bin.tar.gz</code>. |
| Then, look inside the unpacked result for a lib directory - it will have the Jars that were built. |
| </p> |
| </blockquote> |
| </p> |
| </td></tr> |
| </table> |
| <div class="sectionTable"> |
| <table class="sectionTable"> |
| <tr><td> |
| <a name="Checkout and Build UIMA-AS"><h1><img src="images/UIMA_4sq50tightCropSolid.png"/> Checkout and Build UIMA-AS</h1></a> |
| </td></tr> |
| <tr><td> |
| <blockquote class="sectionBody"> |
| <p>To build UIMA-AS |
| (including the docbooks and the binary assembly) and install these artifacts |
| to your local maven repository, do the following: |
| <ul> |
| <li><code>cd \myWorkingCopy</code></li> |
| <li><code>svn checkout https://svn.apache.org/repos/asf/uima/uima-as/trunk uima-as</code></li> |
| <li><code>cd uima-as</code></li> |
| <li><code>mvn install</code></li> |
| </ul> |
| </p> |
| </blockquote> |
| </p> |
| </td></tr> |
| </table> |
| <div class="sectionTable"> |
| <table class="sectionTable"> |
| <tr><td> |
| <a name="Checkout and Build an Addons (Sandbox) project"><h1><img src="images/UIMA_4sq50tightCropSolid.png"/> Checkout and Build an Addons (Sandbox) project</h1></a> |
| </td></tr> |
| <tr><td> |
| <blockquote class="sectionBody"> |
| <p> |
| <ul> |
| <li><code>cd \myWorkingCopy</code></li> |
| <li><code>svn checkout https://svn.apache.org/repos/asf/uima/addons/trunk addons</code></li> |
| <li><code>cd addons</code></li> |
| <li><code>mvn install</code></li> |
| </ul> |
| </p> |
| <p>To check out just one of the addons and build it, say, the WhitespaceTokenizer, do:<a /> |
| <ul> |
| <li><code>cd \myWorkingCopy</code></li> |
| <li><code>svn checkout https://svn.apache.org/repos/asf/uima/addons/trunk/WhitespaceTokenizer whitespaceTokenizer</code></li> |
| <li><code>cd whitespaceTokenizer</code></li> |
| <li><code>mvn install</code></li> |
| </ul> |
| </p> |
| </blockquote> |
| </p> |
| </td></tr> |
| </table> |
| <div class="sectionTable"> |
| <table class="sectionTable"> |
| <tr><td> |
| <a name="Checkout and Build UIMA C++ SDK"><h1><img src="images/UIMA_4sq50tightCropSolid.png"/> Checkout and Build UIMA C++ SDK</h1></a> |
| </td></tr> |
| <tr><td> |
| <blockquote class="sectionBody"> |
| <p> |
| Checkout the source code as follows: |
| <ul> |
| <li><code>svn checkout https://svn.apache.org/repos/asf/uima/uimacpp/trunk /myWorkingCopyUimacpp</code></li> |
| </ul> |
| </p> |
| <p> |
| UIMACPP runtime prerequisites are APR, ICU, Xerces-C, ActiveMQ-cpp, |
| APR-Util and a JDK for building the JNI interface. The SDK also |
| requires doxygen for building the documentation. |
| </p> |
| <p> |
| To build the SDK, all prerequisites need to be built from source. |
| Alternatively UIMACPP can be built and installed on a machine with all the prerequisites available in system directories. |
| In this case the prerequisites can be installed from binary distributions. |
| </p> |
| <table class="subsectionTable"> |
| <tr><td> |
| |
| |
| |
| <a name="Building on Unix"> |
| <h2>Building on Unix |
| </h2> |
| </a> |
| </td></tr> |
| <tr><td> |
| <blockquote class="subsectionBody"> |
| <p> |
| To build and install on a machine with prerequisites available in system directories: |
| </p> |
| <ul> |
| <li><code>cd /myWorkingCopyUimacpp</code></li> |
| <li><code>./configure --with-jdk=location_of_jni.h [other options]</code></li> |
| <li><code>make</code></li> |
| <li><code>make check</code></li> |
| </ul> |
| <p> |
| For a full SDK build, |
| <ul> |
| <li> |
| <code>./configure --with-apr=loc_of_apr_install --with-icu=loc_of_icu_install --with-xerces=loc_of_xerces_install --with-activemq=loc_of_amq_install --with-apr-util=loc_of_apr-util_install</code> |
| </li> |
| <li><code>make install</code></li> |
| <li><code>make sdk TARGETDIR="loc_of_sdk_tree [clean]"</code></li> |
| </ul> |
| </p> |
| <p> |
| For a build of UIMACPP without UIMA-AS support, specify the option |
| <code>--without-activemq</code>. The options <code>--with-activemq</code> and <code>--with-apr-util</code> can be left out. |
| </p> |
| </blockquote> |
| </td></tr> |
| </table> |
| <table class="subsectionTable"> |
| <tr><td> |
| |
| |
| |
| <a name="Building on Windows"> |
| <h2>Building on Windows |
| </h2> |
| </a> |
| </td></tr> |
| <tr><td> |
| <blockquote class="subsectionBody"> |
| <p> |
| To build an SDK all prerequisite components, APR, ICU, Xerces-C, |
| ActiveMQ-cpp and APR-Util must first be built on the machine, and a |
| JDK installed. The location of the dependencies must be set in |
| environment variables APR_HOME, ICU_HOME, XERCES_HOME, ACTIVEMQ_HOME, |
| APU_HOME and JAVA_INCLUDE. |
| </p> |
| <ul> |
| <li><code>cd /myWorkingCopyUimacpp</code></li> |
| <li><code>winmake /build release (or debug)</code></li> |
| <li><code>cd src\test</code></li> |
| <li><code>devenv test.sln /build release</code></li> |
| <li><code>fvt</code></li> |
| <li><code>cd /myWorkingCopyUimacpp/docs</code></li> |
| <li><code>builddocs</code></li> |
| <li><code>buildsdk "target_dir [clean]"</code></li> |
| </ul> |
| </blockquote> |
| </td></tr> |
| </table> |
| <p>For more details on platform specific build issues and on the dependencies, see |
| <a href="doc-uimacpp-build.html">UIMA C++ Building from source</a>. |
| </p> |
| </blockquote> |
| </p> |
| </td></tr> |
| </table> |
| </td> |
| </tr> |
| <!-- FOOTER --> |
| <tr><td colspan="2"> |
| <hr noshade="" size="1"/> |
| </td></tr> |
| <tr><td colspan="2"> |
| <table class="pageFooter"> |
| <tr> |
| <td><a href="index.html">Home</a></td> |
| <td><a href="privacy-policy.html">Privacy Policy</a></td> |
| <td style="font-size:75%"> |
| Copyright © 2006-2013, The Apache Software Foundation.<br/> |
| Apache UIMA, UIMA, the Apache UIMA logo and the Apache Feather logo are trademarks of The Apache Software Foundation.<br/> |
| All other marks mentioned may be trademarks or registered trademarks of their respective owners. |
| </td> |
| <td><a href="mailto:dev@uima.apache.org">Contact us</a></td> |
| </tr> |
| </table> |
| </td></tr> |
| </table> |
| </body> |
| </html> |
| |
