Interface CpeCasProcessor
- All Superinterfaces:
Cloneable,MetaDataObject,Serializable,XMLizable
- All Known Subinterfaces:
CpeIntegratedCasProcessor,CpeLocalCasProcessor,CpeRemoteCasProcessor
An object that holds configuration that is part of the CPE descriptor. It provides the means of
configuring behavior that is common to all CasProcessor types.
-
Method Summary
Modifier and TypeMethodDescriptionvoidaddDeployParam(String aParamName, String aParamValue) Adds deployment parameter used by the CPE when launching CasProcessorReturns strategy for dealing with exceeding error thresholds.Returns strategy for dealing with exceeding error thresholds.intReturns CasProcessor batch sizeReturns CasProcessor filter expression.ReturnsCpeCheckpointobject containing checkpoint configuration ( checkpoint file, frequency of checkpoints )ReturnsCasProcessorConfigurationParameterSettingsobject containing overrides to parameter settings for this CAS Processor.Returns theCpeComponentDescriptorinstance associated with this Cas Processor.Returns CasProcessor deployment type.ReturnsCasProcessorDeploymentParamsobject containing deployment parameters used for launching CasProcessor.Deprecated.Doesn't support the new import syntax.ReturnsCasProcessorErrorHandlingobject containing strategies to deal with errors that may occur during processing.booleanintReturns the max number of errors tolerated by the CPE.intReturns sample size.intReturns max restarts threshold fro CasProcessorgetName()Returns CasProcessor's namegetSOFA()intReturns the timeout value.voidsetActionOnMaxError(String aAction) Sets a strategy for dealing with exceeding error thresholds.voidsetActionOnMaxRestart(String aAction) Sets strategy for dealing with exceeding error thresholds.voidsetBatchSize(int aBatchSize) Sets CasProcessor's batch size.voidsetCasProcessorFilter(String aFilterExpression) Sets CasProcessor filter expression used by the CPE to route CASs.voidSets theCasProcessorConfigurationParameterSettingsobject containing overrides to parameter settings for this CAS Processor.voidsetCpeComponentDescriptor(CpeComponentDescriptor aDescriptor) Sets theCpeComponentDescriptorinstance associated with this Cas Processor.voidsetDescriptor(String aDescriptor) Deprecated.Doesn't support the new import syntax.voidsetIsParallelizable(boolean isP) voidsetMaxErrorCount(int aErrorCount) Sets the max number of errors tolerated by the CPE.voidsetMaxErrorSampleSize(int aErrorSampleSize) Sets the sample size.voidsetMaxRestartCount(int aErrorCount) Sets max tolerated restarts threshold for CasProcessorvoidSets CasProcessor's namevoidvoidsetSofaNameMappings(CpeSofaMappings mappings) voidsetTimeout(int aTimeoutValue) Sets the timeout value.Methods 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
-
setName
Sets CasProcessor's name- Parameters:
aName- - CasProcessor name- Throws:
CpeDescriptorException- tbd
-
getName
String getName()Returns CasProcessor's name- Returns:
- - name
-
setSOFA
- Throws:
CpeDescriptorException
-
getSOFA
String getSOFA() -
setDescriptor
Deprecated.Doesn't support the new import syntax. Use setCpeComponentDescriptor() instead.Sets CasProcessor descriptor path.- Parameters:
aDescriptor- - descriptor path- Throws:
CpeDescriptorException- tbd
-
getDescriptor
Deprecated.Doesn't support the new import syntax. Use getCpeComponentDescriptor().findAbsoluteUrl() instead.Returns CasProcessor descriptor.- Returns:
- descriptor
-
getCpeComponentDescriptor
CpeComponentDescriptor getCpeComponentDescriptor()Returns theCpeComponentDescriptorinstance associated with this Cas Processor. That object contains a path to the component descriptor.- Returns:
CpeComponentDescriptorinstance
-
setCpeComponentDescriptor
Sets theCpeComponentDescriptorinstance associated with this Cas Processor. That object contains a path to the component descriptor.- Parameters:
aDescriptor-CpeComponentDescriptorinstance- Throws:
CpeDescriptorException- tbd
-
getDeployment
String getDeployment()Returns CasProcessor deployment type. Three types are currently supported:- integrated
- remote
- local
- Returns:
- - deployment mode
-
setCasProcessorFilter
Sets CasProcessor filter expression used by the CPE to route CASs. A CasProcessor can be configured in the CPE Descriptor to use filtering using an SQL-like WHERE clause: where featurespec [ and featurespec2 ...]. The featurespec can be one of these four forms and meanings:- Feature Process CAS if the Feature is present (e.g. where Person)
- Feature! Process CAS if the Feature is not present (e.g. where Person!)
- Feature=value Process CAS if the Feature has this value( e.g. where Person=Bush)
- Feature!=value Process CAS if the Feature does not have this value (e.g. where Person!=Bush)
- Parameters:
aFilterExpression- - filter- Throws:
CpeDescriptorException- tbd
-
getCasProcessorFilter
String getCasProcessorFilter()Returns CasProcessor filter expression. A CasProcessor can be configured in the CPE Descriptor to use filtering using an SQL-like WHERE clause: where featurespec [ and featurespec2 ...]. The featurespec can be one of these four forms and meanings:- Feature Process CAS if the Feature is present (e.g. where Person)
- Feature! Process CAS if the Feature is not present (e.g. where Person!)
- Feature=value Process CAS if the Feature has this value( e.g. where Person=Bush)
- Feature!=value Process CAS if the Feature does not have this value (e.g. where Person!=Bush)
- Returns:
- - filter expression
-
setBatchSize
void setBatchSize(int aBatchSize) Sets CasProcessor's batch size.- Parameters:
aBatchSize- - size of CasProcessor batch
-
getBatchSize
int getBatchSize()Returns CasProcessor batch size- Returns:
- - batch size
-
getErrorHandling
CasProcessorErrorHandling getErrorHandling()ReturnsCasProcessorErrorHandlingobject containing strategies to deal with errors that may occur during processing. This object provides the means of modifying error thresholds and actions to take when error thresholds are exceeded.- Returns:
CasProcessorErrorHandling
-
getCheckpoint
CpeCheckpoint getCheckpoint()ReturnsCpeCheckpointobject containing checkpoint configuration ( checkpoint file, frequency of checkpoints )- Returns:
CasProcessorErrorHandling
-
getDeploymentParams
CasProcessorDeploymentParams getDeploymentParams()ReturnsCasProcessorDeploymentParamsobject containing deployment parameters used for launching CasProcessor. This object provides the means of adding, getting, and removingCasProcessorDeploymentParamobjects.- Returns:
- - object containing list of
CasProcessorDeploymentParam
-
setMaxErrorCount
void setMaxErrorCount(int aErrorCount) Sets the max number of errors tolerated by the CPE. If the the threshold is exceeded the CPE will take an action based on defined strategy. Max Error is defined in terms of a quotient, like 3/1000. Where 3 is the actual max error tolerance and 1000 is a sample size. So the above is interpreted as 3 errors per thousand entities processed.- Parameters:
aErrorCount- - max error threshold
-
getMaxErrorCount
int getMaxErrorCount()Returns the max number of errors tolerated by the CPE. If the the threshold is exceeded the CPE will take an action based on defined strategy. Max Error is defined in terms of a quotient, like 3/1000. Where 3 is the actual max error tolerance and 1000 is a sample size. So the above is interpreted as 3 errors per thousand entities processed.- Returns:
- - max error threshold
-
setMaxErrorSampleSize
void setMaxErrorSampleSize(int aErrorSampleSize) Sets the sample size. Max Error is defined in terms of a quotient, like 3/1000. Where 3 is the actual max error tolerance and 1000 is a sample size. So the above is interpreted as 3 errors per thousand entities processed.- Parameters:
aErrorSampleSize- the sample size
-
getMaxErrorSampleSize
int getMaxErrorSampleSize()Returns sample size. Max Error is defined in terms of a quotient, like 3/1000. Where 3 is the actual max error tolerance and 1000 is a sample size. So the above is interpreted as 3 errors per thousand entities processed.- Returns:
- - sample size
-
setActionOnMaxError
Sets a strategy for dealing with exceeding error thresholds. The three supported strategies are:- terminate - termines the CPE
- continue - continue despite the error
- disable - disable CasProcessor
- Parameters:
aAction- - action to take
-
getActionOnMaxError
String getActionOnMaxError()Returns strategy for dealing with exceeding error thresholds. The three supported strategies are:- terminate - termines the CPE
- continue - continue despite the error
- disable - disable CasProcessor
- Returns:
- - action to take
-
setMaxRestartCount
void setMaxRestartCount(int aErrorCount) Sets max tolerated restarts threshold for CasProcessor- Parameters:
aErrorCount- - max restart count
-
getMaxRestartCount
int getMaxRestartCount()Returns max restarts threshold fro CasProcessor- Returns:
- - max restart count
-
setActionOnMaxRestart
Sets strategy for dealing with exceeding error thresholds. The three supported strategies are:- terminate - termines the CPE
- continue - continue despite the error
- disable - disable CasProcessor
- Parameters:
aAction- - action to take
-
getActionOnMaxRestart
String getActionOnMaxRestart()Returns strategy for dealing with exceeding error thresholds. The three supported strategies are:- terminate - termines the CPE
- continue - continue despite the error
- disable - disable CasProcessor
- Returns:
- the action to take when the error threshold is exceeded
-
setTimeout
void setTimeout(int aTimeoutValue) Sets the timeout value. The amount of time the CPE will wait for response from CasProcessor- Parameters:
aTimeoutValue- - timeout value
-
getTimeout
int getTimeout()Returns the timeout value. The amount of time the CPE will wait for response from CasProcessor- Returns:
- - timeout value
-
addDeployParam
Adds deployment parameter used by the CPE when launching CasProcessor- Parameters:
aParamName- - param nameaParamValue- - param value- Throws:
CpeDescriptorException- tbd
-
getConfigurationParameterSettings
CasProcessorConfigurationParameterSettings getConfigurationParameterSettings()ReturnsCasProcessorConfigurationParameterSettingsobject containing overrides to parameter settings for this CAS Processor.- Returns:
- - object containing parameter setting overrides
-
setConfigurationParameterSettings
void setConfigurationParameterSettings(CasProcessorConfigurationParameterSettings aSettings) throws CpeDescriptorException Sets theCasProcessorConfigurationParameterSettingsobject containing overrides to parameter settings for this CAS Processor.- Parameters:
aSettings- object containing parameter setting overrides- Throws:
CpeDescriptorException- tbd
-
getSofaNameMappings
CpeSofaMappings getSofaNameMappings() -
setSofaNameMappings
- Parameters:
mappings- -
-
getRunInSeparateProcess
CasProcessorRunInSeperateProcess getRunInSeparateProcess() -
setIsParallelizable
void setIsParallelizable(boolean isP) -
getIsParallelizable
boolean getIsParallelizable()
-