You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by al...@apache.org on 2007/01/30 00:04:00 UTC
svn commit: r501222 - in
/incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides:
tug.cas_multiplier.xml tug.xmi_emf.xml
Author: alally
Date: Mon Jan 29 15:03:59 2007
New Revision: 501222
URL: http://svn.apache.org/viewvc?view=rev&rev=501222
Log:
Miscellaneous edits
Modified:
incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.cas_multiplier.xml
incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.xmi_emf.xml
Modified: incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.cas_multiplier.xml
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.cas_multiplier.xml?view=diff&rev=501222&r1=501221&r2=501222
==============================================================================
--- incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.cas_multiplier.xml (original)
+++ incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.cas_multiplier.xml Mon Jan 29 15:03:59 2007
@@ -257,7 +257,7 @@
// Note: this example segmenter implementation
// assumes that the document contains many newlines.
// In the worst case, if this segmenter
- // is runon a document with no newlines,
+ // is run on a document with no newlines,
// it will produce only one segment containing the
// entire document text.
// A better implementation might specify a maximum segment size as
@@ -458,7 +458,9 @@
<multiValued>false</multiValued>
<mandatory>false</mandatory>
<overrides>
- <parameter>FixedFlowController/ActionAfterCasMultiplier</parameter>
+ <parameter>
+ FixedFlowController/ActionAfterCasMultiplier
+ </parameter>
</overrides>
</configurationParameter>
</configurationParameters>
@@ -477,7 +479,7 @@
Engine that overrides this parameter can be found in
<literal>examples/descriptors/cas_multiplier/Segment_Annotate_Merge_AE.xml</literal>. For more
information about how to specify a flow controller as part of your Aggregate Analysis Engine descriptor, see
- <olink targetdoc="&uima_docs_tutorial_guides;" targetptr="ugr.tug.fc"/>.</para>
+ <olink targetdoc="&uima_docs_tutorial_guides;" targetptr="ugr.tug.fc.adding_fc_to_aggregate"/>.</para>
<para>If you would like to further customize the flow, you will need to implement a custom FlowController as
described in <olink targetdoc="&uima_docs_tutorial_guides;" targetptr="ugr.tug.fc"/>. For example,
@@ -507,7 +509,7 @@
occurring inside it is hidden from users of that Analysis Engine.</para> <note>
<para>If you want to output some new Output CASes and not others, you need to implement a custom Flow Controller
that makes this decision — see <olink targetdoc="&uima_docs_tutorial_guides;"
- targetptr="ugr.tug.fc"/>. </para> </note>
+ targetptr="ugr.tug.fc.using_fc_with_cas_multipliers"/>. </para> </note>
</section>
</section>
@@ -571,8 +573,8 @@
<para>Note that as defined by the CAS Multiplier contract in <xref
linkend="ugr.tug.cm.cm_interface_overview"/>, the CAS Multiplier owns the input CAS
- (<literal>initialCAS</literal> in the example) until the last new output CAS has been produced. This means
- that the application should not try to make changes to <literal>initialCAS</literal> until after the
+ (<literal>initialCas</literal> in the example) until the last new output CAS has been produced. This means
+ that the application should not try to make changes to <literal>initialCas</literal> until after the
<literal>CasIterator.hasNext</literal> method has returned false, indicating that the segmenter has
finished.</para>
Modified: incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.xmi_emf.xml
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.xmi_emf.xml?view=diff&rev=501222&r1=501221&r2=501222
==============================================================================
--- incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.xmi_emf.xml (original)
+++ incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.xmi_emf.xml Mon Jan 29 15:03:59 2007
@@ -29,47 +29,41 @@
<section id="ugr.tug.xmi_emf.overview">
<title>Overview</title>
- <para>In traditional object-oriented terms, a UIMA Type System is a class model and a UIMA
- CAS is an object graph. There are established standards in this area
- – specifically, <trademark class="registered">UML</trademark> is an
- <trademark class="trade">OMG</trademark> standard for class models and XMI (XML
- Metadata Interchange) is an OMG standard for the XML representation of object
- graphs.</para>
-
- <para>Furthermore, the Eclipse Modeling Framework (EMF) is an open-source framework
- for model-based application development, and it is based on UML and XMI. In EMF, you
- define class models using a metamodel called Ecore, which is similar to UML. EMF
- provides tools for converting a UML model to Ecore. EMF can then generate Java classes
- from your model, and supports persistence of those classes in the XMI format.</para>
-
- <para>The UIMA SDK now provides tools for interoperability with XMI and EMF. These tools
- allow conversions of UIMA Type Systems to and from Ecore models, as well as conversions
- of UIMA CASes to and from XMI format. This provides a number of advantages,
- including:</para>
+ <para>In traditional object-oriented terms, a UIMA Type System is a class model and a UIMA CAS is an object graph.
+ There are established standards in this area
+ – specifically, <trademark class="registered">UML</trademark> is an <trademark class="trade">
+ OMG</trademark> standard for class models and XMI (XML Metadata Interchange) is an OMG standard for the XML
+ representation of object graphs.</para>
+
+ <para>Furthermore, the Eclipse Modeling Framework (EMF) is an open-source framework for model-based
+ application development, and it is based on UML and XMI. In EMF, you define class models using a metamodel called
+ Ecore, which is similar to UML. EMF provides tools for converting a UML model to Ecore. EMF can then generate Java
+ classes from your model, and supports persistence of those classes in the XMI format.</para>
+
+ <para>The UIMA SDK provides tools for interoperability with XMI and EMF. These tools allow conversions of UIMA
+ Type Systems to and from Ecore models, as well as conversions of UIMA CASes to and from XMI format. This provides a
+ number of advantages, including:</para>
<blockquote>
- <para>You can define a model using a UML Editor, such as Rational Rose or EclipseUML, and
- then automatically convert it to a UIMA Type System.</para>
+ <para>You can define a model using a UML Editor, such as Rational Rose or EclipseUML, and then automatically
+ convert it to a UIMA Type System.</para>
+
+ <para>You can take an existing UIMA application, convert its type system to Ecore, and save the CASes it
+ produces to XMI. This data is now in a form where it can easily be ingested by an EMF-based application.</para>
+ </blockquote>
+
+ <para>More generally, we are adopting the well-documented, open standard XMI as the standard way to represent
+ UIMA-compliant analysis results (replacing the UIMA-specific XCAS format). This use of an open standard
+ enables other applications to more easily produce or consume these UIMA analysis results.</para>
- <para>You can take an existing UIMA application, convert its type system to Ecore, and
- save the CASes it produces to XMI. This data is now in a form where it can easily be ingested
- by an EMF-based application.</para>
- </blockquote>
-
- <para>More generally, we are adopting the well-documented, open standard XMI as the
- standard way to represent UIMA-compliant analysis results (replacing the
- UIMA-specific XCAS format). This use of an open standard enables other applications to
- more easily produce or consume these UIMA analysis results.</para>
+ <para>For more information on XMI, see Grose et al. <emphasis>Mastering XMI. Java Programming with XMI, XML, and
+ UML.</emphasis> John Wiley & Sons, Inc. 2002.</para>
- <para>For more information on XMI, see Grose et al. Mastering XMI. Java Programming with
- XMI, XML, and UML. John Wiley & Sons, Inc. 2002.</para>
-
- <para>For more information on EMF, see Budinsky et al. Eclipse Modeling Framework 2.0.
+ <para>For more information on EMF, see Budinsky et al. <emphasis>Eclipse Modeling Framework 2.0.</emphasis>
Addison-Wesley. 2006.</para>
- <para>For details of how the UIMA CAS is represented in XMI format, see <olink
- targetdoc="&uima_docs_ref;" targetptr="ugr.ref.xmi"/>
- .</para>
+ <para>For details of how the UIMA CAS is represented in XMI format, see <olink targetdoc="&uima_docs_ref;"
+ targetptr="ugr.ref.xmi"/> .</para>
</section>