public class ConfigurationParameter_impl extends MetaDataObject_impl implements ConfigurationParameter
ConfigurationParameter
.MetaDataObject_impl.MetaDataAttr, MetaDataObject_impl.SerialContext, MetaDataObject_impl.Serializer
serialContext
TYPE_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, writePropertyAsElement
finalize, getClass, notify, notifyAll, wait, wait, wait
clone, equals, getAttributeValue, getSourceUrl, getSourceUrlString, isModifiable, listAttributes, setAttributeValue, setSourceUrl
buildFromXMLElement, buildFromXMLElement, toXML, toXML, toXML, toXML
public String getName()
ConfigurationParameter
getName
in interface ConfigurationParameter
ConfigurationParameter.getName()
public void setName(String aName)
ConfigurationParameter
setName
in interface ConfigurationParameter
aName
- the name of this configuration parameter.ConfigurationParameter.setName(String)
public String getExternalOverrideName()
ConfigurationParameter
getExternalOverrideName
in interface ConfigurationParameter
ConfigurationParameter.getExternalOverrideName()
public void setExternalOverrideName(String aExternalOverrideName)
ConfigurationParameter
setExternalOverrideName
in interface ConfigurationParameter
aExternalOverrideName
- the external name of this configuration parameter.ConfigurationParameter.setExternalOverrideName(String)
public String getDescription()
ConfigurationParameter
getDescription
in interface ConfigurationParameter
ConfigurationParameter.getDescription()
public void setDescription(String aDescription)
ConfigurationParameter
setDescription
in interface ConfigurationParameter
aDescription
- the description of this configuration parameter.ConfigurationParameter.setDescription(String)
public String getType()
ConfigurationParameter
getType
in interface ConfigurationParameter
ConfigurationParameter.getType()
public void setType(String aType) throws UIMA_IllegalArgumentException
ConfigurationParameter
setType
in interface ConfigurationParameter
aType
- 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()
ConfigurationParameter
isMultiValued
in interface ConfigurationParameter
ConfigurationParameter.isMultiValued()
public void setMultiValued(boolean aMultiValued)
ConfigurationParameter
setMultiValued
in interface ConfigurationParameter
aMultiValued
- true if and only if this parameter is multi-valued.ConfigurationParameter.setMultiValued(boolean)
public boolean isMandatory()
ConfigurationParameter
isMandatory
in interface ConfigurationParameter
ConfigurationParameter.isMandatory()
public void setMandatory(boolean aMandatory)
ConfigurationParameter
setMandatory
in interface ConfigurationParameter
aMandatory
- 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 ConfigurationParameter
public 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 ConfigurationParameter
aOverrides
- the parameters this this parameter overridespublic void addOverride(String aOverride)
ConfigurationParameter
addOverride
in interface ConfigurationParameter
aOverride
- the override to addConfigurationParameter.setOverrides(String[])
public void removeOverride(String aOverride)
ConfigurationParameter
removeOverride
in interface ConfigurationParameter
aOverride
- 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_impl
aPropXmlInfo
- 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_impl
getXmlizationInfo
in class MetaDataObject_impl
Copyright © 2006–2021 The Apache Software Foundation. All rights reserved.