You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by sc...@apache.org on 2015/10/29 18:49:39 UTC
svn commit: r1711311 -
/uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/package.html
Author: schor
Date: Thu Oct 29 17:49:39 2015
New Revision: 1711311
URL: http://svn.apache.org/viewvc?rev=1711311&view=rev
Log:
[UIMA-4662] comment update
Modified:
uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/package.html
Modified: uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/package.html
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/package.html?rev=1711311&r1=1711310&r2=1711311&view=diff
==============================================================================
--- uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/package.html (original)
+++ uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/package.html Thu Oct 29 17:49:39 2015
@@ -18,21 +18,110 @@
* under the License.
***************************************************************
-->
-<html>
- <head>
- <title>Common Analysis System(CAS) Interfaces</title>
- </head>
-
- <body>
- Common Analysis System (CAS) Interfaces.
-
- <p>
-
-The CAS provides data modelling, definition and retrieval. The data model is stored
-in a <a href="TypeSystem.html">type system</a>. Use factory methods on a
-<a href="CAS.html">CAS</a> object to create data structures. Also from a CAS, you
-can access the <a href="FSIndexRepository.html">index repository</a> to retrieve
-the data structure that have already been created.
- </p>
- </body>
-</html>
+ <!-- edit using tinymce -->
+<p>Common Analysis System(CAS) Interfaces</p>
+<h1>Common Analysis System (CAS) Interfaces</h1>
+<p>The <a href="CAS.html">CAS</a> provides</p>
+<ul>
+<li>a set of methods for creating Feature Structures and setting / getting their Feature values, based on parameters referencing Types and Features.</li>
+<li>a link to the <a href="TypeSystem.html">type system</a> being used</li>
+<li>a container for the set of one or more "Views" - each view corresponding to a separate set of indexes, contained in a <a href="FSIndexRepository.html">index repository</a>. These indexes can be used to retrieve the Feature Structures that have already been created.
+<ul>
+<li>For each view:
+<ul>
+<li>a link to the indexes used to index Feature Structures</li>
+<li>information about that view's (optional) Subject of Analysis (SofA).</li>
+<li>convenience methods for adding Feature Structures to the view's indexes</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+<h2>Type System</h2>
+<p>The Type System is a collection of types and features of each type, where the types are in a single type hierarchy. The type/feature information is collected from possibly multiple annotators that make up a UIMA pipeline, and the definitions are merged.</p>
+<h2>Index Repository</h2>
+<p>Indexes provide a way to access those Feature Structures which have been indexed (added to the index, and not subsequently removed). Each CAS view has a separate set of indexes.</p>
+<ul>
+<li>FSIndexRepository - UIMA pipelines specify a set of index definitions to be used; these definitions are used for all views. In addition to user-specified indexes, there are two built-in indexes: the Annotation Index, and a default "bag" index that is used whenever no other index is defined, to enable retrieval of all indexed Feature Structures. When users add instances to the indexes, they do so for the indexes in just one view. Users may choose to index the same Feature Structure in multiple views, with one restriction: Feature Structures which are subtypes of AnnotationBase may only be added to the view where the Feature Structure was created. The FSIndexRepository instance per view allows access to the Feature Structures indexed in that view.</li>
+<li>FSIndex - represents a particular index over a type and its subtypes. There are three underlying kinds of indexes: Bag, Set, and Sorted. The Set and Sorted include a "comparator" which defines a compare order which is also used as the definition of "equal" for Sets.</li>
+</ul>
+<h2>Built-in Feature Structure classes</h2>
+<p>This package holds the definition for many of the built-in Feature Structures.</p>
+<p>The following classes are alternate interfaces for built-in Feature Structures; they remain for backwards compatibility.org.apache.uima.cas</p>
+<table style="height: 247px;" border="1" width="307" cellpadding="2">
+<tbody>
+<tr>
+<td style="text-align: center;">UIMA v2 name<br />org.apache.uima.cas</td>
+<td style="text-align: center;">preferred<br />org.apache.uima.jcas.cas</td>
+</tr>
+<tr>
+<td>BooleanArrayFS</td>
+<td>BooleanArray</td>
+</tr>
+<tr>
+<td>ByteArrayFS</td>
+<td>ByteArray</td>
+</tr>
+<tr>
+<td>ShortArrayFS</td>
+<td>ShortArray</td>
+</tr>
+<tr>
+<td>IntegerArrayFS</td>
+<td>IntegerArray</td>
+</tr>
+<tr>
+<td>FloatArrayFS</td>
+<td>FloatArray</td>
+</tr>
+<tr>
+<td>LongArrayFS</td>
+<td>LongArray</td>
+</tr>
+<tr>
+<td>DoubleArrayFS</td>
+<td>DoubleArray</td>
+</tr>
+<tr>
+<td>SofaFS</td>
+<td>Sofa</td>
+</tr>
+<tr>
+<td>AnnotationBaseFS</td>
+<td>AnnotationBase</td>
+</tr>
+</tbody>
+</table>
+<h2>Constraints - used by filtered iterators</h2>
+<p>Iterators may be filtered, using constraints, specified using these interfaces.</p>
+<ul>
+<li>ConstraintFactor</li>
+<li>FeaturePath</li>
+<li>FeatureValuePath</li>
+<li>FSBooleanConstraint</li>
+<li>FSConstraint</li>
+<li>FSFloatConstraint</li>
+<li>FSIntConstraint</li>
+<li>FSMatchConstraint</li>
+<li>FSStringConstraint</li>
+<li>FSTypeConstraint</li>
+</ul>
+<h2>Exception collections</h2>
+<p>Many of the exceptions that UIMA may throw are collected into groups here. These classes provide one level of indirection that permit IDE environments to conveniently locate and work with these.</p>
+<table>
+<tbody>
+<tr>
+<td> </td>
+<td style="text-align: center;">Extends</td>
+</tr>
+<tr>
+<td>CASException</td>
+<td>UIMAException (checked)</td>
+</tr>
+<tr>
+<td>CASRuntimeException</td>
+<td>UIMARuntimeException</td>
+</tr>
+</tbody>
+</table>
+<p> </p>