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 2016/12/16 14:53:40 UTC

svn commit: r1774608 - in /uima/uimaj/branches/experiment-v3-jcas/uima-docbook-references/src/docbook: ./ ref.cas.xml ref.xml.component_descriptor.xml

Author: schor
Date: Fri Dec 16 14:53:40 2016
New Revision: 1774608

URL: http://svn.apache.org/viewvc?rev=1774608&view=rev
Log:
[UIMA-5207][UIMA-5208] update to docs

Modified:
    uima/uimaj/branches/experiment-v3-jcas/uima-docbook-references/src/docbook/   (props changed)
    uima/uimaj/branches/experiment-v3-jcas/uima-docbook-references/src/docbook/ref.cas.xml
    uima/uimaj/branches/experiment-v3-jcas/uima-docbook-references/src/docbook/ref.xml.component_descriptor.xml

Propchange: uima/uimaj/branches/experiment-v3-jcas/uima-docbook-references/src/docbook/
------------------------------------------------------------------------------
--- svn:mergeinfo (added)
+++ svn:mergeinfo Fri Dec 16 14:53:40 2016
@@ -0,0 +1,4 @@
+/uima/uimaj/branches/depend-on-july-9-build-tools/uima-docbook-references/src/docbook:963167-964468
+/uima/uimaj/branches/depend-on-parent-pom-4/uima-docbook-references/src/docbook:961329-961745
+/uima/uimaj/branches/filteredCompress-uima-2498/uima-docbook-references/src/docbook:1436573-1462257
+/uima/uimaj/trunk/uima-docbook-references/src/docbook:1690273-1774606

Modified: uima/uimaj/branches/experiment-v3-jcas/uima-docbook-references/src/docbook/ref.cas.xml
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/experiment-v3-jcas/uima-docbook-references/src/docbook/ref.cas.xml?rev=1774608&r1=1774607&r2=1774608&view=diff
==============================================================================
--- uima/uimaj/branches/experiment-v3-jcas/uima-docbook-references/src/docbook/ref.cas.xml (original)
+++ uima/uimaj/branches/experiment-v3-jcas/uima-docbook-references/src/docbook/ref.cas.xml Fri Dec 16 14:53:40 2016
@@ -281,6 +281,14 @@ under the License.
     
     <para>The <literal>uima.cas.FSArray</literal> type is an array whose elements are
       arbitrary other feature structures (instances of non-primitive types).</para>
+      
+    <para>The JCas cover classes for the array types support the Iterable API, so you may
+    write extended for loops over instances of these.  For example:
+    <programlisting>FSArray myArray = ...
+for (TOP fs : myArray) {
+  somemethod(fs);
+}</programlisting>
+    </para>
     
     <para>There are 3 built-in types associated with the artifact being analyzed:
       
@@ -364,6 +372,25 @@ under the License.
       particular value for that part of the list. The tail refers to the next list object
       (either a non-empty one or the empty version to indicate the end of the list).</para>
     
+    <para>For JCas users, the new operator for the NonEmptyXyzList classes includes a 3 argument version
+    where you may specify the head and tail values as part of the constructor.  The JCas 
+    cover classes for these implement
+    a <code>push(item)</code> method which creates a new non-empty node, sets the <code>head</code> value
+    to <code>item</code>, and the tail to the node it is called on, and returns the new node.
+    These classes also implement Iterable, so you can use the enhanced Java <code>for</code> operator.
+    The iterator stops when it gets to the end of the list, determined by either the tail being null or 
+    the element being one of the EmptyXXXList elements.
+    Here's a StringList example:
+    <programlisting>StringList sl = new EmptyStringList(jcas);
+sl = sl.push("2");
+sl = sl.push("1");
+
+for (String s : sl) {
+  someMethod(s);  // some sample use
+}</programlisting>
+    
+    </para>
+    
     <para>There are no other built-in types. Users are free to define their own type systems,
       building upon these types.</para>
     

Modified: uima/uimaj/branches/experiment-v3-jcas/uima-docbook-references/src/docbook/ref.xml.component_descriptor.xml
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/experiment-v3-jcas/uima-docbook-references/src/docbook/ref.xml.component_descriptor.xml?rev=1774608&r1=1774607&r2=1774608&view=diff
==============================================================================
--- uima/uimaj/branches/experiment-v3-jcas/uima-docbook-references/src/docbook/ref.xml.component_descriptor.xml (original)
+++ uima/uimaj/branches/experiment-v3-jcas/uima-docbook-references/src/docbook/ref.xml.component_descriptor.xml Fri Dec 16 14:53:40 2016
@@ -1945,8 +1945,9 @@ uima.tcas.Annotation.</programlisting>
             <para>
             The settings for all descriptors in a pipeline are usually loaded from one or more files
             whose names are obtained from the Java system property <emphasis>UimaExternalOverrides</emphasis>.
-            The value of the property must be a list of file names, each separated by single comma,
-            e.g. <literal>&minus;DUimaExternalOverrides=file1.settings,file2.settings</literal>
+            The value of the property must be a list of file names, each separated by a single comma 
+            e.g. <literal>&minus;DUimaExternalOverrides=file1.settings,file2.settings</literal>.
+            If a file is not in the filesystem and is a relative reference, both the datapath and classpath are searched.
             </para>
 
             <para>