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/08/29 18:58:40 UTC
svn commit: r1758290 - in /uima/uimaj/branches/experiment-v3-jcas:
uima-docbook-references/ uima-docbook-references/src/docbook/
uima-docbook-tutorials-and-users-guides/
uima-docbook-tutorials-and-users-guides/src/docbook/
Author: schor
Date: Mon Aug 29 18:58:39 2016
New Revision: 1758290
URL: http://svn.apache.org/viewvc?rev=1758290&view=rev
Log:
[UIMA-5043] merge catchup for documentation
Modified:
uima/uimaj/branches/experiment-v3-jcas/uima-docbook-references/ (props changed)
uima/uimaj/branches/experiment-v3-jcas/uima-docbook-references/src/docbook/ref.xml.component_descriptor.xml
uima/uimaj/branches/experiment-v3-jcas/uima-docbook-tutorials-and-users-guides/ (props changed)
uima/uimaj/branches/experiment-v3-jcas/uima-docbook-tutorials-and-users-guides/src/docbook/ (props changed)
uima/uimaj/branches/experiment-v3-jcas/uima-docbook-tutorials-and-users-guides/src/docbook/annotator_analysis_engine_guide.xml
Propchange: uima/uimaj/branches/experiment-v3-jcas/uima-docbook-references/
------------------------------------------------------------------------------
--- svn:mergeinfo (original)
+++ svn:mergeinfo Mon Aug 29 18:58:39 2016
@@ -1,4 +1,4 @@
/uima/uimaj/branches/depend-on-july-9-build-tools/uima-docbook-references:963167-964468
/uima/uimaj/branches/depend-on-parent-pom-4/uima-docbook-references:961329-961745
/uima/uimaj/branches/filteredCompress-uima-2498/uima-docbook-references:1436573-1462257
-/uima/uimaj/trunk/uima-docbook-references:1690273-1693269
+/uima/uimaj/trunk/uima-docbook-references:1690273-1693269,1757296-1757568
Modified: uima/uimaj/branches/experiment-v3-jcas/uima-docbook-references/src/docbook/ref.xml.component_descriptor.xml
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/experiment-v3-jcas/uima-docbook-references/src/docbook/ref.xml.component_descriptor.xml?rev=1758290&r1=1758289&r2=1758290&view=diff
==============================================================================
--- uima/uimaj/branches/experiment-v3-jcas/uima-docbook-references/src/docbook/ref.xml.component_descriptor.xml (original)
+++ uima/uimaj/branches/experiment-v3-jcas/uima-docbook-references/src/docbook/ref.xml.component_descriptor.xml Mon Aug 29 18:58:39 2016
@@ -1909,7 +1909,7 @@ uima.tcas.Annotation.</programlisting>
<para>
External parameter overrides are usually declared in primitive descriptors as a way to
easily modify the parameters in some or all of an application's annotators.
- By using external settings files and global parameter names the configuration
+ By using external settings files and shared parameter names the configuration
information can be specified without regard for a particular descriptor hierachy.
</para>
@@ -1955,7 +1955,7 @@ uima.tcas.Annotation.</programlisting>
<literal>produceAnalysisEngine</literal> method. In this case the
Java system property <emphasis>UimaExternalOverrides</emphasis> is ignored.
<programlisting> // Construct an analysis engine that uses two settings files
- Settings extSettings = new Settings_impl();
+ Settings extSettings = UIMAFramework.getResourceSpecifierFactory().createSettings();
for (String fname : new String[] { "externalOverride.settings",
"default.settings" }) {
FileInputStream fis = new FileInputStream(fname);
@@ -2040,6 +2040,34 @@ key9 : [ array element1\, with embedde
</para>
</section>
+ <section id="&tp;aes.external_configuration_parameter_access">
+ <title>Direct Access to External Configuration Parameters</title>
+
+ <para>
+ Annotators and flow controllers can directly access these shared configuration
+ parameters from their UimaContext.
+ Direct access means an access where the key to select the shared parameter is the
+ parameter name as specified in the external configuration settings file.
+ <programlisting>
+String value = aContext.getSharedSettingValue(paramName);
+String values[] = aContext.getSharedSettingArray(arrayParamName);
+String allNames[] = aContext.getSharedSettingNames();
+ </programlisting>
+ Java code called by an annotator or flow controller in the same thread or a child thread
+ can use the <literal>UimaContextHolder</literal> to get the annotator's UimaContext and
+ hence access the shared configuration parameters.
+ <programlisting>
+UimaContext uimaContext = UimaContextHolder.getUimaContext();
+if (uimaContext != null) {
+ value = uimaContext.getSharedSettingValue(paramName);
+}
+ </programlisting>
+ The UIMA framework puts the context in an InheritableThreadLocal variable. The value
+ will be null if <literal>getUimaContext</literal> is not invoked by an annotator or flow
+ controller on the same thread or a child thread.
+ </para>
+ </section>
+
</section>
</section>
Propchange: uima/uimaj/branches/experiment-v3-jcas/uima-docbook-tutorials-and-users-guides/
------------------------------------------------------------------------------
--- svn:mergeinfo (original)
+++ svn:mergeinfo Mon Aug 29 18:58:39 2016
@@ -1,4 +1,4 @@
/uima/uimaj/branches/depend-on-july-9-build-tools/uima-docbook-tutorials-and-users-guides:963167-964468
/uima/uimaj/branches/depend-on-parent-pom-4/uima-docbook-tutorials-and-users-guides:961329-961745
/uima/uimaj/branches/filteredCompress-uima-2498/uima-docbook-tutorials-and-users-guides:1436573-1462257
-/uima/uimaj/trunk/uima-docbook-tutorials-and-users-guides:1690273-1693269,1744753-1744754
+/uima/uimaj/trunk/uima-docbook-tutorials-and-users-guides:1690273-1693269,1744753-1744754,1757296-1757568
Propchange: uima/uimaj/branches/experiment-v3-jcas/uima-docbook-tutorials-and-users-guides/src/docbook/
------------------------------------------------------------------------------
--- svn:mergeinfo (original)
+++ svn:mergeinfo Mon Aug 29 18:58:39 2016
@@ -1,4 +1,4 @@
/uima/uimaj/branches/depend-on-july-9-build-tools/uima-docbook-tutorials-and-users-guides/src/docbook:963167-964468
/uima/uimaj/branches/depend-on-parent-pom-4/uima-docbook-tutorials-and-users-guides/src/docbook:961329-961745
/uima/uimaj/branches/filteredCompress-uima-2498/uima-docbook-tutorials-and-users-guides/src/docbook:1436573-1462257
-/uima/uimaj/trunk/uima-docbook-tutorials-and-users-guides/src/docbook:1690273-1757433
+/uima/uimaj/trunk/uima-docbook-tutorials-and-users-guides/src/docbook:1690273-1757568
Modified: uima/uimaj/branches/experiment-v3-jcas/uima-docbook-tutorials-and-users-guides/src/docbook/annotator_analysis_engine_guide.xml
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/experiment-v3-jcas/uima-docbook-tutorials-and-users-guides/src/docbook/annotator_analysis_engine_guide.xml?rev=1758290&r1=1758289&r2=1758290&view=diff
==============================================================================
--- uima/uimaj/branches/experiment-v3-jcas/uima-docbook-tutorials-and-users-guides/src/docbook/annotator_analysis_engine_guide.xml (original)
+++ uima/uimaj/branches/experiment-v3-jcas/uima-docbook-tutorials-and-users-guides/src/docbook/annotator_analysis_engine_guide.xml Mon Aug 29 18:58:39 2016
@@ -915,12 +915,12 @@ public void initialize(UimaContext aCont
names in an external properties file. With this approach a particular parameter setting can
be easily shared by multiple descriptors, even across different applications. For applications
with many levels of descriptor nesting it avoids the need to edit aggregate override
- definitions when the location of an annotator in the hierarchy is changed.</para>
+ definitions when the location of an annotator in the hierarchy is changed.
- <para>For details see
+ For details see
<olink targetdoc="&uima_docs_ref;"/>
<olink targetdoc="&uima_docs_ref;"
- targetptr="ugr.ref.xml.component_descriptor.aes.aggregate.configuration_parameter_overrides"/>
+ targetptr="ugr.ref.xml.component_descriptor.aes.external_configuration_parameter_overrides"/>
</para>
</section>
</section>