Class CpeLocalCasProcessorImpl
- java.lang.Object
-
- org.apache.uima.resource.metadata.impl.MetaDataObject_impl
-
- org.apache.uima.collection.impl.metadata.cpe.CasProcessorCpeObject
-
- org.apache.uima.collection.impl.metadata.cpe.CpeLocalCasProcessorImpl
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Cloneable
,CpeCasProcessor
,CpeLocalCasProcessor
,MetaDataObject
,XMLizable
public class CpeLocalCasProcessorImpl extends CasProcessorCpeObject implements CpeLocalCasProcessor
The Class CpeLocalCasProcessorImpl.- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.uima.resource.metadata.impl.MetaDataObject_impl
MetaDataObject_impl.MetaDataAttr, MetaDataObject_impl.SerialContext, MetaDataObject_impl.Serializer
-
-
Field Summary
Fields Modifier and Type Field Description private static long
serialVersionUID
The Constant serialVersionUID.-
Fields inherited from class org.apache.uima.resource.metadata.impl.MetaDataObject_impl
serialContext
-
-
Constructor Summary
Constructors Modifier Constructor Description CpeLocalCasProcessorImpl()
Instantiates a new cpe local cas processor impl.CpeLocalCasProcessorImpl(boolean initializeWithDefaultValues)
Instantiates a new cpe local cas processor impl.protected
CpeLocalCasProcessorImpl(java.lang.String aName, java.lang.String aSoFa)
Instantiates a new cpe local cas processor impl.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
addDefaults()
Adds default configuration shared by CasProcessors.void
addExecArg(java.lang.String aArgValue)
void
addExecEnv(java.lang.String aEnvKeyName, java.lang.String aEnvKeyValue)
Adds a new env key to the list of env keys.private CasProcessorRunInSeperateProcess
getBaseRunInSeperateProcess()
Gets the base run in seperate process.java.util.List
getExecArgs()
Gets the exec args.java.util.List
getExecEnv()
Gets the exec env.java.lang.String
getExecutable()
Returns a name of a program to use when launching this CasProcessorCasProcessorRunInSeperateProcess
getRunInSeperateProcess()
boolean
isJava()
Returns true if the local Cas Processor is a java programvoid
removeExecArg(int aIndex)
Removes the exec arg.void
removeExecEnv(int aIndex)
Removes the exec env.void
setExecutable(java.lang.String aCasProcessorExecutable)
Defines the name of a program to run when launching this Cas Processor.void
setIsJava(boolean aJava)
Defines if this Cas Processor is a java programvoid
setRunInSeperateProcess(CasProcessorRunInSeperateProcess aSepProcess)
-
Methods inherited from class org.apache.uima.collection.impl.metadata.cpe.CasProcessorCpeObject
addDeployParam, buildFromXMLElement, getActionOnMaxError, getActionOnMaxRestart, getBatchSize, getCasProcessorFilter, getCheckpoint, getConfigurationParameterSettings, getCpeComponentDescriptor, getDeployment, getDeploymentParameters, getDeploymentParams, getDescriptor, getErrorHandling, getFilter, getIsParallelizable, getMaxErrorCount, getMaxErrorSampleSize, getMaxRestartCount, getName, getParameters, getParameterSettings, getRunInSeparateProcess, getSOFA, getSofaNameMappings, getTimeout, getXMLAttributes, getXmlizationInfo, setActionOnMaxError, setActionOnMaxRestart, setBatchSize, setCasProcessorFilter, setCasProcessorFilter, setCheckpoint, setConfigurationParameterSettings, setCpeComponentDescriptor, setDeployment, setDeploymentParameters, setDeploymentParams, setDescriptor, setErrorHandling, setFilter, setIsParallelizable, setMaxErrorCount, setMaxErrorSampleSize, setMaxRestartCount, setName, setParameters, setParameterSettings, setRunInSeparateProcess, setSOFA, setSofaNameMappings, setTimeout
-
Methods inherited from class org.apache.uima.resource.metadata.impl.MetaDataObject_impl
buildFromXMLElement, clone, equals, getAdditionalAttributes, getAttributeClass, getAttributeValue, getInfoset, getMatchingNode, getPropertyDescriptors, getPropertyXmlInfo, getRelativePathBase, getSerialContext, getSourceUrl, getSourceUrlString, getWrapperClass, hashCode, isModifiable, listAttributes, readArrayPropertyValueFromXMLElement, readMapPropertyFromXml, readPropertyValueFromXMLElement, readUnknownPropertyValueFromXMLElement, resolveSettings, setAttributeValue, setInfoset, setSourceUrl, setSourceUrlIfNull, toString, toXML, toXML, toXML, toXML, valueIsNullOrEmptyArray, writeArrayPropertyAsElement, writeMapPropertyToXml, writePropertyAsElement
-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
-
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, setTimeout
-
Methods inherited from interface org.apache.uima.resource.metadata.MetaDataObject
clone, equals, getAttributeValue, getSourceUrl, getSourceUrlString, isModifiable, listAttributes, setAttributeValue, setSourceUrl
-
Methods inherited from interface org.apache.uima.util.XMLizable
buildFromXMLElement, buildFromXMLElement, toXML, toXML, toXML, toXML
-
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
The Constant serialVersionUID.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
CpeLocalCasProcessorImpl
public CpeLocalCasProcessorImpl()
Instantiates a new cpe local cas processor impl.
-
CpeLocalCasProcessorImpl
public CpeLocalCasProcessorImpl(boolean initializeWithDefaultValues)
Instantiates a new cpe local cas processor impl.- Parameters:
initializeWithDefaultValues
- the initialize with default values
-
CpeLocalCasProcessorImpl
protected CpeLocalCasProcessorImpl(java.lang.String aName, java.lang.String aSoFa) throws CpeDescriptorException
Instantiates a new cpe local cas processor impl.- Parameters:
aName
- the a nameaSoFa
- the a so fa- Throws:
CpeDescriptorException
- the cpe descriptor exception
-
-
Method Detail
-
getBaseRunInSeperateProcess
private CasProcessorRunInSeperateProcess getBaseRunInSeperateProcess() throws CpeDescriptorException
Gets the base run in seperate process.- Returns:
- the base run in seperate process
- Throws:
CpeDescriptorException
- the cpe descriptor exception
-
addExecArg
public void addExecArg(java.lang.String aArgValue) throws CpeDescriptorException
- Specified by:
addExecArg
in interfaceCpeLocalCasProcessor
- Throws:
CpeDescriptorException
-
removeExecArg
public void removeExecArg(int aIndex) throws CpeDescriptorException
Removes the exec arg.- Parameters:
aIndex
- the a index- Throws:
CpeDescriptorException
- the cpe descriptor exception
-
getExecArgs
public java.util.List getExecArgs() throws CpeDescriptorException
Gets the exec args.- Returns:
- the exec args
- Throws:
CpeDescriptorException
- the cpe descriptor exception
-
addDefaults
protected void addDefaults() throws CpeDescriptorException
Description copied from class:CasProcessorCpeObject
Adds default configuration shared by CasProcessors.- Overrides:
addDefaults
in classCasProcessorCpeObject
- Throws:
CpeDescriptorException
- tbd
-
isJava
public boolean isJava() throws CpeDescriptorException
Description copied from interface:CpeLocalCasProcessor
Returns true if the local Cas Processor is a java program- Specified by:
isJava
in interfaceCpeLocalCasProcessor
- Returns:
- true if java program, false otherwise
- Throws:
CpeDescriptorException
- -
-
addExecEnv
public void addExecEnv(java.lang.String aEnvKeyName, java.lang.String aEnvKeyValue) throws CpeDescriptorException
Adds a new env key to the list of env keys. If a kay with a given key name exists the new key value replaces the old.- Specified by:
addExecEnv
in interfaceCpeLocalCasProcessor
- Parameters:
aEnvKeyName
- the a env key nameaEnvKeyValue
- the a env key value- Throws:
CpeDescriptorException
- the cpe descriptor exception
-
getExecEnv
public java.util.List getExecEnv() throws CpeDescriptorException
Gets the exec env.- Returns:
- the exec env
- Throws:
CpeDescriptorException
- the cpe descriptor exception
-
removeExecEnv
public void removeExecEnv(int aIndex) throws CpeDescriptorException
Removes the exec env.- Parameters:
aIndex
- the a index- Throws:
CpeDescriptorException
- the cpe descriptor exception
-
setExecutable
public void setExecutable(java.lang.String aCasProcessorExecutable) throws CpeDescriptorException
Description copied from interface:CpeLocalCasProcessor
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.- Specified by:
setExecutable
in interfaceCpeLocalCasProcessor
- Parameters:
aCasProcessorExecutable
- - name of a program- Throws:
CpeDescriptorException
- tbd
-
getExecutable
public java.lang.String getExecutable() throws CpeDescriptorException
Description copied from interface:CpeLocalCasProcessor
Returns a name of a program to use when launching this CasProcessor- Specified by:
getExecutable
in interfaceCpeLocalCasProcessor
- Returns:
- the name of the program to execute
- Throws:
CpeDescriptorException
- tbd
-
setIsJava
public void setIsJava(boolean aJava) throws CpeDescriptorException
Description copied from interface:CpeLocalCasProcessor
Defines if this Cas Processor is a java program- Specified by:
setIsJava
in interfaceCpeLocalCasProcessor
- Parameters:
aJava
- - true if java, false otherwise- Throws:
CpeDescriptorException
- -
-
setRunInSeperateProcess
public void setRunInSeperateProcess(CasProcessorRunInSeperateProcess aSepProcess) throws CpeDescriptorException
- Specified by:
setRunInSeperateProcess
in interfaceCpeLocalCasProcessor
- Throws:
CpeDescriptorException
-
getRunInSeperateProcess
public CasProcessorRunInSeperateProcess getRunInSeperateProcess() throws CpeDescriptorException
- Specified by:
getRunInSeperateProcess
in interfaceCpeLocalCasProcessor
- Throws:
CpeDescriptorException
-
-