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

Class CasProcessorMaxRestartsImpl

java.lang.Object

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

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

All Implemented Interfaces:

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

public class CasProcessorMaxRestartsImpl
extends MetaDataObject_impl
implements CasProcessorMaxRestarts

The Class CasProcessorMaxRestartsImpl.

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 int	waitTimeBetweenRetries	The wait time between retries.
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
CasProcessorMaxRestartsImpl()	Instantiates a new cas processor max restarts 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 a strategy to apply by the CPE when max restart count is exceeded.
int	getRestartCount()	Returns max restarts threshold fro CasProcessor
java.lang.String	getValue()	Gets the value.
int	getWaitTimeBetweenRetries()	Gets the wait time between retries.
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 to apply by the CPE when max restart count is exceeded.
void	setRestartCount(int aRestartCount)	Sets max tolerated restarts threshold for CasProcessor
void	setValue(java.lang.String string)	Sets the value.
void	setWaitTimeBetweenRetries(int i)	Sets the wait time between retries.

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.

waitTimeBetweenRetries

private int waitTimeBetweenRetries

The wait time between retries.

XMLIZATION_INFO

private static final XmlizationInfo XMLIZATION_INFO

The Constant XMLIZATION_INFO.

Constructor Detail

CasProcessorMaxRestartsImpl

public CasProcessorMaxRestartsImpl()

Instantiates a new cas processor max restarts impl.

Method Detail

setRestartCount

public void setRestartCount(int aRestartCount)

Description copied from interface: CasProcessorMaxRestarts

Sets max tolerated restarts threshold for CasProcessor

Specified by:

setRestartCount in interface CasProcessorMaxRestarts

Parameters:

aRestartCount - - max restart count

getRestartCount

public int getRestartCount()

Description copied from interface: CasProcessorMaxRestarts

Returns max restarts threshold fro CasProcessor

Specified by:

getRestartCount in interface CasProcessorMaxRestarts

Returns:

- restart count

setAction

public void setAction(java.lang.String aAction)

Description copied from interface: CasProcessorMaxRestarts

Sets a strategy to apply by the CPE when max restart count is exceeded. The three supported strategies are:

• terminate - termines the CPE
• continue - continue despite the error
• disable - disable CasProcessor

Specified by:

setAction in interface CasProcessorMaxRestarts

Parameters:

aAction - - action to take

getAction

public java.lang.String getAction()

Description copied from interface: CasProcessorMaxRestarts

Returns a strategy to apply by the CPE when max restart count is exceeded. The three supported strategies are:

• terminate - termines the CPE
• continue - continue despite the error
• disable - disable CasProcessor

Specified by:

getAction in interface CasProcessorMaxRestarts

Returns:

- action as String

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

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

getWaitTimeBetweenRetries

public int getWaitTimeBetweenRetries()

Gets the wait time between retries.

Specified by:

getWaitTimeBetweenRetries in interface CasProcessorMaxRestarts

Returns:

the wait time between retries

setWaitTimeBetweenRetries

public void setWaitTimeBetweenRetries(int i)

Sets the wait time between retries.

Specified by:

setWaitTimeBetweenRetries in interface CasProcessorMaxRestarts

Parameters:

i - the new wait time between retries