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/07 18:24:28 UTC
svn commit: r1768570 - in /uima/uimaj/branches/experiment-v3-jcas: README
RELEASE_NOTES.html
Author: schor
Date: Mon Nov 7 18:24:28 2016
New Revision: 1768570
URL: http://svn.apache.org/viewvc?rev=1768570&view=rev
Log:
[UIMA-5172]
Modified:
uima/uimaj/branches/experiment-v3-jcas/README
uima/uimaj/branches/experiment-v3-jcas/RELEASE_NOTES.html
Modified: uima/uimaj/branches/experiment-v3-jcas/README
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/experiment-v3-jcas/README?rev=1768570&r1=1768569&r2=1768570&view=diff
==============================================================================
--- uima/uimaj/branches/experiment-v3-jcas/README (original)
+++ uima/uimaj/branches/experiment-v3-jcas/README Mon Nov 7 18:24:28 2016
@@ -2,65 +2,16 @@
Apache UIMA (Unstructured Information Management Architecture)
--------------------------------------------------------------
-This file applies to UIMA-SDK version 2.8.0 and subsequent versions.
+This file applies to UIMA-SDK version 3.0.0-alpha1 and subsequent versions.
Backwards Compatibility
-----------------------
-New releases strive to maintain backwards compatibility; in general you should
-expect that upgrading will not break existing UIMA pipelines.
+Version 3 is a major new release, and many APIs have been augmented.
+The Version 3 users guide has a chapter on backwards compatibility.
+In general, existing pipelines, after having their JCas class migrated,
+will likely run with version 3.
-From time to time, non-backward compatible changes are made, such as increased
-checking for error situations. This may cause existing pipelines to fail. In
-most cases, there are JVM -D properties that can be used to disable these changes
-until the underlying issues are corrected or accommodated.
-
-Out of the box,
- it will do additional checking and fixups for some hard-to-find user errors; see
- the first section above coping with backwards compatibility issues.
-
-The JVM -D property names for these, and their meaning, are:
-
- -Duima.allow_duplicate_add_to_indexes
-
- Adding the same exact FS instance to the indexes multiple times no longer
- results in duplicate entries in the indexes. You may restore the previous
- behavior using this flag.
-
- -Duima.disable_auto_protect_indexes
-
- UIMA now checks and automatically protects indexes if users (after adding
- a feature structure to the indexes) updates a feature which is being used
- as a key. For production runs, after insuring there are no such updates
- going on, or explicitly protecting those that are being done using the
- protectIndexes() method, you can disable this protection and checking,
- which may make things run slightly faster.
-
- -Duima.report_fs_update_corrupts_index
-
- See https://issues.apache.org/jira/browse/UIMA-4135.
- Updating Features which are used in Set and Sorted indexes
- as "keys" may corrupt the indexes, if the Feature Structure (FS) has been
- added to the indexes. To update these, you must first completely remove
- the FS from the indexes in all views, then do the updates, and then add
- it back. UIMA now checks for this (unless specifically disabled),
- and if this property is set, will log WARN messages for each occurrence
- unless the user wraps these updates inside explicit protectIndexes
- blocks.
-
- To scan the logs for these reports, search for instances of lines having
- the string While FS was in the index, the feature
-
- -Duima.disable_enhanced_check_wrong_add_to_index
-
- See https://issues.apache.org/jira/browse/UIMA-4099.
- Feature Structures which are subtypes of AnnotationBase may only be
- added to the View corresponding to their Sofa reference. From version
- 2.7.0, there is additional checking of this which can be disabled
- if needed for backward compatibility.
-
- See the UIMA References http://uima.apache.org/d/uimaj-current/references.html#ugr.ref.config
- for a table of these and other settings.
Building from the Source Distribution
-------------------------------------
@@ -90,12 +41,12 @@ What's New
Supported Platforms
--------------------
-Apache UIMA requires Java version 7 or later; it has been tested with Sun/Oracle Java SDK 7, and 8,
-and IBM Java 7 and 8.
+Apache UIMA v3.0.0 requires Java version 8 or later; it has been tested with Sun/Oracle Java 8,
+and IBM 8.
-Running the Eclipse plugin tooling for UIMA requires you start Eclipse using a Java 7 or later, as well.
+Running the Eclipse plugin tooling for UIMA requires you start Eclipse using a Java 8 or later, as well.
-The supported platforms are: Windows, Linux, and Mac OS X. Other platforms and Java (7+)
+The supported platforms are: Windows, Linux, and Mac OS X. Other platforms and Java (8+)
implementations should work, but have not been significantly tested.
Many of the scripts in the /bin directory invoke Java. They use the value of the environment variable, JAVA_HOME,
@@ -141,6 +92,5 @@ Double-click on one of the documents to
Getting Started
----------------
-For an introduction to Apache UIMA and how to use it, please read the documentation
-located in the docs subdirectory. A good place to start is the overview_and_setup
-book's first chapter, which has a brief guide to the documentation.
\ No newline at end of file
+Version 3 requires migration for existing Version 2 deployments that use JCas. For instructions on this, please
+read the documentation for Version 3 located in the docs subdirectory.
\ No newline at end of file
Modified: uima/uimaj/branches/experiment-v3-jcas/RELEASE_NOTES.html
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/experiment-v3-jcas/RELEASE_NOTES.html?rev=1768570&r1=1768569&r2=1768570&view=diff
==============================================================================
--- uima/uimaj/branches/experiment-v3-jcas/RELEASE_NOTES.html (original)
+++ uima/uimaj/branches/experiment-v3-jcas/RELEASE_NOTES.html Mon Nov 7 18:24:28 2016
@@ -20,10 +20,10 @@
-->
<html>
<head>
- <title>Apache UIMA v2.8.1 Release Notes</title>
+ <title>Apache UIMA v3.0.0-alpha1 Release Notes</title>
</head>
<body>
-<h1>Apache UIMA (Unstructured Information Management Architecture) v2.8.1 Release Notes</h1>
+<h1>Apache UIMA (Unstructured Information Management Architecture) v3.0.0-alpha1 Release Notes</h1>
<h2>Contents</h2>
<p>
@@ -81,30 +81,50 @@
<h2><a id="major.changes">Major Changes in this Release</a></h2>
-<p>The flattened index support added in 2.8.0 has some edge cases where the
-flattened version needs to be invalidated. In trading off complexity versus
-performance improvements, we decided to disable this feature for now.
-<a target="_blank" href="https://issues.apache.org/jira/browse/UIMA-4542">UIMA-4542</a>
+<p>Version 3 is a major reimplementation of the internals of UIMA,
+with many significant changes. A migration step is required if
+JCas cover classes are being used, as these have changed.
+Please read the Version 3 users guide located in the docs directory
+for information on these changes and migration.
</p>
-<p>A few bugs were fixed in the CasAnnotationViewer
-<a target="_blank" href="https://issues.apache.org/jira/browse/UIMA-4533">UIMA-4533</a>, a name-clash was
-fixed in an internal method, which could clash with a JCas-generated name
-if there was a feature that happened to be named "TypeCode"
-<a target="_blank" href="https://issues.apache.org/jira/browse/UIMA-4534">UIMA-4534</a>,
-and the CasCopier code was improved to cover an additional use case
-<a target="_blank" href="https://issues.apache.org/jira/browse/UIMA-4541">UIMA-4541</a>
+<p>A very brief summary of Version 3:
+<ul><li>Feature Structures become Java Objects,
+and may be Garbage Collected.</li>
+<li>Many performance improvements</li>
+<li>Iterating over indexes no longer throws
+ConcurrentModificationException</li>
+<li>Support for arbitrary Java Objects in the CAS</li>
+<li>Using above, new built-ins for ArrayList style
+lists of Feature Structures and ints</li>
+<li>New "select" framework for flexible
+access to Feature Structures</li>
+<li>Integration with Java 8 facilities such as Streams</li>
</p>
+
+<p>Please read the overview section of the Version 3
+users guide for more.</p>
- <h3>API changes</h3>
- <p>
- There were no API changes that affect backward compatibility.
+<h3>API changes</h3>
+ <p>Many APIs were changed, typically by adding new capability.
+ However, we attempt to preserve existing APIs, for backward compatibility.
</p>
-<h2><a id="list.issues">Full list of JIRA Issues Fixed in this Release</a></h2>
+<h2><a id="list.issues">Full list of JIRA Issues affecting this Release</a></h2>
Click <a href="issuesFixed/jira-report.html">issuesFixed/jira-report.hmtl</a> for the list of
-issues fixed in this release.
+issues affecting this release.
+<h2><a id="alpha">Alpha Release</a></h2>
+<p>Because this release makes major changes to UIMA internals,
+this is an alpha release of version 3. It is being made to get
+wider community involvement in testing and feedback.
+The APIs may change, and features
+may be added or altered.<\p>
+
+<p>Please use the mailing lists
+( http://uima.apache.org/mail-lists.html )
+for feedback.</p>
+
<h2><a id="get.involved">How to Get Involved</a></h2>
<p>
The Apache UIMA project really needs and appreciates any contributions,