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

Class CasProcessorDeploymentParamsImpl

java.lang.Object

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

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

All Implemented Interfaces:

Serializable, Cloneable, CasProcessorDeploymentParams, MetaDataObject, XMLizable

public class CasProcessorDeploymentParamsImpl
extends MetaDataObject_impl
implements CasProcessorDeploymentParams

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 and Description
CasProcessorDeploymentParamsImpl()

Method Summary

Modifier and Type	Method and Description
void	add(CasProcessorDeploymentParam aParam) Adds new CasProcessorDeploymentParam param
void	buildFromXMLElement(Element aElement, XMLParser aParser, XMLParser.ParsingOptions aOptions) Overridden to read "name" and "value" attributes.
CasProcessorDeploymentParam	get(String aParamName) Returns CasProcessorDeploymentParam instance identified by aParamName.
CasProcessorDeploymentParam[]	getAll() Returns all instances of CasProcessorDeploymentParam
protected XmlizationInfo	getXmlizationInfo() To be implemented by subclasses to return information describing how to represent this object in XML.
void	remove(CasProcessorDeploymentParam aParam) Deletes named instance of CasProcessorDeploymentParam
void	toXML(ContentHandler aContentHandler, boolean aWriteDefaultNamespaceAttribute) Writes this object's XML representation by making calls on a SAX ContentHandler.

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, getXMLAttributes, hashCode, isModifiable, listAttributes, readArrayPropertyValueFromXMLElement, readMapPropertyFromXml, readPropertyValueFromXMLElement, readUnknownPropertyValueFromXMLElement, resolveSettings, setAttributeValue, setInfoset, setSourceUrl, setSourceUrlIfNull, toString, toXML, toXML, toXML, valueIsNullOrEmptyArray, writeArrayPropertyAsElement, writeMapPropertyToXml, writePropertyAsElement

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CasProcessorDeploymentParamsImpl

public CasProcessorDeploymentParamsImpl()

Method Detail

add

public void add(CasProcessorDeploymentParam aParam)

Description copied from interface: CasProcessorDeploymentParams

Adds new CasProcessorDeploymentParam param

Specified by:

add in interface CasProcessorDeploymentParams

Parameters:

aParam - - parameter to add

get

public CasProcessorDeploymentParam get(String aParamName)
                                throws CpeDescriptorException

Description copied from interface: CasProcessorDeploymentParams

Returns CasProcessorDeploymentParam instance identified by aParamName.

Specified by:

get in interface CasProcessorDeploymentParams

Parameters:

aParamName - - name of the parameter to get

Returns:

- instance of CasProcessorDeploymentParam

Throws:

CpeDescriptorException - tbd

getAll

public CasProcessorDeploymentParam[] getAll()

Description copied from interface: CasProcessorDeploymentParams

Returns all instances of CasProcessorDeploymentParam

Specified by:

getAll in interface CasProcessorDeploymentParams

Returns:

- array of CasProcessorDeploymentParam instances

remove

public void remove(CasProcessorDeploymentParam aParam)
            throws CpeDescriptorException

Description copied from interface: CasProcessorDeploymentParams

Deletes named instance of CasProcessorDeploymentParam

Specified by:

remove in interface CasProcessorDeploymentParams

Parameters:

aParam - - parameter to remove

Throws:

CpeDescriptorException - tbd

buildFromXMLElement

public void buildFromXMLElement(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 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 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)

toXML

public void toXML(ContentHandler aContentHandler,
                  boolean aWriteDefaultNamespaceAttribute)
           throws SAXException

Description copied from interface: XMLizable

Writes this object's XML representation by making calls on a SAX ContentHandler.

Specified by:

toXML in interface XMLizable

Overrides:

toXML in class MetaDataObject_impl

Parameters:

aContentHandler - the content handler to which this object will write events that describe its XML representation.

aWriteDefaultNamespaceAttribute - whether the namespace of this element should be written as the default namespace. This should be done only for the root element, and it defaults to false.

Throws:

SAXException - pass thru

See Also:

This is called internally, also for JSon serialization If this is the first call to serialize, create a serialContext (and clean up afterwards) Other callers (e.g. JSON) must set the serialContext first before calling

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