public class CasProcessorCpeObject extends MetaDataObject_impl implements CpeCasProcessor
MetaDataObject_impl.MetaDataAttr, MetaDataObject_impl.SerialContext, MetaDataObject_impl.Serializer
serialContext
Constructor and Description |
---|
CasProcessorCpeObject() |
Modifier and Type | Method and Description |
---|---|
protected void |
addDefaults()
Adds default configuration shared by CasProcessors
|
void |
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 CasProcessor
|
String |
getCasProcessorFilter()
Returns filter string associated with this CasProcessor
|
CpeCheckpoint |
getCheckpoint()
Returns
CpeCheckpoint object containing checkpoint
configuration ( checkpoint file, frequency of checkpoints ) |
CasProcessorConfigurationParameterSettings |
getConfigurationParameterSettings()
Returns configuration parameter settings for this CasProcessor.
|
CpeComponentDescriptor |
getCpeComponentDescriptor()
Returns the
CpeComponentDescriptor 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. Use getCpeComponentDescriptor().findAbsoluteUrl() instead.
|
CasProcessorErrorHandling |
getErrorHandling()
Returns
CasProcessorErrorHandling 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 CasProcessor
|
Parameter[] |
getParameters() |
ConfigurationParameterSettings |
getParameterSettings() |
CasProcessorRunInSeperateProcess |
getRunInSeparateProcess() |
String |
getSOFA()
Deprecated.
(non-Javadoc)
|
CpeSofaMappings |
getSofaNameMappings() |
int |
getTimeout()
Returns max millis to wait for CasProcessor response
|
protected org.xml.sax.helpers.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(CasProcessorFilter aFilter) |
void |
setCasProcessorFilter(String aFilterExpression)
Associates a filter string with this CasProcessor.
|
void |
setCheckpoint(CpeCheckpoint checkpoint) |
void |
setConfigurationParameterSettings(CasProcessorConfigurationParameterSettings settings)
Sets configuration parameter settings for this CasProcessor.
|
void |
setCpeComponentDescriptor(CpeComponentDescriptor aDescriptor)
Sets the
CpeComponentDescriptor 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 CasProcessor
|
void |
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 CasProcessor
|
void |
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.
|
buildFromXMLElement, clone, equals, getAdditionalAttributes, getAttributeClass, getAttributeValue, getInfoset, getMatchingNode, getPropertyDescriptors, getPropertyXmlInfo, getRelativePathBase, getSerialContext, getSourceUrl, getSourceUrlString, getWrapperClass, hashCode, isModifiable, listAttributes, readArrayPropertyValueFromXMLElement, readMapPropertyFromXml, readPropertyValueFromXMLElement, readUnknownPropertyValueFromXMLElement, setAttributeValue, setInfoset, setSourceUrl, setSourceUrlIfNull, toString, toXML, toXML, toXML, toXML, valueIsNullOrEmptyArray, writeArrayPropertyAsElement, writeMapPropertyToXml, writePropertyAsElement
finalize, getClass, notify, notifyAll, wait, wait, wait
clone, equals, getAttributeValue, getSourceUrl, getSourceUrlString, isModifiable, listAttributes, setAttributeValue, setSourceUrl
public void setDeployment(String aDeployMode) throws CpeDescriptorException
aDeployMode
- -
String identifying deployment typeCpeDescriptorException
- -
if invalid deployment type is providedpublic String getDeployment()
getDeployment
in interface CpeCasProcessor
public void setDescriptor(String aDescriptorPath) throws CpeDescriptorException
setDescriptor
in interface CpeCasProcessor
aDescriptorPath
- -
path to the descriptorCpeDescriptorException
- tbd@Deprecated public String getDescriptor()
getDescriptor
in interface CpeCasProcessor
public CpeComponentDescriptor getCpeComponentDescriptor()
CpeComponentDescriptor
instance associated with this Cas Processor. That
object contains a path to the component descriptor.getCpeComponentDescriptor
in interface CpeCasProcessor
CpeComponentDescriptor
instancepublic void setCasProcessorFilter(String aFilterExpression)
setCasProcessorFilter
in interface CpeCasProcessor
aFilterExpression
- -
String containing a filterpublic String getCasProcessorFilter()
getCasProcessorFilter
in interface CpeCasProcessor
protected void addDefaults() throws CpeDescriptorException
CpeDescriptorException
- tbdpublic void setBatchSize(int aBatchSize)
setBatchSize
in interface CpeCasProcessor
aBatchSize
- -
batch size of this CasProcessorpublic int getBatchSize()
getBatchSize
in interface CpeCasProcessor
public void addDeployParam(String aParamName, String aParamValue) throws CpeDescriptorException
addDeployParam
in interface CpeCasProcessor
aParamName
- -
name of the new parameteraParamValue
- -
value of the new parameterCpeDescriptorException
- tbdprotected void setDeploymentParams(CasProcessorDeploymentParams aParams) throws CpeDescriptorException
aParams
- CpeDescriptorException
- tbdpublic CasProcessorDeploymentParams getDeploymentParams()
getDeploymentParams
in interface CpeCasProcessor
instance
public void setName(String aName) throws CpeDescriptorException
setName
in interface CpeCasProcessor
aName
- -
name as stringCpeDescriptorException
- tbdpublic String getName()
getName
in interface CpeCasProcessor
@Deprecated public void setSOFA(String aSoFa) throws CpeDescriptorException
setSOFA
in interface CpeCasProcessor
aSoFa
- CpeDescriptorException
- tbd@Deprecated public String getSOFA()
getSOFA
in interface CpeCasProcessor
CpeCasProcessor.getSOFA()
public void setCpeComponentDescriptor(CpeComponentDescriptor aDescriptor) throws CpeDescriptorException
CpeCasProcessor
CpeComponentDescriptor
instance associated with this Cas Processor. That
object contains a path to the component descriptor.setCpeComponentDescriptor
in interface CpeCasProcessor
aDescriptor
- CpeComponentDescriptor
instanceCpeDescriptorException
- tbdpublic void setCasProcessorFilter(CasProcessorFilter aFilter) throws CpeDescriptorException
CpeDescriptorException
public void setErrorHandling(CasProcessorErrorHandling aErrorHandling) throws CpeDescriptorException
CpeDescriptorException
public CasProcessorErrorHandling getErrorHandling()
CpeCasProcessor
CasProcessorErrorHandling
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.getErrorHandling
in interface CpeCasProcessor
CasProcessorErrorHandling
public void setMaxErrorCount(int aErrorCount)
setMaxErrorCount
in interface CpeCasProcessor
aErrorCount
- -
max error tolerancepublic int getMaxErrorCount()
getMaxErrorCount
in interface CpeCasProcessor
public void setMaxErrorSampleSize(int aErrorSampleSize)
setMaxErrorSampleSize
in interface CpeCasProcessor
aErrorSampleSize
- -
max error tolerancepublic int getMaxErrorSampleSize()
getMaxErrorSampleSize
in interface CpeCasProcessor
public void setActionOnMaxError(String aAction)
setActionOnMaxError
in interface CpeCasProcessor
aAction
- -
action stringpublic String getActionOnMaxError()
getActionOnMaxError
in interface CpeCasProcessor
public void setActionOnMaxRestart(String aAction)
setActionOnMaxRestart
in interface CpeCasProcessor
aAction
- -
action stringpublic String getActionOnMaxRestart()
getActionOnMaxRestart
in interface CpeCasProcessor
public void setMaxRestartCount(int aRestartCount)
setMaxRestartCount
in interface CpeCasProcessor
aRestartCount
- -
max number of restartspublic int getMaxRestartCount()
getMaxRestartCount
in interface CpeCasProcessor
public void setTimeout(int aTimeoutValue)
setTimeout
in interface CpeCasProcessor
aTimeoutValue
- -
millis to wait for responsepublic int getTimeout()
getTimeout
in interface CpeCasProcessor
public void setConfigurationParameterSettings(CasProcessorConfigurationParameterSettings settings) throws CpeDescriptorException
setConfigurationParameterSettings
in interface CpeCasProcessor
settings
- object containing parameter setting overridesCpeDescriptorException
- tbdpublic CasProcessorConfigurationParameterSettings getConfigurationParameterSettings()
getConfigurationParameterSettings
in interface CpeCasProcessor
public void setParameterSettings(ConfigurationParameterSettings settings)
settings
- public ConfigurationParameterSettings getParameterSettings()
public Parameter[] getParameters()
public CasProcessorFilter getFilter()
public void setCheckpoint(CpeCheckpoint checkpoint)
checkpoint
- public void setParameters(Parameter[] aparameters)
aparameters
- public void setFilter(CasProcessorFilter aFilter)
aFilter
- public CasProcessorRunInSeperateProcess getRunInSeparateProcess()
getRunInSeparateProcess
in interface CpeCasProcessor
public void setRunInSeparateProcess(CasProcessorRunInSeperateProcess process)
process
- container with configuration info for running CasProcessor in separate processpublic CasProcessorDeploymentParams getDeploymentParameters()
public void setDeploymentParameters(CasProcessorDeploymentParams parameters)
parameters
- deployment parameterspublic void buildFromXMLElement(Element aElement, XMLParser aParser, XMLParser.ParsingOptions aOptions) throws InvalidXMLException
buildFromXMLElement
in interface XMLizable
buildFromXMLElement
in class MetaDataObject_impl
aElement
- the XML element that represents this object.aParser
- a reference to the UIMA XMLParser
. The
XMLParser.buildObject(Element)
method can be used to construct sub-objects.aOptions
- option settingsInvalidXMLException
- if the input XML element does not specify a valid objectMetaDataObject_impl.buildFromXMLElement(org.w3c.dom.Element,
org.apache.uima.util.XMLParser, org.apache.uima.util.XMLParser.ParsingOptions)
protected org.xml.sax.helpers.AttributesImpl getXMLAttributes()
getXMLAttributes
in class MetaDataObject_impl
MetaDataObject_impl.getXMLAttributes()
protected XmlizationInfo getXmlizationInfo()
MetaDataObject_impl
getXmlizationInfo
in class MetaDataObject_impl
public CpeCheckpoint getCheckpoint()
CpeCasProcessor
CpeCheckpoint
object containing checkpoint
configuration ( checkpoint file, frequency of checkpoints )getCheckpoint
in interface CpeCasProcessor
public CpeSofaMappings getSofaNameMappings()
getSofaNameMappings
in interface CpeCasProcessor
public void setSofaNameMappings(CpeSofaMappings mappings)
setSofaNameMappings
in interface CpeCasProcessor
mappings
- sofa name mappingspublic void setIsParallelizable(boolean isP)
setIsParallelizable
in interface CpeCasProcessor
public boolean getIsParallelizable()
getIsParallelizable
in interface CpeCasProcessor
Copyright © 2015. All rights reserved.