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

java.lang.Object
  extended by org.apache.uima.resource.metadata.impl.MetaDataObject_impl
      extended by 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

See Also:
Serialized Form

Constructor Summary
CasProcessorExecutableImpl()
           
 
Method Summary
 void addCasProcessorExecArg(CasProcessorExecArg aArg)
          Adds a CasProcessorExecArg argument to be supplied when launching a program.
 void addCasProcessorRuntimeEnvParam(CasProcessorRuntimeEnvParam aParam)
           
 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()
           
 CasProcessorExecArg getCasProcessorExecArg(int aIndex)
          Returns a CasProcessorExecArg argument idenitied by a given position in the list.
 CasProcessorExecArgs getCASProcessorExecArgs()
           
 java.lang.String getDir()
           
 java.util.ArrayList getEnvs()
           
 java.lang.String getExecutable()
          Returns an executable program that the CPE will use for launching CasProcessor.
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)
           
 void setCASProcessorExecArgs(CasProcessorExecArgs aArgs)
           
 void setDir(java.lang.String string)
           
 void setEnvs(java.util.ArrayList params)
           
 void setExecutable(java.lang.String string)
          Sets an executable program that the CPE will use for launching CasProcessor.
 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, getAttributeClass, getAttributeValue, getPropertyDescriptors, getPropertyXmlInfo, getRelativePathBase, getSourceUrl, getSourceUrlString, getWrapperClass, hashCode, isModifiable, listAttributes, readArrayPropertyValueFromXMLElement, readMapPropertyFromXml, readPropertyValueFromXMLElement, readUnknownPropertyValueFromXMLElement, setAttributeValue, setSourceUrl, setSourceUrlIfNull, toString, toXML, toXML, toXML, 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
 

Constructor Detail

CasProcessorExecutableImpl

public CasProcessorExecutableImpl()
Method Detail

setCASProcessorExecArgs

public void setCASProcessorExecArgs(CasProcessorExecArgs aArgs)

getCASProcessorExecArgs

public CasProcessorExecArgs getCASProcessorExecArgs()

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)

getCasProcessorExecArg

public CasProcessorExecArg getCasProcessorExecArg(int aIndex)
Description copied from interface: CasProcessorExecutable
Returns a CasProcessorExecArg argument idenitied 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 idenitied 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()
Returns:

getExecutable

public java.lang.String getExecutable()
Description copied from interface: CasProcessorExecutable
Returns an executable program that the CPE will use for launching CasProcessor.

Specified by:
getExecutable in interface CasProcessorExecutable
Returns:

setDir

public void setDir(java.lang.String string)
Parameters:
string -

setExecutable

public void setExecutable(java.lang.String string)
Description copied from interface: CasProcessorExecutable
Sets an executable program that the CPE will use for launching CasProcessor.

Specified by:
setExecutable in interface CasProcessorExecutable
Parameters:
string -

getArgs

protected CasProcessorExecArg[] getArgs()
Returns:

setArgs

protected void setArgs(CasProcessorExecArg[] aargs)
Parameters:
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 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(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
See Also:
XMLizable.toXML(org.xml.sax.ContentHandler, boolean)

getXMLAttributes

protected org.xml.sax.helpers.AttributesImpl getXMLAttributes()
Overridden to handle "name" and "value" attributes.

Overrides:
getXMLAttributes in class MetaDataObject_impl
Returns:
an object defining the attributes to be written to the XML
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()
Specified by:
getEnvs in interface CasProcessorExecutable
Returns:

setEnvs

public void setEnvs(java.util.ArrayList params)
Specified by:
setEnvs in interface CasProcessorExecutable
Parameters:
params -


Copyright © 2012. All Rights Reserved.