|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.uima.resource.metadata.impl.MetaDataObject_impl
org.apache.uima.resource.metadata.impl.ConfigurationParameter_impl
public class ConfigurationParameter_impl
Reference implementation of org.apache.uima.resource.ConfigurationParameter
.
Field Summary |
---|
Fields inherited from interface org.apache.uima.resource.metadata.ConfigurationParameter |
---|
TYPE_BOOLEAN, TYPE_FLOAT, TYPE_INTEGER, TYPE_STRING |
Constructor Summary | |
---|---|
ConfigurationParameter_impl()
|
Method Summary | |
---|---|
void |
addOverride(java.lang.String aOverride)
Adds an override to this configuration parameter. |
java.lang.String |
getDescription()
Retrieves the description of this configuration parameter. |
java.lang.String |
getName()
Retrieves the name of this configuration parameter. |
java.lang.String[] |
getOverrides()
Gets the parameters that are this parameter overrides. |
java.lang.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(java.lang.Object aTypeName)
Determines whether the given String is a valid name for a data type. |
protected void |
readArrayPropertyValueFromXMLElement(PropertyXmlInfo aPropXmlInfo,
java.lang.Class aPropClass,
org.w3c.dom.Element aElement,
XMLParser aParser,
XMLParser.ParsingOptions aOptions)
Overriden to allow both "param" and "parameter" as the array element tags. |
void |
removeOverride(java.lang.String aOverride)
Removes an override from this configuration parameter. |
void |
setDescription(java.lang.String aDescription)
Sets the description 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(java.lang.String aName)
Sets the name of this configuration parameter. |
void |
setOverrides(java.lang.String[] aOverrides)
Sets the parameters that are this parameter overrides. |
void |
setType(java.lang.String aType)
Sets the data type of this configuration parameter. |
static boolean |
typeMatch(java.lang.Class aClass,
java.lang.String aTypeName,
boolean aMultiValued)
Determines whether the given Java class is an appropriate value for a parameter with the specified type. |
Methods inherited from class org.apache.uima.resource.metadata.impl.MetaDataObject_impl |
---|
buildFromXMLElement, buildFromXMLElement, clone, equals, getAttributeClass, getAttributeValue, getPropertyDescriptors, getPropertyXmlInfo, getRelativePathBase, getSourceUrl, getSourceUrlString, getWrapperClass, getXMLAttributes, hashCode, isModifiable, listAttributes, readMapPropertyFromXml, readPropertyValueFromXMLElement, readUnknownPropertyValueFromXMLElement, setAttributeValue, setSourceUrl, setSourceUrlIfNull, toString, toXML, toXML, toXML, toXML, 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, buildFromXMLElement, toXML, toXML, toXML, toXML |
Constructor Detail |
---|
public ConfigurationParameter_impl()
Method Detail |
---|
public java.lang.String getName()
ConfigurationParameter
getName
in interface ConfigurationParameter
org.apache.uima.resource.ConfigurationParameter#getName()
public void setName(java.lang.String aName)
ConfigurationParameter
setName
in interface ConfigurationParameter
aName
- the name of this configuration parameter.org.apache.uima.resource.ConfigurationParameter#setName(String)
public java.lang.String getDescription()
ConfigurationParameter
getDescription
in interface ConfigurationParameter
org.apache.uima.resource.ConfigurationParameter#getDescription()
public void setDescription(java.lang.String aDescription)
ConfigurationParameter
setDescription
in interface ConfigurationParameter
aDescription
- the description of this configuraiton parameter.org.apache.uima.resource.ConfigurationParameter#setDescription(String)
public java.lang.String getType()
ConfigurationParameter
getType
in interface ConfigurationParameter
org.apache.uima.resource.ConfigurationParameter#getType()
public void setType(java.lang.String aType) throws UIMA_IllegalArgumentException
ConfigurationParameter
setType
in interface ConfigurationParameter
aType
- the data type of this configuraiton 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.org.apache.uima.resource.ConfigurationParameter#setType(int)
public boolean isMultiValued()
ConfigurationParameter
isMultiValued
in interface ConfigurationParameter
org.apache.uima.resource.ConfigurationParameter#isMultiValued()
public void setMultiValued(boolean aMultiValued)
ConfigurationParameter
setMultiValued
in interface ConfigurationParameter
aMultiValued
- true if and only if this parameter is multi-valued.org.apache.uima.resource.ConfigurationParameter#setMultiValued(boolean)
public boolean isMandatory()
ConfigurationParameter
isMandatory
in interface ConfigurationParameter
org.apache.uima.resource.ConfigurationParameter#isMandatory()
public void setMandatory(boolean aMandatory)
ConfigurationParameter
setMandatory
in interface ConfigurationParameter
aMandatory
- true if and only if this parameter is mandatory.org.apache.uima.resource.ConfigurationParameter#setMandatory(boolean)
public java.lang.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
org.apache.uima.resource.ConfigurationParameter#setPublished(boolean)
public void setOverrides(java.lang.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(java.lang.String aOverride)
ConfigurationParameter
addOverride
in interface ConfigurationParameter
aOverride
- the override to addConfigurationParameter.setOverrides(String[])
public void removeOverride(java.lang.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(java.lang.Class aClass, java.lang.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(java.lang.Object aTypeName)
setType(String)
method, and are defined by the TYPE constants on
the ConfigurationParameter
interface.
aTypeName
- an Object to test
aTypeName
is a String
that is a valid
data type name.protected void readArrayPropertyValueFromXMLElement(PropertyXmlInfo aPropXmlInfo, java.lang.Class aPropClass, org.w3c.dom.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 settings
InvalidXMLException
protected XmlizationInfo getXmlizationInfo()
MetaDataObject_impl
getXmlizationInfo
in class MetaDataObject_impl
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |