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/11/08 22:39:52 UTC
svn commit: r1768803 - in /uima/uimaj/branches/experiment-v3-jcas:
PearPackagingMavenPlugin/ uima-docbook-overview-and-setup/
uima-docbook-references/ uima-docbook-tools/
uima-docbook-tutorials-and-users-guides/
uima-docbook-tutorials-and-users-guides/...
Author: schor
Date: Tue Nov 8 22:39:52 2016
New Revision: 1768803
URL: http://svn.apache.org/viewvc?rev=1768803&view=rev
Log: (empty)
Modified:
uima/uimaj/branches/experiment-v3-jcas/PearPackagingMavenPlugin/ (props changed)
uima/uimaj/branches/experiment-v3-jcas/uima-docbook-overview-and-setup/ (props changed)
uima/uimaj/branches/experiment-v3-jcas/uima-docbook-references/ (props changed)
uima/uimaj/branches/experiment-v3-jcas/uima-docbook-tools/ (props changed)
uima/uimaj/branches/experiment-v3-jcas/uima-docbook-tutorials-and-users-guides/ (props changed)
uima/uimaj/branches/experiment-v3-jcas/uima-docbook-tutorials-and-users-guides/src/docbook/ (props changed)
uima/uimaj/branches/experiment-v3-jcas/uima-docbook-tutorials-and-users-guides/src/docbook/tug.application.xml
Propchange: uima/uimaj/branches/experiment-v3-jcas/PearPackagingMavenPlugin/
------------------------------------------------------------------------------
--- svn:mergeinfo (original)
+++ svn:mergeinfo Tue Nov 8 22:39:52 2016
@@ -3,4 +3,4 @@
/uima/uimaj/branches/depend-on-parent-pom-4/PearPackagingMavenPlugin:961329-961745
/uima/uimaj/branches/filteredCompress-uima-2498/PearPackagingMavenPlugin:1436573-1462257
/uima/uimaj/branches/mavenAlign/PearPackagingMavenPlugin:933273-944394
-/uima/uimaj/trunk/PearPackagingMavenPlugin:1690273-1693269
+/uima/uimaj/trunk/PearPackagingMavenPlugin:1690273-1768790
Propchange: uima/uimaj/branches/experiment-v3-jcas/uima-docbook-overview-and-setup/
------------------------------------------------------------------------------
--- svn:mergeinfo (original)
+++ svn:mergeinfo Tue Nov 8 22:39:52 2016
@@ -1,4 +1,4 @@
/uima/uimaj/branches/depend-on-july-9-build-tools/uima-docbook-overview-and-setup:963167-964468
/uima/uimaj/branches/depend-on-parent-pom-4/uima-docbook-overview-and-setup:961329-961745
/uima/uimaj/branches/filteredCompress-uima-2498/uima-docbook-overview-and-setup:1436573-1462257
-/uima/uimaj/trunk/uima-docbook-overview-and-setup:1690273-1693269
+/uima/uimaj/trunk/uima-docbook-overview-and-setup:1690273-1768790
Propchange: uima/uimaj/branches/experiment-v3-jcas/uima-docbook-references/
------------------------------------------------------------------------------
--- svn:mergeinfo (original)
+++ svn:mergeinfo Tue Nov 8 22:39:52 2016
@@ -1,4 +1,4 @@
/uima/uimaj/branches/depend-on-july-9-build-tools/uima-docbook-references:963167-964468
/uima/uimaj/branches/depend-on-parent-pom-4/uima-docbook-references:961329-961745
/uima/uimaj/branches/filteredCompress-uima-2498/uima-docbook-references:1436573-1462257
-/uima/uimaj/trunk/uima-docbook-references:1690273-1766094
+/uima/uimaj/trunk/uima-docbook-references:1690273-1768790
Propchange: uima/uimaj/branches/experiment-v3-jcas/uima-docbook-tools/
------------------------------------------------------------------------------
--- svn:mergeinfo (original)
+++ svn:mergeinfo Tue Nov 8 22:39:52 2016
@@ -1,4 +1,4 @@
/uima/uimaj/branches/depend-on-july-9-build-tools/uima-docbook-tools:963167-964468
/uima/uimaj/branches/depend-on-parent-pom-4/uima-docbook-tools:961329-961745
/uima/uimaj/branches/filteredCompress-uima-2498/uima-docbook-tools:1436573-1462257
-/uima/uimaj/trunk/uima-docbook-tools:1690273-1693269
+/uima/uimaj/trunk/uima-docbook-tools:1690273-1768790
Propchange: uima/uimaj/branches/experiment-v3-jcas/uima-docbook-tutorials-and-users-guides/
------------------------------------------------------------------------------
--- svn:mergeinfo (original)
+++ svn:mergeinfo Tue Nov 8 22:39:52 2016
@@ -1,4 +1,4 @@
/uima/uimaj/branches/depend-on-july-9-build-tools/uima-docbook-tutorials-and-users-guides:963167-964468
/uima/uimaj/branches/depend-on-parent-pom-4/uima-docbook-tutorials-and-users-guides:961329-961745
/uima/uimaj/branches/filteredCompress-uima-2498/uima-docbook-tutorials-and-users-guides:1436573-1462257
-/uima/uimaj/trunk/uima-docbook-tutorials-and-users-guides:1690273-1693269,1744753-1744754,1757296-1757568
+/uima/uimaj/trunk/uima-docbook-tutorials-and-users-guides:1690273-1768790
Propchange: uima/uimaj/branches/experiment-v3-jcas/uima-docbook-tutorials-and-users-guides/src/docbook/
('svn:mergeinfo' removed)
Modified: uima/uimaj/branches/experiment-v3-jcas/uima-docbook-tutorials-and-users-guides/src/docbook/tug.application.xml
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/experiment-v3-jcas/uima-docbook-tutorials-and-users-guides/src/docbook/tug.application.xml?rev=1768803&r1=1768802&r2=1768803&view=diff
==============================================================================
--- uima/uimaj/branches/experiment-v3-jcas/uima-docbook-tutorials-and-users-guides/src/docbook/tug.application.xml (original)
+++ uima/uimaj/branches/experiment-v3-jcas/uima-docbook-tutorials-and-users-guides/src/docbook/tug.application.xml Tue Nov 8 22:39:52 2016
@@ -640,6 +640,17 @@ ae.destroy();</programlisting></para>
<entry>Yes</entry>
<entry>-</entry>
</row>
+ <row>
+ <entry>optionally include embedded Type System and Indexes definition?</entry>
+ <entry>-</entry>
+ <entry>-</entry>
+ <entry>Just type system</entry>
+ <entry>Yes</entry>
+ <entry>Yes</entry>
+ <entry>Yes</entry>
+ <entry>Yes</entry>
+ </row>
+
</tbody>
</tgroup>
@@ -686,24 +697,32 @@ ae.destroy();</programlisting></para>
Normally this causes an exception, but with the lenient flag turned on, these extra types and/or features are
skipped over and ignored, with no error indicated.</para>
+ <para>Some formats optionally allow embedded type system and indexes definition to be saved;
+ loaders for these can use that information to
+ replace the CAS's type system and indexes definition, or (for compressed form 6) use the type system part
+ to decode the serialized data. This is described in detail in the Javadocs for CasIOUtils.
+ JSON serialization has several alternatives for optionally including portions of the type system, described in
+ the reference document chapter on JSON.</para>
+
<para>To save an XMI representation of a CAS, use the <code>save</code> method in <code>CasIOUtils</code> or the
<literal>serialize</literal> method of the class
<literal>org.apache.uima.util.XmlCasSerializer</literal>. To save an XCAS representation of a CAS,
- use the <code>save</code> method in <code>CasIOUtils</code> class or see the <literal>org.apache.uima.cas.impl.XCASSerializer</literal> instead; see the Javadocs
+ use the <code>save</code> method in <code>CasIOUtils</code> class or use the
+ <literal>org.apache.uima.cas.impl.XCASSerializer</literal> instead; see the Javadocs
for details.</para>
<para>All the external serialized forms (except JSON and the inline CAS approximate serialization)
can be read back in using the <code>CasIOUtils load</code> methods.
- The <code>CasIOUtils load</code> methods also support loading type system and index definition information
- at the same time (usually from addition input sources). Some variations of these will use the read type system
- and indexes definition to replace those in the CAS.
+ The <code>CasIOUtils load</code> methods also have API forms that support
+ loading type system and index definition information
+ at the same time (from addition input sources); there is also a form for loading compressed form 6 where
+ you can pass the type system to use for decoding, when it is different from that of the receiving CAS.
The XCAS and XMI external forms can also be read back in using the <literal>deserialize</literal> method of
the class <literal>org.apache.uima.util.XmlCasDeserializer</literal>. All of these methods deserialize
into a pre-existing CAS, which you must create ahead of time. See the
Javadocs for details.</para>
- <para>The <code>CasIOUtils</code> class has a collection of static methods to load (deserialize) and save (serialize) CASes,
- optionally with their type system and index definitions.
+ <para>
The <code>Serialization</code> class has various static methods for serializing and deserializing Java Object forms and
compressed forms, with finer control over available options.
See the Javadocs for that class for details.</para>