Author: bhavani
Date: Wed Dec 21 14:59:33 2011
New Revision: 1221753
URL: http://svn.apache.org/viewvc?rev=1221753&view=rev
Log:
UIMA-2053 removed incubation mentions and other cleanup
Modified:
uima/uimacpp/trunk/README.4sdk
uima/uimacpp/trunk/README.4src
uima/uimacpp/trunk/RELEASE_NOTES.html
uima/uimacpp/trunk/buildSrcTree.cmd
uima/uimacpp/trunk/buildSrcTree.sh
uima/uimacpp/trunk/createRelease.txt
uima/uimacpp/trunk/docs/overview_and_setup.html
uima/uimacpp/trunk/examples/descriptors/XCasWriterCasConsumer.xml
Modified: uima/uimacpp/trunk/README.4sdk
URL:
http://svn.apache.org/viewvc/uima/uimacpp/trunk/README.4sdk?rev=1221753&r1=1221752&r2=1221753&view=diff
==============================================================================
--- uima/uimacpp/trunk/README.4sdk (original)
+++ uima/uimacpp/trunk/README.4sdk Wed Dec 21 14:59:33 2011
@@ -1,74 +1,68 @@
-
- Apache UIMA C++ (Unstructured Information Management
Architecture) v2.3.0
-
-------------------------------------------------------------------------
-
-Getting Started
-----------------
-
-Apache UIMA C++ can be used as a standalone framework, but it is primarily
intended to be integrated with the Apache UIMA Java framework. Interoperability
is enhanced if the uimacpp SDK package is installed directly under the top
level directory of the Apache UIMA Java framework.
-
-For information about the Apache UIMA C++ package go to index.html in the
uimacpp/docs directory. For more information about Apache UIMA, go to
http://incubator.apache.org/uima/index.html, or to the documentation in the
Apache UIMA Java package.
-
-
-Supported Platforms
---------------------
-
-Apache UIMA C++ has been tested with gcc v4.0 on Linux and MacOSX, and with
VC8 on Windows. Binary distributions are available for selected platforms.
-
-
-Environment Variables
-----------------------
-
-The following environmental variables are needed for UIMA C++ to function
properly.
-
- * UIMACPP_HOME should point to the uimacpp directory of your unpacked
Apache UIMA C++
- distribution. UIMACPP_HOME is used when compiling & linking UIMA C++
components.
- * Append $UIMACPP_HOME/bin to your PATH to pick up the runAECpp test driver
- and shared libraries (Windows)
- * Append $UIMACPP_HOME/lib to your LD_LIBRARY_PATH (Linux) or
DYLD_LIBRARY_PATH (MacOSX)
- so that the necessary shared libraries can be found.
-
-Also note that UIMA C++ annotators are built as shared libraries, so they must
be in a directory in the LD_LIBRARY_PATH, DYLD_LIBRARY_PATH or PATH (as
appropriate to your platform) as well. An example of this is given in the next
section.
-
-For better runtime integration between Java and C++, the Apache UIMA Java SDK
command line utilities and Eclipse run configurations automatically add
$UIMA_HOME/uimacpp/lib to LD_LIBRARY_PATH and DYLD_LIBRARY_PATH, and add
$UIMA_HOME/uimacpp/bin to PATH.
-
-
-Verifying Your Installation
-----------------------------
-
-The procedure here is to first test that Apache UIMA C++ is installed and
operating correctly. Then if desired, check if the code is interoperating
properly with Apache UIMA Java.
-
-Set up the environment as described above. Go to $UIMACPP_HOME/examples/src to
build the sample code and add the src directory to the appropriate path as
follows.
-
-On Linux:
- * make -f DaveDetector.mak
- * LD_LIBRARY_PATH=$LD_LIBRARY_PATH:`pwd`
-
-On Windows:
- * devenv DaveDetector.vcproj /build release
- * PATH=%PATH%;%CD%
-
-To test the sample code in the C++ environment, change back to the
$UIMACPP_HOME/examples directory and run:
- * runAECpp descriptors/DaveDetector.xml data
-
-The console should show that a Dave was found in some of the files in the data
directory.
-
-To test interoperability with Java using the JNI, first verify that Apache
UIMA Java is working from the current shell, as described in that package, and
then use the runAE.sh utility (use runAE on Windows) from
$UIMACPP_HOME/examples:
- * runAE.sh descriptors/DaveDetector.xml data
-
-For more information about the C++ sample code see
$UIMACPP_HOME/examples/readme.html.
-
-For more information about UIMA C++ $UIMACPP_HOME/RELEASE_NOTES.html.
-
-
-Disclaimer
------------
-
-Apache UIMA is an effort undergoing incubation at The Apache Software
-Foundation (ASF). Incubation is required of all newly accepted projects
-until a further review indicates that the infrastructure, communications,
-and decision making process have stabilized in a manner consistent with
-other successful ASF projects. While incubation status is not necessarily
-a reflection of the completeness or stability of the code, it does
-indicate that the project has yet to be fully endorsed by the ASF.
-
+
+ Apache UIMA C++ (Unstructured Information Management
Architecture) v2.3.0
+
-------------------------------------------------------------------------
+
+Getting Started
+----------------
+
+Apache UIMA C++ can be used as a standalone framework, but it is primarily
intended to be integrated with the Apache UIMA Java framework. Interoperability
is enhanced if the uimacpp SDK package is installed directly under the top
level directory of the Apache UIMA Java framework.
+
+For information about the Apache UIMA C++ package go to index.html in the
uimacpp/docs directory. For more information about Apache UIMA, go to
http://uima.apache.org, or to the documentation in the Apache UIMA Java package.
+
+
+Supported Platforms
+--------------------
+
+Apache UIMA C++ has been tested with gcc v4.0 on Linux and MacOSX, and with
VC8 on Windows. Binary distributions are available for selected platforms.
+
+
+Environment Variables
+----------------------
+
+The following environmental variables are needed for UIMA C++ to function
properly.
+
+ * UIMACPP_HOME should point to the uimacpp directory of your unpacked
Apache UIMA C++
+ distribution. UIMACPP_HOME is used when compiling & linking UIMA C++
components.
+ * Append $UIMACPP_HOME/bin to your PATH to pick up the runAECpp test driver
+ and shared libraries (Windows)
+ * Append $UIMACPP_HOME/lib to your LD_LIBRARY_PATH (Linux) or
DYLD_LIBRARY_PATH (MacOSX)
+ so that the necessary shared libraries can be found.
+
+Also note that UIMA C++ annotators are built as shared libraries, so they must
be in a directory in the LD_LIBRARY_PATH, DYLD_LIBRARY_PATH or PATH (as
appropriate to your platform) as well. An example of this is given in the next
section.
+
+For better runtime integration between Java and C++, the Apache UIMA Java SDK
command line utilities and Eclipse run configurations automatically add
$UIMA_HOME/uimacpp/lib to LD_LIBRARY_PATH and DYLD_LIBRARY_PATH, and add
$UIMA_HOME/uimacpp/bin to PATH.
+
+
+Verifying Your Installation
+----------------------------
+
+The procedure here is to first test that Apache UIMA C++ is installed and
operating correctly. Then if desired, check if the code is interoperating
properly with Apache UIMA Java.
+
+Set up the environment as described above. Go to $UIMACPP_HOME/examples/src to
build the sample code and add the src directory to the appropriate path as
follows.
+
+On Linux:
+ * make -f DaveDetector.mak
+ * LD_LIBRARY_PATH=$LD_LIBRARY_PATH:`pwd`
+
+On Windows:
+ * devenv DaveDetector.vcproj /build release
+ * PATH=%PATH%;%CD%
+
+To test the sample code in the C++ environment, change back to the
$UIMACPP_HOME/examples directory and run:
+ * runAECpp descriptors/DaveDetector.xml data
+
+The console should show that a Dave was found in some of the files in the data
directory.
+
+To test interoperability with Java using the JNI, first verify that Apache
UIMA Java is working from the current shell, as described in that package, and
then use the runAE.sh utility (use runAE on Windows) from
$UIMACPP_HOME/examples:
+ * runAE.sh descriptors/DaveDetector.xml data
+
+For more information about the C++ sample code see
$UIMACPP_HOME/examples/readme.html.
+
+For more information about UIMA C++ $UIMACPP_HOME/RELEASE_NOTES.html.
+
+
+Disclaimer
+-----------
+
+
+
Modified: uima/uimacpp/trunk/README.4src
URL:
http://svn.apache.org/viewvc/uima/uimacpp/trunk/README.4src?rev=1221753&r1=1221752&r2=1221753&view=diff
==============================================================================
--- uima/uimacpp/trunk/README.4src (original)
+++ uima/uimacpp/trunk/README.4src Wed Dec 21 14:59:33 2011
@@ -50,7 +50,7 @@ To override the location for MSCV redist
Building, testing and packaging on Linux:
-----------------------------------------
Set up your environment as described above. The following instructions
-assume you have unpacked the source into $HOME/uimacpp-2.X.Y-incubating.
+assume you have unpacked the source into $HOME/uimacpp-2.X.Y.
1 Create the GNU automake scripts:
Note: This step is only done when building from an SVN extract;
@@ -65,6 +65,7 @@ assume you have unpacked the source into
./configure --with-jdk=$JAVA_HOME/include --with-apr=$APR_HOME
--with-icu=$ICU_HOME --with-xerces=$XERCES_HOME --with-activemq=$ACTIVEMQ_HOME
make
DESTDIR=`pwd` make install
+
3 Build and run the test suite:
From root of the SVN extract
make check
@@ -88,7 +89,7 @@ assume you have unpacked the source into
Building, testing and packaging on Windows:
-----------------------------
Set up your environment as described above. The following instructions
-assume you have unpacked the source into \uimacpp-2.X.Y-incubating.
+assume you have unpacked the source into \uimacpp-2.X.Y.
1 Build the UIMA C++ framework in both release and debug:
cd \uimacpp-2.X.Y\src
@@ -139,6 +140,10 @@ Download and build information for these
XERCES - http://xml.apache.org/xerces-c/
ACTIVEMQ - http://activemq.apache.org/cms/download.html
+ACTIVEMQ CPP library version 3.2 or higher is required.
+ACTIVEMQ CPP has a dependency on APR at version 1.3.8 or higher.
+
+
For UNIX users that cannot or do not want to install these at
system root, specify DESTDIR for the install step. For example,
after building APR, install using:
@@ -155,10 +160,3 @@ instructions in Makefile.win.
Disclaimer
-----------
-Apache UIMA is an effort undergoing incubation at The Apache Software
-Foundation (ASF). Incubation is required of all newly accepted projects
-until a further review indicates that the infrastructure, communications,
-and decision making process have stabilized in a manner consistent with
-other successful ASF projects. While incubation status is not necessarily
-a reflection of the completeness or stability of the code, it does
-indicate that the project has yet to be fully endorsed by the ASF.
Modified: uima/uimacpp/trunk/RELEASE_NOTES.html
URL:
http://svn.apache.org/viewvc/uima/uimacpp/trunk/RELEASE_NOTES.html?rev=1221753&r1=1221752&r2=1221753&view=diff
==============================================================================
--- uima/uimacpp/trunk/RELEASE_NOTES.html (original)
+++ uima/uimacpp/trunk/RELEASE_NOTES.html Wed Dec 21 14:59:33 2011
@@ -131,8 +131,8 @@ included along with associated documenta
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://incubator.apache.org/uima/get-involved.html";>
- http://incubator.apache.org/uima/get-involved.html</a>.
+<a href="http://uima.apache.org/get-involved.html";>
+ http://uima.apache.org/get-involved.html</a>.
</p>
<h2><a name="report.issues">4. How to Report Issues</a></h2>
Modified: uima/uimacpp/trunk/buildSrcTree.cmd
URL:
http://svn.apache.org/viewvc/uima/uimacpp/trunk/buildSrcTree.cmd?rev=1221753&r1=1221752&r2=1221753&view=diff
==============================================================================
--- uima/uimacpp/trunk/buildSrcTree.cmd (original)
+++ uima/uimacpp/trunk/buildSrcTree.cmd Wed Dec 21 14:59:33 2011
@@ -19,7 +19,7 @@ REM specific language governing permis
REM under the License.
REM For now, update version in line below
-set srcName=uimacpp-2.3.0-incubating
+set srcName=uimacpp-2.4.0
REM check args
if "%~1" == "" (
Modified: uima/uimacpp/trunk/buildSrcTree.sh
URL:
http://svn.apache.org/viewvc/uima/uimacpp/trunk/buildSrcTree.sh?rev=1221753&r1=1221752&r2=1221753&view=diff
==============================================================================
--- uima/uimacpp/trunk/buildSrcTree.sh (original)
+++ uima/uimacpp/trunk/buildSrcTree.sh Wed Dec 21 14:59:33 2011
@@ -18,7 +18,7 @@
# under the License.
# for now, change versionnumber in line below
-srcName=uimacpp-2.3.0-incubating
+srcName=uimacpp-2.4.0
if [ "$1" = 'TRACE' ]
then set -vx ;shift
Modified: uima/uimacpp/trunk/createRelease.txt
URL:
http://svn.apache.org/viewvc/uima/uimacpp/trunk/createRelease.txt?rev=1221753&r1=1221752&r2=1221753&view=diff
==============================================================================
--- uima/uimacpp/trunk/createRelease.txt (original)
+++ uima/uimacpp/trunk/createRelease.txt Wed Dec 21 14:59:33 2011
@@ -4,7 +4,7 @@ Instructions for creating a uimacpp rele
For a new release
1. create a branch for the new release, e.g.
- svn copy https://svn.apache.org/repos/asf/incubator/uima/uimacpp/trunk
https://svn.apache.org/repos/asf/incubator/uima/uimacpp/branches/uimacpp-2.3.0
-m"create branch for 2.3.0 release"
+ svn copy https://svn.apache.org/repos/asf/uima/uimacpp/trunk
https://svn.apache.org/repos/asf/uima/uimacpp/branches/uimacpp-2.4.0 -m"create
branch for 2.4.0 release"
2. if changes are needed, update branch
@@ -15,39 +15,43 @@ For a new release
For a new build on Linux
1. create new directory for release candidate and cd there
- mkdir uimacpp-2.3.0
- cd uimacpp-2.3.0
+ mkdir uimacpp-2.4.0
+ cd uimacpp-2.4.0
2. checkout source from current release branch
- svn co
https://svn.apache.org/repos/asf/incubator/uima/uimacpp/branches/uimacpp-2.3.0
+ svn co
https://svn.apache.org/repos/asf/uima/uimacpp/branches/uimacpp-2.4.0
-3. do prebuild and create source tree
- cd uimacpp-2.3.0/src
- make -f Makefile.prebuild
- cd ..
- ./buildSrcTree.sh ..
+3. Modify configure.ac
+ Update package version number specified in AC_INIT call.
+ Update the library number by modifying LT_VERSION_NUMBER following the
+ libtool version numbering convention. This is summarize on the
+ wiki page
https://cwiki.apache.org/UIMA/proposed-changes-to-uima-c-build-and-packaging.html.
+
+4 Create configure script
+ cd uimacpp-2.4.0
+ ./autogen.sh
+
+5. Run configure
+ define environment variable ICU_HOME, APR_HOME, XERCES_HOME, ACTIVEMQ_HOME,
JAVA_INCLUDE
+ ./configure --with-jdk=$JAVA_HOME/include --with-apr=$APR_HOME
--with-icu=$ICU_HOME --with-xerces=$XERCES_HOME --with-activemq=$ACTIVEMQ_HOME
4. create src tarball
- cd ..
- tar -czf uimacpp-2.3.0-incubating-src.tgz uimacpp-2.3.0-incubating
+ make dist
+ This create libuima-2.4.0.tar.gz
5. rat scan of source
- java -jar apache-rat-0.6.jar uimacpp-2.3.0-incubating >
uimacpp-src-linux-report.txt
+ java -jar apache-rat-0.6.jar uimacpp-2.4.0 >
uimacpp-src-linux-report.txt
6. build, test and create sdk tree
- cd uimacpp-2.3.0-incubating/src
+ cd uimacpp-2.4.0
[setup env for the build]
- make -f Makefile.unix install
- cd ../docs
- ./builddocs.sh
- cd ../src/test
- UIMA_HOME=someGoodUimaSDK ./fvt.sh
- cd ../..
- ./buildsdk.sh ..
+ make
+ DESTDIR=`pwd` make install
+ make check
+ make sdk ARGS=`pwd`
7. create bin tarball
- cd ..
- tar -czf uimacpp-2.3.0-incubating-bin.tgz uimacpp
+ tar -czf uimacpp-2.4.0-bin.tgz uimacpp
8. rat scan of bin
java -jar apache-rat-0.6.jar uimacpp > uimacpp-bin-linux-report.txt
@@ -71,7 +75,7 @@ For a new build on Linux
cd ../python
make
- LD_LIBRARY_PATH=$LD_LIBRARY_PATH:`pwd`
+ LD_LIBRARY_PATH=$LD_LIBRARY_PATH:`pwd`h
export PYTHONPATH=`pwd`
runAECpp PythonSample.xml ../../examples/data/
@@ -93,20 +97,20 @@ For a new build on Linux
For a new build on Windows
1. checkout source from current release branch
- svn co
https://svn.apache.org/repos/asf/incubator/uima/uimacpp/branches/uimacpp-2.3.0
+ svn co
https://svn.apache.org/repos/asf/uima/uimacpp/branches/uimacpp-2.4.0
3. create source tree
./buildSrcTree buildDir
-4. create src zipfile of buildDir\uimacpp-2.3.0-incubating as
- uimacpp-2.3.0-incubating-src.zip
+4. create src zipfile of buildDir\uimacpp-2.4.0 as
+ uimacpp-2.4.0-src.zip
5. rat scan of source
cd buildDir
- java -jar apache-rat-0.6.jar uimacpp-2.3.0-incubating >
uimacpp-src-windows-report.txt
+ java -jar apache-rat-0.6.jar uimacpp-2.4.0 >
uimacpp-src-windows-report.txt
6. build, test and create sdk tree
- cd uimacpp-2.3.0-incubating\src
+ cd uimacpp-2.4.0\src
[setup env for the build]
winmake /build release
winmake /build debug
@@ -122,7 +126,7 @@ For a new build on Windows
buildsdk ..
7. create bin zipfile of buildDir\uimacpp as
- uimacpp-2.3.0-incubating-bin.zip
+ uimacpp-2.4.0-bin.zip
8. rat scan of bin
java -jar apache-rat-0.6.jar uimacpp > uimacpp-bin-windows-report.txt
Modified: uima/uimacpp/trunk/docs/overview_and_setup.html
URL:
http://svn.apache.org/viewvc/uima/uimacpp/trunk/docs/overview_and_setup.html?rev=1221753&r1=1221752&r2=1221753&view=diff
==============================================================================
--- uima/uimacpp/trunk/docs/overview_and_setup.html (original)
+++ uima/uimacpp/trunk/docs/overview_and_setup.html Wed Dec 21 14:59:33 2011
@@ -24,12 +24,8 @@
<title>Apache C++ Overview and Setup</title>
<link rel="stylesheet" href="css/stylesheet.css" type="text/css">
</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084"
alink="#0000FF"><div class="book" lang="en" id="d0e2"><div
class="titlepage"><div><div><h1 class="title"><a name="d0e2"></a>Apache UIMA
C++ Overview and Setup</h1></div><div><div class="authorgroup"><h3
class="corpauthor">Authors: The Apache UIMA Development
Community</h3></div></div><div><p class="releaseinfo">Version
2.3.0</p></div><div><p class="copyright">Copyright © 2006, 2007 The Apache
Software Foundation</p></div><div><p class="copyright">Copyright © 2004,
2006 International Business Machines Corporation</p></div><div><div
class="legalnotice"><a name="d0e15"></a><p> </p><p><b>Incubation Notice and
Disclaimer. </b>Apache UIMA is an effort undergoing incubation at the
Apache Software Foundation (ASF).
- Incubation is required of all newly accepted projects until a
further review indicates that
- the infrastructure, communications, and decision making process have
stabilized in a manner
- consistent with other successful ASF projects. While incubation
status is not necessarily
- a reflection of the completeness or stability of the code,
- it does indicate that the project has yet to be fully endorsed by
the ASF.</p><p> </p><p> </p><p><b>License and Disclaimer. </b>The ASF
licenses this documentation
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084"
alink="#0000FF"><div class="book" lang="en" id="d0e2"><div
class="titlepage"><div><div><h1 class="title"><a name="d0e2"></a>Apache UIMA
C++ Overview and Setup</h1></div><div><div class="authorgroup"><h3
class="corpauthor">Authors: The Apache UIMA Development
Community</h3></div></div><div><p class="releaseinfo">Version
2.3.0</p></div><div><p class="copyright">Copyright © 2006, 2007 The Apache
Software Foundation</p></div><div><p class="copyright">Copyright © 2004,
2006 International Business Machines Corporation</p></div><div><div
class="legalnotice"><a name="d0e15"></a><p> </p>
+<p> </p><p> </p><p><b>License and Disclaimer. </b>The ASF licenses this
documentation
to you under the Apache License, Version 2.0 (the
"License"); you may not use this documentation except in compliance
with the License. You may obtain a copy of the License at
Modified: uima/uimacpp/trunk/examples/descriptors/XCasWriterCasConsumer.xml
URL:
http://svn.apache.org/viewvc/uima/uimacpp/trunk/examples/descriptors/XCasWriterCasConsumer.xml?rev=1221753&r1=1221752&r2=1221753&view=diff
==============================================================================
--- uima/uimacpp/trunk/examples/descriptors/XCasWriterCasConsumer.xml (original)
+++ uima/uimacpp/trunk/examples/descriptors/XCasWriterCasConsumer.xml Wed Dec
21 14:59:33 2011
@@ -1,98 +1,98 @@
-<?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.
- ***************************************************************
- -->
-
-<!-- A simple CAS consumer that writes an inline XML representation of the CAS
to the filesystem. -->
-
-<casConsumerDescription xmlns="http://uima.apache.org/resourceSpecifier";
xmlns:xi="http://www.w3.org/2001/XInclude";>
-
- <frameworkImplementation>org.apache.uima.cpp</frameworkImplementation>
- <implementationName>XCasWriterCasConsumer</implementationName>
-
- <processingResourceMetaData>
-
- <name>XCAS Writer CAS Consumer</name>
- <description>Writes the CAS to a stand-off XML format
(XCAS)</description>
- <version>1.0</version>
- <vendor>IBM</vendor>
-
- <configurationParameters>
- <configurationParameter>
- <name>OutputDirectory</name>
- <description>The directory where xcas files are
to be created. The directory will be created if it does not
exist.</description>
- <type>String</type>
- <multiValued>false</multiValued>
- <mandatory>false</mandatory>
- </configurationParameter>
- </configurationParameters>
-
-
- <!--
- <configurationParameterSettings>
- <nameValuePair>
- <name>OutputDirectory</name>
- <value>
- <string>xcasOutputDirectory</string>
- </value>
- </nameValuePair>
- </configurationParameterSettings>
- -->
-
-
- <typeSystemDescription>
- <types>
- <typeDescription>
-
<name>org.apache.uima.examples.SourceDocumentInformation</name>
- <description>Stores detailed information about the
original source document from which the current CAS was initialized. All
information (like size) refers to the source document and not to the document
in the CAS which may be converted and filtered by a CAS Initializer. For
example this information will be written to the Semantic Search index so that
the original document contents can be retrieved by queries.</description>
- <supertypeName>uima.tcas.Annotation</supertypeName>
- <features>
- <featureDescription>
- <name>uri</name>
- <description>URI of document. (For
example, file:///MyDirectory/myFile.txt for a simple file or
http://incubator.apache.org/uima/index.html for content from a web
source.)</description>
-
<rangeTypeName>uima.cas.String</rangeTypeName>
- </featureDescription>
- <featureDescription>
- <name>offsetInSource</name>
- <description>Byte offset of the start
of document content within original source file or other input source. Only
used if the CAS document was retrieved from an source where one physical source
file contained several conceptual documents. Zero otherwise.</description>
-
<rangeTypeName>uima.cas.Integer</rangeTypeName>
- </featureDescription>
- <featureDescription>
- <name>documentSize</name>
- <description>Size of original document
in bytes before processing by CAS Initializer. Either absolute file size of
size within file or other source.</description>
-
<rangeTypeName>uima.cas.Integer</rangeTypeName>
- </featureDescription>
- </features>
- </typeDescription>
- </types>
- </typeSystemDescription>
-
- <capabilities>
- <capability>
- <inputs>
- <type
allAnnotatorFeatures="true">org.apache.uima.examples.SourceDocumentInformation</type>
- </inputs>
- </capability>
- </capabilities>
-
- </processingResourceMetaData>
-
-</casConsumerDescription>
+<?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.
+ ***************************************************************
+ -->
+
+<!-- A simple CAS consumer that writes an inline XML representation of the CAS
to the filesystem. -->
+
+<casConsumerDescription xmlns="http://uima.apache.org/resourceSpecifier";
xmlns:xi="http://www.w3.org/2001/XInclude";>
+
+ <frameworkImplementation>org.apache.uima.cpp</frameworkImplementation>
+ <implementationName>XCasWriterCasConsumer</implementationName>
+
+ <processingResourceMetaData>
+
+ <name>XCAS Writer CAS Consumer</name>
+ <description>Writes the CAS to a stand-off XML format
(XCAS)</description>
+ <version>1.0</version>
+ <vendor>IBM</vendor>
+
+ <configurationParameters>
+ <configurationParameter>
+ <name>OutputDirectory</name>
+ <description>The directory where xcas files are
to be created. The directory will be created if it does not
exist.</description>
+ <type>String</type>
+ <multiValued>false</multiValued>
+ <mandatory>false</mandatory>
+ </configurationParameter>
+ </configurationParameters>
+
+
+ <!--
+ <configurationParameterSettings>
+ <nameValuePair>
+ <name>OutputDirectory</name>
+ <value>
+ <string>xcasOutputDirectory</string>
+ </value>
+ </nameValuePair>
+ </configurationParameterSettings>
+ -->
+
+
+ <typeSystemDescription>
+ <types>
+ <typeDescription>
+
<name>org.apache.uima.examples.SourceDocumentInformation</name>
+ <description>Stores detailed information about the
original source document from which the current CAS was initialized. All
information (like size) refers to the source document and not to the document
in the CAS which may be converted and filtered by a CAS Initializer. For
example this information will be written to the Semantic Search index so that
the original document contents can be retrieved by queries.</description>
+ <supertypeName>uima.tcas.Annotation</supertypeName>
+ <features>
+ <featureDescription>
+ <name>uri</name>
+ <description>URI of document. (For
example, file:///MyDirectory/myFile.txt for a simple file or
http://uima.apache.org for content from a web source.)</description>
+
<rangeTypeName>uima.cas.String</rangeTypeName>
+ </featureDescription>
+ <featureDescription>
+ <name>offsetInSource</name>
+ <description>Byte offset of the start
of document content within original source file or other input source. Only
used if the CAS document was retrieved from an source where one physical source
file contained several conceptual documents. Zero otherwise.</description>
+
<rangeTypeName>uima.cas.Integer</rangeTypeName>
+ </featureDescription>
+ <featureDescription>
+ <name>documentSize</name>
+ <description>Size of original document
in bytes before processing by CAS Initializer. Either absolute file size of
size within file or other source.</description>
+
<rangeTypeName>uima.cas.Integer</rangeTypeName>
+ </featureDescription>
+ </features>
+ </typeDescription>
+ </types>
+ </typeSystemDescription>
+
+ <capabilities>
+ <capability>
+ <inputs>
+ <type
allAnnotatorFeatures="true">org.apache.uima.examples.SourceDocumentInformation</type>
+ </inputs>
+ </capability>
+ </capabilities>
+
+ </processingResourceMetaData>
+
+</casConsumerDescription>
