Author: schor Date: Thu Aug 18 18:08:20 2011 New Revision: 1159331 URL: http://svn.apache.org/viewvc?rev=1159331&view=rev Log: [UIMA-1967] move uimaj project up one level; merge uimaj-distr into it. Change uimaj-parent to use version 3-SNAPSHOT of the UIMA -wide parent. (This will be converted to version 3 once we release build parent-pom at that level).
Added: uima/uimaj/trunk/README (with props) uima/uimaj/trunk/RELEASE_NOTES.html (with props) uima/uimaj/trunk/pom.xml (with props) Modified: uima/uimaj/trunk/ (props changed) uima/uimaj/trunk/uimaj-parent/pom.xml Propchange: uima/uimaj/trunk/ ------------------------------------------------------------------------------ --- svn:ignore (original) +++ svn:ignore Thu Aug 18 18:08:20 2011 @@ -1 +1,4 @@ .project +.settings +target +issuesFixed Added: uima/uimaj/trunk/README URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/README?rev=1159331&view=auto ============================================================================== --- uima/uimaj/trunk/README (added) +++ uima/uimaj/trunk/README Thu Aug 18 18:08:20 2011 @@ -0,0 +1,128 @@ + + Apache UIMA (Unstructured Information Management Architecture) v2.3.1 SDK + ------------------------------------------------------------------------- + +Building from the Source Distribution +------------------------------------- + +We use Maven 3.0 for building; download this if needed, +and set the environment variable MAVEN_OPTS to -Xmx800m -XX:MaxPerSize-256m. + +Then do the build by going into the .../uimaj directory, and issuing the command + mvn clean install + +This builds everything except the ...source-release.zip file. If you want that, +change the command to + + mvn clean install -Papache-release + +Look for the result in the two artifacts: + ../uimaj/target/uimaj-[version]-source-release.zip (if run with -Papache-release) and + ../uimaj-distr/target/uimaj-[version]-bin.zip (or ...tar.gz) + +For more details, please see http://uima.apache.org/building-uima.html + +What's New in 2.3.1 +------------------- + + CAS Editor + ---------- + The Cas Editor received a few important enhancements aimed at making it + the preferred editor and viewer for CAS files inside a UIMA project. + It is now possible to open CAS files from any location within an + eclipse workspace. + + Based on feedback from our users the Cas Editor received a number of + usability enhancements and bug fixes. + + A new view to show the annotation colors and visualization style was added. + The view interacts with the editor and can be used to define which + kind of annotations are displayed. + + There is now a new annotation style to display features values in between + the text lines. This is especially useful to show Part-Of-Speech tags, + entity categories or a stemming. + + There have been a couple of minor improvements: the editor context menu + now shows keyboard shortcuts, and it is possible to choose the encoding + and resulting CAS format when importing a text file. + + + Build + ----- + + The build process was redone to align it with normal Maven build procedures, where possible. + There is a new top-level directory in our SVN called "build" which holds the build tooling. + The new build tooling is described in general on the website + http://uima.apache.org/maven-design.html + + + Result Specification + -------------------- + + The implementation handling the result specification was redone to correct several corner case issues. + + + Performance + ----------- + + The Component Descriptor Editor (CDE) (an Eclipse tool) had potentially poor performance when + editing aggregate descriptors that referenced many remote components. The performance in this + case has been greatly improved, using a caching technique and eliminating repetitive remote accesses. + + A complete list of fixes is in issuesFixed/jira-report.hmtl. + +Supported Platforms +-------------------- + +Apache UIMA requires Java level 1.5; it has been tested with Sun Java SDK v5.0 and v6.0, and IBM Java 6.0. +Running the Eclipse plugin tooling for UIMA requires you start Eclipse using a Java 1.5 or later, as well. +The supported platforms are: Windows, Linux, Solaris, AIX and Mac OS X. +Other platforms and Java (1.5+) 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. + + +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. + + +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 Propchange: uima/uimaj/trunk/README ------------------------------------------------------------------------------ svn:eol-style = native Added: uima/uimaj/trunk/RELEASE_NOTES.html URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/RELEASE_NOTES.html?rev=1159331&view=auto ============================================================================== --- uima/uimaj/trunk/RELEASE_NOTES.html (added) +++ uima/uimaj/trunk/RELEASE_NOTES.html Thu Aug 18 18:08:20 2011 @@ -0,0 +1,186 @@ + <!-- + *************************************************************** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + *************************************************************** + --> +<html> +<head> + <title>Apache UIMA v2.3.1 Release Notes</title> +</head> +<body> +<h1>Apache UIMA (Unstructured Information Management Architecture) v2.3.1 Release Notes</h1> + +<h2>Contents</h2> +<p> +<a href="#what.is.uima">What is UIMA?</a><br/> +<a href="#major.changes">Major Changes in this Release</a><br/> +<a href="#get.involved">How to Get Involved</a><br/> +<a href="#report.issues">How to Report Issues</a><br/> +<a href="#list.issues">List of JIRA Issues Fixed in this Release</a><br/> +<a href="#migrating">Migrating from IBM UIMA to Apache UIMA</a><br/> +</p> + +<h2><a name="what.is.uima">1. What is UIMA?</a></h2> + + <p> + Unstructured Information Management applications are + software systems that analyze large volumes of + unstructured information in order to discover knowledge + that is relevant to an end user. UIMA is a framework and + SDK for developing such applications. An example UIM + application might ingest plain text and identify + entities, such as persons, places, organizations; or + relations, such as works-for or located-at. UIMA enables + such an application to be decomposed into components, + for example "language identification" -> "language + specific segmentation" -> "sentence boundary + detection" -> "entity detection (person/place names + etc.)". Each component must implement interfaces defined + by the framework and must provide self-describing + metadata via XML descriptor files. The framework manages + these components and the data flow between them. + Components are written in Java or C++; the data that + flows between components is designed for efficient + mapping between these languages. UIMA additionally + provides capabilities to wrap components as network + services, and can scale to very large volumes by + replicating processing pipelines over a cluster of + networked nodes. + </p> + <p> + Apache UIMA is an Apache-licensed open source + implementation of the UIMA specification (that + specification is, in turn, being developed concurrently + by a technical committee within + <a href="http://www.oasis-open.org">OASIS</a> + , a standards organization). We invite and encourage you + to participate in both the implementation and + specification efforts. + </p> + <p> + UIMA is a component framework for analysing unstructured + content such as text, audio and video. It comprises an + SDK and tooling for composing and running analytic + components written in Java and C++, with some support + for Perl, Python and TCL. + </p> + +<h2><a name="major.changes">Major Changes in this Release</a></h2> +<p> +Please see the <a href="README">README</a> for this information. +</p> + +<h2><a name="get.involved">How to Get Involved</a></h2> +<p> +The Apache UIMA project really needs and appreciates any contributions, +including documentation help, source code and feedback. If you are interested +in contributing, please visit +<a href="http://uima.apache.org/get-involved.html"> + http://uima.apache.org/get-involved.html</a>. +</p> + +<h2><a name="report.issues">How to Report Issues</a></h2> +<p> +The Apache UIMA project uses JIRA for issue tracking. Please report any +issues you find at +<a href="http://issues.apache.org/jira/browse/uima">http://issues.apache.org/jira/browse/uima</a> +</p> + +<h2><a name="list.issues">List of JIRA Issues Fixed in 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. + +<h2><a name="migrating">Migrating from IBM UIMA to Apache UIMA</a></h2> + +<p> +This section describes how to move from pre-Apache versions of UIMA to the +Apache version (starting with Apache UIMA 2.1). +</p> + +<p> +Note: 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. +</p> +<p> +The migration utility is run by executing the script file +apache-uima/bin/ibmUimaToApacheUima.bat (Windows) or +apache-uima/bin/ibmUimaToApacheUima.sh (UNIX). You must pass one argument: the +directory containing the files that you want to be migrated. Subdirectories +will be processed recursively. +</p> +<p> +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. +</p> +<p> +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 -ext argument appropriately.) +</p> +<p> +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. +</p> + +<h3>3.1. JCas Cover Classes for DocumentAnnotation</h3> +<p> +If you have run JCasGen it is likely that you have the classes +com.ibm.uima.jcas.tcas.DocumentAnnotation and +com.ibm.uima.jcas.tcas.DocumentAnnotation_Type 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. +</p> +<p> +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 uima-document-annotation.jar file that is +included in Apache UIMA. If you have made custom changes, then you should not +delete the file but instead move it to the correct package +org.apache.uima.jcas.tcas. For more information about JCas and +DocumentAnnotation please see Section 5.5.4, +"Adding Features to DocumentAnnotation" in the + <a href="docs/html/references/references.html">UIMA References</a> manual. +</p> + +<h3>3.2. JCas.getDocumentAnnotation</h3> +<p> +The deprecated method JCas.getDocumentAnnotation has been removed. Its use +must be replaced with JCas.getDocumentAnnotationFs. The method +JCas.getDocumentAnnotationFs() returns type TOP, so your code must cast this to +type DocumentAnnotation. The reasons for this are described in Section +5.5.4, "Adding Features to DocumentAnnotation" in the +<a href="docs/html/references/references.html">UIMA References</a> manual. +</p> + +<h3>3.3. Rare Cases Where Additional Manual Migration is Necessary</h3> +<p> +For most users there should not be any additional migration steps necessary. +However, if the migration tool reported an additional warning or if you are +having trouble getting your code to compile or run after running the migration, +please see Section 1.4.2. "Rare Cases Where Additional Manual Migration is +Necessary," in the <a href="docs/html/overview_and_setup/overview_and_setup.html"> +Overview and Setup</a> manual. +</p> + + +</body> +</html> \ No newline at end of file Propchange: uima/uimaj/trunk/RELEASE_NOTES.html ------------------------------------------------------------------------------ svn:eol-style = native Added: uima/uimaj/trunk/pom.xml URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/pom.xml?rev=1159331&view=auto ============================================================================== --- uima/uimaj/trunk/pom.xml (added) +++ uima/uimaj/trunk/pom.xml Thu Aug 18 18:08:20 2011 @@ -0,0 +1,272 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> + +<!-- This pom serves as the release top level project, + and for users wanting to build all of the + base UIMA Java SDK + --> + +<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>2.3.2-SNAPSHOT</version> + <relativePath>uimaj-parent/pom.xml</relativePath> + </parent> + + <artifactId>uimaj</artifactId> + <packaging>pom</packaging> + <version>2.3.2-SNAPSHOT</version> + <name>UIMA Java SDK: ${project.artifactId}</name> + <description>The top project for the uimaj SDK</description> + <url>${uimaWebsiteUrl}</url> + + <!-- Special inheritance note + even though the <scm> element that follows is exactly the + same as those in super poms, it cannot be inherited because + there is some special code that computes the connection elements + from the chain of parent poms, if this is omitted. + + Keeping this a bit factored allows cutting/pasting the <scm> + element, and just changing the following two properties --> + <scm> + <connection> + scm:svn:http://svn.apache.org/repos/asf/uima/uimaj/trunk/uimaj + </connection> + <developerConnection> + scm:svn:https://svn.apache.org/repos/asf/uima/uimaj/trunk/uimaj + </developerConnection> + <url> + http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj + </url> + </scm> + + <properties> + <uimaScmProject>${project.artifactId}</uimaScmProject> + <jiraVersion>12315996</jiraVersion> <!-- for 2.3.2SDK --> + <assemblyFinalName>uimaj-${project.version}</assemblyFinalName> + <postNoticeText>${ibmNoticeText}</postNoticeText> + </properties> + + <!-- dependencies that go into the various builds via dependency-sets --> + <!-- version is specified here --> + <!-- default scope is compile --> + <!-- Used for assemblies, to insure they're built *before* the assembly --> + + <dependencies> + <dependency> + <groupId>org.apache.uima</groupId> + <artifactId>uimaj-adapter-vinci</artifactId> + <version>${project.version}</version> + </dependency> + <dependency> + <groupId>org.apache.uima</groupId> + <artifactId>uimaj-adapter-soap</artifactId> + <version>${project.version}</version> + </dependency> + <dependency> + <groupId>org.apache.uima</groupId> + <artifactId>uimaj-bootstrap</artifactId> + <version>${project.version}</version> + </dependency> + <dependency> + <groupId>org.apache.uima</groupId> + <artifactId>uimaj-core</artifactId> + <version>${project.version}</version> + </dependency> + <dependency> + <groupId>org.apache.uima</groupId> + <artifactId>uimaj-cpe</artifactId> + <version>${project.version}</version> + </dependency> + <dependency> + <groupId>org.apache.uima</groupId> + <artifactId>uimaj-examples</artifactId> + <version>${project.version}</version> + </dependency> + <dependency> + <groupId>org.apache.uima</groupId> + <artifactId>uimaj-tools</artifactId> + <version>${project.version}</version> + </dependency> + <dependency> + <groupId>org.apache.uima</groupId> + <artifactId>uimaj-ep-cas-editor</artifactId> + <version>${project.version}</version> + </dependency> + <dependency> + <groupId>org.apache.uima</groupId> + <artifactId>uimaj-ep-configurator</artifactId> + <version>${project.version}</version> + </dependency> + <dependency> + <groupId>org.apache.uima</groupId> + <artifactId>uimaj-ep-debug</artifactId> + <version>${project.version}</version> + </dependency> + <dependency> + <groupId>org.apache.uima</groupId> + <artifactId>uimaj-ep-jcasgen</artifactId> + <version>${project.version}</version> + </dependency> + <dependency> + <groupId>org.apache.uima</groupId> + <artifactId>uimaj-ep-pear-packager</artifactId> + <version>${project.version}</version> + </dependency> + <dependency> + <groupId>org.apache.uima</groupId> + <artifactId>uimaj-ep-runtime</artifactId> + <version>${project.version}</version> + </dependency> + </dependencies> + + <modules> + <module>uimaj-parent</module> + <module>../aggregate-uimaj</module> + </modules> + + <build> + <plugins> + + <!-- This java doc config is for building the ones distributed with the bin packaging, and also + posted on our website. It is not a complete javadoc - it only has user-level API info. + + There is another javadoc config in the parent POM that builds all the java docs - intended + for use by developers (currently not used) --> + + <plugin> + <artifactId>maven-javadoc-plugin</artifactId> + <executions> + <execution> + <id>javadocs-distr</id> <!-- name should match one in parent-pom --> + <phase>prepare-package</phase> <!-- must come before package which uses the results --> + <!--phase>deploy</phase--> <!-- comment above and uncomment to disable javadocs, for testing/experimentation, with assembly:assembly--> + <goals> + <goal>javadoc</goal> + </goals> + <configuration> + <!-- fix java api links because Oracle bought Sun --> + <javaApiLinks> + <property> + <name>api_1.5</name> + <value>http://download.oracle.com/javase/1.5.0/docs/api/</value> + </property> + </javaApiLinks> + <groups> + <group> + <title>Packages</title> + <packages>*</packages> + </group> + </groups> + <sourcepath>uimaj-core/src/main/java;uimaj-document-annotation/src/main/java</sourcepath> + <excludePackageNames>*.internal.*:*.impl.*</excludePackageNames> + <!-- add a few classes in impl packages that are directly used by user code --> + <additionalparam> + ${basedir}/uimaj-core/src/main/java/org/apache/uima/cas/impl/XCASDeserializer.java + ${basedir}/uimaj-core/src/main/java/org/apache/uima/cas/impl/XCASParsingException.java + ${basedir}/uimaj-core/src/main/java/org/apache/uima/cas/impl/XCASSerializer.java + ${basedir}/uimaj-core/src/main/java/org/apache/uima/cas/impl/XmiCasDeserializer.java + ${basedir}/uimaj-core/src/main/java/org/apache/uima/cas/impl/XmiCasSerializer.java + ${basedir}/uimaj-core/src/main/java/org/apache/uima/cas/impl/XmiSerializationSharedData.java + ${basedir}/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/metadata/cpe/CpeDescriptorFactory.java + ${basedir}/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/engine/CPMChunkTimeoutException.java + </additionalparam> + <doctitle>Apache UIMA Java SDK ${project.version} User-Level API Documentation</doctitle> + <windowtitle>Apache UIMA Java SDK ${project.version} User-Level API Documentation</windowtitle> + </configuration> + </execution> + </executions> + </plugin> + + <plugin> + <groupId>org.apache.rat</groupId> + <artifactId>apache-rat-plugin</artifactId> + <executions> + <execution> + <id>default-cli</id> + <goals><goal>check</goal></goals> + <phase>verify</phase> + <!-- default configuration --> + <configuration> + <excludes> + <exclude>release.properties</exclude> <!-- generated file --> + <exclude>README*</exclude> + <exclude>RELEASE_NOTES*</exclude> + <exclude>issuesFixed/**</exclude> <!-- generated file --> + <exclude>src/main/resources/docbook-shared/titlepage/*.xsl</exclude> + <exclude>marker-file-identifying-*</exclude> <!-- empty file --> + <exclude>DEPENDENCIES</exclude> <!-- generated file --> + + <!-- workaround https://issues.apache.org/jira/browse/RAT-97 --> + <exclude>aggregate-uimaj*/**</exclude> + <exclude>jVinci/**</exclude> + <exclude>PearPackagingMavenPlugin/**</exclude> + <exclude>uima-docbook-*/**</exclude> + <exclude>uimaj-adapter-*/**</exclude> + <exclude>uimaj-component-test-util/**</exclude> + <exclude>uimaj-core/**</exclude> + <exclude>uimaj-cpe/**</exclude> + <exclude>uimaj-document-annotation/**</exclude> + <exclude>uimaj-eclipse-*/**</exclude> + <exclude>uimaj-ep-*/**</exclude> + <exclude>uimaj-examples/**</exclude> + <exclude>uimaj-test-util/**</exclude> + <exclude>uimaj-tools/**</exclude> + <exclude>uimaj-jet-expander/**</exclude> + <exclude>uimaj-bootstrap/**</exclude> + <exclude>uimaj-internal-tools/**</exclude> + <exclude>uimaj/**</exclude> <!-- to be removed when remove the old uimaj project --> + <exclude>uimaj-distr/**</exclude> <!-- to be removed when remove the old uimaj-distr project --> + </excludes> + </configuration> + </execution> + </executions> + </plugin> + </plugins> + </build> + + <profiles> + <profile> + <id>apache-release</id> + + <build> + <!-- Run jira report --> + <!-- depends on having -DjiraVersion set --> + <plugins> + <plugin> + <artifactId>maven-changes-plugin</artifactId> + <executions> + <execution> + <id>default-cli</id> + <configuration> + <fixVersionIds>${jiraVersion}</fixVersionIds> + </configuration> + </execution> + </executions> + </plugin> + </plugins> + </build> + </profile> + </profiles> + +</project> Propchange: uima/uimaj/trunk/pom.xml ------------------------------------------------------------------------------ svn:eol-style = native Modified: uima/uimaj/trunk/uimaj-parent/pom.xml URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-parent/pom.xml?rev=1159331&r1=1159330&r2=1159331&view=diff ============================================================================== --- uima/uimaj/trunk/uimaj-parent/pom.xml (original) +++ uima/uimaj/trunk/uimaj-parent/pom.xml Thu Aug 18 18:08:20 2011 @@ -31,7 +31,7 @@ <parent> <groupId>org.apache.uima</groupId> <artifactId>parent-pom</artifactId> - <version>2</version> + <version>3-SNAPSHOT</version> <relativePath /> </parent>