public class CasProcessorCpeObject
extends org.apache.uima.resource.metadata.impl.MetaDataObject_impl
implements org.apache.uima.collection.metadata.CpeCasProcessor
org.apache.uima.resource.metadata.impl.MetaDataObject_impl.MetaDataAttr, org.apache.uima.resource.metadata.impl.MetaDataObject_impl.SerialContext, org.apache.uima.resource.metadata.impl.MetaDataObject_impl.Serializer| 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,
org.apache.uima.util.XMLParser aParser,
org.apache.uima.util.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.
|
org.apache.uima.collection.metadata.CpeCheckpoint |
getCheckpoint()
Gets the checkpoint.
|
org.apache.uima.collection.metadata.CasProcessorConfigurationParameterSettings |
getConfigurationParameterSettings()
Returns configuration parameter settings for this CasProcessor.
|
org.apache.uima.collection.metadata.CpeComponentDescriptor |
getCpeComponentDescriptor()
Returns the
CpeComponentDescriptor instance associated with this Cas Processor. |
String |
getDeployment()
Returns deployment type associated with this CasProcessor.
|
org.apache.uima.collection.metadata.CasProcessorDeploymentParams |
getDeploymentParameters()
Gets the deployment parameters.
|
org.apache.uima.collection.metadata.CasProcessorDeploymentParams |
getDeploymentParams()
Returns deployment parameters for this CasProcessor.
|
String |
getDescriptor()
Deprecated.
Doesn't support the new import syntax. Use getCpeComponentDescriptor().findAbsoluteUrl() instead.
|
org.apache.uima.collection.metadata.CasProcessorErrorHandling |
getErrorHandling() |
org.apache.uima.collection.metadata.CasProcessorFilter |
getFilter()
Gets the filter.
|
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.
|
org.apache.uima.resource.Parameter[] |
getParameters()
Gets the parameters.
|
org.apache.uima.resource.metadata.ConfigurationParameterSettings |
getParameterSettings()
Gets the parameter settings.
|
org.apache.uima.collection.metadata.CasProcessorRunInSeperateProcess |
getRunInSeparateProcess()
Gets the run in separate process.
|
String |
getSOFA()
Deprecated.
(non-Javadoc)
|
org.apache.uima.collection.metadata.CpeSofaMappings |
getSofaNameMappings()
Gets the sofa name mappings.
|
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 org.apache.uima.resource.metadata.impl.XmlizationInfo |
getXmlizationInfo() |
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(org.apache.uima.collection.metadata.CasProcessorFilter aFilter)
Sets the cas processor filter.
|
void |
setCasProcessorFilter(String aFilterExpression)
Associates a filter string with this CasProcessor.
|
void |
setCheckpoint(org.apache.uima.collection.metadata.CpeCheckpoint checkpoint)
Sets the checkpoint.
|
void |
setConfigurationParameterSettings(org.apache.uima.collection.metadata.CasProcessorConfigurationParameterSettings settings)
Sets configuration parameter settings for this CasProcessor.
|
void |
setCpeComponentDescriptor(org.apache.uima.collection.metadata.CpeComponentDescriptor aDescriptor) |
void |
setDeployment(String aDeployMode)
Associates deployment type with for this CasProcessor.
|
void |
setDeploymentParameters(org.apache.uima.collection.metadata.CasProcessorDeploymentParams parameters)
Sets the deployment parameters.
|
protected void |
setDeploymentParams(org.apache.uima.collection.metadata.CasProcessorDeploymentParams aParams)
Sets the deployment params.
|
void |
setDescriptor(String aDescriptorPath)
Associates a given descriptor path with this CasProcessor.
|
void |
setErrorHandling(org.apache.uima.collection.metadata.CasProcessorErrorHandling aErrorHandling)
Sets the error handling.
|
void |
setFilter(org.apache.uima.collection.metadata.CasProcessorFilter aFilter)
Sets the filter.
|
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(org.apache.uima.resource.Parameter[] aparameters)
Sets the parameters.
|
void |
setParameterSettings(org.apache.uima.resource.metadata.ConfigurationParameterSettings settings)
Sets the parameter settings.
|
void |
setRunInSeparateProcess(org.apache.uima.collection.metadata.CasProcessorRunInSeperateProcess process)
Sets the run in separate process.
|
void |
setSOFA(String aSoFa)
Deprecated.
|
void |
setSofaNameMappings(org.apache.uima.collection.metadata.CpeSofaMappings mappings)
Sets the sofa name 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, resolveSettings, setAttributeValue, setInfoset, setSourceUrl, setSourceUrlIfNull, toString, toXML, toXML, toXML, toXML, valueIsNullOrEmptyArray, writeArrayPropertyAsElement, writeMapPropertyToXml, writePropertyAsElementfinalize, getClass, notify, notifyAll, wait, wait, waitpublic void setDeployment(String aDeployMode) throws org.apache.uima.collection.metadata.CpeDescriptorException
aDeployMode - -
String identifying deployment typeorg.apache.uima.collection.metadata.CpeDescriptorException - -
if invalid deployment type is providedpublic String getDeployment()
getDeployment in interface org.apache.uima.collection.metadata.CpeCasProcessorpublic void setDescriptor(String aDescriptorPath) throws org.apache.uima.collection.metadata.CpeDescriptorException
setDescriptor in interface org.apache.uima.collection.metadata.CpeCasProcessoraDescriptorPath - -
path to the descriptororg.apache.uima.collection.metadata.CpeDescriptorException - tbd@Deprecated public String getDescriptor()
getDescriptor in interface org.apache.uima.collection.metadata.CpeCasProcessorpublic org.apache.uima.collection.metadata.CpeComponentDescriptor getCpeComponentDescriptor()
CpeComponentDescriptor instance associated with this Cas Processor. That
object contains a path to the component descriptor.getCpeComponentDescriptor in interface org.apache.uima.collection.metadata.CpeCasProcessorCpeComponentDescriptor instancepublic void setCasProcessorFilter(String aFilterExpression)
setCasProcessorFilter in interface org.apache.uima.collection.metadata.CpeCasProcessoraFilterExpression - -
String containing a filterpublic String getCasProcessorFilter()
getCasProcessorFilter in interface org.apache.uima.collection.metadata.CpeCasProcessorprotected void addDefaults()
throws org.apache.uima.collection.metadata.CpeDescriptorException
org.apache.uima.collection.metadata.CpeDescriptorException - tbdpublic void setBatchSize(int aBatchSize)
setBatchSize in interface org.apache.uima.collection.metadata.CpeCasProcessoraBatchSize - -
batch size of this CasProcessorpublic int getBatchSize()
getBatchSize in interface org.apache.uima.collection.metadata.CpeCasProcessorpublic void addDeployParam(String aParamName, String aParamValue) throws org.apache.uima.collection.metadata.CpeDescriptorException
addDeployParam in interface org.apache.uima.collection.metadata.CpeCasProcessoraParamName - -
name of the new parameteraParamValue - -
value of the new parameterorg.apache.uima.collection.metadata.CpeDescriptorException - tbdprotected void setDeploymentParams(org.apache.uima.collection.metadata.CasProcessorDeploymentParams aParams)
throws org.apache.uima.collection.metadata.CpeDescriptorException
aParams - the new deployment paramsorg.apache.uima.collection.metadata.CpeDescriptorException - tbdpublic org.apache.uima.collection.metadata.CasProcessorDeploymentParams getDeploymentParams()
getDeploymentParams in interface org.apache.uima.collection.metadata.CpeCasProcessorinstancepublic void setName(String aName) throws org.apache.uima.collection.metadata.CpeDescriptorException
setName in interface org.apache.uima.collection.metadata.CpeCasProcessoraName - -
name as stringorg.apache.uima.collection.metadata.CpeDescriptorException - tbdpublic String getName()
getName in interface org.apache.uima.collection.metadata.CpeCasProcessor@Deprecated public void setSOFA(String aSoFa) throws org.apache.uima.collection.metadata.CpeDescriptorException
setSOFA in interface org.apache.uima.collection.metadata.CpeCasProcessoraSoFa - the new sofaorg.apache.uima.collection.metadata.CpeDescriptorException - tbd@Deprecated public String getSOFA()
getSOFA in interface org.apache.uima.collection.metadata.CpeCasProcessorCpeCasProcessor.getSOFA()public void setCpeComponentDescriptor(org.apache.uima.collection.metadata.CpeComponentDescriptor aDescriptor)
throws org.apache.uima.collection.metadata.CpeDescriptorException
setCpeComponentDescriptor in interface org.apache.uima.collection.metadata.CpeCasProcessororg.apache.uima.collection.metadata.CpeDescriptorExceptionpublic void setCasProcessorFilter(org.apache.uima.collection.metadata.CasProcessorFilter aFilter)
throws org.apache.uima.collection.metadata.CpeDescriptorException
aFilter - the new cas processor filterorg.apache.uima.collection.metadata.CpeDescriptorException - the cpe descriptor exceptionpublic void setErrorHandling(org.apache.uima.collection.metadata.CasProcessorErrorHandling aErrorHandling)
throws org.apache.uima.collection.metadata.CpeDescriptorException
aErrorHandling - the new error handlingorg.apache.uima.collection.metadata.CpeDescriptorException - the cpe descriptor exceptionpublic org.apache.uima.collection.metadata.CasProcessorErrorHandling getErrorHandling()
getErrorHandling in interface org.apache.uima.collection.metadata.CpeCasProcessorpublic void setMaxErrorCount(int aErrorCount)
setMaxErrorCount in interface org.apache.uima.collection.metadata.CpeCasProcessoraErrorCount - -
max error tolerancepublic int getMaxErrorCount()
getMaxErrorCount in interface org.apache.uima.collection.metadata.CpeCasProcessorpublic void setMaxErrorSampleSize(int aErrorSampleSize)
setMaxErrorSampleSize in interface org.apache.uima.collection.metadata.CpeCasProcessoraErrorSampleSize - -
max error tolerancepublic int getMaxErrorSampleSize()
getMaxErrorSampleSize in interface org.apache.uima.collection.metadata.CpeCasProcessorpublic void setActionOnMaxError(String aAction)
setActionOnMaxError in interface org.apache.uima.collection.metadata.CpeCasProcessoraAction - -
action stringpublic String getActionOnMaxError()
getActionOnMaxError in interface org.apache.uima.collection.metadata.CpeCasProcessorpublic void setActionOnMaxRestart(String aAction)
setActionOnMaxRestart in interface org.apache.uima.collection.metadata.CpeCasProcessoraAction - -
action stringpublic String getActionOnMaxRestart()
getActionOnMaxRestart in interface org.apache.uima.collection.metadata.CpeCasProcessorpublic void setMaxRestartCount(int aRestartCount)
setMaxRestartCount in interface org.apache.uima.collection.metadata.CpeCasProcessoraRestartCount - -
max number of restartspublic int getMaxRestartCount()
getMaxRestartCount in interface org.apache.uima.collection.metadata.CpeCasProcessorpublic void setTimeout(int aTimeoutValue)
setTimeout in interface org.apache.uima.collection.metadata.CpeCasProcessoraTimeoutValue - -
millis to wait for responsepublic int getTimeout()
getTimeout in interface org.apache.uima.collection.metadata.CpeCasProcessorpublic void setConfigurationParameterSettings(org.apache.uima.collection.metadata.CasProcessorConfigurationParameterSettings settings)
throws org.apache.uima.collection.metadata.CpeDescriptorException
setConfigurationParameterSettings in interface org.apache.uima.collection.metadata.CpeCasProcessorsettings - the new configuration parameter settingsorg.apache.uima.collection.metadata.CpeDescriptorException - the cpe descriptor exceptionpublic org.apache.uima.collection.metadata.CasProcessorConfigurationParameterSettings getConfigurationParameterSettings()
getConfigurationParameterSettings in interface org.apache.uima.collection.metadata.CpeCasProcessorpublic void setParameterSettings(org.apache.uima.resource.metadata.ConfigurationParameterSettings settings)
settings - the new parameter settingspublic org.apache.uima.resource.metadata.ConfigurationParameterSettings getParameterSettings()
public org.apache.uima.resource.Parameter[] getParameters()
public org.apache.uima.collection.metadata.CasProcessorFilter getFilter()
public void setCheckpoint(org.apache.uima.collection.metadata.CpeCheckpoint checkpoint)
checkpoint - the new checkpointpublic void setParameters(org.apache.uima.resource.Parameter[] aparameters)
aparameters - the new parameterspublic void setFilter(org.apache.uima.collection.metadata.CasProcessorFilter aFilter)
aFilter - the new filterpublic org.apache.uima.collection.metadata.CasProcessorRunInSeperateProcess getRunInSeparateProcess()
getRunInSeparateProcess in interface org.apache.uima.collection.metadata.CpeCasProcessorpublic void setRunInSeparateProcess(org.apache.uima.collection.metadata.CasProcessorRunInSeperateProcess process)
process - container with configuration info for running CasProcessor in separate processpublic org.apache.uima.collection.metadata.CasProcessorDeploymentParams getDeploymentParameters()
public void setDeploymentParameters(org.apache.uima.collection.metadata.CasProcessorDeploymentParams parameters)
parameters - deployment parameterspublic void buildFromXMLElement(Element aElement, org.apache.uima.util.XMLParser aParser, org.apache.uima.util.XMLParser.ParsingOptions aOptions) throws org.apache.uima.util.InvalidXMLException
buildFromXMLElement in interface org.apache.uima.util.XMLizablebuildFromXMLElement in class org.apache.uima.resource.metadata.impl.MetaDataObject_implaElement - the a elementaParser - the a parseraOptions - the a optionsorg.apache.uima.util.InvalidXMLException - the invalid XML exceptionMetaDataObject_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 org.apache.uima.resource.metadata.impl.MetaDataObject_implMetaDataObject_impl.getXMLAttributes()protected org.apache.uima.resource.metadata.impl.XmlizationInfo getXmlizationInfo()
getXmlizationInfo in class org.apache.uima.resource.metadata.impl.MetaDataObject_implpublic org.apache.uima.collection.metadata.CpeCheckpoint getCheckpoint()
getCheckpoint in interface org.apache.uima.collection.metadata.CpeCasProcessorpublic org.apache.uima.collection.metadata.CpeSofaMappings getSofaNameMappings()
getSofaNameMappings in interface org.apache.uima.collection.metadata.CpeCasProcessorpublic void setSofaNameMappings(org.apache.uima.collection.metadata.CpeSofaMappings mappings)
setSofaNameMappings in interface org.apache.uima.collection.metadata.CpeCasProcessormappings - sofa name mappingspublic void setIsParallelizable(boolean isP)
setIsParallelizable in interface org.apache.uima.collection.metadata.CpeCasProcessorpublic boolean getIsParallelizable()
getIsParallelizable in interface org.apache.uima.collection.metadata.CpeCasProcessorCopyright © 2006–2017 The Apache Software Foundation. All rights reserved.