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 TypeMethodDescriptionvoidAdds aCasProcessorExecArgargument to be supplied when launching a program.voidvoidbuildFromXMLElement(Element aElement, XMLParser aParser, XMLParser.ParsingOptions aOptions) Overridden to read "name" and "value" attributes.Returns ALLCasProcessorExecArgargumentsprotected CasProcessorExecArg[]getArgs()getCasProcessorExecArg(int aIndex) Returns aCasProcessorExecArgargument identified by a given position in the list.getDir()getEnvs()Returns an executable program that the CPE will use for launching CasProcessor.protected AttributesImplOverridden to handle "name" and "value" attributes.protected XmlizationInfoTo be implemented by subclasses to return information describing how to represent this object in XML.voidremoveCasProcessorExecArg(int aIndex) Removes program argument from the list.protected voidsetArgs(CasProcessorExecArg[] aargs) voidvoidvoidvoidsetExecutable(String string) Sets an executable program that the CPE will use for launching CasProcessor.voidtoXML(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, writePropertyAsElementMethods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.uima.resource.metadata.MetaDataObject
clone, equals, getAttributeValue, getSourceUrl, getSourceUrlString, isModifiable, listAttributes, setAttributeValue, setSourceUrlMethods 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:CasProcessorExecutableAdds aCasProcessorExecArgargument to be supplied when launching a program.- Specified by:
addCasProcessorExecArgin interfaceCasProcessorExecutable- Parameters:
aArg- - argument for the executable program
-
addCasProcessorRuntimeEnvParam
-
getCasProcessorExecArg
Description copied from interface:CasProcessorExecutableReturns aCasProcessorExecArgargument identified by a given position in the list.- Specified by:
getCasProcessorExecArgin interfaceCasProcessorExecutable- Parameters:
aIndex- - position of argument to return- Returns:
CasProcessorExecArgargument
-
getAllCasProcessorExecArgs
Description copied from interface:CasProcessorExecutableReturns ALLCasProcessorExecArgarguments- Specified by:
getAllCasProcessorExecArgsin interfaceCasProcessorExecutable- Returns:
- array of
CasProcessorExecArg
-
removeCasProcessorExecArg
public void removeCasProcessorExecArg(int aIndex) Description copied from interface:CasProcessorExecutableRemoves program argument from the list. The argument for deletion is identified by provided position in the list.- Specified by:
removeCasProcessorExecArgin interfaceCasProcessorExecutable- Parameters:
aIndex- - position of argument to delete
-
getDir
- Returns:
- the directory
-
getExecutable
Description copied from interface:CasProcessorExecutableReturns an executable program that the CPE will use for launching CasProcessor.- Specified by:
getExecutablein interfaceCasProcessorExecutable- Returns:
- the executable
-
setDir
- Parameters:
string-
-
setExecutable
Description copied from interface:CasProcessorExecutableSets an executable program that the CPE will use for launching CasProcessor.- Specified by:
setExecutablein 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:
buildFromXMLElementin interfaceXMLizable- Overrides:
buildFromXMLElementin 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:XMLizableWrites this object's XML representation by making calls on a SAXContentHandler.- Specified by:
toXMLin interfaceXMLizable- Overrides:
toXMLin 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:
getXMLAttributesin classMetaDataObject_impl- Returns:
- an object defining the attributes to be written to the XML
- See Also:
-
getXmlizationInfo
Description copied from class:MetaDataObject_implTo be implemented by subclasses to return information describing how to represent this object in XML.- Specified by:
getXmlizationInfoin classMetaDataObject_impl- Returns:
- information defining this object's XML representation
-
getEnvs
- Specified by:
getEnvsin interfaceCasProcessorExecutable- Returns:
- the environment items
-
setEnvs
- Specified by:
setEnvsin interfaceCasProcessorExecutable- Parameters:
params-
-