Package org.apache.uima.collection.impl.metadata.cpe

Class CasProcessorErrorRateThresholdImpl

java.lang.Object

org.apache.uima.resource.metadata.impl.MetaDataObject_impl

org.apache.uima.collection.impl.metadata.cpe.CasProcessorErrorRateThresholdImpl

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, CasProcessorErrorRateThreshold, MetaDataObject, XMLizable

public class CasProcessorErrorRateThresholdImpl
extends MetaDataObject_impl
implements CasProcessorErrorRateThreshold

The Class CasProcessorErrorRateThresholdImpl.

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 java.lang.String	action	The action.
private static long	serialVersionUID	The Constant serialVersionUID.
private java.lang.String	value	The value.
private static XmlizationInfo	XMLIZATION_INFO	The Constant XMLIZATION_INFO.

Fields inherited from class org.apache.uima.resource.metadata.impl.MetaDataObject_impl

serialContext

Constructor Summary

Constructors

Constructor	Description
CasProcessorErrorRateThresholdImpl()	Instantiates a new cas processor error rate threshold impl.

Method Summary

Modifier and Type	Method	Description
void	buildFromXMLElement(org.w3c.dom.Element aElement, XMLParser aParser, XMLParser.ParsingOptions aOptions)	Overridden to read "name" and "value" attributes.
java.lang.String	getAction()	Returns strategy for dealing with exceeding error thresholds.
int	getMaxErrorCount()	Returns max number of errors tolerated by the CPE.
int	getMaxErrorSampleSize()	Returns sample size.
java.lang.String	getValue()	Gets the value.
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	setAction(java.lang.String aAction)	Sets a strategy for dealing with exceeding error thresholds.
void	setMaxErrorCount(int aErrorCount)	Sets the max number of errors tolerated by the CPE.
void	setMaxErrorSampleSize(int aSampleSize)	Sets the sample size.
void	setValue(java.lang.String string)	Sets the value.

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

Methods inherited from interface org.apache.uima.util.XMLizable

buildFromXMLElement, toXML, toXML, toXML, toXML

Field Detail

serialVersionUID

private static final long serialVersionUID

The Constant serialVersionUID.

See Also:

Constant Field Values

value

private java.lang.String value

The value.

action

private java.lang.String action

The action.

XMLIZATION_INFO

private static final XmlizationInfo XMLIZATION_INFO

The Constant XMLIZATION_INFO.

Constructor Detail

CasProcessorErrorRateThresholdImpl

public CasProcessorErrorRateThresholdImpl()

Instantiates a new cas processor error rate threshold impl.

Method Detail

setMaxErrorCount

public void setMaxErrorCount(int aErrorCount)

Description copied from interface: CasProcessorErrorRateThreshold

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.

Specified by:

setMaxErrorCount in interface CasProcessorErrorRateThreshold

Parameters:

aErrorCount - - max tolerated errors for CasProcessor

getMaxErrorCount

public int getMaxErrorCount()

Description copied from interface: CasProcessorErrorRateThreshold

Returns 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.

Specified by:

getMaxErrorCount in interface CasProcessorErrorRateThreshold

Returns:

- max error count

setMaxErrorSampleSize

public void setMaxErrorSampleSize(int aSampleSize)

Description copied from interface: CasProcessorErrorRateThreshold

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.

Specified by:

setMaxErrorSampleSize in interface CasProcessorErrorRateThreshold

Parameters:

aSampleSize - the sample size

getMaxErrorSampleSize

public int getMaxErrorSampleSize()

Description copied from interface: CasProcessorErrorRateThreshold

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.

Specified by:

getMaxErrorSampleSize in interface CasProcessorErrorRateThreshold

Returns:

- sample size

setAction

public void setAction(java.lang.String aAction)

Description copied from interface: CasProcessorErrorRateThreshold

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

Specified by:

setAction in interface CasProcessorErrorRateThreshold

Parameters:

aAction - - action to take

getAction

public java.lang.String getAction()

Description copied from interface: CasProcessorErrorRateThreshold

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

Specified by:

getAction in interface CasProcessorErrorRateThreshold

Returns:

String - action to take

buildFromXMLElement

public void buildFromXMLElement(org.w3c.dom.Element aElement,
                                XMLParser aParser,
                                XMLParser.ParsingOptions aOptions)
                         throws InvalidXMLException

Overridden to read "name" and "value" attributes.

Specified by:

buildFromXMLElement in interface XMLizable

Overrides:

buildFromXMLElement in class MetaDataObject_impl

Parameters:

aElement - the a element

aParser - the a parser

aOptions - the a options

Throws:

InvalidXMLException - the invalid XML exception

See Also:

MetaDataObject_impl.buildFromXMLElement(org.w3c.dom.Element, org.apache.uima.util.XMLParser, org.apache.uima.util.XMLParser.ParsingOptions)

getXMLAttributes

protected org.xml.sax.helpers.AttributesImpl getXMLAttributes()

Overridden to handle "name" and "value" attributes.

Overrides:

getXMLAttributes in class MetaDataObject_impl

Returns:

the XML attributes

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 class MetaDataObject_impl

Returns:

information defining this object's XML representation

getValue

public java.lang.String getValue()

Gets the value.

Returns:

the value

setValue

public void setValue(java.lang.String string)

Sets the value.

Parameters:

string - the new value