org.apache.uima.collection.metadata
Interface CasProcessorRuntimeEnvParam

All Superinterfaces:

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

All Known Implementing Classes:

CasProcessorRuntimeEnvParamImpl

public interface CasProcessorRuntimeEnvParam
extends MetaDataObject

An object that holds configuration that is part of the CPE descriptor. It provides the means of configuring environment variables used when launching local CasProcessors.

Method Summary

java.lang.String	getEnvParamName() Returns a name of parameter
java.lang.String	getEnvParamValue() Returns parameter value
void	setEnvParamName(java.lang.String aEnvParamName) Sets a name for new parameter
void	setEnvParamValue(java.lang.String aEnvParamValue) Sets a value for new parameter

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, buildFromXMLElement, toXML, toXML, toXML, toXML

Method Detail

setEnvParamName

void setEnvParamName(java.lang.String aEnvParamName)
                     throws CpeDescriptorException

Sets a name for new parameter

Parameters:

aEnvParamName - - param name

Throws:

CpeDescriptorException

getEnvParamName

java.lang.String getEnvParamName()
                                 throws CpeDescriptorException

Returns a name of parameter

Returns:

- parm name

Throws:

CpeDescriptorException

setEnvParamValue

void setEnvParamValue(java.lang.String aEnvParamValue)
                      throws CpeDescriptorException

Sets a value for new parameter

Parameters:

aEnvParamValue - - param value

Throws:

CpeDescriptorException

getEnvParamValue

java.lang.String getEnvParamValue()
                                  throws CpeDescriptorException

Returns parameter value

Returns:

- param value

Throws:

CpeDescriptorException