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

java.lang.Object
  org.apache.uima.resource.metadata.impl.MetaDataObject_impl
      org.apache.uima.resource.metadata.impl.ConfigurationParameterDeclarations_impl

All Implemented Interfaces:

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

public class ConfigurationParameterDeclarations_impl
extends MetaDataObject_impl
implements ConfigurationParameterDeclarations

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.apache.uima.resource.metadata.ConfigurationParameterDeclarations

SEARCH_STRATEGY_DEFAULT_FALLBACK, SEARCH_STRATEGY_LANGUAGE_FALLBACK, SEARCH_STRATEGY_NONE

Constructor Summary

ConfigurationParameterDeclarations_impl()

Method Summary

protected ConfigurationParameter	_getConfigurationParameter(ConfigurationParameter[] aParams, java.lang.String aName) Utility method
void	addCommonParameter(ConfigurationParameter aConfigurationParameter) Adds a Configuration Parameter that is common to all groups.
void	addConfigurationGroup(ConfigurationGroup aConfigurationGroup) Adds a Configuration Group.
void	addConfigurationParameter(ConfigurationParameter aConfigurationParameter) Adds a Configuration Parameter that is not in any group.
void	buildFromXMLElement(org.w3c.dom.Element aElement, XMLParser aParser, XMLParser.ParsingOptions aOptions) Overridden to provide custom XMLization.
ConfigurationParameter[]	getCommonParameters() Gets the configuration parameters that are common to all groups.
ConfigurationGroup[]	getConfigurationGroupDeclarations(java.lang.String aGroupName) Gets the declarations of a named configuration group.
ConfigurationGroup[]	getConfigurationGroups() Gets the configuration parameter groups for this Resource.
ConfigurationParameter	getConfigurationParameter(java.lang.String aGroupName, java.lang.String aParamName) Gets a configuration parameter.
ConfigurationParameter[]	getConfigurationParameters() Gets the configuration parameters for this Resource.
java.lang.String	getDefaultGroupName() Gets the name of the default configuration group.
java.lang.String	getSearchStrategy() Gets the configuration parameter search strategy.
protected org.xml.sax.helpers.AttributesImpl	getXMLAttributes() Called by the toXML(Writer,String) method to get the XML attributes that will be written as part of the element's tag.
protected java.lang.String	getXMLAttributeString() Overridden to return defaultGroup and searchStrategy as XML attributes.
protected XmlizationInfo	getXmlizationInfo() To be implemented by subclasses to return information describing how to represent this object in XML.
void	removeCommonParameter(ConfigurationParameter aConfigurationParameter) Removes an Configuration Parameter that is common to all groups.
void	removeConfigurationGroup(ConfigurationGroup aConfigurationGroup) Removes an Configuration Group
void	removeConfigurationParameter(ConfigurationParameter aConfigurationParameter) Removes an Configuration Parameter that is not in any group.
void	setCommonParameters(ConfigurationParameter[] aParams) Sets the configuration parameters that are common to all groups.
void	setConfigurationGroups(ConfigurationGroup[] aGroups) Sets the configuration parameter groups for this Resource.
void	setConfigurationParameters(ConfigurationParameter[] aParams) Sets the configuration parameters for this Resource.
void	setDefaultGroupName(java.lang.String aGroupName) Sets the name of the default configuration group.
void	setSearchStrategy(java.lang.String aStrategy) Sets the configuration parameter search strategy.

Methods inherited from class org.apache.uima.resource.metadata.impl.MetaDataObject_impl

buildFromXMLElement, clone, equals, getAttributeClass, getAttributeValue, getPropertyDescriptors, getPropertyXmlInfo, getRelativePathBase, getSourceUrl, getSourceUrlString, getWrapperClass, hashCode, isModifiable, listAttributes, readArrayPropertyValueFromXMLElement, 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, toXML, toXML, toXML, toXML

Constructor Detail

ConfigurationParameterDeclarations_impl

public ConfigurationParameterDeclarations_impl()

Method Detail

getConfigurationParameters

public ConfigurationParameter[] getConfigurationParameters()

Description copied from interface: ConfigurationParameterDeclarations

Gets the configuration parameters for this Resource. This gets configuration parameters that are not defined within a group - see also ConfigurationParameterDeclarations.getConfigurationGroups().

Specified by:

getConfigurationParameters in interface ConfigurationParameterDeclarations

Returns:

an array containing ConfigurationParameter objects, each of which describes a configuration parameter for this Resource.

See Also:

org.apache.uima.resource.ConfigurationParameterDeclarations#getConfigurationParameters()

setConfigurationParameters

public void setConfigurationParameters(ConfigurationParameter[] aParams)

Description copied from interface: ConfigurationParameterDeclarations

Sets the configuration parameters for this Resource. This sets the configuration parameters that are not defined within groups - see also ConfigurationParameterDeclarations.setConfigurationGroups(ConfigurationGroup[]).

