Class CasProcessorExecutableImpl
java.lang.Object
org.apache.uima.resource.metadata.impl.MetaDataObject_impl
org.apache.uima.collection.impl.metadata.cpe.CasProcessorExecutableImpl
- All Implemented Interfaces:
Serializable
,Cloneable
,CasProcessorExecutable
,MetaDataObject
,XMLizable
public class CasProcessorExecutableImpl
extends MetaDataObject_impl
implements CasProcessorExecutable
- See Also:
-
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 -
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds aCasProcessorExecArg
argument to be supplied when launching a program.void
void
buildFromXMLElement
(Element aElement, XMLParser aParser, XMLParser.ParsingOptions aOptions) Overridden to read "name" and "value" attributes.Returns ALLCasProcessorExecArg
argumentsprotected CasProcessorExecArg[]
getArgs()
getCasProcessorExecArg
(int aIndex) Returns aCasProcessorExecArg
argument identified by a given position in the list.getDir()
getEnvs()
Returns an executable program that the CPE will use for launching CasProcessor.protected AttributesImpl
Overridden to handle "name" and "value" attributes.protected XmlizationInfo
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
void
void
void
setExecutable
(String string) Sets an executable program that the CPE will use for launching CasProcessor.void
toXML
(ContentHandler aContentHandler, boolean aWriteDefaultNamespaceAttribute) Writes this object's XML representation by making calls on a SAXContentHandler
.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
-
Constructor Details
-
CasProcessorExecutableImpl
public CasProcessorExecutableImpl()
-
-
Method Details
-
setCASProcessorExecArgs
-
getCASProcessorExecArgs
-
addCasProcessorExecArg
Description copied from interface:CasProcessorExecutable
Adds aCasProcessorExecArg
argument to be supplied when launching a program.- Specified by:
addCasProcessorExecArg
in interfaceCasProcessorExecutable
- Parameters:
aArg
- - argument for the executable program
-
addCasProcessorRuntimeEnvParam
-
getCasProcessorExecArg
Description copied from interface:CasProcessorExecutable
Returns aCasProcessorExecArg
argument identified by a given position in the list.- Specified by:
getCasProcessorExecArg
in interfaceCasProcessorExecutable
- Parameters:
aIndex
- - position of argument to return- Returns:
CasProcessorExecArg
argument
-
getAllCasProcessorExecArgs
Description copied from interface:CasProcessorExecutable
Returns ALLCasProcessorExecArg
arguments- Specified by:
getAllCasProcessorExecArgs
in interfaceCasProcessorExecutable
- 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 interfaceCasProcessorExecutable
- Parameters:
aIndex
- - position of argument to delete
-
getDir
- Returns:
- the directory
-
getExecutable
Description copied from interface:CasProcessorExecutable
Returns an executable program that the CPE will use for launching CasProcessor.- Specified by:
getExecutable
in interfaceCasProcessorExecutable
- Returns:
- the executable
-
setDir
- Parameters:
string
-
-
setExecutable
Description copied from interface:CasProcessorExecutable
Sets an executable program that the CPE will use for launching CasProcessor.- Specified by:
setExecutable
in interfaceCasProcessorExecutable
- Parameters:
string
-
-
getArgs
- Returns:
- an array of arguments
-
setArgs
- Parameters:
aargs
-
-
buildFromXMLElement
public void buildFromXMLElement(Element aElement, XMLParser aParser, XMLParser.ParsingOptions aOptions) throws InvalidXMLException Overridden to read "name" and "value" attributes.- Specified by:
buildFromXMLElement
in interfaceXMLizable
- Overrides:
buildFromXMLElement
in classMetaDataObject_impl
- Parameters:
aElement
- the XML element that represents this object.aParser
- a reference to the UIMAXMLParser
. TheXMLParser.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:
-
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 SAXContentHandler
.- Specified by:
toXML
in interfaceXMLizable
- Overrides:
toXML
in classMetaDataObject_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:
-
getXMLAttributes
Overridden to handle "name" and "value" attributes.- Overrides:
getXMLAttributes
in classMetaDataObject_impl
- Returns:
- an object defining the attributes to be written to the XML
- See Also:
-
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 classMetaDataObject_impl
- Returns:
- information defining this object's XML representation
-
getEnvs
- Specified by:
getEnvs
in interfaceCasProcessorExecutable
- Returns:
- the environment items
-
setEnvs
- Specified by:
setEnvs
in interfaceCasProcessorExecutable
- Parameters:
params
-
-