public class ConfigurationParameter_impl extends MetaDataObject_impl implements ConfigurationParameter
ConfigurationParameter.MetaDataObject_impl.MetaDataAttr, MetaDataObject_impl.SerialContext, MetaDataObject_impl.SerializerserialContextTYPE_BOOLEAN, TYPE_FLOAT, TYPE_INTEGER, TYPE_STRING| Constructor and Description |
|---|
ConfigurationParameter_impl() |
| Modifier and Type | Method and Description |
|---|---|
void |
addOverride(String aOverride)
Adds an override to this configuration parameter.
|
String |
getDescription()
Retrieves the description of this configuration parameter.
|
String |
getExternalOverrideName()
Retrieves the external name of this configuration parameter.
|
String |
getName()
Retrieves the name of this configuration parameter.
|
String[] |
getOverrides()
Gets the parameters that are this parameter overrides.
|
String |
getType()
Retrieves the data type of this configuration parameter.
|
protected XmlizationInfo |
getXmlizationInfo()
To be implemented by subclasses to return information describing how to represent this object
in XML.
|
boolean |
isMandatory()
Retrieves whether this parameter is mandatory.
|
boolean |
isMultiValued()
Retrieves whether this parameter is multi-valued.
|
protected static boolean |
isValidDataTypeName(Object aTypeName)
Determines whether the given String is a valid name for a data type.
|
protected void |
readArrayPropertyValueFromXMLElement(PropertyXmlInfo aPropXmlInfo,
Class aPropClass,
Element aElement,
XMLParser aParser,
XMLParser.ParsingOptions aOptions)
Overriden to allow both "param" and "parameter" as the array element tags.
|
void |
removeOverride(String aOverride)
Removes an override from this configuration parameter.
|
void |
setDescription(String aDescription)
Sets the description of this configuration parameter.
|
void |
setExternalOverrideName(String aExternalOverrideName)
Sets the external name of this configuration parameter.
|
void |
setMandatory(boolean aMandatory)
Sets whether this parameter is mandatory.
|
void |
setMultiValued(boolean aMultiValued)
Sets whether this parameter is multi-valued.
|
void |
setName(String aName)
Sets the name of this configuration parameter.
|
void |
setOverrides(String[] aOverrides)
Sets the parameters that are this parameter overrides.
|
void |
setType(String aType)
Sets the data type of this configuration parameter.
|
static boolean |
typeMatch(Class aClass,
String aTypeName,
boolean aMultiValued)
Determines whether the given Java class is an appropriate value for a parameter with the
specified type.
|
buildFromXMLElement, buildFromXMLElement, clone, equals, getAdditionalAttributes, getAttributeClass, getAttributeValue, getInfoset, getMatchingNode, getPropertyDescriptors, getPropertyXmlInfo, getRelativePathBase, getSerialContext, getSourceUrl, getSourceUrlString, getWrapperClass, getXMLAttributes, hashCode, isModifiable, listAttributes, readMapPropertyFromXml, readPropertyValueFromXMLElement, readUnknownPropertyValueFromXMLElement, resolveSettings, setAttributeValue, setInfoset, setSourceUrl, setSourceUrlIfNull, toString, toXML, toXML, toXML, toXML, valueIsNullOrEmptyArray, writeArrayPropertyAsElement, writeMapPropertyToXml, writePropertyAsElementfinalize, getClass, notify, notifyAll, wait, wait, waitclone, equals, getAttributeValue, getSourceUrl, getSourceUrlString, isModifiable, listAttributes, setAttributeValue, setSourceUrlbuildFromXMLElement, buildFromXMLElement, toXML, toXML, toXML, toXMLpublic String getName()
ConfigurationParametergetName in interface ConfigurationParameterConfigurationParameter.getName()public void setName(String aName)
ConfigurationParametersetName in interface ConfigurationParameteraName - the name of this configuration parameter.ConfigurationParameter.setName(String)public String getExternalOverrideName()
ConfigurationParametergetExternalOverrideName in interface ConfigurationParameterConfigurationParameter.getExternalOverrideName()public void setExternalOverrideName(String aExternalOverrideName)
ConfigurationParametersetExternalOverrideName in interface ConfigurationParameteraExternalOverrideName - the external name of this configuration parameter.ConfigurationParameter.setExternalOverrideName(String)public String getDescription()
ConfigurationParametergetDescription in interface ConfigurationParameterConfigurationParameter.getDescription()public void setDescription(String aDescription)
ConfigurationParametersetDescription in interface ConfigurationParameteraDescription - the description of this configuration parameter.ConfigurationParameter.setDescription(String)public String getType()
ConfigurationParametergetType in interface ConfigurationParameterConfigurationParameter.getType()public void setType(String aType) throws UIMA_IllegalArgumentException
ConfigurationParametersetType in interface ConfigurationParameteraType - the data type of this configuration parameter. This must be one of the TYPE constants
defined on this interface.UIMA_IllegalArgumentException - if aType is not a valid data type defined by a TYPE constant on this
interface.ConfigurationParameter.setType(String)public boolean isMultiValued()
ConfigurationParameterisMultiValued in interface ConfigurationParameterConfigurationParameter.isMultiValued()public void setMultiValued(boolean aMultiValued)
ConfigurationParametersetMultiValued in interface ConfigurationParameteraMultiValued - true if and only if this parameter is multi-valued.ConfigurationParameter.setMultiValued(boolean)public boolean isMandatory()
ConfigurationParameterisMandatory in interface ConfigurationParameterConfigurationParameter.isMandatory()public void setMandatory(boolean aMandatory)
ConfigurationParametersetMandatory in interface ConfigurationParameteraMandatory - true if and only if this parameter is mandatory.ConfigurationParameter.setMandatory(boolean)public String[] getOverrides()
ConfigurationParameter/parameterName.
For example the overrides annotator1/parameter1 would override the parameter
named parameter1 within the component named annotator1.getOverrides in interface ConfigurationParameterpublic void setOverrides(String[] aOverrides)
ConfigurationParameter/parameterName.
For example the overrides annotator1/parameter1 would override the parameter
named parameter1 within the component named annotator1.setOverrides in interface ConfigurationParameteraOverrides - the parameters this this parameter overridespublic void addOverride(String aOverride)
ConfigurationParameteraddOverride in interface ConfigurationParameteraOverride - the override to addConfigurationParameter.setOverrides(String[])public void removeOverride(String aOverride)
ConfigurationParameterremoveOverride in interface ConfigurationParameteraOverride - the override to remove. Must equal (via the equals() method) one of the overrides on
this parameter, or this method will do nothing.ConfigurationParameter.setOverrides(String[])public static boolean typeMatch(Class aClass, String aTypeName, boolean aMultiValued)
aClass - class to checkaTypeName - configuration parameter type, as defined by one of the TYPE constants on the
ConfigurationParameter interface.aMultiValued - true if and only if the configuration parameter is multi-valued. If true,
aClass is expected to be an array.aClass can be legally assigned to
a parameter described by aTypeName and aMultiValued.protected static boolean isValidDataTypeName(Object aTypeName)
setType(String) method, and are defined by the TYPE constants on
the ConfigurationParameter interface.aTypeName - an Object to testaTypeName is a String that is a valid
data type name.protected void readArrayPropertyValueFromXMLElement(PropertyXmlInfo aPropXmlInfo, Class aPropClass, Element aElement, XMLParser aParser, XMLParser.ParsingOptions aOptions) throws InvalidXMLException
readArrayPropertyValueFromXMLElement in class MetaDataObject_implaPropXmlInfo - information about the property to readaPropClass - class of the property's valueaElement - DOM element representing the entire arrayaParser - parser to use to construct complex valuesaOptions - option settingsInvalidXMLException - -protected XmlizationInfo getXmlizationInfo()
MetaDataObject_implgetXmlizationInfo in class MetaDataObject_implCopyright © 2006–2021 The Apache Software Foundation. All rights reserved.