no Jira, fixup javadocs
git-svn-id: https://svn.apache.org/repos/asf/uima/uimaj/trunk@1862507 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/engine/ArtifactProducer.java b/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/engine/ArtifactProducer.java
index 423f8da..fbdf0f0 100644
--- a/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/engine/ArtifactProducer.java
+++ b/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/engine/ArtifactProducer.java
@@ -104,7 +104,7 @@
/**
* Instantiates and initializes this instance.
*
- * @param acpm
+ * @param acpm -
*/
public ArtifactProducer(CPMEngine acpm) {
cpm = acpm;
@@ -217,7 +217,7 @@
* Add table that will contain statistics gathered while reading entities from a Collection This
* table is used for non-uima reports.
*
- * @param aStatTable
+ * @param aStatTable -
*/
public void setCPMStatTable(Map aStatTable) {
cpmStatTable = aStatTable;
@@ -246,6 +246,7 @@
* Fills the queue up to capacity. This is called before activating ProcessingPipeline as means of
* optimizing processing. When pipelines start up there are already entities in the work queue to
* process.
+ * @throws Exception -
*/
public void fillQueue() throws Exception {
// Create an array holding CAS'es. Configuration of the Reader may
diff --git a/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/engine/CPECasPool.java b/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/engine/CPECasPool.java
index 68bb6f4..a96e141 100644
--- a/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/engine/CPECasPool.java
+++ b/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/engine/CPECasPool.java
@@ -66,7 +66,7 @@
* max size of the pool
* @param aCasManager -
* CAS Manager to use to create the CASes
- * @param aPerformanceTuningSettings
+ * @param aPerformanceTuningSettings -
* @throws ResourceInitializationException -
*/
public CPECasPool(int aNumInstances, CasManager aCasManager, Properties aPerformanceTuningSettings) throws ResourceInitializationException {
@@ -79,7 +79,7 @@
*
* @param aCasManager -
* definition (type system, indexes, etc.) of CASes to create
- * @param aPerformanceTuningSettings
+ * @param aPerformanceTuningSettings -
* @throws ResourceInitializationException -
*/
protected void fillPool(CasManager aCasManager, Properties aPerformanceTuningSettings) throws ResourceInitializationException {
diff --git a/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/engine/CPMEngine.java b/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/engine/CPMEngine.java
index 7c318db..2715dd6 100644
--- a/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/engine/CPMEngine.java
+++ b/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/engine/CPMEngine.java
@@ -262,6 +262,7 @@
* instance of the ProcessTrace where the CPM accumulates stats
* @param aCheckpointData -
* checkpoint object facillitating restart from the last known point
+ * @throws Exception -
*/
public CPMEngine(CPMThreadGroup aThreadGroup, CPEFactory aCpeFactory, ProcessTrace aProcTr,
CheckpointData aCheckpointData) throws Exception {
@@ -302,7 +303,7 @@
}
/**
- * Returns a list of Processing Containers for Analysis Engines. Each CasProcessor is managed by
+ * @return a list of Processing Containers for Analysis Engines. Each CasProcessor is managed by
* its own container.
*
*/
@@ -311,7 +312,7 @@
}
/**
- * Returns a list of All Processing Containers. Each CasProcessor is managed by its own container.
+ * @return a list of All Processing Containers. Each CasProcessor is managed by its own container.
*
*/
public LinkedList getAllProcessingContainers() {
@@ -1138,6 +1139,7 @@
*
* @param aCasProcessor
* CASProcessor to be added to the processing pipeline
+ * @throws ResourceConfigurationException -
*/
public void addCasProcessor(CasProcessor aCasProcessor) throws ResourceConfigurationException {
@@ -1171,6 +1173,7 @@
* CASProcessor to be added to the processing pipeline
* @param aIndex -
* insertion point for a given CasProcessor
+ * @throws ResourceConfigurationException -
*/
public void addCasProcessor(CasProcessor aCasProcessor, int aIndex)
throws ResourceConfigurationException {
@@ -1256,7 +1259,7 @@
}
/**
- * Returns all CASProcesors in the processing pipeline
+ * @return all CASProcesors in the processing pipeline
*/
public CasProcessor[] getCasProcessors() {
if (casprocessorList != null) {
@@ -1352,7 +1355,8 @@
/**
* Deploys CasProcessor and associates it with a {@link ProcessingContainer}
*
- * @param aProcessingContainer
+ * @param aProcessingContainer -
+ * @throws Exception -
*/
public void redeployAnalysisEngine(ProcessingContainer aProcessingContainer) throws Exception {
if (UIMAFramework.getLogger().isLoggable(Level.FINEST)) {
@@ -1465,7 +1469,7 @@
/**
* Starts CASProcessor containers one a time. During this phase the container deploys a TAE as
* local,remote, or integrated CasProcessor.
- *
+ * @throws AbortCPMException -
*/
public void deployCasProcessors() throws AbortCPMException {
try {
@@ -1535,7 +1539,7 @@
}
/**
- * Returns a global flag indicating if this Thread is in processing state
+ * @return a global flag indicating if this Thread is in processing state
*
*/
public boolean isRunning() {
@@ -1543,7 +1547,7 @@
}
/**
- * Returns a global flag indicating if this Thread is in pause state
+ * @return a global flag indicating if this Thread is in pause state
*/
public boolean isPaused() {
synchronized (lockForPause) {
@@ -1623,6 +1627,7 @@
/**
* Defines the size of the batch
+ * @param aNumToProcess -
*/
public void setNumToProcess(long aNumToProcess) {
@@ -1630,7 +1635,7 @@
}
/**
- * Returns Id of the last document processed
+ * @return Id of the last document processed
*/
public String getLastProcessedDocId() {
return producer.getLastDocId();
@@ -2846,6 +2851,7 @@
* Stops All Cas Processors and optionally changes the status according to kill flag
*
* @param kill - true if CPE has been stopped before completing normally
+ * @throws CasProcessorDeploymentException -
*/
public void stopCasProcessors(boolean kill) throws CasProcessorDeploymentException {
@@ -2903,7 +2909,7 @@
}
/**
- * Returns collectionReader progress.
+ * @return collectionReader progress.
*/
public Progress[] getProgress() {
if (collectionReader == null) {
@@ -3002,7 +3008,7 @@
/**
*
- * @param aPca
+ * @param aPca -
*/
public void setProcessControllerAdapter(ProcessControllerAdapter aPca) {
pca = aPca;
diff --git a/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/engine/CPMThreadGroup.java b/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/engine/CPMThreadGroup.java
index 24b9c01..614f9e0 100644
--- a/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/engine/CPMThreadGroup.java
+++ b/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/engine/CPMThreadGroup.java
@@ -41,7 +41,7 @@
private ProcessTrace procTr = null;
/**
- * @param name
+ * @param name -
*/
public CPMThreadGroup(String name) {
super(name);
diff --git a/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/engine/NonThreadedProcessingUnit.java b/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/engine/NonThreadedProcessingUnit.java
index e893b0c..7458253 100644
--- a/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/engine/NonThreadedProcessingUnit.java
+++ b/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/engine/NonThreadedProcessingUnit.java
@@ -575,14 +575,14 @@
/**
*
- * @param aFlag
+ * @param aFlag -
*/
public void setReleaseCASFlag(boolean aFlag) {
relaseCAS = aFlag;
}
/**
- * @param aPool
+ * @param aPool -
*/
public void setCasPool(CPECasPool aPool) {
casPool = aPool;
@@ -1204,6 +1204,8 @@
/**
* Check if the CASProcessor status is available for processing
+ * @param aStatus -
+ * @return -
*/
protected boolean isProcessorReady(int aStatus) {
if (aStatus == Constants.CAS_PROCESSOR_READY || aStatus == Constants.CAS_PROCESSOR_RUNNING) {
diff --git a/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/engine/ProcessingUnit.java b/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/engine/ProcessingUnit.java
index 9249cce..465385b 100644
--- a/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/engine/ProcessingUnit.java
+++ b/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/engine/ProcessingUnit.java
@@ -641,6 +641,7 @@
/**
* Consumes the input queue to make sure all bundles still there get processede before CPE
* terminates.
+ * @return -
*/
public boolean consumeQueue() {
Object artifact = null;
@@ -687,6 +688,12 @@
*
* @param aCasObjectList - bundle of Cas to analyze
* @param pTrTemp - object used to aggregate stats
+ * @return -
+ * @throws AbortCPMException -
+ * @throws ResourceProcessException -
+ * @throws CollectionException -
+ * @throws IOException -
+ * @throws KillPipelineException -
*/
protected boolean processNext(Object[] aCasObjectList, ProcessTrace pTrTemp)
throws ResourceProcessException, IOException, CollectionException, AbortCPMException,
@@ -1756,7 +1763,7 @@
/**
*
- * @param anArtifact
+ * @param anArtifact -
*/
protected void process(Object anArtifact) {
if (anArtifact instanceof Object[]) {
@@ -1769,13 +1776,13 @@
/**
*
- * @param aCasList
+ * @param aCasList -
*/
protected void showMetadata(Object[] aCasList) {
}
/**
- * Check if the CASProcessor status is available for processing
+ * @return true if the CASProcessor status is available for processing
*/
protected boolean isProcessorReady(int aStatus) {
if (aStatus == Constants.CAS_PROCESSOR_READY || aStatus == Constants.CAS_PROCESSOR_RUNNING) {
@@ -1805,7 +1812,7 @@
}
/**
- * @param aPool
+ * @param aPool -
*/
public void setCasPool(CPECasPool aPool) {
casPool = aPool;
@@ -1847,7 +1854,8 @@
* a list of CASes to analyze
* @param pTrTemp -
* process trace where statistics are added during analysis
- *
+ * @throws Exception -
+ * @return -
*/
protected boolean analyze(Object[] aCasObjectList, ProcessTrace pTrTemp) throws Exception // throws
// ResourceProcessException,
diff --git a/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/vinci/DATACasUtils.java b/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/vinci/DATACasUtils.java
index 3b02a2f..b2e4ad6 100644
--- a/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/vinci/DATACasUtils.java
+++ b/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/vinci/DATACasUtils.java
@@ -201,8 +201,8 @@
/**
*
- * @param aKey
- * @param typeList
+ * @param aKey -
+ * @param typeList -
* @return true if tbd
*/
public static boolean isValidType(String aKey, String[] typeList) {
@@ -228,8 +228,8 @@
/**
*
- * @param aCAS
- * @param featureName
+ * @param aCAS -
+ * @param featureName -
* @return true if
*/
public static boolean hasFeature(CasData aCAS, String featureName) {
@@ -249,8 +249,8 @@
/**
*
- * @param aCAS
- * @param aName
+ * @param aCAS -
+ * @param aName -
* @return true if tbd
*/
public static boolean hasFeatureStructure(CasData aCAS, String aName) {
@@ -271,7 +271,7 @@
/**
*
- * @param aCAS
+ * @param aCAS -
*/
public static void dumpFeatures(CasData aCAS) {
Iterator it = aCAS.getFeatureStructures();
@@ -310,8 +310,8 @@
/**
*
- * @param aCAS
- * @param featureName
+ * @param aCAS -
+ * @param featureName -
* @return true if tbd
*/
public static String getFeatureValueByType(CasData aCAS, String featureName) {
diff --git a/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/metadata/cpe/CpeDescriptionImpl.java b/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/metadata/cpe/CpeDescriptionImpl.java
index deee840..668d83f 100644
--- a/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/metadata/cpe/CpeDescriptionImpl.java
+++ b/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/metadata/cpe/CpeDescriptionImpl.java
@@ -56,6 +56,8 @@
/**
* This is needed for XMLParser.parseCpeDesription() to work. Typically users should use
* CpeDescriptorFactory.produceDescriptor() instead. - APL
+ * @param aInput -
+ * @throws InvalidXMLException -
*/
public CpeDescriptionImpl(XMLInputSource aInput) throws InvalidXMLException {
try {
diff --git a/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/metadata/cpe/CpeIncludeImpl.java b/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/metadata/cpe/CpeIncludeImpl.java
index ee8e64f..96f5775 100644
--- a/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/metadata/cpe/CpeIncludeImpl.java
+++ b/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/metadata/cpe/CpeIncludeImpl.java
@@ -85,13 +85,15 @@
static final private XmlizationInfo XMLIZATION_INFO = new XmlizationInfo("include",
new PropertyXmlInfo[0]);
- /** METHODS CALLED BY THE PARSER * */
+ /** METHODS CALLED BY THE PARSER *
+ * @return -
+ */
public String getHref() {
return href;
}
/**
- * @param string
+ * @param string -
*/
public void setHref(String string) {
href = string;
diff --git a/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/metadata/cpe/CpeResourceManagerConfigurationImpl.java b/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/metadata/cpe/CpeResourceManagerConfigurationImpl.java
index 9e3234c..2de0ddd 100644
--- a/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/metadata/cpe/CpeResourceManagerConfigurationImpl.java
+++ b/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/metadata/cpe/CpeResourceManagerConfigurationImpl.java
@@ -93,7 +93,7 @@
}
/**
- * @param string
+ * @param string -
*/
public void setHref(String string) {
href = string;
diff --git a/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/metadata/cpe/CpeSofaMappingImpl.java b/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/metadata/cpe/CpeSofaMappingImpl.java
index 36b384b..dd6f960 100644
--- a/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/metadata/cpe/CpeSofaMappingImpl.java
+++ b/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/metadata/cpe/CpeSofaMappingImpl.java
@@ -94,14 +94,14 @@
}
/**
- * @param string
+ * @param string -
*/
public void setComponentSofaName(String string) {
componentSofaName = string;
}
/**
- * @param string
+ * @param string -
*/
public void setCpeSofaName(String string) {
cpeSofaName = string;
diff --git a/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/metadata/cpe/CpeSofaMappingsImpl.java b/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/metadata/cpe/CpeSofaMappingsImpl.java
index ef3a41f..87e7f2b 100644
--- a/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/metadata/cpe/CpeSofaMappingsImpl.java
+++ b/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/metadata/cpe/CpeSofaMappingsImpl.java
@@ -112,7 +112,7 @@
}
/**
- * @param sofaMappings
+ * @param sofaMappings -
*/
public void setSofaNameMappings(CpeSofaMapping[] sofaMappings) {
for (int i = 0; sofaMappings != null && i < sofaMappings.length; i++) {
diff --git a/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/metadata/cpe/OutputQueue_impl.java b/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/metadata/cpe/OutputQueue_impl.java
index cca0adc..9bc3189 100644
--- a/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/metadata/cpe/OutputQueue_impl.java
+++ b/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/metadata/cpe/OutputQueue_impl.java
@@ -87,14 +87,14 @@
}
/**
- * @param i
+ * @param i -
*/
public void setDequeueTimeout(int i) {
dequeueTimeout = i;
}
/**
- * @param string
+ * @param string -
*/
public void setQueueClass(String string) {
queueClass = string;
