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 2019/07/03 13:32:49 UTC
svn commit: r1862470 - in
/uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima:
cas_data/impl/vinci/ collection/impl/base_cpm/container/
collection/impl/cpm/ collection/impl/cpm/container/
collection/impl/cpm/container/deployer/ collection/impl/cp...
Author: schor
Date: Wed Jul 3 13:32:49 2019
New Revision: 1862470
URL: http://svn.apache.org/viewvc?rev=1862470&view=rev
Log:
no Jira, fixup javadocs
Modified:
uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/cas_data/impl/vinci/VinciCasDataConverter.java
uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/base_cpm/container/CasProcessorController.java
uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/BaseCPMImpl.java
uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/Checkpoint.java
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/NetworkCasProcessorImpl.java
uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/ProcessingContainer_Impl.java
uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/CPEDeployerDefaultImpl.java
uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/JavaApplication.java
uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/NonJavaApplication.java
uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/RunnableApplication.java
uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/VinciTAP.java
uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/socket/SocketCasProcessorDeployer.java
uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/socket/SocketTransport.java
uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/vinci/VinciCasProcessorDeployer.java
uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/vns/LocalVNS.java
uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/vinci/DATACasUtils.java
Modified: uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/cas_data/impl/vinci/VinciCasDataConverter.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/cas_data/impl/vinci/VinciCasDataConverter.java?rev=1862470&r1=1862469&r2=1862470&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/cas_data/impl/vinci/VinciCasDataConverter.java (original)
+++ uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/cas_data/impl/vinci/VinciCasDataConverter.java Wed Jul 3 13:32:49 2019
@@ -86,6 +86,8 @@ public class VinciCasDataConverter {
* CasData to convert
* @param aParentFrame
* VinciFrame to be the parent of the frame created from the CasData
+ * @throws SAXException -
+ * @throws IOException -
*/
public void casDataToVinciFrame(CasData aCasData, AFrame aParentFrame) throws IOException,
SAXException {
@@ -123,6 +125,7 @@ public class VinciCasDataConverter {
* CasData to which FeatureStructures from XCAS will be appended
*
* @deprecated Use appendVinciFrameToCasData(Aframe, CasData) or vinciFrameToCasData(AFrame)
+ * @throws SAXException -
*/
@Deprecated
public void vinciFrameToCasData(AFrame aCasFrame, CasData aCasData) throws SAXException {
@@ -136,6 +139,7 @@ public void vinciFrameToCasData(AFrame a
* VinciFrame containing XCAS
*
* @return a new CasData corrsponding to the XCAS in aCasFrame
+ * @throws SAXException -
*/
public CasData vinciFrameToCasData(AFrame aCasFrame) throws SAXException {
CasData casData = new CasDataImpl();
@@ -150,6 +154,7 @@ public void vinciFrameToCasData(AFrame a
* VinciFrame containing XCAS
* @param aCasData
* CasData to which FeatureStructures from XCAS will be appended
+ * @throws SAXException -
*/
public void appendVinciFrameToCasData(AFrame aCasFrame, CasData aCasData) throws SAXException {
// Use VinciSaxParser to generate SAX events from VinciFrame, and send
Modified: uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/base_cpm/container/CasProcessorController.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/base_cpm/container/CasProcessorController.java?rev=1862470&r1=1862469&r2=1862470&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/base_cpm/container/CasProcessorController.java (original)
+++ uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/base_cpm/container/CasProcessorController.java Wed Jul 3 13:32:49 2019
@@ -54,7 +54,7 @@ public interface CasProcessorController
/**
* Sets status of CasProcessor
*
- * @param aStatus
+ * @param aStatus -
*/
public void setStatus(int aStatus);
Modified: uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/BaseCPMImpl.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/BaseCPMImpl.java?rev=1862470&r1=1862469&r2=1862470&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/BaseCPMImpl.java (original)
+++ uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/BaseCPMImpl.java Wed Jul 3 13:32:49 2019
@@ -117,6 +117,7 @@ public class BaseCPMImpl implements Base
* ResourceManager instance to be used by the CPE
* @param aDefaultProcessTrace -
* ProcessTrace instance to capture events and stats
+ * @param aProps -
* @throws Exception -
*/
public BaseCPMImpl(CpeDescription aDescriptor, ResourceManager aResourceManager,
@@ -156,7 +157,7 @@ public class BaseCPMImpl implements Base
/**
* Plugs in custom perfomance tunning parameters
*
- * @param aPerformanceTuningSettings
+ * @param aPerformanceTuningSettings -
*/
public void setPerformanceTuningSettings(Properties aPerformanceTuningSettings) {
cpEngine.setPerformanceTuningSettings(aPerformanceTuningSettings);
@@ -178,7 +179,7 @@ public class BaseCPMImpl implements Base
* use at the end of processing. Jedii-style reporting shows a summary for this run. The CPM
* default report shows more detail information.
*
- * @param aUseJediiReport
+ * @param aUseJediiReport -
*/
public void setJediiReport(boolean aUseJediiReport) {
mEventTypeMap = new HashMap();
@@ -192,6 +193,7 @@ public class BaseCPMImpl implements Base
* Instantiates and initializes a CPE.
*
* @param aDummyCasProcessor -
+ * @param aProps -
*
* @throws Exception -
*/
@@ -559,6 +561,8 @@ public class BaseCPMImpl implements Base
*
* @see org.apache.uima.collection.base_cpm.BaseCPM#process()
* @deprecated
+ * @param aCollectionReader -
+ * @throws ResourceInitializationException -
*/
@Deprecated
public void process(BaseCollectionReader aCollectionReader)
@@ -612,6 +616,9 @@ public void process(BaseCollectionReader
*
* @see org.apache.uima.collection.base_cpm.BaseCPM#process()
* @deprecated
+ * @param aCollectionReader -
+ * @param aBatchSize -
+ * @throws ResourceInitializationException -
*/
@Deprecated
public void process(BaseCollectionReader aCollectionReader, int aBatchSize)
@@ -891,8 +898,8 @@ public void process(BaseCollectionReader
/**
* Helper method to help build the CPM report
*
- * @param aEvent
- * @param aTotalTime
+ * @param aEvent -
+ * @param aTotalTime -
*/
public void buildEventTree(ProcessTraceEvent aEvent, int aTotalTime) {
// Skip reporting the CPM time.This time has already been acquired by summing up
@@ -1137,6 +1144,7 @@ public void process(BaseCollectionReader
* list of components
*
* @return - descriptor populated with a given components
+ * @throws ResourceConfigurationException -
*/
public String getDescriptor(List aList) throws ResourceConfigurationException {
return cpeFactory.getDescriptor(aList);
Modified: uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/Checkpoint.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/Checkpoint.java?rev=1862470&r1=1862469&r2=1862470&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/Checkpoint.java (original)
+++ uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/Checkpoint.java Wed Jul 3 13:32:49 2019
@@ -63,9 +63,9 @@ public class Checkpoint implements Runna
* Initialize the checkpoint with a reference to controlling cpe, the file where the checkpoint is
* to be stored, and the frequency of checkpoints.
*
- * @param aCpm
- * @param aFilename
- * @param aCheckpointFrequency
+ * @param aCpm -
+ * @param aFilename -
+ * @param aCheckpointFrequency -
*/
public Checkpoint(BaseCPMImpl aCpm, String aFilename, long aCheckpointFrequency) {
fileName = aFilename;
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=1862470&r1=1862469&r2=1862470&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 Wed Jul 3 13:32:49 2019
@@ -30,7 +30,7 @@ public class CPEContext {
/**
*
- * @param aDescriptorPath
+ * @param aDescriptorPath -
*/
public CPEContext(String aDescriptorPath) {
cpeDescriptorPath = aDescriptorPath;
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=1862470&r1=1862469&r2=1862470&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 Wed Jul 3 13:32:49 2019
@@ -128,6 +128,7 @@ public class CPEFactory {
/**
* Create a new CPEFactory on which we will later call parse(String) to parse a CPE descriptor.
+ * @param aResourceManager -
*/
public CPEFactory(ResourceManager aResourceManager) {
if (aResourceManager == null) {
@@ -140,10 +141,11 @@ public class CPEFactory {
/**
* Create a new CPEFactory for a CpeDescription that's already been parsed.
*
- * @param aDescriptor
- * @param aResourceManager
+ * @param aDescriptor -
+ * @param aResourceManager
* the resource manager that all components of this CPE will share If null, a new
* ResourceManager will be created.
+ * @throws ResourceInitializationException -
*/
public CPEFactory(CpeDescription aDescriptor, ResourceManager aResourceManager)
throws ResourceInitializationException {
@@ -280,7 +282,7 @@ public class CPEFactory {
*
* @return CollectionReader instance
*
- * @throws ResourceConfigurationException
+ * @throws ResourceConfigurationException -
*/
public BaseCollectionReader getCollectionReader() throws ResourceConfigurationException {
checkForErrors();
@@ -1132,7 +1134,7 @@ public class CPEFactory {
* </ul>
*
* @return Global CPE Configuration
- * @throws InstantiationException
+ * @throws InstantiationException -
*/
public CpeConfiguration getCPEConfig() throws InstantiationException {
try {
@@ -1313,6 +1315,7 @@ public class CPEFactory {
*
* @param aCasProcessor -
* CasProcessor to add
+ * @throws ResourceConfigurationException -
*/
public void addCasProcessor(CasProcessor aCasProcessor) throws ResourceConfigurationException {
if (!initialized) {
@@ -1418,7 +1421,7 @@ public class CPEFactory {
/**
*
- * @param aList
+ * @param aList -
* @return the cpe descriptor constructed from the list
* @throws ResourceConfigurationException -
*/
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=1862470&r1=1862469&r2=1862470&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 Wed Jul 3 13:32:49 2019
@@ -69,6 +69,7 @@ public class CasObjectNetworkCasProcesso
*
* @param aCasProcessor -
* Cas Process configuration from the CPE descriptor
+ * @throws ResourceConfigurationException -
*/
public CasObjectNetworkCasProcessorImpl(CpeCasProcessor aCasProcessor)
throws ResourceConfigurationException {
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=1862470&r1=1862469&r2=1862470&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 Wed Jul 3 13:32:49 2019
@@ -72,7 +72,7 @@ public class NetworkCasProcessorImpl imp
/**
* Initializes this instance with configuration defined in the CPE descriptor.
*
- * @param aCasProcessorType
+ * @param aCasProcessorType -
*/
public NetworkCasProcessorImpl(CpeCasProcessor aCasProcessorType) {
casProcessorType = aCasProcessorType;
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=1862470&r1=1862469&r2=1862470&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 Wed Jul 3 13:32:49 2019
@@ -165,6 +165,8 @@ public class ProcessingContainer_Impl ex
* CasProcessor configuration as defined in cpe descriptor
* @param aCasProcessorPool -
* pool of CasProcessor instances
+ * @param aMetaData -
+ * @throws ResourceConfigurationException -
*/
public ProcessingContainer_Impl(CasProcessorConfiguration aCasProcessorConfig,
ProcessingResourceMetaData aMetaData, ServiceProxyPool aCasProcessorPool)
@@ -183,7 +185,7 @@ public class ProcessingContainer_Impl ex
/**
* Returns component's input/output capabilities
- *
+ * @return component's input/output capabilities
*/
public ProcessingResourceMetaData getMetadata() {
return metadata;
Modified: uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/CPEDeployerDefaultImpl.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/CPEDeployerDefaultImpl.java?rev=1862470&r1=1862469&r2=1862470&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/CPEDeployerDefaultImpl.java (original)
+++ uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/CPEDeployerDefaultImpl.java Wed Jul 3 13:32:49 2019
@@ -77,6 +77,7 @@ public class CPEDeployerDefaultImpl impl
* @param redeploy - true when redeploying failed Cas Processor
*
* @return - ProcessingContainer containing pool of CasProcessors
+ * @throws ResourceConfigurationException -
*/
public ProcessingContainer deployCasProcessor(List aCasProcessorList, CPMEngine aEngine,
boolean redeploy) throws ResourceConfigurationException {
Modified: uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/JavaApplication.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/JavaApplication.java?rev=1862470&r1=1862469&r2=1862470&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/JavaApplication.java (original)
+++ uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/JavaApplication.java Wed Jul 3 13:32:49 2019
@@ -49,7 +49,7 @@ public class JavaApplication extends Run
*
* @param aCasProcessorConfiguration -
* configuration for CasProcessor
- * @param aJaxbCasProcessorConfig
+ * @param aJaxbCasProcessorConfig -
* @throws ResourceConfigurationException passthru
*/
public JavaApplication(CasProcessorConfiguration aCasProcessorConfiguration,
@@ -63,7 +63,7 @@ public class JavaApplication extends Run
*
* @param aCasProcessorConfiguration -
* access to Cas Processor configuration
- * @param aCasProcessor
+ * @param aCasProcessor -
* @throws ResourceConfigurationException passthru
*/
protected void addApplicationInfo(CasProcessorConfiguration aCasProcessorConfiguration,
@@ -86,6 +86,7 @@ public class JavaApplication extends Run
* executable program
*
* @return - complete command line ready for use
+ * @throws ResourceConfigurationException -
*/
protected String[] addApplicationCmdLineArguments(
CasProcessorConfiguration aCasProcessorConfiguration, List argList, String aExecutable)
Modified: uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/NonJavaApplication.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/NonJavaApplication.java?rev=1862470&r1=1862469&r2=1862470&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/NonJavaApplication.java (original)
+++ uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/NonJavaApplication.java Wed Jul 3 13:32:49 2019
@@ -54,7 +54,7 @@ public class NonJavaApplication extends
*
* @param aCasProcessorConfiguration -
* access to Cas Processor configuration
- * @param aCasProcessor
+ * @param aCasProcessor -
* @throws ResourceConfigurationException passthru
*/
protected void addApplicationInfo(CasProcessorConfiguration aCasProcessorConfiguration,
@@ -78,6 +78,7 @@ public class NonJavaApplication extends
* @param aExecutable -
* name of the program to launch
* @return - command line as array of Strings
+ * @throws ResourceConfigurationException -
*/
protected String[] addApplicationCmdLineArguments(
CasProcessorConfiguration aCasProcessorConfiguration, List argList, String aExecutable)
Modified: uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/RunnableApplication.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/RunnableApplication.java?rev=1862470&r1=1862469&r2=1862470&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/RunnableApplication.java (original)
+++ uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/RunnableApplication.java Wed Jul 3 13:32:49 2019
@@ -54,7 +54,7 @@ public class RunnableApplication {
*
* @param aCasProcessorConfiguration -
* access to Cas Processor configuration
- * @param aCasProcessor
+ * @param aCasProcessor -
* @throws ResourceConfigurationException wraps Exception
*/
protected void addApplicationInfo(CasProcessorConfiguration aCasProcessorConfiguration,
Modified: uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/VinciTAP.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/VinciTAP.java?rev=1862470&r1=1862469&r2=1862470&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/VinciTAP.java (original)
+++ uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/VinciTAP.java Wed Jul 3 13:32:49 2019
@@ -290,6 +290,7 @@ public class VinciTAP {
*
* @param aServiceName -
* name of the service
+ * @throws ServiceConnectionException -
*/
public void connect(String aServiceName) throws ServiceConnectionException {
// To locate the service by name the VNS is critical. Make sure we know where it is
@@ -415,6 +416,8 @@ public class VinciTAP {
* Vinci Frame containing request
*
* @return AFrame - Frame containing result
+ * @throws ServiceConnectionException -
+ * @throws ServiceException -
*/
public AFrame sendAndReceive(AFrame aFrame) throws ServiceException, ServiceConnectionException {
int currentTimeout = 0;
@@ -1051,7 +1054,8 @@ public class VinciTAP {
/**
* Returns Cas Processor metadata as it is returned from the remote Cas Processor running as vinci
* service.
- *
+ * @return -
+ * @throws ResourceServiceException -
*/
public ProcessingResourceMetaData getAnalysisEngineMetaData() throws ResourceServiceException {
if (UIMAFramework.getLogger().isLoggable(Level.FINEST)) {
@@ -1142,6 +1146,7 @@ public class VinciTAP {
/**
* Let the remote service now that end of batch marker has been reached, the notification is
* one-way meaning the CPE does not expect anything back from the service.
+ * @throws ResourceServiceException -
*/
public void batchProcessComplete() throws ResourceServiceException {
// For some installations, like WF, dont bother sending end-of-batch marker.
Modified: uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/socket/SocketCasProcessorDeployer.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/socket/SocketCasProcessorDeployer.java?rev=1862470&r1=1862469&r2=1862470&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/socket/SocketCasProcessorDeployer.java (original)
+++ uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/socket/SocketCasProcessorDeployer.java Wed Jul 3 13:32:49 2019
@@ -75,8 +75,10 @@ public class SocketCasProcessorDeployer
*
* @param aCasProcessorList - list containing instantiated Cas Processors
* @param redeploy - true when redeploying failed Cas Processor
+ * @param aEngine -
*
* @return - ProcessingContainer containing pool of CasProcessors
+ * @throws ResourceConfigurationException -
*/
public ProcessingContainer deployCasProcessor(List aCasProcessorList, CPMEngine aEngine,
boolean redeploy) throws ResourceConfigurationException {
Modified: uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/socket/SocketTransport.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/socket/SocketTransport.java?rev=1862470&r1=1862469&r2=1862470&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/socket/SocketTransport.java (original)
+++ uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/socket/SocketTransport.java Wed Jul 3 13:32:49 2019
@@ -66,6 +66,7 @@ public interface SocketTransport {
* CasProcessor
* @throws
* SocketException - connection broken
+ * @throws AnalysisEngineProcessException -
*
*/
public CAS process(Socket aSocket, CAS aCas) throws SocketTimeoutException, SocketException,
Modified: uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/vinci/VinciCasProcessorDeployer.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/vinci/VinciCasProcessorDeployer.java?rev=1862470&r1=1862469&r2=1862470&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/vinci/VinciCasProcessorDeployer.java (original)
+++ uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/vinci/VinciCasProcessorDeployer.java Wed Jul 3 13:32:49 2019
@@ -134,7 +134,7 @@ public class VinciCasProcessorDeployer i
/**
* Instantiaes the class and gives it access to CPE configuration.
*
- * @param aCpeFactory
+ * @param aCpeFactory -
*/
public VinciCasProcessorDeployer(CPEFactory aCpeFactory) {
cpeFactory = aCpeFactory;
@@ -148,8 +148,10 @@ public class VinciCasProcessorDeployer i
*
* @param aCasProcessorList - list containing instantiated Cas Processors
* @param redeploy - true when redeploying failed Cas Processor
+ * @param aEngine -
*
* @return - ProcessingContainer containing pool of CasProcessors
+ * @throws ResourceConfigurationException -
*/
public ProcessingContainer deployCasProcessor(List aCasProcessorList, CPMEngine aEngine,
boolean redeploy) throws ResourceConfigurationException {
Modified: uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/vns/LocalVNS.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/vns/LocalVNS.java?rev=1862470&r1=1862469&r2=1862470&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/vns/LocalVNS.java (original)
+++ uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/vns/LocalVNS.java Wed Jul 3 13:32:49 2019
@@ -68,6 +68,7 @@ public class LocalVNS extends VinciServa
* an ending port # for clients( services)
* @param aVNSPort -
* port on which this VNS will listen on
+ * @throws PortUnreachableException -
*/
public LocalVNS(String aStartPort, String aEndPort, String aVNSPort)
throws PortUnreachableException {
@@ -182,6 +183,7 @@ public class LocalVNS extends VinciServa
* successful returns false.
*
* @param port number to check
+ * @return -
*/
public boolean isAvailable(int port) {
ServerSocket socket = null;
Modified: uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/vinci/DATACasUtils.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/vinci/DATACasUtils.java?rev=1862470&r1=1862469&r2=1862470&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/vinci/DATACasUtils.java (original)
+++ uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/vinci/DATACasUtils.java Wed Jul 3 13:32:49 2019
@@ -59,10 +59,10 @@ public class DATACasUtils {
/**
*
- * @param dataCas
- * @param featureType
- * @param featureName
- * @param featureValue
+ * @param dataCas -
+ * @param featureType -
+ * @param featureName -
+ * @param featureValue -
*/
public static void addFeatureStructure(CasData dataCas, String featureType, String featureName,
String featureValue) {
@@ -75,7 +75,7 @@ public class DATACasUtils {
/**
*
- * @param aDataCas
+ * @param aDataCas -
* @return true if the data cas is empty
*/
public static boolean isCasEmpty(CasData aDataCas) {
@@ -88,10 +88,10 @@ public class DATACasUtils {
/**
*
- * @param dataCas
- * @param featureType
- * @param featureName
- * @param featureValue
+ * @param dataCas -
+ * @param featureType -
+ * @param featureName -
+ * @param featureValue -
*/
public static void addFeature(CasData dataCas, String featureType, String featureName,
String featureValue) {
@@ -107,7 +107,7 @@ public class DATACasUtils {
/**
*
- * @param aDataCas
+ * @param aDataCas -
* @return the byte count
* @throws Exception -
*/
@@ -132,8 +132,8 @@ public class DATACasUtils {
/**
*
- * @param aCAS
- * @param aFilterList
+ * @param aCAS -
+ * @param aFilterList -
* @return true if this cas should be analyzed
*/
public static boolean shouldAnalyzeCAS(CasData aCAS, LinkedList aFilterList) {
@@ -185,8 +185,8 @@ public class DATACasUtils {
/**
*
- * @param aKey
- * @param dropKeyList
+ * @param aKey -
+ * @param dropKeyList -
* @return true if this key is in the dropKeyList
*/
public static boolean dropIt(String aKey, String[] dropKeyList) {