org.apache.uima.resource.metadata.impl
Class ConfigurationParameter_impl

java.lang.Object
  extended by org.apache.uima.resource.metadata.impl.MetaDataObject_impl
      extended by org.apache.uima.resource.metadata.impl.ConfigurationParameter_impl
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, ConfigurationParameter, MetaDataObject, XMLizable

public class ConfigurationParameter_impl
extends MetaDataObject_impl
implements ConfigurationParameter

Reference implementation of org.apache.uima.resource.ConfigurationParameter.

See Also:
Serialized Form

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

ConfigurationParameter_impl

public ConfigurationParameter_impl()
Method Detail

getName

public java.lang.String getName()
Description copied from interface: ConfigurationParameter
Retrieves the name of this configuration parameter.

Specified by:
getName in interface ConfigurationParameter
Returns:
the name of this configuration parameter.
See Also:
org.apache.uima.resource.ConfigurationParameter#getName()

setName

public void setName(java.lang.String aName)
Description copied from interface: ConfigurationParameter
Sets the name of this configuration parameter.

Specified by:
setName in interface ConfigurationParameter
Parameters:
aName - the name of this configuration parameter.
See Also:
org.apache.uima.resource.ConfigurationParameter#setName(String)

getDescription

public java.lang.String getDescription()
Description copied from interface: ConfigurationParameter
Retrieves the description of this configuration parameter.

Specified by:
getDescription in interface ConfigurationParameter
Returns:
the description of this configuraiton parameter.
See Also:
org.apache.uima.resource.ConfigurationParameter#getDescription()

setDescription

public void setDescription(java.lang.String aDescription)
Description copied from interface: ConfigurationParameter
Sets the description of this configuration parameter.

Specified by:
setDescription in interface ConfigurationParameter
Parameters:
aDescription - the description of this configuraiton parameter.
See Also:
org.apache.uima.resource.ConfigurationParameter#setDescription(String)

getType

public java.lang.String getType()
Description copied from interface: ConfigurationParameter
Retrieves the data type of this configuration parameter.

Specified by:
getType in interface ConfigurationParameter
Returns:
the data type of this configuraiton parameter. This will be one of the TYPE constants defined on this interface.
See Also:
org.apache.uima.resource.ConfigurationParameter#getType()

setType

public void setType(java.lang.String aType)
             throws UIMA_IllegalArgumentException
Description copied from interface: ConfigurationParameter
Sets the data type of this configuration parameter.

Specified by:
setType in interface ConfigurationParameter
Parameters:
aType - the data type of this configuraiton parameter. This must be one of the TYPE constants defined on this interface.
Throws:
UIMA_IllegalArgumentException - if aType is not a valid data type defined by a TYPE constant on this interface.
See Also:
org.apache.uima.resource.ConfigurationParameter#setType(int)

isMultiValued

public boolean isMultiValued()
Description copied from interface: ConfigurationParameter
Retrieves whether this parameter is multi-valued. Multi-valued parameters take an array of values, each of which must be of the appropriate data type.

Specified by:
isMultiValued in interface ConfigurationParameter
Returns:
true if and only if this parameter is multi-valued.
See Also:
org.apache.uima.resource.ConfigurationParameter#isMultiValued()

setMultiValued

public void setMultiValued(boolean aMultiValued)
Description copied from interface: ConfigurationParameter
Sets whether this parameter is multi-valued. Multi-valued parameters take an array of values, each of which must be of the appropriate data type.

Specified by:
setMultiValued in interface ConfigurationParameter
Parameters:
aMultiValued - true if and only if this parameter is multi-valued.
See Also:
org.apache.uima.resource.ConfigurationParameter#setMultiValued(boolean)

isMandatory

public boolean isMandatory()
Description copied from interface: ConfigurationParameter
Retrieves whether this parameter is mandatory.

Specified by:
isMandatory in interface ConfigurationParameter
Returns:
true if and only if this parameter is mandatory.
See Also:
org.apache.uima.resource.ConfigurationParameter#isMandatory()

