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 2010/05/17 17:02:09 UTC
svn commit: r945195 - in
/uima/uima-as/trunk/uimaj-as-core/src/main/java/org/apache/uima/aae:
client/UimaAsynchronousEngine.java error/ErrorResult.java
jmx/monitor/JmxMonitorListener.java
jmx/monitor/SingleLineUimaJmxMonitorListener.java
Author: schor
Date: Mon May 17 15:02:09 2010
New Revision: 945195
URL: http://svn.apache.org/viewvc?rev=945195&view=rev
Log:
[UIMA-1756] clean up javadoc warnings
Modified:
uima/uima-as/trunk/uimaj-as-core/src/main/java/org/apache/uima/aae/client/UimaAsynchronousEngine.java
uima/uima-as/trunk/uimaj-as-core/src/main/java/org/apache/uima/aae/error/ErrorResult.java
uima/uima-as/trunk/uimaj-as-core/src/main/java/org/apache/uima/aae/jmx/monitor/JmxMonitorListener.java
uima/uima-as/trunk/uimaj-as-core/src/main/java/org/apache/uima/aae/jmx/monitor/SingleLineUimaJmxMonitorListener.java
Modified: uima/uima-as/trunk/uimaj-as-core/src/main/java/org/apache/uima/aae/client/UimaAsynchronousEngine.java
URL: http://svn.apache.org/viewvc/uima/uima-as/trunk/uimaj-as-core/src/main/java/org/apache/uima/aae/client/UimaAsynchronousEngine.java?rev=945195&r1=945194&r2=945195&view=diff
==============================================================================
--- uima/uima-as/trunk/uimaj-as-core/src/main/java/org/apache/uima/aae/client/UimaAsynchronousEngine.java (original)
+++ uima/uima-as/trunk/uimaj-as-core/src/main/java/org/apache/uima/aae/client/UimaAsynchronousEngine.java Mon May 17 15:02:09 2010
@@ -33,11 +33,11 @@ import org.apache.uima.resource.metadata
* UIMA AS service. It provides a high level API and hides the detail of the transport
* implementation. The UIMA AS Client implementation uses JMS as its transport mechanism. Both
* synchronous and asynchronous processing is supported. For synchronous processing an application
- * should call {@link #sendAndReceive(CAS)} method. For asynchronous processing the application
+ * should call {@link #sendAndReceiveCAS(CAS)} method. For asynchronous processing the application
* should call {@link #sendCAS(CAS)} method. Additionally, processing with a client side
* <code>CollectionReader</code> is supported as well. The application first instantiates and
* initializes the <code>CollectionReader</code> and registers it via
- * {@link #setCollectionReader(CollectionReads)} method. Once the <code>CollectionReader</code> is
+ * {@link #setCollectionReader(CollectionReader)} method. Once the <code>CollectionReader</code> is
* registered, and {@link #initialize(Map)} method is called, the application may call
* {@link #process()} method.
*
@@ -56,13 +56,13 @@ import org.apache.uima.resource.metadata
*
* <p>
* Listeners can register with the <code>UimaAsynchronousEngine</code> by calling the
- * {@link #addStatusCallbackListener(UimaASStatusCallbackListener)} method. These listeners receive
+ * {@link #addStatusCallbackListener(UimaAsBaseCallbackListener)} method. These listeners receive
* status callbacks during the processing. An exception to that is the synchronous processing via
- * {@link #sendAndReceive(CAS)} method. This method returns either a CAS containing results of
+ * {@link #sendAndReceiveCAS(CAS)} method. This method returns either a CAS containing results of
* analysis or an exception. No callbacks are made while processing CASes synchronously.
* <p>
* An application may choose to implement parallelization of the processing, calling either
- * {@link #sendAndReceive(CAS)} or {@link #sendCASCAS)} methods from multiple threads.
+ * {@link #sendAndReceiveCAS(CAS)} or {@link #sendCAS(CAS)} methods from multiple threads.
* <p>
*
*
@@ -104,7 +104,8 @@ public interface UimaAsynchronousEngine
* A temporary reply queue is also created with a JMS listener attached to it. Once the
* connections are made and the listener is started the method sends getMeta request to the UIMA
* AS service and waits for a response. When the reply to getMeta is received the UIMA AS client
- * is fully initialized and notifies an application by calling {@link #initializationComplete()}
+ * is fully initialized and notifies an application by calling
+ * {@link org.apache.uima.aae.client.UimaASStatusCallbackListener#initializationComplete(EntityProcessStatus)}
* on the application listener.
*
* @param anApplicationContext
@@ -163,15 +164,15 @@ public interface UimaAsynchronousEngine
/**
* Initiates processing of a collection. This method should be only called after initialize() has
* been called and an instance of a <code>CollectionReader</code> is provided via
- * {@link #setCollectionReader()}. This method blocks until the <code>CollectionReader</code>
+ * {@link #setCollectionReader(CollectionReader)}. This method blocks until the <code>CollectionReader</code>
* finishes processing the entire collection. Status of the processing can be obtained by
* registering a listener with the
- * {@link #addStatusCallbackListener(UimaASStatusCallbackListener)} method.
+ * {@link #addStatusCallbackListener(UimaAsBaseCallbackListener)} method.
* <p>
* The method is synchronized to allow processing of only one collection at a time. The
* application must wait with processing another collection until it receives notification via a
* listener
- * {@link #org.apache.uima.aae.clientcollectionProcessComplete(EntityProcessStatus aStatus)}
+ * {@link UimaASStatusCallbackListener#collectionProcessComplete(EntityProcessStatus aStatus)}
*
* @throws ResourceProcessException
* - if there is a problem processing the Collection
@@ -261,8 +262,8 @@ public interface UimaAsynchronousEngine
* If there is a problem deploying any of the UIMA AS services the container is destroyed and
* exception thrown.
*
- * @param aDeploymentDescriptor
- * - a deployment descriptor to deploy in a container.
+ * @param aDeploymentDescriptorList
+ * - a list of deployment descriptors to deploy in a container.
* @param anApplicationContext
* - initialization parameters needed to configure the client and services
*
Modified: uima/uima-as/trunk/uimaj-as-core/src/main/java/org/apache/uima/aae/error/ErrorResult.java
URL: http://svn.apache.org/viewvc/uima/uima-as/trunk/uimaj-as-core/src/main/java/org/apache/uima/aae/error/ErrorResult.java?rev=945195&r1=945194&r2=945195&view=diff
==============================================================================
--- uima/uima-as/trunk/uimaj-as-core/src/main/java/org/apache/uima/aae/error/ErrorResult.java (original)
+++ uima/uima-as/trunk/uimaj-as-core/src/main/java/org/apache/uima/aae/error/ErrorResult.java Mon May 17 15:02:09 2010
@@ -44,28 +44,28 @@ public interface ErrorResult extends Ser
/**
* Returns a path consisting of a list of component key names
*
- * @return
+ * @return a path consisting of a list of component key names
*/
public ErrorResultComponentPath getComponentKeyPath();
/**
* Returns true is any termination occurred with this error
*
- * @return
+ * @return true is any termination occurred with this error
*/
public boolean wasTerminated();
/**
* Returns true if any disabling occured with this error
*
- * @return
+ * @return true if any disabling occured with this error
*/
public boolean wasDisabled();
/**
* Returns a collection of paths to the components that were terminated or disabled
*
- * @return
+ * @return a collection of paths to the components that were terminated or disabled
*/
public ErrorResultTDs getTDs();
Modified: uima/uima-as/trunk/uimaj-as-core/src/main/java/org/apache/uima/aae/jmx/monitor/JmxMonitorListener.java
URL: http://svn.apache.org/viewvc/uima/uima-as/trunk/uimaj-as-core/src/main/java/org/apache/uima/aae/jmx/monitor/JmxMonitorListener.java?rev=945195&r1=945194&r2=945195&view=diff
==============================================================================
--- uima/uima-as/trunk/uimaj-as-core/src/main/java/org/apache/uima/aae/jmx/monitor/JmxMonitorListener.java (original)
+++ uima/uima-as/trunk/uimaj-as-core/src/main/java/org/apache/uima/aae/jmx/monitor/JmxMonitorListener.java Mon May 17 15:02:09 2010
@@ -23,7 +23,7 @@ import org.apache.uima.aae.jmx.monitor.S
public interface JmxMonitorListener {
/**
* Provides metrics for all UIMA AS services collected during a checkpoint. This method is called
- * by the {@link JmxMonitor} after each checkpoint with the latest metrics. The metrics are deltas
+ * by the {@link org.apache.uima.aae.jmx.monitor.JmxMonitor} after each checkpoint with the latest metrics. The metrics are deltas
* except for queue depth attribute.
*
* @param sampleTime
Modified: uima/uima-as/trunk/uimaj-as-core/src/main/java/org/apache/uima/aae/jmx/monitor/SingleLineUimaJmxMonitorListener.java
URL: http://svn.apache.org/viewvc/uima/uima-as/trunk/uimaj-as-core/src/main/java/org/apache/uima/aae/jmx/monitor/SingleLineUimaJmxMonitorListener.java?rev=945195&r1=945194&r2=945195&view=diff
==============================================================================
--- uima/uima-as/trunk/uimaj-as-core/src/main/java/org/apache/uima/aae/jmx/monitor/SingleLineUimaJmxMonitorListener.java (original)
+++ uima/uima-as/trunk/uimaj-as-core/src/main/java/org/apache/uima/aae/jmx/monitor/SingleLineUimaJmxMonitorListener.java Mon May 17 15:02:09 2010
@@ -45,12 +45,7 @@ public class SingleLineUimaJmxMonitorLis
private double period;
/**
- * Constructor
- *
- * @param aMaxNameLength
- * - the longest name of the UIMA-AS service. This is use to pad other names so that the
- * output is easier to read.
- *
+ * Constructor
*/
public SingleLineUimaJmxMonitorListener() {
}