Specified by:

setConfigurationParameters in interface ConfigurationParameterDeclarations

Parameters:

aParams - an array containing ConfigurationParameter objects, each of which describes a configuration parameter for this Resource.

See Also:

org.apache.uima.resource.ConfigurationParameterDeclarations#setConfigurationParameters(ConfigurationParameter[])

getCommonParameters

public ConfigurationParameter[] getCommonParameters()

Description copied from interface: ConfigurationParameterDeclarations

Gets the configuration parameters that are common to all groups. This property is only meaninful if at least one group is defined.

Specified by:

getCommonParameters in interface ConfigurationParameterDeclarations

Returns:

an array containing ConfigurationParameter objects, each of which describes a parameter common to all groups.

See Also:

org.apache.uima.resource.ConfigurationParameterDeclarations#getCommonParameters()

getConfigurationGroups

public ConfigurationGroup[] getConfigurationGroups()

Description copied from interface: ConfigurationParameterDeclarations

Gets the configuration parameter groups for this Resource.

Specified by:

getConfigurationGroups in interface ConfigurationParameterDeclarations

Returns:

an array containing ConfigurationGroup objects, each of which describes a configuration parameter group for this Resource.

See Also:

org.apache.uima.resource.ConfigurationParameterDeclarations#getConfigurationGroups()

getDefaultGroupName

public java.lang.String getDefaultGroupName()

Description copied from interface: ConfigurationParameterDeclarations

Gets the name of the default configuration group. This must refer to the names of the configuration groups.

Specified by:

getDefaultGroupName in interface ConfigurationParameterDeclarations

Returns:

the name of the default configuration group

See Also:

org.apache.uima.resource.ConfigurationParameterDeclarations#getDefaultGroupName()

getSearchStrategy

public java.lang.String getSearchStrategy()

Description copied from interface: ConfigurationParameterDeclarations

Gets the configuration parameter search strategy. Valid values for this property are defined by constants on this interface.

Specified by:

getSearchStrategy in interface ConfigurationParameterDeclarations

Returns:

the configuration parameter search strategy

See Also:

org.apache.uima.resource.ConfigurationParameterDeclarations#getSearchStragtegy()

setCommonParameters

public void setCommonParameters(ConfigurationParameter[] aParams)

Description copied from interface: ConfigurationParameterDeclarations

Sets the configuration parameters that are common to all groups. This property is only meaninful if at least one group is defined.

Specified by:

setCommonParameters in interface ConfigurationParameterDeclarations

Parameters:

aParams - an array containing ConfigurationParameter objects, each of which describes a parameter common to all groups.

See Also:

org.apache.uima.resource.ConfigurationParameterDeclarations#setCommonParameters(org.apache.uima.resource.ConfigurationParameter[])

setConfigurationGroups

public void setConfigurationGroups(ConfigurationGroup[] aGroups)

Description copied from interface: ConfigurationParameterDeclarations

Sets the configuration parameter groups for this Resource.

Specified by:

setConfigurationGroups in interface ConfigurationParameterDeclarations

Parameters:

aGroups - an array containing ConfigurationGroup objects, each of which describes a configuration parameter group for this Resource.

See Also:

org.apache.uima.resource.ConfigurationParameterDeclarations#setConfigurationGroups(org.apache.uima.resource.ConfigurationGroup[])

setDefaultGroupName

public void setDefaultGroupName(java.lang.String aGroupName)

Description copied from interface: ConfigurationParameterDeclarations

Sets the name of the default configuration group. This must refer to the names of the configuration groups.

Specified by:

setDefaultGroupName in interface ConfigurationParameterDeclarations

Parameters:

aGroupName - the name of the default configuration group

See Also:

org.apache.uima.resource.ConfigurationParameterDeclarations#setDefaultGroupName(java.lang.String)

setSearchStrategy

public void setSearchStrategy(java.lang.String aStrategy)

Description copied from interface: ConfigurationParameterDeclarations

Sets the configuration parameter search strategy. Valid values for this property are defined by constants on this interface.

Specified by:

setSearchStrategy in interface ConfigurationParameterDeclarations

Parameters:

aStrategy - the configuration parameter search strategy

See Also:

org.apache.uima.resource.ConfigurationParameterDeclarations#setSearchStrategy(java.lang.String)

getConfigurationParameter

public ConfigurationParameter getConfigurationParameter(java.lang.String aGroupName,
                                                        java.lang.String aParamName)

Description copied from interface: ConfigurationParameterDeclarations

Gets a configuration parameter.

Specified by:

getConfigurationParameter in interface ConfigurationParameterDeclarations

Parameters:

aGroupName - the name of a group, or null for no group

aParamName - the name of the parameter

Returns:

the specified parameter, null if it does not exist

See Also:

org.apache.uima.resource.ConfigurationParameterDeclarations#getConfigurationParameter(java.lang.String, java.lang.String)

