Class CasProcessorCpeObject
- java.lang.Object
-
- org.apache.uima.resource.metadata.impl.MetaDataObject_impl
-
- org.apache.uima.collection.impl.metadata.cpe.CasProcessorCpeObject
-
- All Implemented Interfaces:
Serializable
,Cloneable
,CpeCasProcessor
,MetaDataObject
,XMLizable
- Direct Known Subclasses:
CpeIntegratedCasProcessorImpl
,CpeLocalCasProcessorImpl
,CpeRemoteCasProcessorImpl
public class CasProcessorCpeObject extends MetaDataObject_impl implements CpeCasProcessor
Base class for all CpeCasProcessor objects in the reference implementation. Provides support for getting and setting common configuration settings shared by all CpeCasProcessor objects- 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 inherited from class org.apache.uima.resource.metadata.impl.MetaDataObject_impl
serialContext
-
-
Constructor Summary
Constructors Constructor Description CasProcessorCpeObject()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected void
addDefaults()
Adds default configuration shared by CasProcessorsvoid
addDeployParam(String aParamName, String aParamValue)
Adds a given deployment param to the param list.void
buildFromXMLElement(Element aElement, XMLParser aParser, XMLParser.ParsingOptions aOptions)
Overridden to read "name" and "value" attributes.String
getActionOnMaxError()
Return action associated with CasProcessor error tolerance.String
getActionOnMaxRestart()
Return action associated with CasProcessor restart tolerance.int
getBatchSize()
Returns a batch size associated with this CasProcessorString
getCasProcessorFilter()
Returns filter string associated with this CasProcessorCpeCheckpoint
getCheckpoint()
ReturnsCpeCheckpoint
object containing checkpoint configuration ( checkpoint file, frequency of checkpoints )CasProcessorConfigurationParameterSettings
getConfigurationParameterSettings()
Returns configuration parameter settings for this CasProcessor.CpeComponentDescriptor
getCpeComponentDescriptor()
Returns theCpeComponentDescriptor
instance associated with this Cas Processor.String
getDeployment()
Returns deployment type associated with this CasProcessor.CasProcessorDeploymentParams
getDeploymentParameters()
CasProcessorDeploymentParams
getDeploymentParams()
Returns deployment parameters for this CasProcessor.String
getDescriptor()
Deprecated.Doesn't support the new import syntax.CasProcessorErrorHandling
getErrorHandling()
ReturnsCasProcessorErrorHandling
object containing strategies to deal with errors that may occur during processing.CasProcessorFilter
getFilter()
boolean
getIsParallelizable()
int
getMaxErrorCount()
Associates a threshold for maximum error tolerance.int
getMaxErrorSampleSize()
Returns error sample size.int
getMaxRestartCount()
Returns max restart tolerance for this CasProcessor.String
getName()
Returns a name of this CasProcessorParameter[]
getParameters()
ConfigurationParameterSettings
getParameterSettings()
CasProcessorRunInSeperateProcess
getRunInSeparateProcess()
String
getSOFA()
Deprecated.(non-Javadoc)CpeSofaMappings
getSofaNameMappings()
int
getTimeout()
Returns max millis to wait for CasProcessor responseprotected AttributesImpl
getXMLAttributes()
Overridden to handle "name" and "value" attributes.protected XmlizationInfo
getXmlizationInfo()
To be implemented by subclasses to return information describing how to represent this object in XML.void
setActionOnMaxError(String aAction)
Associates action in the event the errors exceed max tolerance.void
setActionOnMaxRestart(String aAction)
Associates action in the event CasProcessor restarts exceed max tolerance.void
setBatchSize(int aBatchSize)
Associates a batch size with this CasProcessor.void
setCasProcessorFilter(String aFilterExpression)
Associates a filter string with this CasProcessor.void
setCasProcessorFilter(CasProcessorFilter aFilter)
void
setCheckpoint(CpeCheckpoint checkpoint)
void
setConfigurationParameterSettings(CasProcessorConfigurationParameterSettings settings)
Sets configuration parameter settings for this CasProcessor.void
setCpeComponentDescriptor(CpeComponentDescriptor aDescriptor)
Sets theCpeComponentDescriptor
instance associated with this Cas Processor.void
setDeployment(String aDeployMode)
Associates deployment type with for this CasProcessor.void
setDeploymentParameters(CasProcessorDeploymentParams parameters)
protected void
setDeploymentParams(CasProcessorDeploymentParams aParams)
void
setDescriptor(String aDescriptorPath)
Associates a given descriptor path with this CasProcessorvoid
setErrorHandling(CasProcessorErrorHandling aErrorHandling)
void
setFilter(CasProcessorFilter aFilter)
void
setIsParallelizable(boolean isP)
void
setMaxErrorCount(int aErrorCount)
Associates a threshold for maximum error tolerance.void
setMaxErrorSampleSize(int aErrorSampleSize)
Associates a threshold for maximum error tolerance.void
setMaxRestartCount(int aRestartCount)
Associates max tolerance for CasProcessor restarts.void
setName(String aName)
Associates a name with this CasProcessorvoid
setParameters(Parameter[] aparameters)
void
setParameterSettings(ConfigurationParameterSettings settings)
void
setRunInSeparateProcess(CasProcessorRunInSeperateProcess process)
void
setSOFA(String aSoFa)
Deprecated.void
setSofaNameMappings(CpeSofaMappings mappings)
void
setTimeout(int aTimeoutValue)
Associates timeout in terms of ms, with this CasProcessor.-
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.resource.metadata.MetaDataObject
clone, equals, getAttributeValue, getSourceUrl, getSourceUrlString, isModifiable, listAttributes, setAttributeValue, setSourceUrl
-
-
-
-
Method Detail
-
setDeployment
public void setDeployment(String aDeployMode) throws CpeDescriptorException
Associates deployment type with for this CasProcessor. Three types are currently supported:- integrated - CasProcessor is collocated with the CPM
- local - CasProcessor runs on the same machine as the CPM however in a different process
- remote - CasProcessor runs on remote machine
- Parameters:
aDeployMode
- - String identifying deployment type- Throws:
CpeDescriptorException
- - if invalid deployment type is provided
-
getDeployment
public String getDeployment()
Returns deployment type associated with this CasProcessor.- Specified by:
getDeployment
in interfaceCpeCasProcessor
- Returns:
- String - deployment type
-
setDescriptor
public void setDescriptor(String aDescriptorPath) throws CpeDescriptorException
Associates a given descriptor path with this CasProcessor- Specified by:
setDescriptor
in interfaceCpeCasProcessor
- Parameters:
aDescriptorPath
- - path to the descriptor- Throws:
CpeDescriptorException
- tbd
-
getDescriptor
@Deprecated public String getDescriptor()
Deprecated.Doesn't support the new import syntax. Use getCpeComponentDescriptor().findAbsoluteUrl() instead.Returns a descriptor path associated with this CasProcessor- Specified by:
getDescriptor
in interfaceCpeCasProcessor
- Returns:
- String - descriptor path
-
getCpeComponentDescriptor
public CpeComponentDescriptor getCpeComponentDescriptor()
Returns theCpeComponentDescriptor
instance associated with this Cas Processor. That object contains a path to the component descriptor.- Specified by:
getCpeComponentDescriptor
in interfaceCpeCasProcessor
- Returns:
CpeComponentDescriptor
instance
-
setCasProcessorFilter
public void setCasProcessorFilter(String aFilterExpression)
Associates a filter string with this CasProcessor. A filter provides a mechanism that facilitates efficient routing of Cas's to the CasProcessor.- Specified by:
setCasProcessorFilter
in interfaceCpeCasProcessor
- Parameters:
aFilterExpression
- - String containing a filter
-
getCasProcessorFilter
public String getCasProcessorFilter()
Returns filter string associated with this CasProcessor- Specified by:
getCasProcessorFilter
in interfaceCpeCasProcessor
- Returns:
- String - a filter string
-
addDefaults
protected void addDefaults() throws CpeDescriptorException
Adds default configuration shared by CasProcessors- Throws:
CpeDescriptorException
- tbd
-
setBatchSize
public void setBatchSize(int aBatchSize)
Associates a batch size with this CasProcessor.- Specified by:
setBatchSize
in interfaceCpeCasProcessor
- Parameters:
aBatchSize
- - batch size of this CasProcessor
-
getBatchSize
public int getBatchSize()
Returns a batch size associated with this CasProcessor- Specified by:
getBatchSize
in interfaceCpeCasProcessor
- Returns:
- - batch size as int, 0 if not defined.
-
addDeployParam
public void addDeployParam(String aParamName, String aParamValue) throws CpeDescriptorException
Adds a given deployment param to the param list. If a param with a given name exists in the list its value will be over-written.- Specified by:
addDeployParam
in interfaceCpeCasProcessor
- Parameters:
aParamName
- - name of the new parameteraParamValue
- - value of the new parameter- Throws:
CpeDescriptorException
- tbd
-
setDeploymentParams
protected void setDeploymentParams(CasProcessorDeploymentParams aParams) throws CpeDescriptorException
- Parameters:
aParams
-- Throws:
CpeDescriptorException
- tbd
-
getDeploymentParams
public CasProcessorDeploymentParams getDeploymentParams()
Returns deployment parameters for this CasProcessor.- Specified by:
getDeploymentParams
in interfaceCpeCasProcessor
- Returns:
- the deployment parameters
- See Also:
instance
-
setName
public void setName(String aName) throws CpeDescriptorException
Associates a name with this CasProcessor- Specified by:
setName
in interfaceCpeCasProcessor
- Parameters:
aName
- - name as string- Throws:
CpeDescriptorException
- tbd
-
getName
public String getName()
Returns a name of this CasProcessor- Specified by:
getName
in interfaceCpeCasProcessor
- Returns:
- - CasProcessor name as string, null if name undefined
-
setSOFA
@Deprecated public void setSOFA(String aSoFa) throws CpeDescriptorException
Deprecated.- Specified by:
setSOFA
in interfaceCpeCasProcessor
- Parameters:
aSoFa
-- Throws:
CpeDescriptorException
- tbd
-
getSOFA
@Deprecated public String getSOFA()
Deprecated.(non-Javadoc)- Specified by:
getSOFA
in interfaceCpeCasProcessor
- See Also:
CpeCasProcessor.getSOFA()
-
setCpeComponentDescriptor
public void setCpeComponentDescriptor(CpeComponentDescriptor aDescriptor) throws CpeDescriptorException
Description copied from interface:CpeCasProcessor
Sets theCpeComponentDescriptor
instance associated with this Cas Processor. That object contains a path to the component descriptor.- Specified by:
setCpeComponentDescriptor
in interfaceCpeCasProcessor
- Parameters:
aDescriptor
-CpeComponentDescriptor
instance- Throws:
CpeDescriptorException
- tbd
-
setCasProcessorFilter
public void setCasProcessorFilter(CasProcessorFilter aFilter) throws CpeDescriptorException
- Throws:
CpeDescriptorException
-
setErrorHandling
public void setErrorHandling(CasProcessorErrorHandling aErrorHandling) throws CpeDescriptorException
- Throws:
CpeDescriptorException
-
getErrorHandling
public CasProcessorErrorHandling getErrorHandling()
Description copied from interface:CpeCasProcessor
ReturnsCasProcessorErrorHandling
object 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.- Specified by:
getErrorHandling
in interfaceCpeCasProcessor
- Returns:
CasProcessorErrorHandling
-
setMaxErrorCount
public void setMaxErrorCount(int aErrorCount)
Associates a threshold for maximum error tolerance. Errors are defined in terms as a quotient. For example, 4/1000 which means max 4 errors per thousand (sample size) CAS's processed. The sample size is defined seperately.- Specified by:
setMaxErrorCount
in interfaceCpeCasProcessor
- Parameters:
aErrorCount
- - max error tolerance
-
getMaxErrorCount
public int getMaxErrorCount()
Associates a threshold for maximum error tolerance. Errors are defined in terms as a quotient. For example, 4/1000 which means max 4 errors per thousand (sample size) CAS's processed. The sample size is defined seperately.- Specified by:
getMaxErrorCount
in interfaceCpeCasProcessor
- Returns:
- max error tolerance
-
setMaxErrorSampleSize
public void setMaxErrorSampleSize(int aErrorSampleSize)
Associates a threshold for maximum error tolerance. Errors are defined in terms as a quotient. For example, 4/1000 which means max 4 errors per thousand (sample size) CAS's processed. The sample size is defined seperately.- Specified by:
setMaxErrorSampleSize
in interfaceCpeCasProcessor
- Parameters:
aErrorSampleSize
- - max error tolerance
-
getMaxErrorSampleSize
public int getMaxErrorSampleSize()
Returns error sample size. The value is used to determine the max error tolerance for this CasProcessor. Error thresholds are defines as quotients. Error Count / Sample Size for example, 3/1000, which means 3 errors per thousand.- Specified by:
getMaxErrorSampleSize
in interfaceCpeCasProcessor
- Returns:
- - the sample size
-
setActionOnMaxError
public void setActionOnMaxError(String aAction)
Associates action in the event the errors exceed max tolerance. In such case, the action determines appropriate strategy ( terminate, continue, disable).- Specified by:
setActionOnMaxError
in interfaceCpeCasProcessor
- Parameters:
aAction
- - action string
-
getActionOnMaxError
public String getActionOnMaxError()
Return action associated with CasProcessor error tolerance.- Specified by:
getActionOnMaxError
in interfaceCpeCasProcessor
- Returns:
- - action as string ( terminate, continue, disable), null when not defined
-
setActionOnMaxRestart
public void setActionOnMaxRestart(String aAction)
Associates action in the event CasProcessor restarts exceed max tolerance. In such case, the action determines appropriate strategy ( terminate, continue, disable).- Specified by:
setActionOnMaxRestart
in interfaceCpeCasProcessor
- Parameters:
aAction
- - action string
-
getActionOnMaxRestart
public String getActionOnMaxRestart()
Return action associated with CasProcessor restart tolerance.- Specified by:
getActionOnMaxRestart
in interfaceCpeCasProcessor
- Returns:
- - action as string ( terminate, continue, disable), null when not defined
-
setMaxRestartCount
public void setMaxRestartCount(int aRestartCount)
Associates max tolerance for CasProcessor restarts.- Specified by:
setMaxRestartCount
in interfaceCpeCasProcessor
- Parameters:
aRestartCount
- - max number of restarts
-
getMaxRestartCount
public int getMaxRestartCount()
Returns max restart tolerance for this CasProcessor.- Specified by:
getMaxRestartCount
in interfaceCpeCasProcessor
- Returns:
- - restart count as int, 0 if not defined
-
setTimeout
public void setTimeout(int aTimeoutValue)
Associates timeout in terms of ms, with this CasProcessor. It is the max number of millis to wait for response.- Specified by:
setTimeout
in interfaceCpeCasProcessor
- Parameters:
aTimeoutValue
- - millis to wait for response
-
getTimeout
public int getTimeout()
Returns max millis to wait for CasProcessor response- Specified by:
getTimeout
in interfaceCpeCasProcessor
- Returns:
- - millis, 0 if not defined
-
setConfigurationParameterSettings
public void setConfigurationParameterSettings(CasProcessorConfigurationParameterSettings settings) throws CpeDescriptorException
Sets configuration parameter settings for this CasProcessor.- Specified by:
setConfigurationParameterSettings
in interfaceCpeCasProcessor
- Parameters:
settings
- object containing parameter setting overrides- Throws:
CpeDescriptorException
- tbd
-
getConfigurationParameterSettings
public CasProcessorConfigurationParameterSettings getConfigurationParameterSettings()
Returns configuration parameter settings for this CasProcessor.- Specified by:
getConfigurationParameterSettings
in interfaceCpeCasProcessor
- Returns:
- - object containing parameter setting overrides
-
setParameterSettings
public void setParameterSettings(ConfigurationParameterSettings settings)
- Parameters:
settings
-
-
getParameterSettings
public ConfigurationParameterSettings getParameterSettings()
- Returns:
- configuration parameter settings
-
getParameters
public Parameter[] getParameters()
- Returns:
- parameters
-
getFilter
public CasProcessorFilter getFilter()
- Returns:
- filter
-
setCheckpoint
public void setCheckpoint(CpeCheckpoint checkpoint)
- Parameters:
checkpoint
-
-
setParameters
public void setParameters(Parameter[] aparameters)
- Parameters:
aparameters
-
-
setFilter
public void setFilter(CasProcessorFilter aFilter)
- Parameters:
aFilter
-
-
getRunInSeparateProcess
public CasProcessorRunInSeperateProcess getRunInSeparateProcess()
- Specified by:
getRunInSeparateProcess
in interfaceCpeCasProcessor
- Returns:
- container with configuration info for running CasProcessor in separate process
-
setRunInSeparateProcess
public void setRunInSeparateProcess(CasProcessorRunInSeperateProcess process)
- Parameters:
process
- container with configuration info for running CasProcessor in separate process
-
getDeploymentParameters
public CasProcessorDeploymentParams getDeploymentParameters()
- Returns:
- deployment parameters
-
setDeploymentParameters
public void setDeploymentParameters(CasProcessorDeploymentParams parameters)
- Parameters:
parameters
- deployment parameters
-
buildFromXMLElement
public void buildFromXMLElement(Element aElement, XMLParser aParser, XMLParser.ParsingOptions aOptions) throws InvalidXMLException
Overridden to read "name" and "value" attributes.- Specified by:
buildFromXMLElement
in interfaceXMLizable
- Overrides:
buildFromXMLElement
in classMetaDataObject_impl
- Parameters:
aElement
- the XML element that represents this object.aParser
- a reference to the UIMAXMLParser
. TheXMLParser.buildObject(Element)
method can be used to construct sub-objects.aOptions
- option settings- Throws:
InvalidXMLException
- if the input XML element does not specify a valid object- See Also:
MetaDataObject_impl.buildFromXMLElement(org.w3c.dom.Element, org.apache.uima.util.XMLParser, org.apache.uima.util.XMLParser.ParsingOptions)
-
getXMLAttributes
protected AttributesImpl getXMLAttributes()
Overridden to handle "name" and "value" attributes.- Overrides:
getXMLAttributes
in classMetaDataObject_impl
- Returns:
- an object defining the attributes to be written to the XML
- See Also:
MetaDataObject_impl.getXMLAttributes()
-
getXmlizationInfo
protected XmlizationInfo getXmlizationInfo()
Description copied from class:MetaDataObject_impl
To be implemented by subclasses to return information describing how to represent this object in XML.- Specified by:
getXmlizationInfo
in classMetaDataObject_impl
- Returns:
- information defining this object's XML representation
-
getCheckpoint
public CpeCheckpoint getCheckpoint()
Description copied from interface:CpeCasProcessor
ReturnsCpeCheckpoint
object containing checkpoint configuration ( checkpoint file, frequency of checkpoints )- Specified by:
getCheckpoint
in interfaceCpeCasProcessor
- Returns:
- configuration for a checkpoint
-
getSofaNameMappings
public CpeSofaMappings getSofaNameMappings()
- Specified by:
getSofaNameMappings
in interfaceCpeCasProcessor
- Returns:
- sofa name mappings
-
setSofaNameMappings
public void setSofaNameMappings(CpeSofaMappings mappings)
- Specified by:
setSofaNameMappings
in interfaceCpeCasProcessor
- Parameters:
mappings
- sofa name mappings
-
setIsParallelizable
public void setIsParallelizable(boolean isP)
- Specified by:
setIsParallelizable
in interfaceCpeCasProcessor
-
getIsParallelizable
public boolean getIsParallelizable()
- Specified by:
getIsParallelizable
in interfaceCpeCasProcessor
-
-