Merge pull request #187 from apache/UIMA-6395-Apache-UIMA-Java-SDK-3.…

…3.0-release

[UIMA-6395] Apache UIMA Java SDK 3.3.0 release

NOTICE → NOTICE.md

@@ -1,32 +1,36 @@
-Apache UIMA
-Copyright 2006 The Apache Software Foundation
-
-This product includes software developed at
-The Apache Software Foundation (http://www.apache.org/).
-
-Portions of UIMA were originally developed by
-International Business Machines Corporation and are
-licensed to the Apache Software Foundation under the
-"Software Grant License Agreement", informally known as the
-"IBM UIMA License Agreement".
-Copyright (c) 2003, 2006 IBM Corporation.
-
-# Jackson JSON processor
-
-Jackson is a high-performance, Free/Open Source JSON processing library.
-It was originally written by Tatu Saloranta (tatu.saloranta@iki.fi), and has
-been in development since 2007.
-It is currently developed by a community of developers, as well as supported
-commercially by FasterXML.com.
-
-## Jackson JSON Credits
-
-A list of contributors may be found from CREDITS file, which is included
-in some artifacts (usually source distributions); but is always available
-from the source code management (SCM) system project uses.
-
-## org.apache.uima.internal.util.WeakIdentityMap
-
-The class org.apache.uima.internal.util.WeakIdentityMap<K, V> was copied from
-the Apache Lucene project which in turn derived it from the Apache CXF project 
+# Apache UIMA Java SDK
+Copyright 2006 The Apache Software Foundation
+
+This product includes software developed at
+The Apache Software Foundation (http://www.apache.org/).
+
+Portions of UIMA were originally developed by
+International Business Machines Corporation and are
+licensed to the Apache Software Foundation under the
+"Software Grant License Agreement", informally known as the
+"IBM UIMA License Agreement".
+Copyright (c) 2003, 2006 IBM Corporation.
+
+# Jackson JSON processor
+
+Jackson is a high-performance, Free/Open Source JSON processing library.
+It was originally written by Tatu Saloranta (tatu.saloranta@iki.fi), and has
+been in development since 2007.
+It is currently developed by a community of developers.
+
+## Licensing
+
+Jackson 2.x core and extension components are licensed under Apache License 2.0
+To find the details that apply to this artifact see the accompanying LICENSE file.
+
+## Credits
+
+A list of contributors may be found from CREDITS(-2.x) file, which is included
+in some artifacts (usually source distributions); but is always available
+from the source code management (SCM) system project uses.
+
+# org.apache.uima.internal.util.WeakIdentityMap
+
+The class org.apache.uima.internal.util.WeakIdentityMap<K, V> was copied from
+the Apache Lucene project which in turn derived it from the Apache CXF project 
 and is Apache License 2.0.

PearPackagingMavenPlugin/pom.xml

@@ -17,15 +17,13 @@
    specific language governing permissions and limitations
    under the License.    
 -->
-<project xmlns="http://maven.apache.org/POM/4.0.0"
-  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
   <modelVersion>4.0.0</modelVersion>
 
   <parent>
     <groupId>org.apache.uima</groupId>
     <artifactId>uimaj-parent</artifactId>
-    <version>3.3.0-SNAPSHOT</version>
+    <version>3.3.1-SNAPSHOT</version>
     <relativePath>../uimaj-parent/pom.xml</relativePath>
   </parent>
 

README.md

@@ -15,8 +15,24 @@ link that entity to a reference dataset, then Apache UIMA provides:
 * any many additional features!
 
 Note the Apache UIMA Java SDK only provides a framework for building analytics but it does not 
-provide any analytics. However, there are various [third-parties](#uima-component-providers) that build on Apache UIMA
-and that provide collections of analysis components or ready-made solutions.
+provide any analytics. However, there are various [third-parties](#uima-component-providers) that
+build on Apache UIMA and that provide collections of analysis components or ready-made solutions.
+
+#### System requirements
+
+Apache UIMA v3.0.0 and later requires Java version 8; it has been tested with Java 11 and Java 8.
+
+Running the Eclipse plugin tooling for UIMA requires you start Eclipse using a Java 8 or later.
+
+Running the migration tool on class files requires running with a Java JDK, not a Java JRE.
+
+The supported platforms are: Windows, Linux, and macOS. Other Java platform 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`, to locate the Java to use; if it is not set, they invoke `java` expecting to find
+an appropriate Java in your `PATH` variable. 
+
 
 #### Using Apache UIMA Java SDK
 
@@ -28,7 +44,7 @@ to your project:
 <dependency>
   <groupId>org.apache.uima</groupId>
   <artifactId>uimaj-core</artifactId>
-  <version>3.2.0</version>
+  <version>3.3.0</version>
 </dependency>
 ```
 
@@ -39,7 +55,7 @@ Apache uimaFIT is a separate dependency that you can add:
 <dependency>
   <groupId>org.apache.uima</groupId>
   <artifactId>uimafit-core</artifactId>
-  <version>3.2.0</version>
+  <version>3.3.0</version>
 </dependency>
 ```
 
@@ -145,12 +161,52 @@ for (var anno : cas.<Annotation>select(entityType)) {
 
 To build Apache UIMA, you need at least a Java 8 JDK and a recent Maven 3 version.
 
-After cloning the repository, change into the repository directory and run the following command:
+After extracting the source distribution ZIP or cloning the repository, change into the created
+directory and run the following command:
 
 ```
 mvn clean install
 ```
 
+For more details, please see http://uima.apache.org/building-uima.html   
+
+
+#### Running examples from the source/binary distribution
+
+You can download the source and binary distributions from the 
+[Apache UIMA website](https://uima.apache.org/downloads.cgi).
+
+##### Environment Variables
+
+After you have unpacked the Apache UIMA distribution from the package of your choice (e.g. `.zip` or 
+`.gz`), perform the steps below to set up UIMA so that it will function properly.
+
+* Set `JAVA_HOME` to the directory of your JRE installation you would like to use for UIMA.  
+* Set `UIMA_HOME` to the `apache-uima` directory of your unpacked Apache UIMA distribution
+* Append `UIMA_HOME/bin` to your `PATH`
+* Please run the script `UIMA_HOME/bin/adjustExamplePaths.bat` (or `.sh`), to update 
+  paths in the examples based on the actual `UIMA_HOME` directory path. 
+  This script runs a Java program; you must either have `java` in your `PATH` or set the environment 
+  variable `JAVA_HOME` to a suitable JRE.
+
+    Note: The Mac OS X operating system procedures for setting up global environment
+    variables are described here: see http://developer.apple.com/qa/qa2001/qa1067.html.
+
+##### Verifying Your Installation
+
+To test the installation, run the `documentAnalyzer.bat` (or `.sh`) file located in the `bin` subdirectory. 
+This should pop up a *Document Analyzer* window. Set the values displayed in this GUI to as follows:
+
+* Input Directory: `UIMA_HOME/examples/data`
+* Output Directory: `UIMA_HOME/examples/data/processed`
+* Location of Analysis Engine XML Descriptor: `UIMA_HOME/examples/descriptors/analysis_engine/PersonTitleAnnotator.xml`
+
+Replace `UIMA_HOME` above with the path of your Apache UIMA installation.
+
+Next, click the *Run* button, which should, after a brief pause, pop up an *Analyzed Results* window. 
+Double-click on one of the documents to display the analysis results for that document.
+
+
 #### UIMA component providers
 
 Here is list of several well-known projects that provide their analysis tools as UIMA components