getConfigurationGroupDeclarations

public ConfigurationGroup[] getConfigurationGroupDeclarations(java.lang.String aGroupName)

Description copied from interface: ConfigurationParameterDeclarations

Gets the declarations of a named configuration group. There may be more than one declaration for a single group name; in this case, all parameters contained in each of these declarations are considered part of the named group.

Specified by:

getConfigurationGroupDeclarations in interface ConfigurationParameterDeclarations

Parameters:

aGroupName - the name of a group

Returns:

an array of ConfigurationGroup declarations having the name aGroupName. If there are no such groups, an empty array is returned.

See Also:

org.apache.uima.resource.ConfigurationParameterDeclarations#getConfigurationGroup(java.lang.String)

addConfigurationParameter

public void addConfigurationParameter(ConfigurationParameter aConfigurationParameter)

Description copied from interface: ConfigurationParameterDeclarations

Adds a Configuration Parameter that is not in any group.

Specified by:

addConfigurationParameter in interface ConfigurationParameterDeclarations

Parameters:

aConfigurationParameter - the Configuration Parameter to add

removeConfigurationParameter

public void removeConfigurationParameter(ConfigurationParameter aConfigurationParameter)

Description copied from interface: ConfigurationParameterDeclarations

Removes an Configuration Parameter that is not in any group.

Specified by:

removeConfigurationParameter in interface ConfigurationParameterDeclarations

Parameters:

aConfigurationParameter - the Configuration Parameter to remove (must be == with an ConfigurationParameter in this collection, or this method will do nothing).

addCommonParameter

public void addCommonParameter(ConfigurationParameter aConfigurationParameter)

Description copied from interface: ConfigurationParameterDeclarations

Adds a Configuration Parameter that is common to all groups.

Specified by:

addCommonParameter in interface ConfigurationParameterDeclarations

Parameters:

aConfigurationParameter - the Configuration Parameter to add

removeCommonParameter

public void removeCommonParameter(ConfigurationParameter aConfigurationParameter)

Description copied from interface: ConfigurationParameterDeclarations

Removes an Configuration Parameter that is common to all groups.

Specified by:

removeCommonParameter in interface ConfigurationParameterDeclarations

Parameters:

aConfigurationParameter - the Configuration Parameter to remove (must be == with an ConfigurationParameter in this collection, or this method will do nothing).

addConfigurationGroup

public void addConfigurationGroup(ConfigurationGroup aConfigurationGroup)

Description copied from interface: ConfigurationParameterDeclarations

Adds a Configuration Group.

Specified by:

addConfigurationGroup in interface ConfigurationParameterDeclarations

Parameters:

aConfigurationGroup - the Configuration Group to add

removeConfigurationGroup

public void removeConfigurationGroup(ConfigurationGroup aConfigurationGroup)

Description copied from interface: ConfigurationParameterDeclarations

Removes an Configuration Group

Specified by:

removeConfigurationGroup in interface ConfigurationParameterDeclarations

Parameters:

aConfigurationGroup - the Configuration Group to remove (must be == with an ConfigurationGroup defined on this resource, or this method will do nothing).

_getConfigurationParameter

protected ConfigurationParameter _getConfigurationParameter(ConfigurationParameter[] aParams,
                                                            java.lang.String aName)

Utility method

buildFromXMLElement

public void buildFromXMLElement(org.w3c.dom.Element aElement,
                                XMLParser aParser,
                                XMLParser.ParsingOptions aOptions)
                         throws InvalidXMLException

Overridden to provide custom XMLization.

Specified by:

buildFromXMLElement in interface XMLizable

Overrides:

buildFromXMLElement in class MetaDataObject_impl

Parameters:

aElement - the XML element that represents this object.

aParser - a reference to the UIMA XMLParser. The XMLParser.buildObject(Element) method can be used to construct sub-objects.

aOptions - option settings

Throws:

InvalidXMLException - if the input XML element does not specify a valid object

See Also:

XMLizable.buildFromXMLElement(org.w3c.dom.Element, org.apache.uima.util.XMLParser)

getXMLAttributeString

protected java.lang.String getXMLAttributeString()

Overridden to return defaultGroup and searchStrategy as XML attributes.

See Also:

org.apache.uima.resource.impl.MetaDataObject_impl#getXMLAttributeString()

getXMLAttributes

protected org.xml.sax.helpers.AttributesImpl getXMLAttributes()

Description copied from class: MetaDataObject_impl

Called by the toXML(Writer,String) method to get the XML attributes that will be written as part of the element's tag. By default this method returns an empty Attributes object. Subclasses may override it in order to write attributes to the XML.

Overrides:

getXMLAttributes in class MetaDataObject_impl

Returns:

an object defining the attributes to be written to the XML

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

See Also:

org.apache.uima.resource.impl.MetaDataObject_impl#getXmlizationInfo()