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 2008/11/24 23:50:36 UTC
svn commit: r720321 - in
/incubator/uima/uimaj/trunk/uima-docbooks/src/docbook:
references/ref.pear.xml tools/tools.pear.installer.xml
Author: schor
Date: Mon Nov 24 14:50:36 2008
New Revision: 720321
URL: http://svn.apache.org/viewvc?rev=720321&view=rev
Log:
[UIMA-1221 UIMA-1222] update docs to say how to launch the PEAR installer, and how to understand PEAR environment variable use.
Modified:
incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/references/ref.pear.xml
incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tools/tools.pear.installer.xml
Modified: incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/references/ref.pear.xml
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/references/ref.pear.xml?rev=720321&r1=720320&r2=720321&view=diff
==============================================================================
--- incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/references/ref.pear.xml (original)
+++ incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/references/ref.pear.xml Mon Nov 24 14:50:36 2008
@@ -28,8 +28,7 @@
<para>
A PEAR (Processing Engine ARchive) file is a standard package
- for UIMA (Unstructured Information Management Architecture)
- components. This chapter describes the PEAR 1.0 structure and
+ for UIMA components. This chapter describes the PEAR 1.0 structure and
specification.
</para>
@@ -48,6 +47,22 @@
targetptr="ugr.tools.pear.packager" />
for more information about these tools.
</para>
+
+ <para>
+ PEARs distributed to new targets can be installed at those targets.
+ UIMA includes a tool for installing PEARs; see
+ <olink targetdoc="&uima_docs_tools;"
+ targetptr="ugr.tools.pear.installer"/> for
+ more information about installing PEARs.
+ </para>
+
+ <para>
+ An installed PEAR can be used as a component within a UIMA pipeline,
+ by specifying the pear descriptor that is created when
+ installing the pear. See
+ <olink targetdoc="&uima_docs_ref;"
+ targetptr="ugr.ref.pear.specifier"/>.
+ </para>
<section id="ugr.ref.pear.packaging_a_component">
<title>Packaging a UIMA component</title>
@@ -923,7 +938,17 @@
variables, system PATH settings or Java library path settings cannot be recognized
automatically and must be set manually when the JVM is started.
</para>
- <para>
+
+ <note><para>The PEAR may contain specifications for "environment variables" and their settings.
+ When such a PEAR is run
+ directly in the UIMA framework, those settings (except for Classpath and Data Path) are converted
+ to Java System properties, and set to the specified values. Java cannot set true environmental variables;
+ if such a setting is needed, the application would need to arrange to do this prior to invoking Java.</para>
+
+ <para>The Classpath and Data Path settings are used by UIMA to configure a special Resource Manager
+ that is used when code from this PEAR is being run.</para></note>
+
+ <para>
The generated PEAR descriptor
is located in the component root directory of the installed PEAR package and has a filename like
<componentID>_pear.xml.
@@ -940,14 +965,14 @@
of the installed PEAR package.
</para>
<note>
- <para>
+ <!--para> should now be possible (11/2008)
When a PEAR descriptor is used within an aggregate AE as primitive AE, it is not possible to
override the PEAR AE configuration parameter settings with the aggregate AE descriptor.
- </para>
+ </para-->
<para>
- Furthermore it is also not possible to share resources between PEAR AE that are instantiated using the PEAR
- descriptor. The PEAR runtime that is used in case of a PEAR descriptor creates an own internal ResourceManager for each
- PEAR engine that is start up.
+ It is not possible to share resources between PEAR Analysis Engines that are instantiated using the PEAR
+ descriptor. The PEAR runtime created for each PEAR descriptor has its own specific ResourceManager
+ (unless exactly the same Classpath and Data Path are being used).
</para>
</note>
</section>
Modified: incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tools/tools.pear.installer.xml
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tools/tools.pear.installer.xml?rev=720321&r1=720320&r2=720321&view=diff
==============================================================================
--- incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tools/tools.pear.installer.xml (original)
+++ incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tools/tools.pear.installer.xml Mon Nov 24 14:50:36 2008
@@ -52,6 +52,9 @@
</mediaobject>
</screenshot></para>
+ <para>To launch the PEAR Installer, use the script in the UIMA bin directory:
+ <code>runPearInstaller.bat</code> or <code>runPearInstaller.sh.</code></para>
+
<para>PEAR Installer is a simple GUI based Java application that helps installing UIMA
compliant components (analysis engines) from PEAR packages in a local file system. To
install a desired UIMA component the user needs to select the appropriate PEAR file in a
@@ -86,6 +89,22 @@
file named <literal><componentID>_pear.xml</literal>
in the <literal><component_root></literal> directory that can be used to directly run
the installed pear file in your application.
- </para>
+ </para>
+
+ <para>
+ The metadata/setenv.txt is not read by the UIMA framework anywhere.
+ It's there for use by non-UIMA application code if that code wants to set environment variables.
+ The metadata/setenv.txt is just a "convenience" file duplicating what's in the xml.
+ </para>
+
+ <para>
+ The setenv.txt file has 2 special variables: the CLASSPATH and the PATH.
+ The CLASSPATH is computed from any supplied CLASSPATH environment variable,
+ plus the jars that are configured in the PEAR structure, including subcomponents.
+ The PATH is similarly computed, using any supplied PATH environment variable plus
+ it includes the "bin" subdirectory of the PEAR structure, if it exists.
+ </para>
+
+
</chapter>
\ No newline at end of file