Google Git
Sign in
apache / uima-site / cf58ed62c27b9d5e5b28116129e79f67eb37ff8f / . / docs / d / uimaj-current / apidocs / org / apache / uima / package-summary.html
blob: a7ba4300b0393202a7bd0cddbc7fe48d2ca29c8b [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.apache.uima (Apache UIMA Java SDK 3.1.0 User-Level API Documentation)</title>
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="org.apache.uima (Apache UIMA Java SDK 3.1.0 User-Level API Documentation)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Package</li>
<li><a href="../../../org/apache/uima/analysis_component/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/apache/uima/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.uima</h1>
<div class="docSummary">
<div class="block">Apache UIMA</div>
</div>
<p>See:&nbsp;<a href="#package.description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/apache/uima/CompositeResourceFactory.html" title="interface in org.apache.uima">CompositeResourceFactory</a></td>
<td class="colLast">
<div class="block">A type of <a href="../../../org/apache/uima/ResourceFactory.html" title="interface in org.apache.uima"><code>ResourceFactory</code></a> that produces resources by delegating to other Resource
Factories.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/apache/uima/I18nExceptionI.html" title="interface in org.apache.uima">I18nExceptionI</a></td>
<td class="colLast">
<div class="block">Like InternationalizedException, but is an interface with default methods.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/apache/uima/List_of_ints.html" title="interface in org.apache.uima">List_of_ints</a></td>
<td class="colLast">
<div class="block">a List API that returns ints instead of T</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/apache/uima/ResourceFactory.html" title="interface in org.apache.uima">ResourceFactory</a></td>
<td class="colLast">
<div class="block">A <code>ResourceFactory</code> is used to acquire instances of <a href="../../../org/apache/uima/resource/Resource.html" title="interface in org.apache.uima.resource"><code>Resource</code></a>s.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/apache/uima/ResourceSpecifierFactory.html" title="interface in org.apache.uima">ResourceSpecifierFactory</a></td>
<td class="colLast">
<div class="block">A factory used to create <a href="../../../org/apache/uima/resource/ResourceSpecifier.html" title="interface in org.apache.uima.resource"><code>ResourceSpecifier</code></a> instances and
instances of other objects needed to compose <code>ResourceSpecifier</code>s.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/apache/uima/UimaContext.html" title="interface in org.apache.uima">UimaContext</a></td>
<td class="colLast">
<div class="block">Provides access to external resources (other than the CAS).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/apache/uima/UimaContextAdmin.html" title="interface in org.apache.uima">UimaContextAdmin</a></td>
<td class="colLast">
<div class="block">Admin interface to the UIMA Context.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/apache/uima/UimaSerializable.html" title="interface in org.apache.uima">UimaSerializable</a></td>
<td class="colLast">
<div class="block">This interface is implemented by JCas classes that need to be called by the
framework when a serialization is about to happen.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/apache/uima/UimaSerializableFSs.html" title="interface in org.apache.uima">UimaSerializableFSs</a></td>
<td class="colLast">
<div class="block">This interface is implemented by JCas classes that need to be called by the
framework when a serialization is about to happen
where the _save_to_cas_data() method update Features which have references to Feature Structures</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/apache/uima/Constants.html" title="class in org.apache.uima">Constants</a></td>
<td class="colLast">
<div class="block">Some constants used by the UIMA framework.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/apache/uima/UimaContextHolder.html" title="class in org.apache.uima">UimaContextHolder</a></td>
<td class="colLast">
<div class="block">This class holds the UimaContext for the current thread, or a parent thread.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/apache/uima/UIMAFramework.html" title="class in org.apache.uima">UIMAFramework</a></td>
<td class="colLast">
<div class="block">This is an application's main interface point to the UIMA Framework.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation">
<caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/apache/uima/InternationalizedException.html" title="class in org.apache.uima">InternationalizedException</a></td>
<td class="colLast">
<div class="block">The <code>InternationalizedException</code> class adds internationalization support to
the standard functionality provided by <code>java.lang.Exception</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/apache/uima/InternationalizedRuntimeException.html" title="class in org.apache.uima">InternationalizedRuntimeException</a></td>
<td class="colLast">
<div class="block">The <code>InternationalizedRuntimeException</code> class adds internationalization support to
the standard functionality provided by <code>java.lang.RuntimeException</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/apache/uima/UIMA_IllegalArgumentException.html" title="class in org.apache.uima">UIMA_IllegalArgumentException</a></td>
<td class="colLast">
<div class="block">Thrown to indicate that a method has been passed an illegal or inappropriate argument.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/apache/uima/UIMA_IllegalStateException.html" title="class in org.apache.uima">UIMA_IllegalStateException</a></td>
<td class="colLast">
<div class="block">Signals that a method has been invoked at an illegal or inappropriate time.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/apache/uima/UIMA_UnsupportedOperationException.html" title="class in org.apache.uima">UIMA_UnsupportedOperationException</a></td>
<td class="colLast">
<div class="block">Thrown to indicate that the requested operation is not supported.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/apache/uima/UIMAException.html" title="class in org.apache.uima">UIMAException</a></td>
<td class="colLast">
<div class="block">This is the superclass for all checked exceptions in UIMA.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/apache/uima/UIMARuntimeException.html" title="class in org.apache.uima">UIMARuntimeException</a></td>
<td class="colLast">
<div class="block">This is the superclass for all unchecked exceptions in UIMA.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.uima Description">Package org.apache.uima Description</h2>
<div class="block"><h1>Apache UIMA</h1>
<p>This package contains:</p>
<ul>
<li>The <a href="../../../org/apache/uima/UIMAFramework.html" title="class in org.apache.uima"><code>UIMAFramework</code></a> class provides the primary interface point for applications.</li>
<li>Most of the error / exception indirection classes (to allow IDEs to do auto-complete looking for messages).</li>
</ul>
<h2>Internationalized Exceptions and Messages</h2>
<p>Internationalization is handled by the static methods in I18nUtil. &nbsp;These are called by the Internationalized Exceptions, but may be also used for non-exception message localization.</p>
<p>Exception messages are collected into classes. &nbsp;These classes may be organized further into hierarchies, but the top of these extend one of the following 3 classes:</p>
<ul>
<li>Exception - for checked exceptions</li>
<li>RuntimeException - for unchecked exceptions</li>
<li>SaxException - for exceptions thrown during Sax related callbacks requiring SaxExceptions be thrown</li>
</ul>
<p>Common code for getting a localized message from arguments and message key and resource bundle are put in the interface I18nExceptionI as default methods. Using default methods allows shared methods to be used with different superclass chains.</p>
<p>The individual classes:</p>
<ul>
<li>hold static public MSG_NAME = "prop-file-key-name" values, allow IDE search via completion, allows renaming via Eclipse refactorization</li>
<li>Classes collect messages for some sub-section of the code</li>
<li>Super class structure can supply common resource bundles</li>
</ul></div>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Package</li>
<li><a href="../../../org/apache/uima/analysis_component/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/apache/uima/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2006&#x2013;2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>