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/03 15:31:01 UTC
svn commit: r1767906 - in
/uima/uimaj/branches/experiment-v3-jcas/uima-docbook-v3-users-guide/src/docbook:
uv3.backwards_compatibility.xml uv3.custom_java_objects.xml uv3.overview.xml
Author: schor
Date: Thu Nov 3 15:31:01 2016
New Revision: 1767906
URL: http://svn.apache.org/viewvc?rev=1767906&view=rev
Log:
[UIMA-5137] doc updates, note that binary serialization not backwards compat due to new builtins
Modified:
uima/uimaj/branches/experiment-v3-jcas/uima-docbook-v3-users-guide/src/docbook/uv3.backwards_compatibility.xml
uima/uimaj/branches/experiment-v3-jcas/uima-docbook-v3-users-guide/src/docbook/uv3.custom_java_objects.xml
uima/uimaj/branches/experiment-v3-jcas/uima-docbook-v3-users-guide/src/docbook/uv3.overview.xml
Modified: uima/uimaj/branches/experiment-v3-jcas/uima-docbook-v3-users-guide/src/docbook/uv3.backwards_compatibility.xml
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/experiment-v3-jcas/uima-docbook-v3-users-guide/src/docbook/uv3.backwards_compatibility.xml?rev=1767906&r1=1767905&r2=1767906&view=diff
==============================================================================
--- uima/uimaj/branches/experiment-v3-jcas/uima-docbook-v3-users-guide/src/docbook/uv3.backwards_compatibility.xml (original)
+++ uima/uimaj/branches/experiment-v3-jcas/uima-docbook-v3-users-guide/src/docbook/uv3.backwards_compatibility.xml Thu Nov 3 15:31:01 2016
@@ -71,6 +71,8 @@ under the License.
<para>Pears are supported in Version 3. If they use JCas, their JCas classes need to be migrated.
</para>
+ <para>The new Java Object support does not support multiple JCas class definitions for the same
+ UIMA Type, inside and outside of the PEAR context. When this is detected, an exception is thrown.</para>
</section>
<section id="uv3.backards_compatibility.typesystem_sharing">
@@ -89,7 +91,7 @@ under the License.
references can then become invalid when the type system is created and perhaps replaced with
an already existing one.</para>
- <para>Application code should code around this by reacquiring references to type and feature
+ <para>Application code may code around this by re-acquiring references to type and feature
objects, if the type system returned from <code>commit</code> is not identical (==) to the
one being committed.</para>
</section>
Modified: uima/uimaj/branches/experiment-v3-jcas/uima-docbook-v3-users-guide/src/docbook/uv3.custom_java_objects.xml
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/experiment-v3-jcas/uima-docbook-v3-users-guide/src/docbook/uv3.custom_java_objects.xml?rev=1767906&r1=1767905&r2=1767906&view=diff
==============================================================================
--- uima/uimaj/branches/experiment-v3-jcas/uima-docbook-v3-users-guide/src/docbook/uv3.custom_java_objects.xml (original)
+++ uima/uimaj/branches/experiment-v3-jcas/uima-docbook-v3-users-guide/src/docbook/uv3.custom_java_objects.xml Thu Nov 3 15:31:01 2016
@@ -174,8 +174,19 @@ public void _save_to_cas_data() {
<para>Some additional built-in UIMA types are defined in Version 3 using this new mechanism. They work fully in
Java, and are transported to non-Java frameworks as ordinary CAS objects.</para>
-
- <section id="uv3.custom_java_objects.builtin_arraylist_features">
+
+<!-- <para>These are called "pre-built" rather than "built-in". They are included in the normal type system by
+ default, but may be excluded in order to have the type system match UIMA V2's built-ins. This would be
+ needed, for instance, when an application needed to match typesystems with other instances, for example,
+ to deserialize a binary-format serialization.</para>
+
+ <para>A new parameter, <code>TypeSystem.PARAM_EXCLUDE_PREBUILT_TYPES</code>, can be added as an additional
+ parameter to the "additionalParameters" map on any of the calls that produce type systems.
+ <code>removePrebuiltTypes()</code> on a type system implementation object,
+ before committing, removes these types.
+ </para>
+ -->
+ <section id="uv3.custom_java_objects.builtin_fsarraylist">
<title>FSArrayList</title>
<titleabbrev>FSArrayList</titleabbrev>
@@ -192,7 +203,7 @@ public void _save_to_cas_data() {
can be used as a source for the <code>select</code> framework.</para>
</section>
- <section id="uv3.custom_java_objects.builtin_arraylist_ints">
+ <section id="uv3.custom_java_objects.builtin_integerarraylists">
<title>IntegerArrayList</title>
<titleabbrev>IntegerArrayList</titleabbrev>
Modified: uima/uimaj/branches/experiment-v3-jcas/uima-docbook-v3-users-guide/src/docbook/uv3.overview.xml
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/experiment-v3-jcas/uima-docbook-v3-users-guide/src/docbook/uv3.overview.xml?rev=1767906&r1=1767905&r2=1767906&view=diff
==============================================================================
--- uima/uimaj/branches/experiment-v3-jcas/uima-docbook-v3-users-guide/src/docbook/uv3.overview.xml (original)
+++ uima/uimaj/branches/experiment-v3-jcas/uima-docbook-v3-users-guide/src/docbook/uv3.overview.xml Thu Nov 3 15:31:01 2016
@@ -55,7 +55,7 @@ under the License.
</varlistentry>
<varlistentry>
- <term><emphasis role="strong">New UIMA built-in types built using the custom Java object support</emphasis></term>
+ <term><emphasis role="strong">New UIMA built-in types, built using the custom Java object support</emphasis></term>
<listitem>
<para>Several new built-in UIMA types are supported:
<variablelist>
@@ -80,8 +80,6 @@ under the License.
-->
</variablelist>
</para>
- <para>Serialization of these is supported, but (of course) these serialized forms may not be
- read by Version 2 code.</para>
</listitem>
</varlistentry>