You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by ea...@apache.org on 2014/12/18 22:07:50 UTC
svn commit: r1646534 - in /uima/uimaj/trunk:
uima-docbook-overview-and-setup/src/docbook/project_overview.xml
uima-docbook-references/src/docbook/ref.cas.xml
uima-docbook-tutorials-and-users-guides/src/docbook/tug.multi_views.xml
Author: eae
Date: Thu Dec 18 21:07:50 2014
New Revision: 1646534
URL: http://svn.apache.org/r1646534
Log:
UIMA-3765
Modified:
uima/uimaj/trunk/uima-docbook-overview-and-setup/src/docbook/project_overview.xml
uima/uimaj/trunk/uima-docbook-references/src/docbook/ref.cas.xml
uima/uimaj/trunk/uima-docbook-tutorials-and-users-guides/src/docbook/tug.multi_views.xml
Modified: uima/uimaj/trunk/uima-docbook-overview-and-setup/src/docbook/project_overview.xml
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uima-docbook-overview-and-setup/src/docbook/project_overview.xml?rev=1646534&r1=1646533&r2=1646534&view=diff
==============================================================================
--- uima/uimaj/trunk/uima-docbook-overview-and-setup/src/docbook/project_overview.xml (original)
+++ uima/uimaj/trunk/uima-docbook-overview-and-setup/src/docbook/project_overview.xml Thu Dec 18 21:07:50 2014
@@ -754,6 +754,10 @@ under the License.
any inputSofas or outputSofas will now be passed the view of default
Sofa instead of the Base CAS. </para>
</listitem>
+ <listitem>
+ <para> As of version 2.7.0, all annotators will be passed the view of
+ the default Sofa. </para>
+ </listitem>
</itemizedlist> </para>
</listitem>
</itemizedlist> </para>
Modified: uima/uimaj/trunk/uima-docbook-references/src/docbook/ref.cas.xml
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uima-docbook-references/src/docbook/ref.cas.xml?rev=1646534&r1=1646533&r2=1646534&view=diff
==============================================================================
--- uima/uimaj/trunk/uima-docbook-references/src/docbook/ref.cas.xml (original)
+++ uima/uimaj/trunk/uima-docbook-references/src/docbook/ref.cas.xml Thu Dec 18 21:07:50 2014
@@ -49,11 +49,6 @@ under the License.
JCas for the same reasons.
</para>
- <para>CASes passed to Annotator Components are either a base CAS or a regular CAS. Base CASes
- are only passed to Multi-View components - they are like regular CASes, but do not have user
- accessible indexes or Sofas. They are used by the component only for switching to other CAS
- views, which are regular CASes.</para>
-
<section id="ugr.ref.cas.javadocs">
<title>Javadocs</title>
Modified: uima/uimaj/trunk/uima-docbook-tutorials-and-users-guides/src/docbook/tug.multi_views.xml
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uima-docbook-tutorials-and-users-guides/src/docbook/tug.multi_views.xml?rev=1646534&r1=1646533&r2=1646534&view=diff
==============================================================================
--- uima/uimaj/trunk/uima-docbook-tutorials-and-users-guides/src/docbook/tug.multi_views.xml (original)
+++ uima/uimaj/trunk/uima-docbook-tutorials-and-users-guides/src/docbook/tug.multi_views.xml Thu Dec 18 21:07:50 2014
@@ -126,11 +126,6 @@ aView.removeFsFromIndexes(aFeatureStruct
does not mention any input or output Sofa names, the framework treats that component
as a Single-View component.</para>
- <para>A Multi-View component is passed a special kind of a CAS object, called a base CAS,
- which it must use to switch to the particular view it wishes to process. The base CAS
- object itself has no Sofa and no ability to use Indexes; only the views have that
- capability.</para>
-
</section>
<section id="ugr.tug.mvs.additional_capabilities">
@@ -344,11 +339,11 @@ aView.removeFsFromIndexes(aFeatureStruct
</section>
- <section id="ugr.tug.mvs.specifying_cas_view_for_single_view">
- <title>Specifying the CAS View for a Single-View Component</title>
- <titleabbrev>CAS View for Single-View Parts</titleabbrev>
+ <section id="ugr.tug.mvs.specifying_cas_view_for_process">
+ <title>Specifying the CAS View delivered to a Components Process Method</title>
+ <titleabbrev>CAS View received by Process</titleabbrev>
- <para>Single-View components receive a Sofa named <quote>_InitialView</quote>, or
+ <para>All components receive a Sofa named <quote>_InitialView</quote>, or
a Sofa that is mapped to this name.</para>
<para>For example, assume that the CAS Consumer to be used in our CPE is a Single-View
@@ -435,8 +430,8 @@ AnalysisEngine ae =
<section id="ugr.tug.mvs.jcas_extensions_for_multi_views">
<title>JCas extensions for Multiple Views</title>
- <para>The JCas interface to the CAS can be used with any / all views, as well as the base CAS
- sent to Multi-View components. You can always get a JCas object from an existing CAS
+ <para>The JCas interface to the CAS can be used with any / all views.
+ You can always get a JCas object from an existing CAS
object by using the method getJCas(); this call will create the JCas if it doesn't
already exist. If it does exist, it just returns the existing JCas that corresponds to
the CAS.</para>
@@ -508,7 +503,7 @@ AnalysisEngine ae =
<para>The application driver instantiates an analysis engine,
<literal>seAnnotator</literal>, from the annotator descriptor, obtains a new
- base CAS using that engine's CAS definition, and creates the expected input
+ CAS using that engine's CAS definition, and creates the expected input
Sofa using:</para>
@@ -684,6 +679,11 @@ InputStream is = aCasOrJCas.getSofaDataS
CAS no longer has an index repository to hold <quote>global</quote> data. Global data
needs to be put in a specific named CAS view of your choice.</para>
+ <note>New behavior as of version 2.7.0
+ <para>A Multi-View component is no longer passed the base CAS view.
+ See <xref linkend="ugr.tug.mvs.specifying_cas_view_for_process"/>.</para>
+ </note>
+
<para>Because of these changes, the following scenarios will break with v2.0 clients:
<itemizedlist spacing="compact"><listitem><para>Any version 1.x services (you