Interface CpeLocalCasProcessor
- All Superinterfaces:
Cloneable,CpeCasProcessor,MetaDataObject,Serializable,XMLizable
An object that holds configuration that is part of the CPE descriptor. Provides the means of
defining and obtaining configuration for CasProcessors deployed locally, ie same machine as CPE
but different process.
Its basic functionality is inherited from
CpeCasProcessor
-
Method Summary
Modifier and TypeMethodDescriptionvoidaddExecArg(String aArgValue) voidaddExecEnv(String aEnvParamName, String aEnvParamValue) Returns a name of a program to use when launching this CasProcessorbooleanisJava()Returns true if the local Cas Processor is a java programvoidsetExecutable(String aCasProcessorExecutable) Defines the name of a program to run when launching this Cas Processor.voidsetIsJava(boolean aJava) Defines if this Cas Processor is a java programvoidsetRunInSeperateProcess(CasProcessorRunInSeperateProcess aSepProcess) Methods inherited from interface org.apache.uima.collection.metadata.CpeCasProcessor
addDeployParam, getActionOnMaxError, getActionOnMaxRestart, getBatchSize, getCasProcessorFilter, getCheckpoint, getConfigurationParameterSettings, getCpeComponentDescriptor, getDeployment, getDeploymentParams, getDescriptor, getErrorHandling, getIsParallelizable, getMaxErrorCount, getMaxErrorSampleSize, getMaxRestartCount, getName, getRunInSeparateProcess, getSOFA, getSofaNameMappings, getTimeout, setActionOnMaxError, setActionOnMaxRestart, setBatchSize, setCasProcessorFilter, setConfigurationParameterSettings, setCpeComponentDescriptor, setDescriptor, setIsParallelizable, setMaxErrorCount, setMaxErrorSampleSize, setMaxRestartCount, setName, setSOFA, setSofaNameMappings, setTimeoutMethods inherited from interface org.apache.uima.resource.metadata.MetaDataObject
clone, equals, getAttributeValue, getSourceUrl, getSourceUrlString, isModifiable, listAttributes, setAttributeValue, setSourceUrlMethods inherited from interface org.apache.uima.util.XMLizable
buildFromXMLElement, buildFromXMLElement, toXML, toXML, toXML, toXML
-
Method Details
-
isJava
Returns true if the local Cas Processor is a java program- Returns:
- true if java program, false otherwise
- Throws:
CpeDescriptorException- -
-
setIsJava
Defines if this Cas Processor is a java program- Parameters:
aJava- - true if java, false otherwise- Throws:
CpeDescriptorException- -
-
setExecutable
Defines the name of a program to run when launching this Cas Processor. A program can be a java exec, a shell script, or any program that can run in a separate process.- Parameters:
aCasProcessorExecutable- - name of a program- Throws:
CpeDescriptorException- tbd
-
getExecutable
Returns a name of a program to use when launching this CasProcessor- Returns:
- the name of the program to execute
- Throws:
CpeDescriptorException- tbd
-
addExecEnv
- Throws:
CpeDescriptorException
-
addExecArg
- Throws:
CpeDescriptorException
-
setRunInSeperateProcess
void setRunInSeperateProcess(CasProcessorRunInSeperateProcess aSepProcess) throws CpeDescriptorException - Throws:
CpeDescriptorException
-
getRunInSeperateProcess
- Throws:
CpeDescriptorException
-