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

Class CasProcessorExecutableImpl

java.lang.Object

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

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

All Implemented Interfaces:

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

public class CasProcessorExecutableImpl
extends MetaDataObject_impl
implements CasProcessorExecutable

The Class CasProcessorExecutableImpl.

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 CasProcessorExecArgs	args	The args.
private java.lang.String	dir	The dir.
private java.util.ArrayList	envs	The envs.
private java.lang.String	executable	The executable.
private static long	serialVersionUID	The Constant serialVersionUID.
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
CasProcessorExecutableImpl()	Instantiates a new cas processor executable impl.

Method Summary

Modifier and Type	Method	Description
void	addCasProcessorExecArg(CasProcessorExecArg aArg)	Adds a CasProcessorExecArg argument to be supplied when launching a program.
void	addCasProcessorRuntimeEnvParam(CasProcessorRuntimeEnvParam aParam)	Adds the cas processor runtime env param.
void	buildFromXMLElement(org.w3c.dom.Element aElement, XMLParser aParser, XMLParser.ParsingOptions aOptions)	Overridden to read "name" and "value" attributes.
CasProcessorExecArg[]	getAllCasProcessorExecArgs()	Returns ALL CasProcessorExecArg arguments
protected CasProcessorExecArg[]	getArgs()	Gets the args.
CasProcessorExecArg	getCasProcessorExecArg(int aIndex)	Returns a CasProcessorExecArg argument identified by a given position in the list.
CasProcessorExecArgs	getCASProcessorExecArgs()	Gets the CAS processor exec args.
java.lang.String	getDir()	Gets the dir.
java.util.ArrayList	getEnvs()	Gets the envs.
java.lang.String	getExecutable()	Gets the executable.
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	removeCasProcessorExecArg(int aIndex)	Removes program argument from the list.
protected void	setArgs(CasProcessorExecArg[] aargs)	Sets the args.
void	setCASProcessorExecArgs(CasProcessorExecArgs aArgs)	Sets the CAS processor exec args.
void	setDir(java.lang.String string)	Sets the dir.
void	setEnvs(java.util.ArrayList params)	Sets the envs.
void	setExecutable(java.lang.String string)	Sets the executable.
void	toXML(org.xml.sax.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, 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

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

Field Detail

serialVersionUID

private static final long serialVersionUID

The Constant serialVersionUID.

See Also:

Constant Field Values

executable

private java.lang.String executable

The executable.

dir

private java.lang.String dir

The dir.

args

private CasProcessorExecArgs args

The args.

envs

private java.util.ArrayList envs

The envs.

XMLIZATION_INFO

private static final XmlizationInfo XMLIZATION_INFO

The Constant XMLIZATION_INFO.

Constructor Detail

CasProcessorExecutableImpl

public CasProcessorExecutableImpl()

Instantiates a new cas processor executable impl.

Method Detail

setCASProcessorExecArgs

public void setCASProcessorExecArgs(CasProcessorExecArgs aArgs)

Sets the CAS processor exec args.

Parameters:

aArgs - the new CAS processor exec args

getCASProcessorExecArgs

public CasProcessorExecArgs getCASProcessorExecArgs()

Gets the CAS processor exec args.

Returns:

the CAS processor exec args

addCasProcessorExecArg

public void addCasProcessorExecArg(CasProcessorExecArg aArg)

Description copied from interface: CasProcessorExecutable

Adds a CasProcessorExecArg argument to be supplied when launching a program.

Specified by:

addCasProcessorExecArg in interface CasProcessorExecutable

Parameters:

aArg - - argument for the executable program

addCasProcessorRuntimeEnvParam

public void addCasProcessorRuntimeEnvParam(CasProcessorRuntimeEnvParam aParam)

Adds the cas processor runtime env param.

Parameters:

aParam - the a param

getCasProcessorExecArg

public CasProcessorExecArg getCasProcessorExecArg(int aIndex)

Description copied from interface: CasProcessorExecutable

Returns a CasProcessorExecArg argument identified by a given position in the list.

Specified by:

getCasProcessorExecArg in interface CasProcessorExecutable

Parameters:

aIndex - - position of argument to return

Returns:

CasProcessorExecArg argument

getAllCasProcessorExecArgs

public CasProcessorExecArg[] getAllCasProcessorExecArgs()

Description copied from interface: CasProcessorExecutable

Returns ALL CasProcessorExecArg arguments

Specified by:

getAllCasProcessorExecArgs in interface CasProcessorExecutable

Returns:

array of CasProcessorExecArg

removeCasProcessorExecArg

public void removeCasProcessorExecArg(int aIndex)

Description copied from interface: CasProcessorExecutable

Removes program argument from the list. The argument for deletion is identified by provided position in the list.

Specified by:

removeCasProcessorExecArg in interface CasProcessorExecutable

Parameters:

aIndex - - position of argument to delete

getDir

public java.lang.String getDir()

Gets the dir.

Returns:

the directory

getExecutable

public java.lang.String getExecutable()

Gets the executable.

Specified by:

getExecutable in interface CasProcessorExecutable

Returns:

the executable

setDir

public void setDir(java.lang.String string)

Sets the dir.

Parameters:

string - the new dir

setExecutable

public void setExecutable(java.lang.String string)

Sets the executable.

Specified by:

setExecutable in interface CasProcessorExecutable

Parameters:

string - the new executable

getArgs

protected CasProcessorExecArg[] getArgs()

Gets the args.

Returns:

an array of arguments

setArgs

protected void setArgs(CasProcessorExecArg[] aargs)

Sets the args.

Parameters:

aargs - the new args

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)

toXML

public void toXML(org.xml.sax.ContentHandler aContentHandler,
                  boolean aWriteDefaultNamespaceAttribute)
           throws org.xml.sax.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:

org.xml.sax.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

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

getEnvs

public java.util.ArrayList getEnvs()

Gets the envs.

Specified by:

getEnvs in interface CasProcessorExecutable

Returns:

the environment items

setEnvs

public void setEnvs(java.util.ArrayList params)

Sets the envs.

Specified by:

setEnvs in interface CasProcessorExecutable

Parameters:

params - the new envs