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/12/09 20:23:07 UTC
svn commit: r1549654 - in
/uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/metadata/cpe:
CasProcessorCpeObject.java CpeDescriptorFactory.java
Author: schor
Date: Mon Dec 9 19:23:07 2013
New Revision: 1549654
URL: http://svn.apache.org/r1549654
Log:
[UIMA-3484] javadoc fixes
Modified:
uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/metadata/cpe/CasProcessorCpeObject.java
uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/metadata/cpe/CpeDescriptorFactory.java
Modified: uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/metadata/cpe/CasProcessorCpeObject.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/metadata/cpe/CasProcessorCpeObject.java?rev=1549654&r1=1549653&r2=1549654&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/metadata/cpe/CasProcessorCpeObject.java (original)
+++ uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/metadata/cpe/CasProcessorCpeObject.java Mon Dec 9 19:23:07 2013
@@ -130,7 +130,7 @@ public class CasProcessorCpeObject exten
*
* @param aDescriptorPath -
* path to the descriptor
- * @throws CpeDescriptorException
+ * @throws CpeDescriptorException tbd
*/
public void setDescriptor(String aDescriptorPath) throws CpeDescriptorException {
if (descriptor == null) {
@@ -210,7 +210,7 @@ public String getDescriptor() {
/**
* Adds default configuration shared by CasProcessors
*
- * @throws CpeDescriptorException
+ * @throws CpeDescriptorException tbd
*/
protected void addDefaults() throws CpeDescriptorException {
if (getCasProcessorFilter() == null) {
@@ -295,7 +295,7 @@ public String getDescriptor() {
* @param aParamValue -
* value of the new parameter
*
- * @throws CpeDescriptorException
+ * @throws CpeDescriptorException tbd
*/
public void addDeployParam(String aParamName, String aParamValue) throws CpeDescriptorException {
boolean found = false;
@@ -317,7 +317,7 @@ public String getDescriptor() {
/**
*
* @param aParams
- * @throws CpeDescriptorException
+ * @throws CpeDescriptorException tbd
*/
protected void setDeploymentParams(CasProcessorDeploymentParams aParams)
throws CpeDescriptorException {
@@ -340,7 +340,7 @@ public String getDescriptor() {
* @param aName -
* name as string
*
- * @throws CpeDescriptorException
+ * @throws CpeDescriptorException tbd
*/
public void setName(String aName) throws CpeDescriptorException {
@@ -365,7 +365,7 @@ public String getDescriptor() {
/**
* @deprecated
* @param aSoFa
- * @throws CpeDescriptorException
+ * @throws CpeDescriptorException tbd
*/
@Deprecated
public void setSOFA(String aSoFa) throws CpeDescriptorException {
Modified: uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/metadata/cpe/CpeDescriptorFactory.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/metadata/cpe/CpeDescriptorFactory.java?rev=1549654&r1=1549653&r2=1549654&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/metadata/cpe/CpeDescriptorFactory.java (original)
+++ uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/metadata/cpe/CpeDescriptorFactory.java Mon Dec 9 19:23:07 2013
@@ -134,9 +134,10 @@ public class CpeDescriptorFactory {
/**
*
- * @param aCollectionReaderDescriptorPath
- * @param aDescriptor
- * @throws CpeDescriptorException
+ * @param aCollectionReaderDescriptorPath a path to the collection reader descriptor
+ * @param aDescriptor the descriptor to associate the collection reader with
+ * @return the CPE Collection Reader
+ * @throws CpeDescriptorException if there is a failure
*/
public static CpeCollectionReader produceCollectionReader(String aCollectionReaderDescriptorPath,
CpeDescription aDescriptor) throws CpeDescriptorException {
@@ -175,9 +176,10 @@ public class CpeDescriptorFactory {
/**
*
- * @param aPath
- * @param aDescriptor
- * @throws CpeDescriptorException
+ * @param aPath don't use
+ * @param aDescriptor don't use
+ * @return a CPE Collection Reader CAS Initializer
+ * @throws CpeDescriptorException passed thru
*
* @deprecated As of v2.0, CAS Initializers are deprecated.
*/
@@ -194,7 +196,8 @@ public static CpeCollectionReaderCasInit
/**
*
- * @param aInitializerDescriptorPath
+ * @param aInitializerDescriptorPath path to the initializer descriptor
+ * @return CPE Collection Reader CAS Initializer
* @deprecated As of v2.0, CAS Initializers are deprecated.
*/
@Deprecated
@@ -210,7 +213,8 @@ protected static CpeCollectionReaderCasI
/**
*
- * @param aPath
+ * @param aPath The path to the the CPE component Descriptor
+ * @return the CPE Component Description
*/
public static CpeComponentDescriptor produceComponentDescriptor(String aPath) {
@@ -223,8 +227,9 @@ protected static CpeCollectionReaderCasI
/**
*
- * @param aDescriptor
- * @throws CpeDescriptorException
+ * @param aDescriptor CPE descriptor to use
+ * @return the Cpe Configuration
+ * @throws CpeDescriptorException if it fails
*/
public static CpeConfiguration produceCpeConfiguration(CpeDescription aDescriptor)
throws CpeDescriptorException {
@@ -240,39 +245,28 @@ protected static CpeCollectionReaderCasI
return new CpeConfigurationImpl();
}
- /**
- *
- */
public static CasProcessorRuntimeEnvParam produceRuntimeEnvParam() {
return new CasProcessorRuntimeEnvParamImpl();
}
- /**
- *
- */
public static CasProcessorDeploymentParams produceDeployParams() {
return new CasProcessorDeploymentParamsImpl();
}
- /**
- *
- */
public static CasProcessorDeploymentParam produceDeployParam() {
return new CasProcessorDeploymentParamImpl();
}
- /**
- *
- */
public static CpeInclude produceComponentDescriptorInclude() {
return new CpeIncludeImpl();
}
/**
*
- * @param aDescriptor
- * @throws CpeDescriptorException
+ * @param aDescriptor to use to produce the CPE CAS Processors
+ * @return Cpe CAS Processors
+ * @throws CpeDescriptorException if an error occurs
*/
public static CpeCasProcessors produceCasProcessors(CpeDescription aDescriptor)
throws CpeDescriptorException {
@@ -290,11 +284,12 @@ protected static CpeCollectionReaderCasI
/**
*
- * @param aInputQSize
- * @param aOutputQSize
- * @param aPuCount
- * @param aDescriptor
- * @throws CpeDescriptorException
+ * @param aInputQSize the input queue size
+ * @param aOutputQSize the output queue size
+ * @param aPuCount the number of processing units
+ * @param aDescriptor the CPE descriptor
+ * @return CPE CAS Processors
+ * @throws CpeDescriptorException if an error occurs
*/
public static CpeCasProcessors produceCasProcessors(int aInputQSize, int aOutputQSize,
int aPuCount, CpeDescription aDescriptor) throws CpeDescriptorException {
@@ -322,9 +317,10 @@ protected static CpeCollectionReaderCasI
/**
*
- * @param aName
- * @param aSoFa
- * @throws CpeDescriptorException
+ * @param aName the processor name
+ * @param aSoFa the processor SofA
+ * @return CPE Local CAS Processor
+ * @throws CpeDescriptorException if an error occurs
*/
public static CpeLocalCasProcessor produceLocalCasProcessor(String aName, String aSoFa)
throws CpeDescriptorException {
@@ -336,8 +332,9 @@ protected static CpeCollectionReaderCasI
/**
*
- * @param aName
- * @throws CpeDescriptorException
+ * @param aName the processor name
+ * @return CPE Remote CAS Processor
+ * @throws CpeDescriptorException if an error occurs
*/
public static CpeRemoteCasProcessor produceRemoteCasProcessor(String aName)
throws CpeDescriptorException {
@@ -368,30 +365,22 @@ protected static CpeCollectionReaderCasI
return resMgr;
}
- /**
- *
- */
public static CasProcessorTimeout produceCasProcessorTimeout() {
return new CasProcessorTimeoutImpl();
}
- /**
- *
- */
public static CasProcessorMaxRestarts produceCasProcessorMaxRestarts() {
return new CasProcessorMaxRestartsImpl();
}
- /**
- *
- */
public static CasProcessorErrorRateThreshold produceCasProcessorErrorRateThreshold() {
return new CasProcessorErrorRateThresholdImpl();
}
/**
*
- * @param aFilter
+ * @param aFilter the filter string
+ * @return a CAS Processor Filter
*/
public static CasProcessorFilter produceCasProcessorFilter(String aFilter) {
CasProcessorFilter filter = new CasProcessorFilterImpl();
@@ -399,58 +388,34 @@ protected static CpeCollectionReaderCasI
return filter;
}
- /**
- *
- */
public static CasProcessorErrorHandling produceCasProcessorErrorHandling() {
return new CasProcessorErrorHandlingImpl();
}
- /**
- *
- */
public static CpeCheckpoint produceCpeCheckpoint() {
return new CpeCheckpointImpl();
}
- /**
- *
- */
public static CasProcessorDeploymentParams produceCasProcessorDeploymentParams() {
return new CasProcessorDeploymentParamsImpl();
}
- /**
- *
- */
public static CasProcessorExecArg produceCasProcessorExecArg() {
return new CasProcessorExecArgImpl();
}
-
- /**
- *
- */
+
public static CasProcessorExecutable produceCasProcessorExecutable() {
return new CasProcessorExecutableImpl();
}
- /**
- *
- */
public static CasProcessorRunInSeperateProcess produceRunInSeperateProcess() {
return new CasProcessorRunInSeperateProcessImpl();
}
- /**
- *
- */
public static CasProcessorConfigurationParameterSettings produceCasProcessorConfigurationParameterSettings() {
return new CasProcessorConfigurationParameterSettingsImpl();
}
- /**
- *
- */
public static NameValuePair produceNameValuePair() {
return new NameValuePairImpl();
}