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 2013/09/09 19:41:06 UTC
svn commit: r1521220 -
/uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/
Author: schor
Date: Mon Sep 9 17:41:06 2013
New Revision: 1521220
URL: http://svn.apache.org/r1521220
Log:
[UIMA-3256] fixup Javadocs
Modified:
uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/CPEContext.java
uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/CPEFactory.java
uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/CasObjectNetworkCasProcessorImpl.java
uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/CasProcessorConfigurationJAXBImpl.java
uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/NetworkCasProcessorImpl.java
uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/ProcessingContainer_Impl.java
Modified: uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/CPEContext.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/CPEContext.java?rev=1521220&r1=1521219&r2=1521220&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/CPEContext.java (original)
+++ uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/CPEContext.java Mon Sep 9 17:41:06 2013
@@ -26,21 +26,21 @@ package org.apache.uima.collection.impl.
* Window>Preferences>Java>Code Generation>Code and Comments
*/
public class CPEContext {
- private String cpeDesctriptorPath = null;
+ private String cpeDescriptorPath = null;
/**
*
* @param aDescriptorPath
*/
public CPEContext(String aDescriptorPath) {
- cpeDesctriptorPath = aDescriptorPath;
+ cpeDescriptorPath = aDescriptorPath;
}
/**
*
- * @return
+ * @return the path to the descriptor
*/
public String getCPEDescriptorPath() {
- return cpeDesctriptorPath;
+ return cpeDescriptorPath;
}
}
Modified: uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/CPEFactory.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/CPEFactory.java?rev=1521220&r1=1521219&r2=1521220&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/CPEFactory.java (original)
+++ uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/CPEFactory.java Mon Sep 9 17:41:06 2013
@@ -239,8 +239,6 @@ public class CPEFactory {
/**
* Creates an object representation from default cpe descriptor.
*
- * @param aDescriptorStream -
- * stream containing cpe description
* @throws InstantiationException
*/
@@ -799,7 +797,7 @@ public class CPEFactory {
/**
* Instantiates a ResourceSpecifier from a given URL.
*
- * @param aDescriptorURL - URL of descriptor
+ * @param aDescriptorUrl - URL of descriptor
* @return - ResourceSpecifier
*
* @throws Exception
@@ -1186,7 +1184,7 @@ public class CPEFactory {
/**
*
- * @return
+ * @return true if the configuration is the default
*/
public boolean isDefault() {
return defaultConfig;
@@ -1195,7 +1193,7 @@ public class CPEFactory {
/**
* Returns Cpe Descriptor
*
- * @return
+ * @return the Cpe Descriptor
*/
public CpeDescription getCpeDescriptor() {
return cpeDescriptor;
@@ -1436,7 +1434,7 @@ public class CPEFactory {
/**
*
* @param aList
- * @return
+ * @return the cpe descriptor constructed from the list
* @throws ResourceConfigurationException
*/
public String getDescriptor(List aList) throws ResourceConfigurationException {
@@ -1559,7 +1557,7 @@ public class CPEFactory {
/**
* Gets the ResourceManager that all components of this CPE should share.
*
- * @return
+ * @return the resource manager
*/
public ResourceManager getResourceManager() {
return uimaContext.getResourceManager();
Modified: uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/CasObjectNetworkCasProcessorImpl.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/CasObjectNetworkCasProcessorImpl.java?rev=1521220&r1=1521219&r2=1521220&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/CasObjectNetworkCasProcessorImpl.java (original)
+++ uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/CasObjectNetworkCasProcessorImpl.java Mon Sep 9 17:41:06 2013
@@ -67,7 +67,7 @@ public class CasObjectNetworkCasProcesso
* Using information from the CPE descriptor creates an instance of Transport class. The transport
* class will delegate analysis of CAS to a remote object.
*
- * @param aCasProcessorType -
+ * @param aCasProcessor -
* Cas Process configuration from the CPE descriptor
*/
public CasObjectNetworkCasProcessorImpl(CpeCasProcessor aCasProcessor)
@@ -182,8 +182,7 @@ public class CasObjectNetworkCasProcesso
/**
* Uses configured transport to delegate given CASes to the remote service
*
- * @param aCASes[] -
- * CASes to be analyzed
+ * @param aCASes - an array of CASes to be analyzed
*
* @throws ResourceInitializationException
*/
Modified: uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/CasProcessorConfigurationJAXBImpl.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/CasProcessorConfigurationJAXBImpl.java?rev=1521220&r1=1521219&r2=1521220&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/CasProcessorConfigurationJAXBImpl.java (original)
+++ uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/CasProcessorConfigurationJAXBImpl.java Mon Sep 9 17:41:06 2013
@@ -104,7 +104,7 @@ public class CasProcessorConfigurationJA
/**
* Initializes instance and copies configuation from cpe descriptor.
*
- * @param aJaxbCasProcessorConfig - -
+ * @param aCasProcessorConfig -
* configuration object containing Cas Processor configuration
* @param aResourceManager -
* needed to resolve import by name
@@ -684,8 +684,7 @@ public class CasProcessorConfigurationJA
/**
* Returns a value for a given deployment parameter
*
- * @param -
- * aDeployParameter - name of the parameter
+ * @param aDeployParameter - name of the parameter
* @return - value for parameter name
*/
public String getDeploymentParameter(String aDeployParameter) {
Modified: uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/NetworkCasProcessorImpl.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/NetworkCasProcessorImpl.java?rev=1521220&r1=1521219&r2=1521220&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/NetworkCasProcessorImpl.java (original)
+++ uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/NetworkCasProcessorImpl.java Mon Sep 9 17:41:06 2013
@@ -129,9 +129,8 @@ public class NetworkCasProcessorImpl imp
* Main method used during analysis. The ProcessingUnit calls this method to initiate analysis of
* the content in the CasData instance. This handles one Cas at a time processing mode.
*
- * @param CasData
- * aCas - instance of CasData to analyze
- * @return CasData - instance containing result of the analysis
+ * @param aCas - instance of CasData to analyze
+ * @return instance containing result of the analysis
*/
public CasData process(CasData aCas) throws ResourceProcessException {
if (textAnalysisProxy == null) {
@@ -176,8 +175,7 @@ public class NetworkCasProcessorImpl imp
* Main method used during analysis. The ProcessingUnit calls this method to initiate analysis of
* the content in the CasData instance. This handles processing of multiple Cas'es at a time.
*
- * @param CasData[]
- * aCas - array of CasData instances to analyze
+ * @param aCasList - array of CasData instances to analyze
* @return CasData - array of CasData instances containing results of the analysis
*/
public CasData[] process(CasData[] aCasList) throws ResourceProcessException {
Modified: uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/ProcessingContainer_Impl.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/ProcessingContainer_Impl.java?rev=1521220&r1=1521219&r2=1521220&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/ProcessingContainer_Impl.java (original)
+++ uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/ProcessingContainer_Impl.java Mon Sep 9 17:41:06 2013
@@ -192,8 +192,7 @@ public class ProcessingContainer_Impl ex
/**
* Sets component's input/output capabilities
*
- * @param Capability -
- * component capabilities
+ * @param aMetadata component capabilities
*/
public void setMetadata(ProcessingResourceMetaData aMetadata) {
metadata = aMetadata;
@@ -365,8 +364,7 @@ public class ProcessingContainer_Impl ex
/**
* Aggregate total bytes ingested by the CasProcessor.
*
- * @param -
- * aBytesIn - number of ingested bytes
+ * @param aBytesIn - number of ingested bytes
*/
public void addBytesIn(long aBytesIn) {
bytesIn += aBytesIn;
@@ -385,7 +383,6 @@ public class ProcessingContainer_Impl ex
/**
* Aggregate total bytes processed by this CasProcessor
*
- * @return - number of bytes added to the Cas
*/
public void addBytesOut(long aBytesOut) {
bytesOut += aBytesOut;
@@ -394,8 +391,7 @@ public class ProcessingContainer_Impl ex
/**
* Increment number of times the casProcessor was restarted due to failures
*
- * @param -
- * aCount - restart count
+ * @param aCount - restart count
*/
public void incrementRestartCount(int aCount) {
restartCount += aCount;
@@ -404,8 +400,7 @@ public class ProcessingContainer_Impl ex
/**
* Returns total number of all CasProcessor restarts.
*
- * @param -
- * number of restarts
+ * @return number of restarts
*/
public int getRestartCount() {
return restartCount;
@@ -415,8 +410,7 @@ public class ProcessingContainer_Impl ex
* Increments number of times CasProceesor failed analyzing Cas'es due to timeout or some other
* problems
*
- * @param -
- * aCount - failure count
+ * @param aCount - failure count
*/
public void incrementRetryCount(int aCount) {
retryCount += aCount;
@@ -434,8 +428,7 @@ public class ProcessingContainer_Impl ex
/**
* Increment number of aborted Cas'es due to inability to process the Cas
*
- * @param -
- * aCount - number of aborts while processing Cas'es
+ * @param aCount - number of aborts while processing Cas'es
*/
public void incrementAbortCount(int aCount) {
abortCount += aCount;
@@ -494,8 +487,7 @@ public class ProcessingContainer_Impl ex
/**
* Copies id of the last entity processed by the CasProcessor
*
- * @param -
- * aEntityId - id of the entity
+ * @param aEntityId - id of the entity
*/
public void setLastProcessedEntityId(String aEntityId) {
processedEntityIds.push(aEntityId);
@@ -540,8 +532,7 @@ public Object getLastCas() {
/**
* Used when recovering from checkpoint, sets the total number of entities before CPE stopped.
*
- * @param -
- * aProcessedCount - number of entities processed before CPE stopped
+ * @param aProcessedCount - number of entities processed before CPE stopped
*/
public void setProcessed(long aProcessedCount) {
processed = aProcessedCount;
@@ -626,7 +617,7 @@ public Object getLastCas() {
* run, if it should disable the CasProcessor (and all its instances), or disregard the error and
* continue.
*
- * @apram aThrowable - exception to examine
+ * @param aThrowable - exception to examine
*
* @exception AbortCPMException -
* force the CPE to stop processing
@@ -1501,7 +1492,7 @@ public boolean isIntegrated() {
/**
* Returns all stats aggregate during the CPM run
*
- * @return
+ * @return a map of all stats aggregated during the CPM run
*/
public HashMap getAllStats() {
synchronized (statMap) {