Google Git
Sign in
apache / uima-site / ae4bf94d1ce1ffde6303a4333f17c60c9898a0a9 / . / docs / doc-uima-examples.html
blob: 0017028389fcdb13ba4628007ef37ac779422cef [file] [log] [blame]
<!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 - Getting Started: Java UIMA Framework and SDK</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">Getting Started: Java UIMA Framework and SDK</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="Getting Started: Installing the Apache UIMA Java Framework and SDK, and Running Examples"><h1><img src="images/UIMA_4sq50tightCropSolid.png"/>&nbsp;Getting Started: Installing the Apache UIMA Java Framework and SDK, and Running Examples</h1></a>
</td></tr>
<tr><td>
<blockquote class="sectionBody">
<p>
This
guide helps you install the Apache UIMA&trade; Java SDK release
package and shows you how run the UIMA analysis example
using some of the UIMA tooling.
</p>
<table class="subsectionTable">
<tr><td>
<a name="Install UIMA SDK">
<h2>Install UIMA SDK
</h2>
</a>
</td></tr>
<tr><td>
<blockquote class="subsectionBody">
<p>
To get started with UIMA, you first have to install
the Apache UIMA Java SDK release package. The packages are
available at the UIMA
<a href="downloads.cgi">download page</a>
in different data formats for different platforms.
Choose for example the .zip packages when you work
on Windows or the .tar.gz packages when you work on
Linux. Further we have two different package types,
the binary distribution that contains the compiled
sources with script files to run the tooling and the
source distribution that only contains the sources
of the release.
</p>
<p>The package you want to download and install is the
core Java SDK package. (Other packages include additional
annotators and tools, and an Asynchronous Scaleout
package enabling deployment of UIMA configurations using
clusters of machines, for higher performance.)</p>
<p>
To install the core UIMA SDK you have to:
<ol>
<li>
Download the perferred binary distribution
package. To verify the download you can use the
signature files provided for each file. For details on
how to verify the download please refer to
"<a href="downloads.cgi#VerifyDownload">Verifying a Release Download</a>"
</li>
<li>
Unzip the downloaded release package to a target directory of your
choice.
</li>
<li>
Create an UIMA_HOME environment variable
that points to the target directory where
you have unzipped the downloaded release package.
</li>
<li>
If you haven't already set a JAVA_HOME
variable, create a JAVA_HOME environment
variable that points to a JDK (Java
Development Kit) of your choice. UIMA
requires at least a Java level 1.5 to run.
For more details about the supported Java
versions, please refer to the README
document of the release package.
</li>
<br />
<li>
Optional: If you want to have the UIMA
script files in the PATH environment
variable of your system you additionally
have to add $UIMA_HOME/bin (or for Windows
%UIMA_HOME%\bin) to your PATH settings.
</li>
<li>
Optional: To use the provided examples you
have to adjust the examples to your UIMA
installation directory. To do that, just run
the
<code>adjustExamplePaths.sh</code>
(or for Windows .bat) script in the
<code>bin</code>
subdirectory of your UIMA installation.
</li>
</ol>
</p>
<p>
Now the installation of UIMA is finished and all the
tooling and the examples should work properly.
</p>
</blockquote>
</td></tr>
</table>
<table class="subsectionTable">
<tr><td>
<a name="Running The UIMA Analysis Example">
<h2>Running The UIMA Analysis Example
</h2>
</a>
</td></tr>
<tr><td>
<blockquote class="subsectionBody">
<p>
UIMA comes with many examples for the different UIMA
components and artifacts that can be created. All
these examples are explained and used in the UIMA
documentation when the specific components or
artifacts are introduced. The UIMA analysis example
that we want to use now is a combination of some of
these example components that shows a basic document
analysis using UIMA.
</p>
<p>
To run the UIMA analysis example, we use the UIMA
DocumentAnalyzer tooling that comes with the UIMA
SDK. The tool can run UIMA analysis components (also
know as annotators) on a given set of text documents
and shows the result of the analysis run at the end.
</p>
<p>
To start the UIMA DocumentAnalyzer, start the
<code>documentAnalyzer.sh</code>
(or for Windows .bat) file located in the
<code>bin</code>
subdirectory of your UIMA installation. The
DocumentAnalyzer window pops up where the following
values must be set to run the UIMA analysis example:
</p>
<p>
Input Directory:
<code>&lt;UIMA_HOME&gt;/examples/data</code>
<br />
Output Directory:
<code>&lt;UIMA_HOME&gt;/examples/data/processed</code>
<br />
AE XML Descriptor:
<code>
&lt;UIMA_HOME&gt;/examples/descriptors/analysis_engine/UIMA_Analysis_Example.xml
</code>
<br />
</p>
<p>
Replace &lt;UIMA_HOME&gt; above with the path of your
Apache UIMA installation directory. In the sample
screenshot below, the Apache UIMA installation
directory was "C:\programme\apache-uima".
</p>
<p>
<table width="100%">
<tr>
<td align="center" valign="middle">
<img src="./images/getting-started/run_config.jpg" alt="DocumentAnalyzer run configuration" border="0" />
</td>
</tr>
</table>
</p>
<p>
To analyze the doccuments, click the "Run" button,
which should, after a brief pause, pop up an
"Analyzed Results" window.
</p>
<p>
<table width="100%">
<tr>
<td align="center" valign="middle">
<img src="./images/getting-started/analyzed_docs.jpg" alt="Analyzed Documents view" border="0" />
</td>
</tr>
</table>
</p>
<p>
To display the analysis results for one of the
documents, just double-click the desired document.
The important one for the UIMA analysis example is
the Apache_UIMA.xmi file. When you open this
document from the result list, you will see
different kind of annotations such as:
</p>
<p>
<ul>
<li>EmailAddress annotations</li>
<li>Name annotations</li>
<li>PersonTitle annotations</li>
<li>Sentence annotations</li>
<li>Token annotations</li>
</ul>
</p>
<p>
When selecting the check-box for those annotations
the highlighting in the text for those annotations
can be turned on or off.
</p>
<p>
<table width="100%">
<tr>
<td align="center" valign="middle">
<img src="./images/getting-started/annotations.jpg" alt="DocumentAnalyzer annotation view" border="0" />
</td>
</tr>
</table>
</p>
<p>
This concludes the exercise. You may wish to
experiment by submitting text of your own for
analysis. To do that you can use the
DocumentAnalyzer in the interactive mode. Just click
the "Interactive" button instead of the "Run" button
when you have entered the settings for the analysis
example as seen in the screenshot above.
</p>
<p>
After clicking the "Interactive" button to following
screen is displayed where you can enter your text.
</p>
<p>
<table width="100%">
<tr>
<td align="center" valign="middle">
<img src="./images/getting-started/interactive.jpg" alt="DocumentAnalyzer interactive mode" border="0" />
</td>
</tr>
</table>
</p>
<p>
When clicking the "Analyze" button your text will be
analyzed and you will see the analysis results in
the annotation view in the same way as for the
example above.
</p>
</blockquote>
</td></tr>
</table>
</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 &#169; 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>