Author: cwiklik
Date: Tue Dec 13 19:06:03 2011
New Revision: 1213871
URL: http://svn.apache.org/viewvc?rev=1213871&view=rev
Log:
UIMA-2180 Documented new API sendAndReceiveCAS(CAS, aCAS,
List<AnalysisEnginePerformanceMetrics> componentMetricsList)
Modified:
uima/uima-as/trunk/uima-as-docbooks/src/docbook/ref.async.api.xml
Modified: uima/uima-as/trunk/uima-as-docbooks/src/docbook/ref.async.api.xml
URL:
http://svn.apache.org/viewvc/uima/uima-as/trunk/uima-as-docbooks/src/docbook/ref.async.api.xml?rev=1213871&r1=1213870&r2=1213871&view=diff
==============================================================================
--- uima/uima-as/trunk/uima-as-docbooks/src/docbook/ref.async.api.xml (original)
+++ uima/uima-as/trunk/uima-as-docbooks/src/docbook/ref.async.api.xml Tue Dec
13 19:06:03 2011
@@ -164,6 +164,16 @@ under the License.
</listitem>
<listitem>
+ <para><code>void sendAndReceiveCAS(CAS aCAS,
List<AnalysisEnginePerformanceMetrics> componentMetricsList)</code>:
+ Send a CAS, wait for response. On success aCAS contains the
analysis results and componentMetricsList
+ contains per Analysis Engine performance breakdown. This breakdown
shows how much time each Analysis Engine
+ took to analyze the CAS. The method throws an exception on error.
Note that this interface cannot be used
+ to interface to a CAS Multiplier service, because it will block
until the parent comes back, and any child
+ CASes will be ignored.
+ </para>
+ </listitem>
+
+ <listitem>
<para><code>String aHandle deploy( String aDeploymentDescriptor, Map
anApplicationContext)</code>:
Deploys the UIMA-AS
service specified by the given deployment descriptor in this JVM,
and returns a handle