setMandatory

public void setMandatory(boolean aMandatory)
Description copied from interface: ConfigurationParameter
Sets whether this parameter is mandatory.

Specified by:
setMandatory in interface ConfigurationParameter
Parameters:
aMandatory - true if and only if this parameter is mandatory.
See Also:
org.apache.uima.resource.ConfigurationParameter#setMandatory(boolean)

getOverrides

public java.lang.String[] getOverrides()
Description copied from interface: ConfigurationParameter
Gets the parameters that are this parameter overrides. This is used for aggregate resources only. Overrides are expressed as strings of the form componentName/parameterName. For example the overrides annotator1/parameter1 would override the parameter named parameter1 within the component named annotator1.

Specified by:
getOverrides in interface ConfigurationParameter
Returns:
the parameters this this parameter overrides
See Also:
org.apache.uima.resource.ConfigurationParameter#setPublished(boolean)

setOverrides

public void setOverrides(java.lang.String[] aOverrides)
Description copied from interface: ConfigurationParameter
Sets the parameters that are this parameter overrides. This is used for aggregate resources only. Overrides are expressed as strings of the form componentName/parameterName. For example the overrides annotator1/parameter1 would override the parameter named parameter1 within the component named annotator1.

Specified by:
setOverrides in interface ConfigurationParameter
Parameters:
aOverrides - the parameters this this parameter overrides

addOverride

public void addOverride(java.lang.String aOverride)
Description copied from interface: ConfigurationParameter
Adds an override to this configuration parameter.

Specified by:
addOverride in interface ConfigurationParameter
Parameters:
aOverride - the override to add
See Also:
ConfigurationParameter.setOverrides(String[])

removeOverride

public void removeOverride(java.lang.String aOverride)
Description copied from interface: ConfigurationParameter
Removes an override from this configuration parameter.

Specified by:
removeOverride in interface ConfigurationParameter
Parameters:
aOverride - the override to remove. Must equal (via the equals() method) one of the overrides on this parameter, or this method will do nothing.
See Also:
ConfigurationParameter.setOverrides(String[])

typeMatch

public 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. For example, if the parameter's type is "Integer", then java.lang.Integer is a match but java.lang.String is not.

Parameters:
aClass - class to check
aTypeName - 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.
Returns:
true if and only if an object of class aClass can be legally assigned to a parameter described by aTypeName and aMultiValued.

isValidDataTypeName

protected static boolean isValidDataTypeName(java.lang.Object aTypeName)
Determines whether the given String is a valid name for a data type. Valid data type names are legal arguments to the setType(String) method, and are defined by the TYPE constants on the ConfigurationParameter interface.

Parameters:
aTypeName - an Object to test
Returns:
true if and only if aTypeName is a String that is a valid data type name.

readArrayPropertyValueFromXMLElement

protected void readArrayPropertyValueFromXMLElement(PropertyXmlInfo aPropXmlInfo,
                                                    java.lang.Class aPropClass,
                                                    org.w3c.dom.Element aElement,
                                                    XMLParser aParser,
                                                    XMLParser.ParsingOptions aOptions)
                                             throws InvalidXMLException
Overriden to allow both "param" and "parameter" as the array element tags. (For historical reasons.)

Overrides:
readArrayPropertyValueFromXMLElement in class MetaDataObject_impl
Parameters:
aPropXmlInfo - information about the property to read
aPropClass - class of the property's value
aElement - DOM element representing the entire array
aParser - parser to use to construct complex values
aOptions - option settings
Throws:
InvalidXMLException

getXmlizationInfo

protected XmlizationInfo getXmlizationInfo()
Description copied from class: MetaDataObject_impl
To be implemented by subclasses to return information describing how to represent this object in XML.

Specified by:
getXmlizationInfo in class MetaDataObject_impl
Returns:
information defining this object's XML representation


Copyright © 2013. All Rights Reserved.