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/02/12 23:31:25 UTC
svn commit: r506711 - in /incubator/uima/uimaj/trunk/uima-docbooks/src:
docbook/overview_and_setup/ olink/overview_and_setup/
olink/tutorials_and_users_guides/
Author: alally
Date: Mon Feb 12 14:31:24 2007
New Revision: 506711
URL: http://svn.apache.org/viewvc?view=rev&rev=506711
Log:
Revised migration section to seem less 'scary' to users.
Modified:
incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/overview_and_setup/project_overview.xml
incubator/uima/uimaj/trunk/uima-docbooks/src/olink/overview_and_setup/htmlsingle-target.db
incubator/uima/uimaj/trunk/uima-docbooks/src/olink/overview_and_setup/pdf-target.db
incubator/uima/uimaj/trunk/uima-docbooks/src/olink/tutorials_and_users_guides/htmlsingle-target.db
incubator/uima/uimaj/trunk/uima-docbooks/src/olink/tutorials_and_users_guides/pdf-target.db
Modified: incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/overview_and_setup/project_overview.xml
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/overview_and_setup/project_overview.xml?view=diff&rev=506711&r1=506710&r2=506711
==============================================================================
--- incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/overview_and_setup/project_overview.xml (original)
+++ incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/overview_and_setup/project_overview.xml Mon Feb 12 14:31:24 2007
@@ -448,42 +448,17 @@
</orderedlist>
</section>
- <section id="ugr.project_overview_migrating_from_ibm_uima">
- <title>Migrating from IBM UIMA to Apache UIMA</title>
- <para>In Apache UIMA, several things have changed that require changes to user code and descriptors. For instance,
- the Java package names for all of the UIMA classes and interfaces have changed from what they
- were in IBM UIMA; all of the package names now start with the prefix <literal>org.apache</literal>.
- These changes require that all user code written to previous APIs be updated
- and recompiled. Some changes to XML descriptors are also required. A migration utility is provided which will
- make the required updates to your files. </para>
+ <section id="ugr.project_overview_changes_from_previous">
+ <title>Changes from Previous Versions</title>
+
+ <section id="ugr.project_overview_changes_from_2_0">
+ <title>Changes from IBM UIMA 2.0 to Apache UIMA 2.1</title>
- <section id="ugr.project_overview_running_the_migration_utility">
- <title>Running the Migration Utility</title>
- <warning>
- <para>Before running the migration utility, be sure to back up your files, just in case you encounter any
- problems, because the migration tool updates the files in place in the directories where it finds them.</para>
- </warning>
- <para> The migration utility is run by executing the script file
- <literal>apache-uima/bin/ibmUimaToApacheUima.bat</literal> (Windows) or
- <literal>apache-uima/bin/ibmUimaToApacheUima.sh</literal> (UNIX). You must pass one argument: the
- directory containing the files that you want to be migrated. Subdirectories will be processed
- recursively.</para>
- <para>The script scans your files and applies the necessary updates, for example replacing the com.ibm
- package names with the new org.apache package names. For more details on what has changed in the UIMA APIs and
- what changes are performed by the migration script, see the next section of this document.</para>
-
- <para>The script will only attempt to modify files with the extensions: java, xml, xmi, wsdd, properties,
- launch, bat, cmd, sh, ksh, or csh; and files with no extension. Also, files with size greater than 1,000,000
- bytes will be skipped. (If you want the script to modify files with other extensions, you can edit the script
- file and change the <literal>-ext</literal> argument appropriately.) </para>
- <para>After running the migration utility, you must recompile your code against the Apache UIMA jar files. The
- migration utility should have done most of the updates necessary for your code to compile and run, but some
- situations require manual intervention. See section <xref
- linkend="ugr.project_overview_manual_migration_necessary"/> for more information.</para>
- </section>
+ <para>This section describes what has changed between version 2.0 and version 2.1 of UIMA.
+ A migration utility is provided which will make the required updates to your Java code and
+ descriptors. See <xref linkend="ugr.project_overview_migrating_from_ibm_uima"/> for
+ instructions on how to run the migration utility.</para>
- <section id="ugr.project_overview_changes_addressed_by_migration_utility">
- <title>Changes Addressed by the Migration Utility</title>
<section id="ugr.project_overview.migration_utility.java_package_name_changes">
<title>Java Package Name Changes</title>
<para>All of the UIMA Java package names have changed in Apache UIMA. They now start with
@@ -518,9 +493,7 @@
. The following have also been removed and replaced with the equivalent "CAS" variants:
<literal>TCASException</literal>, <literal>TCASRuntimeException</literal>,
<literal>TCasPool</literal>, and <literal>CasCreationUtils.createTCas(...)</literal>. </para>
- <para>The migration script will apply the necessary replacements. It will only replace "TCAS" when it
- appears capitalized and as a word by itself, or as one of the class or method names listed above. Otherwise it
- will not be replaced.</para>
+ <para>The migration script will apply the necessary replacements.</para>
</section>
<section id="ugr.project_overview.migration_utility.jcas_interface">
<title>JCas Is Now an Interface</title>
@@ -545,97 +518,6 @@
the migration utility will process by default.)
</para>
</section>
- </section>
-
- <section id="ugr.project_overview_manual_migration_necessary">
- <title>Situations Where Manual Migration is Necessary</title>
- <para> In the following situations the migration script will not be able to automatically apply the necessary
- changes, and some manual intervention is necessary. </para>
- <section id="ugr.project_overview.manual_migration_needed.jcas_for_document_annotation">
- <title>JCas Cover Classes for DocumentAnnotation</title>
- <para> If you have run JCasGen it is likely that you have the classes
- <literal>com.ibm.uima.jcas.tcas.DocumentAnnotation</literal> and
- <literal>com.ibm.uima.jcas.tcas.DocumentAnnotation_Type</literal> as part of your code. This
- package name is no longer valid, and the migration utility does not move your files between directories so
- it is unable to fix this. </para>
- <para> If you have not made manual modifications to these classes, the best solution is usually to just delete
- these two classes (and their containing package). There is a default version in the
- <literal>uima-document-annotation.jar</literal> file that is included in Apache UIMA. If you
- <emphasis>have</emphasis> made custom changes, then you should not delete the file but instead move it to
- the correct package <literal>org.apache.uima.jcas.tcas</literal>. For more information about JCas
- and DocumentAnnotation please see <olink targetdoc="&uima_docs_ref;"
- targetptr="ugr.ref.jcas.documentannotation_issues"/> </para>
- </section>
- <section id="ugr.project_overview.manual_migration_needed.getdocumentannotation">
- <title>JCas.getDocumentAnnotation</title>
- <para>The deprecated method <literal>JCas.getDocumentAnnotation</literal> has been removed. Its use
- must be replaced with <literal>JCas.getDocumentAnnotationFs</literal>. The method
- <literal>JCas.getDocumentAnnotationFs()</literal> returns type <literal>TOP</literal>, so your
- code must cast this to type <literal>DocumentAnnotation</literal>. The reasons for this are described
- in <olink targetdoc="&uima_docs_ref;" targetptr="ugr.ref.jcas.documentannotation_issues"/>.
- </para>
- </section>
- <section id="ugr.project_overview.manual_migration_needed.xiinclude">
- <title>xi:include</title>
- <para>The use of <xi:include> in UIMA component descriptors has been discouraged for some time, and in
- Apache UIMA support for it has been removed. If you have descriptors that use that, you must change them to
- use UIMA's <import> syntax instead. The proper syntax is described in <olink
- targetdoc="&uima_docs_ref;" targetptr="ugr.ref.xml.component_descriptor.imports"/>.
- </para>
- </section>
- <section id="ugr.project_overview.manual_migration_needed.duplicate_methods_cas_tcas">
- <title>Duplicate Methods Taking CAS and TCAS as Arguments</title>
- <para>Because <literal>TCAS</literal> has been replaced by <literal>CAS</literal>, if you had two
- methods distinguished only by whether an argument type was <literal>TCAS</literal> or
- <literal>CAS</literal>, the migration tool will cause these to have identical signatures, which will be
- a compile error. If this happens, consider why the two variants were needed in the first place. Often, it may
- work to simply delete one of the methods.</para>
- </section>
- <section id="ugr.project_overview.manual_migration_needed.undocumented_methods">
- <title>Use of Undocumented Methods from the com.ibm.uima.util package</title>
- <para>Previous UIMA versions has some methods in the <literal>com.ibm.uima.util</literal> package that
- were for internal use and were not documented in the JavaDoc. (There are also many methods in that package
- which are documented, and there is no issue with using these.) It is not recommended that you use any of the
- undocumented methods. If you do, the migration script will not handle them correctly. These have now been
- moved to <literal>org.apache.uima.internal.util</literal>, and you will have to manually update your
- imports to point to this location.</para>
- </section>
- <section id="ugr.project_overview.manual_migration_needed.uima_package_names_in_user_code">
- <title>Use of UIMA Package Names for User Code</title>
- <para>If you have placed your own classes in a package that has exactly the same name as one of the UIMA packages
- (not recommended), this will cause problems when your run the migration script. Since the script replaces
- UIMA package names, all of your imports that refer to your class will get replaced and your code will no
- longer compile. If this happens, you can fix it by manually moving your code to the new Apache UIMA package
- name (i.e., whatever name your imports got replaced with). However, we recommend instead that you do not
- use Apache UIMA package names for your own code.</para>
- <para>An even more rare case would be if you had a package name that started with a capital letter (poor Java
- style) AND was prefixed by one of the UIMA package names, for example a package named
- <literal>com.ibm.uima.MyPackage</literal>. This would be treated as a class name and replaced with
- <literal>org.apache.uima.MyPackage</literal> wherever it occurs.</para>
- </section>
- <section id="ugr.project_overview.manual_migration_needed.exceptions_extend_uima_exceptions">
- <title>CASException and CASRuntimeException now extend UIMA(Runtime)Exception</title>
- <para>
- This change may affect user code to a small extent, as some of the APIs on
- <literal>CASException</literal> and <literal>CASRuntimeException</literal> no longer exist.
- On the up side, all UIMA exceptions are now derived from the same base classes and behave
- the same way. The most significant change is that you can no longer check for the specific
- type of exception the way you used to. For example, if you had code like this:
-
- <programlisting>catch (CASRuntimeException e) {
- if (e.getError() == CASRuntimeException.ILLEGAL_ARRAY_SIZE) {
- // Do something in case this particular error is caught</programlisting>
-
- you will need to replace it with the following:
-
- <programlisting>catch (CASRuntimeException e) {
- if (e.getMessageKey().equals(CASRuntimeException.ILLEGAL_ARRAY_SIZE)) {
- // Do something in case this particular error is caught</programlisting>
-
- as the message keys are now strings. This change is not handled by the migration script.
- </para>
- </section>
- </section>
<section id="ugr.ovv.search_engine_repackaged">
<title>Semantic Search Engine Repackaged</title>
<para>The versions of the UIMA SDK prior to the move into Apache came with a semantic search engine. The Apache
@@ -644,7 +526,8 @@
time) with other open source search engines, such as the Lucene search engine project in Apache.</para>
</section>
</section>
-
+
+
<section id="ugr.project_overview_changes_from_v1">
<title>Changes from UIMA Version 1.x</title>
<para>Version 2.x of UIMA provides new capabilities and refines several areas of the UIMA
@@ -812,6 +695,136 @@
</section>
</section>
+ </section>
+
+ <section id="ugr.project_overview_migrating_from_ibm_uima">
+ <title>Migrating from IBM UIMA to Apache UIMA</title>
+ <para>In Apache UIMA, several things have changed that require changes to user code and descriptors.
+ A migration utility is provided which will make the required updates to your files. The most
+ significant change is that the Java package names for all of the UIMA classes and interfaces have changed
+ from what they were in IBM UIMA; all of the package names now start with the prefix <literal>org.apache</literal>.</para>
+
+ <section id="ugr.project_overview_running_the_migration_utility">
+ <title>Running the Migration Utility</title>
+ <note>
+ <para>Before running the migration utility, be sure to back up your files, just in case you encounter any
+ problems, because the migration tool updates the files in place in the directories where it finds them.</para>
+ </note>
+ <para> The migration utility is run by executing the script file
+ <literal>apache-uima/bin/ibmUimaToApacheUima.bat</literal> (Windows) or
+ <literal>apache-uima/bin/ibmUimaToApacheUima.sh</literal> (UNIX). You must pass one argument: the
+ directory containing the files that you want to be migrated. Subdirectories will be processed
+ recursively.</para>
+
+ <para>The script scans your files and applies the necessary updates, for example replacing the com.ibm
+ package names with the new org.apache package names. For more details on what has changed in the UIMA APIs and
+ what changes are performed by the migration script, see <xref linkend="ugr.project_overview_changes_from_2_0"/>.</para>
+
+ <para>The script will only attempt to modify files with the extensions: java, xml, xmi, wsdd, properties,
+ launch, bat, cmd, sh, ksh, or csh; and files with no extension. Also, files with size greater than 1,000,000
+ bytes will be skipped. (If you want the script to modify files with other extensions, you can edit the script
+ file and change the <literal>-ext</literal> argument appropriately.) </para>
+
+ <para>If the migration tool reports warnings, there may be a few additional steps to take. The following two
+ sections explain some simple manual changes that you might need to make to your code.</para>
+
+ <section id="ugr.project_overview_running_the_migration_utility.jcas_for_document_annotation">
+ <title>JCas Cover Classes for DocumentAnnotation</title>
+ <para> If you have run JCasGen it is likely that you have the classes
+ <literal>com.ibm.uima.jcas.tcas.DocumentAnnotation</literal> and
+ <literal>com.ibm.uima.jcas.tcas.DocumentAnnotation_Type</literal> as part of your code. This
+ package name is no longer valid, and the migration utility does not move your files between directories so
+ it is unable to fix this. </para>
+ <para> If you have not made manual modifications to these classes, the best solution is usually to just delete
+ these two classes (and their containing package). There is a default version in the
+ <literal>uima-document-annotation.jar</literal> file that is included in Apache UIMA. If you
+ <emphasis>have</emphasis> made custom changes, then you should not delete the file but instead move it to
+ the correct package <literal>org.apache.uima.jcas.tcas</literal>. For more information about JCas
+ and DocumentAnnotation please see <olink targetdoc="&uima_docs_ref;"
+ targetptr="ugr.ref.jcas.documentannotation_issues"/> </para>
+ </section>
+ <section id="ugr.project_overview_running_the_migration_utility.manual_migration_needed.getdocumentannotation">
+ <title>JCas.getDocumentAnnotation</title>
+ <para>The deprecated method <literal>JCas.getDocumentAnnotation</literal> has been removed. Its use
+ must be replaced with <literal>JCas.getDocumentAnnotationFs</literal>. The method
+ <literal>JCas.getDocumentAnnotationFs()</literal> returns type <literal>TOP</literal>, so your
+ code must cast this to type <literal>DocumentAnnotation</literal>. The reasons for this are described
+ in <olink targetdoc="&uima_docs_ref;" targetptr="ugr.ref.jcas.documentannotation_issues"/>.
+ </para>
+ </section>
+
+ </section>
+
+
+ <section id="ugr.project_overview_rare_migration">
+ <title>Rare Cases Where Additional Manual Migration is Necessary</title>
+ <para>The following are rare cases where you may need to take additional steps to migrate your code. You need only
+ read this section if the migration tool reported a warning or if you are having trouble getting your code to
+ compile or run after running the migration.</para>
+
+ <section id="ugr.project_overview.manual_migration_needed.xiinclude">
+ <title>xi:include</title>
+ <para>The use of <xi:include> in UIMA component descriptors has been discouraged for some time, and in
+ Apache UIMA support for it has been removed. If you have descriptors that use that, you must change them to
+ use UIMA's <import> syntax instead. The proper syntax is described in <olink
+ targetdoc="&uima_docs_ref;" targetptr="ugr.ref.xml.component_descriptor.imports"/>.
+ </para>
+ </section>
+ <section id="ugr.project_overview.manual_migration_needed.duplicate_methods_cas_tcas">
+ <title>Duplicate Methods Taking CAS and TCAS as Arguments</title>
+ <para>Because <literal>TCAS</literal> has been replaced by <literal>CAS</literal>, if you had two
+ methods distinguished only by whether an argument type was <literal>TCAS</literal> or
+ <literal>CAS</literal>, the migration tool will cause these to have identical signatures, which will be
+ a compile error. If this happens, consider why the two variants were needed in the first place. Often, it may
+ work to simply delete one of the methods.</para>
+ </section>
+ <section id="ugr.project_overview.manual_migration_needed.undocumented_methods">
+ <title>Use of Undocumented Methods from the com.ibm.uima.util package</title>
+ <para>Previous UIMA versions has some methods in the <literal>com.ibm.uima.util</literal> package that
+ were for internal use and were not documented in the JavaDoc. (There are also many methods in that package
+ which are documented, and there is no issue with using these.) It is not recommended that you use any of the
+ undocumented methods. If you do, the migration script will not handle them correctly. These have now been
+ moved to <literal>org.apache.uima.internal.util</literal>, and you will have to manually update your
+ imports to point to this location.</para>
+ </section>
+ <section id="ugr.project_overview.manual_migration_needed.uima_package_names_in_user_code">
+ <title>Use of UIMA Package Names for User Code</title>
+ <para>If you have placed your own classes in a package that has exactly the same name as one of the UIMA packages
+ (not recommended), this will cause problems when your run the migration script. Since the script replaces
+ UIMA package names, all of your imports that refer to your class will get replaced and your code will no
+ longer compile. If this happens, you can fix it by manually moving your code to the new Apache UIMA package
+ name (i.e., whatever name your imports got replaced with). However, we recommend instead that you do not
+ use Apache UIMA package names for your own code.</para>
+ <para>An even more rare case would be if you had a package name that started with a capital letter (poor Java
+ style) AND was prefixed by one of the UIMA package names, for example a package named
+ <literal>com.ibm.uima.MyPackage</literal>. This would be treated as a class name and replaced with
+ <literal>org.apache.uima.MyPackage</literal> wherever it occurs.</para>
+ </section>
+ <section id="ugr.project_overview.manual_migration_needed.exceptions_extend_uima_exceptions">
+ <title>CASException and CASRuntimeException now extend UIMA(Runtime)Exception</title>
+ <para>
+ This change may affect user code to a small extent, as some of the APIs on
+ <literal>CASException</literal> and <literal>CASRuntimeException</literal> no longer exist.
+ On the up side, all UIMA exceptions are now derived from the same base classes and behave
+ the same way. The most significant change is that you can no longer check for the specific
+ type of exception the way you used to. For example, if you had code like this:
+
+ <programlisting>catch (CASRuntimeException e) {
+ if (e.getError() == CASRuntimeException.ILLEGAL_ARRAY_SIZE) {
+ // Do something in case this particular error is caught</programlisting>
+
+ you will need to replace it with the following:
+
+ <programlisting>catch (CASRuntimeException e) {
+ if (e.getMessageKey().equals(CASRuntimeException.ILLEGAL_ARRAY_SIZE)) {
+ // Do something in case this particular error is caught</programlisting>
+
+ as the message keys are now strings. This change is not handled by the migration script.
+ </para>
+ </section>
+ </section>
+ </section>
+
<section id="ugr.project_overview_summary">
<title>Apache UIMA Summary</title>
<section id="ugr.ovv.summary.general">
Modified: incubator/uima/uimaj/trunk/uima-docbooks/src/olink/overview_and_setup/htmlsingle-target.db
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uima-docbooks/src/olink/overview_and_setup/htmlsingle-target.db?view=diff&rev=506711&r1=506710&r2=506711
==============================================================================
--- incubator/uima/uimaj/trunk/uima-docbooks/src/olink/overview_and_setup/htmlsingle-target.db (original)
+++ incubator/uima/uimaj/trunk/uima-docbooks/src/olink/overview_and_setup/htmlsingle-target.db Mon Feb 12 14:31:24 2007
@@ -125,123 +125,127 @@
<ttl>How to use the Documentation</ttl>
<xreftext>Section 1.2, âHow to use the Documentationâ</xreftext>
</div>
- <div element="section" href="#ugr.project_overview_migrating_from_ibm_uima" number="1.3" targetptr="ugr.project_overview_migrating_from_ibm_uima">
- <ttl>Migrating from IBM UIMA to Apache UIMA</ttl>
- <xreftext>Section 1.3, âMigrating from IBM UIMA to Apache UIMAâ</xreftext>
- <div element="section" href="#ugr.project_overview_running_the_migration_utility" number="1.3.1" targetptr="ugr.project_overview_running_the_migration_utility">
- <ttl>Running the Migration Utility</ttl>
- <xreftext>Section 1.3.1, âRunning the Migration Utilityâ</xreftext>
- </div>
- <div element="section" href="#ugr.project_overview_changes_addressed_by_migration_utility" number="1.3.2" targetptr="ugr.project_overview_changes_addressed_by_migration_utility">
- <ttl>Changes Addressed by the Migration Utility</ttl>
- <xreftext>Section 1.3.2, âChanges Addressed by the Migration Utilityâ</xreftext>
- <div element="section" href="#ugr.project_overview.migration_utility.java_package_name_changes" number="1.3.2.1" targetptr="ugr.project_overview.migration_utility.java_package_name_changes">
+ <div element="section" href="#ugr.project_overview_changes_from_previous" number="1.3" targetptr="ugr.project_overview_changes_from_previous">
+ <ttl>Changes from Previous Versions</ttl>
+ <xreftext>Section 1.3, âChanges from Previous Versionsâ</xreftext>
+ <div element="section" href="#ugr.project_overview_changes_from_2_0" number="1.3.1" targetptr="ugr.project_overview_changes_from_2_0">
+ <ttl>Changes from IBM UIMA 2.0 to Apache UIMA 2.1</ttl>
+ <xreftext>Section 1.3.1, âChanges from IBM UIMA 2.0 to Apache UIMA 2.1â</xreftext>
+ <div element="section" href="#ugr.project_overview.migration_utility.java_package_name_changes" number="1.3.1.1" targetptr="ugr.project_overview.migration_utility.java_package_name_changes">
<ttl>Java Package Name Changes</ttl>
- <xreftext>Section 1.3.2.1, âJava Package Name Changesâ</xreftext>
+ <xreftext>Section 1.3.1.1, âJava Package Name Changesâ</xreftext>
</div>
- <div element="section" href="#ugr.project_overview.migration_utility.xml_descriptor_changes" number="1.3.2.2" targetptr="ugr.project_overview.migration_utility.xml_descriptor_changes">
+ <div element="section" href="#ugr.project_overview.migration_utility.xml_descriptor_changes" number="1.3.1.2" targetptr="ugr.project_overview.migration_utility.xml_descriptor_changes">
<ttl>XML Descriptor Changes</ttl>
- <xreftext>Section 1.3.2.2, âXML Descriptor Changesâ</xreftext>
+ <xreftext>Section 1.3.1.2, âXML Descriptor Changesâ</xreftext>
</div>
- <div element="section" href="#ugr.project_overview.migration_utility.tcas_replaced_by_cas" number="1.3.2.3" targetptr="ugr.project_overview.migration_utility.tcas_replaced_by_cas">
+ <div element="section" href="#ugr.project_overview.migration_utility.tcas_replaced_by_cas" number="1.3.1.3" targetptr="ugr.project_overview.migration_utility.tcas_replaced_by_cas">
<ttl>TCAS replaced by CAS</ttl>
- <xreftext>Section 1.3.2.3, âTCAS replaced by CASâ</xreftext>
+ <xreftext>Section 1.3.1.3, âTCAS replaced by CASâ</xreftext>
</div>
- <div element="section" href="#ugr.project_overview.migration_utility.jcas_interface" number="1.3.2.4" targetptr="ugr.project_overview.migration_utility.jcas_interface">
+ <div element="section" href="#ugr.project_overview.migration_utility.jcas_interface" number="1.3.1.4" targetptr="ugr.project_overview.migration_utility.jcas_interface">
<ttl>JCas Is Now an Interface</ttl>
- <xreftext>Section 1.3.2.4, âJCas Is Now an Interfaceâ</xreftext>
+ <xreftext>Section 1.3.1.4, âJCas Is Now an Interfaceâ</xreftext>
</div>
- <div element="section" href="#ugr.project_overview.migration_utility.jar_files" number="1.3.2.5" targetptr="ugr.project_overview.migration_utility.jar_files">
+ <div element="section" href="#ugr.project_overview.migration_utility.jar_files" number="1.3.1.5" targetptr="ugr.project_overview.migration_utility.jar_files">
<ttl>JAR File names Have Changed</ttl>
- <xreftext>Section 1.3.2.5, âJAR File names Have Changedâ</xreftext>
+ <xreftext>Section 1.3.1.5, âJAR File names Have Changedâ</xreftext>
+ </div>
+ <div element="section" href="#ugr.ovv.search_engine_repackaged" number="1.3.1.6" targetptr="ugr.ovv.search_engine_repackaged">
+ <ttl>Semantic Search Engine Repackaged</ttl>
+ <xreftext>Section 1.3.1.6, âSemantic Search Engine Repackagedâ</xreftext>
+ </div>
+ </div>
+ <div element="section" href="#ugr.project_overview_changes_from_v1" number="1.3.2" targetptr="ugr.project_overview_changes_from_v1">
+ <ttl>Changes from UIMA Version 1.x</ttl>
+ <xreftext>Section 1.3.2, âChanges from UIMA Version 1.xâ</xreftext>
+ <div element="section" href="#ugr.project_overview_new_capabilities" number="1.3.2.1" targetptr="ugr.project_overview_new_capabilities">
+ <ttl>New Capabilities</ttl>
+ <xreftext>Section 1.3.2.1, âNew Capabilitiesâ</xreftext>
+ <obj element="formalpara" href="#ugr.project_overview_new_data_types" number="" targetptr="ugr.project_overview_new_data_types">
+ <ttl>New Primitive data types</ttl>
+ <xreftext>New Primitive data types</xreftext>
+ </obj>
+ <obj element="formalpara" href="#ugr.ovv.simpler_aes_and_cases" number="" targetptr="ugr.ovv.simpler_aes_and_cases">
+ <ttl>Simpler Analysis Engines and CASes</ttl>
+ <xreftext>Simpler Analysis Engines and CASes</xreftext>
+ </obj>
+ <obj element="formalpara" href="#ugr.ovv.sofas_and_cas_views_simplified" number="" targetptr="ugr.ovv.sofas_and_cas_views_simplified">
+ <ttl>Sofas and CAS Views simplified</ttl>
+ <xreftext>Sofas and CAS Views simplified</xreftext>
+ </obj>
+ <obj element="formalpara" href="#ugr.ovv.ae_support_multiple_new_cases" number="" targetptr="ugr.ovv.ae_support_multiple_new_cases">
+ <ttl>Analysis Component generalized to support multiple new CAS
+ outputs</ttl>
+ <xreftext>Analysis Component generalized to support multiple new CAS
+ outputs</xreftext>
+ </obj>
+ <obj element="formalpara" href="#ugr.ovv.user_customized_fc" number="" targetptr="ugr.ovv.user_customized_fc">
+ <ttl>User-customized Flow Controllers</ttl>
+ <xreftext>User-customized Flow Controllers</xreftext>
+ </obj>
+ </div>
+ <div element="section" href="#ugr.ovv.other_changes" number="1.3.2.2" targetptr="ugr.ovv.other_changes">
+ <ttl>Other Changes</ttl>
+ <xreftext>Section 1.3.2.2, âOther Changesâ</xreftext>
+ <obj element="formalpara" href="#ugr.ovv.exceptions_rationalized" number="" targetptr="ugr.ovv.exceptions_rationalized">
+ <ttl>UIMA Exceptions rationalized</ttl>
+ <xreftext>UIMA Exceptions rationalized</xreftext>
+ </obj>
+ <obj element="formalpara" href="#ugr.ovv.result_specification" number="" targetptr="ugr.ovv.result_specification">
+ <ttl>Changes in Result Specifications</ttl>
+ <xreftext>Changes in Result Specifications</xreftext>
+ </obj>
+ <obj element="formalpara" href="#ugr.ovv.one_capability_set" number="" targetptr="ugr.ovv.one_capability_set">
+ <ttl>Only one Capability Set</ttl>
+ <xreftext>Only one Capability Set</xreftext>
+ </obj>
+ </div>
+ <div element="section" href="#ugr.project_overview_backwards_compatibility" number="1.3.2.3" targetptr="ugr.project_overview_backwards_compatibility">
+ <ttl>Backwards Compatibility</ttl>
+ <xreftext>Section 1.3.2.3, âBackwards Compatibilityâ</xreftext>
</div>
</div>
- <div element="section" href="#ugr.project_overview_manual_migration_necessary" number="1.3.3" targetptr="ugr.project_overview_manual_migration_necessary">
- <ttl>Situations Where Manual Migration is Necessary</ttl>
- <xreftext>Section 1.3.3, âSituations Where Manual Migration is Necessaryâ</xreftext>
- <div element="section" href="#ugr.project_overview.manual_migration_needed.jcas_for_document_annotation" number="1.3.3.1" targetptr="ugr.project_overview.manual_migration_needed.jcas_for_document_annotation">
+ </div>
+ <div element="section" href="#ugr.project_overview_migrating_from_ibm_uima" number="1.4" targetptr="ugr.project_overview_migrating_from_ibm_uima">
+ <ttl>Migrating from IBM UIMA to Apache UIMA</ttl>
+ <xreftext>Section 1.4, âMigrating from IBM UIMA to Apache UIMAâ</xreftext>
+ <div element="section" href="#ugr.project_overview_running_the_migration_utility" number="1.4.1" targetptr="ugr.project_overview_running_the_migration_utility">
+ <ttl>Running the Migration Utility</ttl>
+ <xreftext>Section 1.4.1, âRunning the Migration Utilityâ</xreftext>
+ <div element="section" href="#ugr.project_overview_running_the_migration_utility.jcas_for_document_annotation" number="1.4.1.1" targetptr="ugr.project_overview_running_the_migration_utility.jcas_for_document_annotation">
<ttl>JCas Cover Classes for DocumentAnnotation</ttl>
- <xreftext>Section 1.3.3.1, âJCas Cover Classes for DocumentAnnotationâ</xreftext>
+ <xreftext>Section 1.4.1.1, âJCas Cover Classes for DocumentAnnotationâ</xreftext>
</div>
- <div element="section" href="#ugr.project_overview.manual_migration_needed.getdocumentannotation" number="1.3.3.2" targetptr="ugr.project_overview.manual_migration_needed.getdocumentannotation">
+ <div element="section" href="#ugr.project_overview_running_the_migration_utility.manual_migration_needed.getdocumentannotation" number="1.4.1.2" targetptr="ugr.project_overview_running_the_migration_utility.manual_migration_needed.getdocumentannotation">
<ttl>JCas.getDocumentAnnotation</ttl>
- <xreftext>Section 1.3.3.2, âJCas.getDocumentAnnotationâ</xreftext>
+ <xreftext>Section 1.4.1.2, âJCas.getDocumentAnnotationâ</xreftext>
</div>
- <div element="section" href="#ugr.project_overview.manual_migration_needed.xiinclude" number="1.3.3.3" targetptr="ugr.project_overview.manual_migration_needed.xiinclude">
+ </div>
+ <div element="section" href="#ugr.project_overview_rare_migration" number="1.4.2" targetptr="ugr.project_overview_rare_migration">
+ <ttl>Rare Cases Where Additional Manual Migration is Necessary</ttl>
+ <xreftext>Section 1.4.2, âRare Cases Where Additional Manual Migration is Necessaryâ</xreftext>
+ <div element="section" href="#ugr.project_overview.manual_migration_needed.xiinclude" number="1.4.2.1" targetptr="ugr.project_overview.manual_migration_needed.xiinclude">
<ttl>xi:include</ttl>
- <xreftext>Section 1.3.3.3, âxi:includeâ</xreftext>
+ <xreftext>Section 1.4.2.1, âxi:includeâ</xreftext>
</div>
- <div element="section" href="#ugr.project_overview.manual_migration_needed.duplicate_methods_cas_tcas" number="1.3.3.4" targetptr="ugr.project_overview.manual_migration_needed.duplicate_methods_cas_tcas">
+ <div element="section" href="#ugr.project_overview.manual_migration_needed.duplicate_methods_cas_tcas" number="1.4.2.2" targetptr="ugr.project_overview.manual_migration_needed.duplicate_methods_cas_tcas">
<ttl>Duplicate Methods Taking CAS and TCAS as Arguments</ttl>
- <xreftext>Section 1.3.3.4, âDuplicate Methods Taking CAS and TCAS as Argumentsâ</xreftext>
+ <xreftext>Section 1.4.2.2, âDuplicate Methods Taking CAS and TCAS as Argumentsâ</xreftext>
</div>
- <div element="section" href="#ugr.project_overview.manual_migration_needed.undocumented_methods" number="1.3.3.5" targetptr="ugr.project_overview.manual_migration_needed.undocumented_methods">
+ <div element="section" href="#ugr.project_overview.manual_migration_needed.undocumented_methods" number="1.4.2.3" targetptr="ugr.project_overview.manual_migration_needed.undocumented_methods">
<ttl>Use of Undocumented Methods from the com.ibm.uima.util package</ttl>
- <xreftext>Section 1.3.3.5, âUse of Undocumented Methods from the com.ibm.uima.util packageâ</xreftext>
+ <xreftext>Section 1.4.2.3, âUse of Undocumented Methods from the com.ibm.uima.util packageâ</xreftext>
</div>
- <div element="section" href="#ugr.project_overview.manual_migration_needed.uima_package_names_in_user_code" number="1.3.3.6" targetptr="ugr.project_overview.manual_migration_needed.uima_package_names_in_user_code">
+ <div element="section" href="#ugr.project_overview.manual_migration_needed.uima_package_names_in_user_code" number="1.4.2.4" targetptr="ugr.project_overview.manual_migration_needed.uima_package_names_in_user_code">
<ttl>Use of UIMA Package Names for User Code</ttl>
- <xreftext>Section 1.3.3.6, âUse of UIMA Package Names for User Codeâ</xreftext>
+ <xreftext>Section 1.4.2.4, âUse of UIMA Package Names for User Codeâ</xreftext>
</div>
- <div element="section" href="#ugr.project_overview.manual_migration_needed.exceptions_extend_uima_exceptions" number="1.3.3.7" targetptr="ugr.project_overview.manual_migration_needed.exceptions_extend_uima_exceptions">
+ <div element="section" href="#ugr.project_overview.manual_migration_needed.exceptions_extend_uima_exceptions" number="1.4.2.5" targetptr="ugr.project_overview.manual_migration_needed.exceptions_extend_uima_exceptions">
<ttl>CASException and CASRuntimeException now extend UIMA(Runtime)Exception</ttl>
- <xreftext>Section 1.3.3.7, âCASException and CASRuntimeException now extend UIMA(Runtime)Exceptionâ</xreftext>
+ <xreftext>Section 1.4.2.5, âCASException and CASRuntimeException now extend UIMA(Runtime)Exceptionâ</xreftext>
</div>
</div>
- <div element="section" href="#ugr.ovv.search_engine_repackaged" number="1.3.4" targetptr="ugr.ovv.search_engine_repackaged">
- <ttl>Semantic Search Engine Repackaged</ttl>
- <xreftext>Section 1.3.4, âSemantic Search Engine Repackagedâ</xreftext>
- </div>
- </div>
- <div element="section" href="#ugr.project_overview_changes_from_v1" number="1.4" targetptr="ugr.project_overview_changes_from_v1">
- <ttl>Changes from UIMA Version 1.x</ttl>
- <xreftext>Section 1.4, âChanges from UIMA Version 1.xâ</xreftext>
- <div element="section" href="#ugr.project_overview_new_capabilities" number="1.4.1" targetptr="ugr.project_overview_new_capabilities">
- <ttl>New Capabilities</ttl>
- <xreftext>Section 1.4.1, âNew Capabilitiesâ</xreftext>
- <obj element="formalpara" href="#ugr.project_overview_new_data_types" number="" targetptr="ugr.project_overview_new_data_types">
- <ttl>New Primitive data types</ttl>
- <xreftext>New Primitive data types</xreftext>
- </obj>
- <obj element="formalpara" href="#ugr.ovv.simpler_aes_and_cases" number="" targetptr="ugr.ovv.simpler_aes_and_cases">
- <ttl>Simpler Analysis Engines and CASes</ttl>
- <xreftext>Simpler Analysis Engines and CASes</xreftext>
- </obj>
- <obj element="formalpara" href="#ugr.ovv.sofas_and_cas_views_simplified" number="" targetptr="ugr.ovv.sofas_and_cas_views_simplified">
- <ttl>Sofas and CAS Views simplified</ttl>
- <xreftext>Sofas and CAS Views simplified</xreftext>
- </obj>
- <obj element="formalpara" href="#ugr.ovv.ae_support_multiple_new_cases" number="" targetptr="ugr.ovv.ae_support_multiple_new_cases">
- <ttl>Analysis Component generalized to support multiple new CAS
- outputs</ttl>
- <xreftext>Analysis Component generalized to support multiple new CAS
- outputs</xreftext>
- </obj>
- <obj element="formalpara" href="#ugr.ovv.user_customized_fc" number="" targetptr="ugr.ovv.user_customized_fc">
- <ttl>User-customized Flow Controllers</ttl>
- <xreftext>User-customized Flow Controllers</xreftext>
- </obj>
- </div>
- <div element="section" href="#ugr.ovv.other_changes" number="1.4.2" targetptr="ugr.ovv.other_changes">
- <ttl>Other Changes</ttl>
- <xreftext>Section 1.4.2, âOther Changesâ</xreftext>
- <obj element="formalpara" href="#ugr.ovv.exceptions_rationalized" number="" targetptr="ugr.ovv.exceptions_rationalized">
- <ttl>UIMA Exceptions rationalized</ttl>
- <xreftext>UIMA Exceptions rationalized</xreftext>
- </obj>
- <obj element="formalpara" href="#ugr.ovv.result_specification" number="" targetptr="ugr.ovv.result_specification">
- <ttl>Changes in Result Specifications</ttl>
- <xreftext>Changes in Result Specifications</xreftext>
- </obj>
- <obj element="formalpara" href="#ugr.ovv.one_capability_set" number="" targetptr="ugr.ovv.one_capability_set">
- <ttl>Only one Capability Set</ttl>
- <xreftext>Only one Capability Set</xreftext>
- </obj>
- </div>
- <div element="section" href="#ugr.project_overview_backwards_compatibility" number="1.4.3" targetptr="ugr.project_overview_backwards_compatibility">
- <ttl>Backwards Compatibility</ttl>
- <xreftext>Section 1.4.3, âBackwards Compatibilityâ</xreftext>
- </div>
</div>
<div element="section" href="#ugr.project_overview_summary" number="1.5" targetptr="ugr.project_overview_summary">
<ttl>Apache UIMA Summary</ttl>
@@ -397,7 +401,7 @@
<div element="section" href="#ugr.ovv.eclipse_setup.install_emf" number="3.1.2" targetptr="ugr.ovv.eclipse_setup.install_emf">
<ttl>Install additional Eclipse component: EMF</ttl>
<xreftext>Section 3.1.2, âInstall additional Eclipse component: EMFâ</xreftext>
- <div element="section" href="#d0e1996" number="3.1.2.1">
+ <div element="section" href="#d0e2008" number="3.1.2.1">
<ttl>EMF Installation Shortcut for Eclipse 3.2</ttl>
<xreftext>Section 3.1.2.1, âEMF Installation Shortcut for Eclipse 3.2â</xreftext>
</div>
Modified: incubator/uima/uimaj/trunk/uima-docbooks/src/olink/overview_and_setup/pdf-target.db
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uima-docbooks/src/olink/overview_and_setup/pdf-target.db?view=diff&rev=506711&r1=506710&r2=506711
==============================================================================
--- incubator/uima/uimaj/trunk/uima-docbooks/src/olink/overview_and_setup/pdf-target.db (original)
+++ incubator/uima/uimaj/trunk/uima-docbooks/src/olink/overview_and_setup/pdf-target.db Mon Feb 12 14:31:24 2007
@@ -125,123 +125,127 @@
<ttl>How to use the Documentation</ttl>
<xreftext>Section 1.2, âHow to use the Documentationâ</xreftext>
</div>
- <div element="section" href="#ugr.project_overview_migrating_from_ibm_uima" number="1.3" targetptr="ugr.project_overview_migrating_from_ibm_uima">
- <ttl>Migrating from IBM UIMA to Apache UIMA</ttl>
- <xreftext>Section 1.3, âMigrating from IBM UIMA to Apache UIMAâ</xreftext>
- <div element="section" href="#ugr.project_overview_running_the_migration_utility" number="1.3.1" targetptr="ugr.project_overview_running_the_migration_utility">
- <ttl>Running the Migration Utility</ttl>
- <xreftext>Section 1.3.1, âRunning the Migration Utilityâ</xreftext>
- </div>
- <div element="section" href="#ugr.project_overview_changes_addressed_by_migration_utility" number="1.3.2" targetptr="ugr.project_overview_changes_addressed_by_migration_utility">
- <ttl>Changes Addressed by the Migration Utility</ttl>
- <xreftext>Section 1.3.2, âChanges Addressed by the Migration Utilityâ</xreftext>
- <div element="section" href="#ugr.project_overview.migration_utility.java_package_name_changes" number="1.3.2.1" targetptr="ugr.project_overview.migration_utility.java_package_name_changes">
+ <div element="section" href="#ugr.project_overview_changes_from_previous" number="1.3" targetptr="ugr.project_overview_changes_from_previous">
+ <ttl>Changes from Previous Versions</ttl>
+ <xreftext>Section 1.3, âChanges from Previous Versionsâ</xreftext>
+ <div element="section" href="#ugr.project_overview_changes_from_2_0" number="1.3.1" targetptr="ugr.project_overview_changes_from_2_0">
+ <ttl>Changes from IBM UIMA 2.0 to Apache UIMA 2.1</ttl>
+ <xreftext>Section 1.3.1, âChanges from IBM UIMA 2.0 to Apache UIMA 2.1â</xreftext>
+ <div element="section" href="#ugr.project_overview.migration_utility.java_package_name_changes" number="1.3.1.1" targetptr="ugr.project_overview.migration_utility.java_package_name_changes">
<ttl>Java Package Name Changes</ttl>
- <xreftext>Section 1.3.2.1, âJava Package Name Changesâ</xreftext>
+ <xreftext>Section 1.3.1.1, âJava Package Name Changesâ</xreftext>
</div>
- <div element="section" href="#ugr.project_overview.migration_utility.xml_descriptor_changes" number="1.3.2.2" targetptr="ugr.project_overview.migration_utility.xml_descriptor_changes">
+ <div element="section" href="#ugr.project_overview.migration_utility.xml_descriptor_changes" number="1.3.1.2" targetptr="ugr.project_overview.migration_utility.xml_descriptor_changes">
<ttl>XML Descriptor Changes</ttl>
- <xreftext>Section 1.3.2.2, âXML Descriptor Changesâ</xreftext>
+ <xreftext>Section 1.3.1.2, âXML Descriptor Changesâ</xreftext>
</div>
- <div element="section" href="#ugr.project_overview.migration_utility.tcas_replaced_by_cas" number="1.3.2.3" targetptr="ugr.project_overview.migration_utility.tcas_replaced_by_cas">
+ <div element="section" href="#ugr.project_overview.migration_utility.tcas_replaced_by_cas" number="1.3.1.3" targetptr="ugr.project_overview.migration_utility.tcas_replaced_by_cas">
<ttl>TCAS replaced by CAS</ttl>
- <xreftext>Section 1.3.2.3, âTCAS replaced by CASâ</xreftext>
+ <xreftext>Section 1.3.1.3, âTCAS replaced by CASâ</xreftext>
</div>
- <div element="section" href="#ugr.project_overview.migration_utility.jcas_interface" number="1.3.2.4" targetptr="ugr.project_overview.migration_utility.jcas_interface">
+ <div element="section" href="#ugr.project_overview.migration_utility.jcas_interface" number="1.3.1.4" targetptr="ugr.project_overview.migration_utility.jcas_interface">
<ttl>JCas Is Now an Interface</ttl>
- <xreftext>Section 1.3.2.4, âJCas Is Now an Interfaceâ</xreftext>
+ <xreftext>Section 1.3.1.4, âJCas Is Now an Interfaceâ</xreftext>
</div>
- <div element="section" href="#ugr.project_overview.migration_utility.jar_files" number="1.3.2.5" targetptr="ugr.project_overview.migration_utility.jar_files">
+ <div element="section" href="#ugr.project_overview.migration_utility.jar_files" number="1.3.1.5" targetptr="ugr.project_overview.migration_utility.jar_files">
<ttl>JAR File names Have Changed</ttl>
- <xreftext>Section 1.3.2.5, âJAR File names Have Changedâ</xreftext>
+ <xreftext>Section 1.3.1.5, âJAR File names Have Changedâ</xreftext>
+ </div>
+ <div element="section" href="#ugr.ovv.search_engine_repackaged" number="1.3.1.6" targetptr="ugr.ovv.search_engine_repackaged">
+ <ttl>Semantic Search Engine Repackaged</ttl>
+ <xreftext>Section 1.3.1.6, âSemantic Search Engine Repackagedâ</xreftext>
+ </div>
+ </div>
+ <div element="section" href="#ugr.project_overview_changes_from_v1" number="1.3.2" targetptr="ugr.project_overview_changes_from_v1">
+ <ttl>Changes from UIMA Version 1.x</ttl>
+ <xreftext>Section 1.3.2, âChanges from UIMA Version 1.xâ</xreftext>
+ <div element="section" href="#ugr.project_overview_new_capabilities" number="1.3.2.1" targetptr="ugr.project_overview_new_capabilities">
+ <ttl>New Capabilities</ttl>
+ <xreftext>Section 1.3.2.1, âNew Capabilitiesâ</xreftext>
+ <obj element="formalpara" href="#ugr.project_overview_new_data_types" number="" targetptr="ugr.project_overview_new_data_types">
+ <ttl>New Primitive data types</ttl>
+ <xreftext>New Primitive data types</xreftext>
+ </obj>
+ <obj element="formalpara" href="#ugr.ovv.simpler_aes_and_cases" number="" targetptr="ugr.ovv.simpler_aes_and_cases">
+ <ttl>Simpler Analysis Engines and CASes</ttl>
+ <xreftext>Simpler Analysis Engines and CASes</xreftext>
+ </obj>
+ <obj element="formalpara" href="#ugr.ovv.sofas_and_cas_views_simplified" number="" targetptr="ugr.ovv.sofas_and_cas_views_simplified">
+ <ttl>Sofas and CAS Views simplified</ttl>
+ <xreftext>Sofas and CAS Views simplified</xreftext>
+ </obj>
+ <obj element="formalpara" href="#ugr.ovv.ae_support_multiple_new_cases" number="" targetptr="ugr.ovv.ae_support_multiple_new_cases">
+ <ttl>Analysis Component generalized to support multiple new CAS
+ outputs</ttl>
+ <xreftext>Analysis Component generalized to support multiple new CAS
+ outputs</xreftext>
+ </obj>
+ <obj element="formalpara" href="#ugr.ovv.user_customized_fc" number="" targetptr="ugr.ovv.user_customized_fc">
+ <ttl>User-customized Flow Controllers</ttl>
+ <xreftext>User-customized Flow Controllers</xreftext>
+ </obj>
+ </div>
+ <div element="section" href="#ugr.ovv.other_changes" number="1.3.2.2" targetptr="ugr.ovv.other_changes">
+ <ttl>Other Changes</ttl>
+ <xreftext>Section 1.3.2.2, âOther Changesâ</xreftext>
+ <obj element="formalpara" href="#ugr.ovv.exceptions_rationalized" number="" targetptr="ugr.ovv.exceptions_rationalized">
+ <ttl>UIMA Exceptions rationalized</ttl>
+ <xreftext>UIMA Exceptions rationalized</xreftext>
+ </obj>
+ <obj element="formalpara" href="#ugr.ovv.result_specification" number="" targetptr="ugr.ovv.result_specification">
+ <ttl>Changes in Result Specifications</ttl>
+ <xreftext>Changes in Result Specifications</xreftext>
+ </obj>
+ <obj element="formalpara" href="#ugr.ovv.one_capability_set" number="" targetptr="ugr.ovv.one_capability_set">
+ <ttl>Only one Capability Set</ttl>
+ <xreftext>Only one Capability Set</xreftext>
+ </obj>
+ </div>
+ <div element="section" href="#ugr.project_overview_backwards_compatibility" number="1.3.2.3" targetptr="ugr.project_overview_backwards_compatibility">
+ <ttl>Backwards Compatibility</ttl>
+ <xreftext>Section 1.3.2.3, âBackwards Compatibilityâ</xreftext>
</div>
</div>
- <div element="section" href="#ugr.project_overview_manual_migration_necessary" number="1.3.3" targetptr="ugr.project_overview_manual_migration_necessary">
- <ttl>Situations Where Manual Migration is Necessary</ttl>
- <xreftext>Section 1.3.3, âSituations Where Manual Migration is Necessaryâ</xreftext>
- <div element="section" href="#ugr.project_overview.manual_migration_needed.jcas_for_document_annotation" number="1.3.3.1" targetptr="ugr.project_overview.manual_migration_needed.jcas_for_document_annotation">
+ </div>
+ <div element="section" href="#ugr.project_overview_migrating_from_ibm_uima" number="1.4" targetptr="ugr.project_overview_migrating_from_ibm_uima">
+ <ttl>Migrating from IBM UIMA to Apache UIMA</ttl>
+ <xreftext>Section 1.4, âMigrating from IBM UIMA to Apache UIMAâ</xreftext>
+ <div element="section" href="#ugr.project_overview_running_the_migration_utility" number="1.4.1" targetptr="ugr.project_overview_running_the_migration_utility">
+ <ttl>Running the Migration Utility</ttl>
+ <xreftext>Section 1.4.1, âRunning the Migration Utilityâ</xreftext>
+ <div element="section" href="#ugr.project_overview_running_the_migration_utility.jcas_for_document_annotation" number="1.4.1.1" targetptr="ugr.project_overview_running_the_migration_utility.jcas_for_document_annotation">
<ttl>JCas Cover Classes for DocumentAnnotation</ttl>
- <xreftext>Section 1.3.3.1, âJCas Cover Classes for DocumentAnnotationâ</xreftext>
+ <xreftext>Section 1.4.1.1, âJCas Cover Classes for DocumentAnnotationâ</xreftext>
</div>
- <div element="section" href="#ugr.project_overview.manual_migration_needed.getdocumentannotation" number="1.3.3.2" targetptr="ugr.project_overview.manual_migration_needed.getdocumentannotation">
+ <div element="section" href="#ugr.project_overview_running_the_migration_utility.manual_migration_needed.getdocumentannotation" number="1.4.1.2" targetptr="ugr.project_overview_running_the_migration_utility.manual_migration_needed.getdocumentannotation">
<ttl>JCas.getDocumentAnnotation</ttl>
- <xreftext>Section 1.3.3.2, âJCas.getDocumentAnnotationâ</xreftext>
+ <xreftext>Section 1.4.1.2, âJCas.getDocumentAnnotationâ</xreftext>
</div>
- <div element="section" href="#ugr.project_overview.manual_migration_needed.xiinclude" number="1.3.3.3" targetptr="ugr.project_overview.manual_migration_needed.xiinclude">
+ </div>
+ <div element="section" href="#ugr.project_overview_rare_migration" number="1.4.2" targetptr="ugr.project_overview_rare_migration">
+ <ttl>Rare Cases Where Additional Manual Migration is Necessary</ttl>
+ <xreftext>Section 1.4.2, âRare Cases Where Additional Manual Migration is Necessaryâ</xreftext>
+ <div element="section" href="#ugr.project_overview.manual_migration_needed.xiinclude" number="1.4.2.1" targetptr="ugr.project_overview.manual_migration_needed.xiinclude">
<ttl>xi:include</ttl>
- <xreftext>Section 1.3.3.3, âxi:includeâ</xreftext>
+ <xreftext>Section 1.4.2.1, âxi:includeâ</xreftext>
</div>
- <div element="section" href="#ugr.project_overview.manual_migration_needed.duplicate_methods_cas_tcas" number="1.3.3.4" targetptr="ugr.project_overview.manual_migration_needed.duplicate_methods_cas_tcas">
+ <div element="section" href="#ugr.project_overview.manual_migration_needed.duplicate_methods_cas_tcas" number="1.4.2.2" targetptr="ugr.project_overview.manual_migration_needed.duplicate_methods_cas_tcas">
<ttl>Duplicate Methods Taking CAS and TCAS as Arguments</ttl>
- <xreftext>Section 1.3.3.4, âDuplicate Methods Taking CAS and TCAS as Argumentsâ</xreftext>
+ <xreftext>Section 1.4.2.2, âDuplicate Methods Taking CAS and TCAS as Argumentsâ</xreftext>
</div>
- <div element="section" href="#ugr.project_overview.manual_migration_needed.undocumented_methods" number="1.3.3.5" targetptr="ugr.project_overview.manual_migration_needed.undocumented_methods">
+ <div element="section" href="#ugr.project_overview.manual_migration_needed.undocumented_methods" number="1.4.2.3" targetptr="ugr.project_overview.manual_migration_needed.undocumented_methods">
<ttl>Use of Undocumented Methods from the com.ibm.uima.util package</ttl>
- <xreftext>Section 1.3.3.5, âUse of Undocumented Methods from the com.ibm.uima.util packageâ</xreftext>
+ <xreftext>Section 1.4.2.3, âUse of Undocumented Methods from the com.ibm.uima.util packageâ</xreftext>
</div>
- <div element="section" href="#ugr.project_overview.manual_migration_needed.uima_package_names_in_user_code" number="1.3.3.6" targetptr="ugr.project_overview.manual_migration_needed.uima_package_names_in_user_code">
+ <div element="section" href="#ugr.project_overview.manual_migration_needed.uima_package_names_in_user_code" number="1.4.2.4" targetptr="ugr.project_overview.manual_migration_needed.uima_package_names_in_user_code">
<ttl>Use of UIMA Package Names for User Code</ttl>
- <xreftext>Section 1.3.3.6, âUse of UIMA Package Names for User Codeâ</xreftext>
+ <xreftext>Section 1.4.2.4, âUse of UIMA Package Names for User Codeâ</xreftext>
</div>
- <div element="section" href="#ugr.project_overview.manual_migration_needed.exceptions_extend_uima_exceptions" number="1.3.3.7" targetptr="ugr.project_overview.manual_migration_needed.exceptions_extend_uima_exceptions">
+ <div element="section" href="#ugr.project_overview.manual_migration_needed.exceptions_extend_uima_exceptions" number="1.4.2.5" targetptr="ugr.project_overview.manual_migration_needed.exceptions_extend_uima_exceptions">
<ttl>CASException and CASRuntimeException now extend UIMA(Runtime)Exception</ttl>
- <xreftext>Section 1.3.3.7, âCASException and CASRuntimeException now extend UIMA(Runtime)Exceptionâ</xreftext>
+ <xreftext>Section 1.4.2.5, âCASException and CASRuntimeException now extend UIMA(Runtime)Exceptionâ</xreftext>
</div>
</div>
- <div element="section" href="#ugr.ovv.search_engine_repackaged" number="1.3.4" targetptr="ugr.ovv.search_engine_repackaged">
- <ttl>Semantic Search Engine Repackaged</ttl>
- <xreftext>Section 1.3.4, âSemantic Search Engine Repackagedâ</xreftext>
- </div>
- </div>
- <div element="section" href="#ugr.project_overview_changes_from_v1" number="1.4" targetptr="ugr.project_overview_changes_from_v1">
- <ttl>Changes from UIMA Version 1.x</ttl>
- <xreftext>Section 1.4, âChanges from UIMA Version 1.xâ</xreftext>
- <div element="section" href="#ugr.project_overview_new_capabilities" number="1.4.1" targetptr="ugr.project_overview_new_capabilities">
- <ttl>New Capabilities</ttl>
- <xreftext>Section 1.4.1, âNew Capabilitiesâ</xreftext>
- <obj element="formalpara" href="#ugr.project_overview_new_data_types" number="" targetptr="ugr.project_overview_new_data_types">
- <ttl>New Primitive data types</ttl>
- <xreftext>New Primitive data types</xreftext>
- </obj>
- <obj element="formalpara" href="#ugr.ovv.simpler_aes_and_cases" number="" targetptr="ugr.ovv.simpler_aes_and_cases">
- <ttl>Simpler Analysis Engines and CASes</ttl>
- <xreftext>Simpler Analysis Engines and CASes</xreftext>
- </obj>
- <obj element="formalpara" href="#ugr.ovv.sofas_and_cas_views_simplified" number="" targetptr="ugr.ovv.sofas_and_cas_views_simplified">
- <ttl>Sofas and CAS Views simplified</ttl>
- <xreftext>Sofas and CAS Views simplified</xreftext>
- </obj>
- <obj element="formalpara" href="#ugr.ovv.ae_support_multiple_new_cases" number="" targetptr="ugr.ovv.ae_support_multiple_new_cases">
- <ttl>Analysis Component generalized to support multiple new CAS
- outputs</ttl>
- <xreftext>Analysis Component generalized to support multiple new CAS
- outputs</xreftext>
- </obj>
- <obj element="formalpara" href="#ugr.ovv.user_customized_fc" number="" targetptr="ugr.ovv.user_customized_fc">
- <ttl>User-customized Flow Controllers</ttl>
- <xreftext>User-customized Flow Controllers</xreftext>
- </obj>
- </div>
- <div element="section" href="#ugr.ovv.other_changes" number="1.4.2" targetptr="ugr.ovv.other_changes">
- <ttl>Other Changes</ttl>
- <xreftext>Section 1.4.2, âOther Changesâ</xreftext>
- <obj element="formalpara" href="#ugr.ovv.exceptions_rationalized" number="" targetptr="ugr.ovv.exceptions_rationalized">
- <ttl>UIMA Exceptions rationalized</ttl>
- <xreftext>UIMA Exceptions rationalized</xreftext>
- </obj>
- <obj element="formalpara" href="#ugr.ovv.result_specification" number="" targetptr="ugr.ovv.result_specification">
- <ttl>Changes in Result Specifications</ttl>
- <xreftext>Changes in Result Specifications</xreftext>
- </obj>
- <obj element="formalpara" href="#ugr.ovv.one_capability_set" number="" targetptr="ugr.ovv.one_capability_set">
- <ttl>Only one Capability Set</ttl>
- <xreftext>Only one Capability Set</xreftext>
- </obj>
- </div>
- <div element="section" href="#ugr.project_overview_backwards_compatibility" number="1.4.3" targetptr="ugr.project_overview_backwards_compatibility">
- <ttl>Backwards Compatibility</ttl>
- <xreftext>Section 1.4.3, âBackwards Compatibilityâ</xreftext>
- </div>
</div>
<div element="section" href="#ugr.project_overview_summary" number="1.5" targetptr="ugr.project_overview_summary">
<ttl>Apache UIMA Summary</ttl>
@@ -397,7 +401,7 @@
<div element="section" href="#ugr.ovv.eclipse_setup.install_emf" number="3.1.2" targetptr="ugr.ovv.eclipse_setup.install_emf">
<ttl>Install additional Eclipse component: EMF</ttl>
<xreftext>Section 3.1.2, âInstall additional Eclipse component: EMFâ</xreftext>
- <div element="section" href="#d0e1996" number="3.1.2.1">
+ <div element="section" href="#d0e2008" number="3.1.2.1">
<ttl>EMF Installation Shortcut for Eclipse 3.2</ttl>
<xreftext>Section 3.1.2.1, âEMF Installation Shortcut for Eclipse 3.2â</xreftext>
</div>
Modified: incubator/uima/uimaj/trunk/uima-docbooks/src/olink/tutorials_and_users_guides/htmlsingle-target.db
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uima-docbooks/src/olink/tutorials_and_users_guides/htmlsingle-target.db?view=diff&rev=506711&r1=506710&r2=506711
==============================================================================
--- incubator/uima/uimaj/trunk/uima-docbooks/src/olink/tutorials_and_users_guides/htmlsingle-target.db (original)
+++ incubator/uima/uimaj/trunk/uima-docbooks/src/olink/tutorials_and_users_guides/htmlsingle-target.db Mon Feb 12 14:31:24 2007
@@ -338,8 +338,8 @@
<xreftext>the section called âprocessCas()â</xreftext>
</div>
<div element="section" href="#ugr.tug.cpe.cas_consumer.optional_methods" number="" targetptr="ugr.tug.cpe.cas_consumer.optional_methods">
- <ttl>Optional Methods></ttl>
- <xreftext>the section called âOptional Methods>â</xreftext>
+ <ttl>Optional Methods</ttl>
+ <xreftext>the section called âOptional Methodsâ</xreftext>
<div element="section" href="#ugr.tug.cpe.cas_consumer.optional_methods.batchprocesscomplete" number="" targetptr="ugr.tug.cpe.cas_consumer.optional_methods.batchprocesscomplete">
<ttl>batchProcessComplete()</ttl>
<xreftext>the section called âbatchProcessComplete()â</xreftext>
Modified: incubator/uima/uimaj/trunk/uima-docbooks/src/olink/tutorials_and_users_guides/pdf-target.db
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uima-docbooks/src/olink/tutorials_and_users_guides/pdf-target.db?view=diff&rev=506711&r1=506710&r2=506711
==============================================================================
--- incubator/uima/uimaj/trunk/uima-docbooks/src/olink/tutorials_and_users_guides/pdf-target.db (original)
+++ incubator/uima/uimaj/trunk/uima-docbooks/src/olink/tutorials_and_users_guides/pdf-target.db Mon Feb 12 14:31:24 2007
@@ -338,8 +338,8 @@
<xreftext>the section called âprocessCas()â</xreftext>
</div>
<div element="section" href="#ugr.tug.cpe.cas_consumer.optional_methods" number="" targetptr="ugr.tug.cpe.cas_consumer.optional_methods">
- <ttl>Optional Methods></ttl>
- <xreftext>the section called âOptional Methods>â</xreftext>
+ <ttl>Optional Methods</ttl>
+ <xreftext>the section called âOptional Methodsâ</xreftext>
<div element="section" href="#ugr.tug.cpe.cas_consumer.optional_methods.batchprocesscomplete" number="" targetptr="ugr.tug.cpe.cas_consumer.optional_methods.batchprocesscomplete">
<ttl>batchProcessComplete()</ttl>
<xreftext>the section called âbatchProcessComplete()â</xreftext>