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:
Serializable,Cloneable,ConfigurationParameterDeclarations,MetaDataObject,XMLizable
public class ConfigurationParameterDeclarations_impl
extends MetaDataObject_impl
implements ConfigurationParameterDeclarations
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.uima.resource.metadata.impl.MetaDataObject_impl
MetaDataObject_impl.MetaDataAttr, MetaDataObject_impl.SerialContext, MetaDataObject_impl.Serializer -
Field Summary
Fields inherited from class org.apache.uima.resource.metadata.impl.MetaDataObject_impl
serialContextFields inherited from interface org.apache.uima.resource.metadata.ConfigurationParameterDeclarations
SEARCH_STRATEGY_DEFAULT_FALLBACK, SEARCH_STRATEGY_LANGUAGE_FALLBACK, SEARCH_STRATEGY_NONE -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected ConfigurationParameter_getConfigurationParameter(ConfigurationParameter[] aParams, String aName) voidaddCommonParameter(ConfigurationParameter aConfigurationParameter) Adds a Configuration Parameter that is common to all groups.voidaddConfigurationGroup(ConfigurationGroup aConfigurationGroup) Adds a Configuration Group.voidaddConfigurationParameter(ConfigurationParameter aConfigurationParameter) Adds a Configuration Parameter that is not in any group.voidbuildFromXMLElement(Element aElement, XMLParser aParser, XMLParser.ParsingOptions aOptions) Overridden to provide custom XMLization.Gets the configuration parameters that are common to all groups.getConfigurationGroupDeclarations(String aGroupName) Gets the declarations of a named configuration group.Gets the configuration parameter groups for this Resource.getConfigurationParameter(String aGroupName, String aParamName) Gets a configuration parameter.Gets the configuration parameters for this Resource.Gets the name of the default configuration group.Gets the configuration parameter search strategy.protected AttributesImplCalled by theMetaDataObject_impl.toXML(ContentHandler, boolean)method to get the XML attributes that will be written as part of the element's tag.protected StringOverridden to return defaultGroup and searchStrategy as XML attributes.protected XmlizationInfoTo be implemented by subclasses to return information describing how to represent this object in XML.voidremoveCommonParameter(ConfigurationParameter aConfigurationParameter) Removes an Configuration Parameter that is common to all groups.voidremoveConfigurationGroup(ConfigurationGroup aConfigurationGroup) Removes an Configuration GroupvoidremoveConfigurationParameter(ConfigurationParameter aConfigurationParameter) Removes an Configuration Parameter that is not in any group.voidsetCommonParameters(ConfigurationParameter[] aParams) Sets the configuration parameters that are common to all groups.voidsetConfigurationGroups(ConfigurationGroup[] aGroups) Sets the configuration parameter groups for this Resource.voidsetConfigurationParameters(ConfigurationParameter[] aParams) Sets the configuration parameters for this Resource.voidsetDefaultGroupName(String aGroupName) Sets the name of the default configuration group.voidsetSearchStrategy(String aStrategy) Sets the configuration parameter search strategy.Methods inherited from class org.apache.uima.resource.metadata.impl.MetaDataObject_impl
buildFromXMLElement, clone, equals, getAdditionalAttributes, getAttributeClass, getAttributeValue, getInfoset, getMatchingNode, getPropertyDescriptors, getPropertyXmlInfo, getRelativePathBase, getSerialContext, getSourceUrl, getSourceUrlString, getWrapperClass, hashCode, isModifiable, listAttributes, readArrayPropertyValueFromXMLElement, readMapPropertyFromXml, readPropertyValueFromXMLElement, readUnknownPropertyValueFromXMLElement, resolveSettings, setAttributeValue, setInfoset, setSourceUrl, setSourceUrlIfNull, toString, toXML, toXML, toXML, toXML, valueIsNullOrEmptyArray, writeArrayPropertyAsElement, writeMapPropertyToXml, writePropertyAsElementMethods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.uima.resource.metadata.MetaDataObject
clone, equals, getAttributeValue, getSourceUrl, getSourceUrlString, isModifiable, listAttributes, setAttributeValue, setSourceUrl
-
Constructor Details
-
ConfigurationParameterDeclarations_impl
public ConfigurationParameterDeclarations_impl()
-
-
Method Details
-
getConfigurationParameters
Description copied from interface:ConfigurationParameterDeclarationsGets the configuration parameters for this Resource. This gets configuration parameters that are not defined within a group - see alsoConfigurationParameterDeclarations.getConfigurationGroups().- Specified by:
getConfigurationParametersin interfaceConfigurationParameterDeclarations- Returns:
- an array containing
ConfigurationParameterobjects, each of which describes a configuration parameter for this Resource. - See Also:
-
setConfigurationParameters
Description copied from interface:ConfigurationParameterDeclarationsSets the configuration parameters for this Resource. This sets the configuration parameters that are not defined within groups - see alsoConfigurationParameterDeclarations.setConfigurationGroups(ConfigurationGroup[]).- Specified by:
setConfigurationParametersin interfaceConfigurationParameterDeclarations- Parameters:
aParams- an array containingConfigurationParameterobjects, each of which describes a configuration parameter for this Resource.- See Also:
-
getCommonParameters
Description copied from interface:ConfigurationParameterDeclarationsGets the configuration parameters that are common to all groups. This property is only meaningful if at least one group is defined.- Specified by:
getCommonParametersin interfaceConfigurationParameterDeclarations- Returns:
- an array containing
ConfigurationParameterobjects, each of which describes a parameter common to all groups. - See Also:
-
getConfigurationGroups
Description copied from interface:ConfigurationParameterDeclarationsGets the configuration parameter groups for this Resource.- Specified by:
getConfigurationGroupsin interfaceConfigurationParameterDeclarations- Returns:
- an array containing
ConfigurationGroupobjects, each of which describes a configuration parameter group for this Resource. - See Also:
-
getDefaultGroupName
Description copied from interface:ConfigurationParameterDeclarationsGets the name of the default configuration group. This must refer to the names of theconfiguration groups.- Specified by:
getDefaultGroupNamein interfaceConfigurationParameterDeclarations- Returns:
- the name of the default configuration group
- See Also:
-
getSearchStrategy
Description copied from interface:ConfigurationParameterDeclarationsGets the configuration parameter search strategy. Valid values for this property are defined by constants on this interface.- Specified by:
getSearchStrategyin interfaceConfigurationParameterDeclarations- Returns:
- the configuration parameter search strategy
- See Also:
-
setCommonParameters
Description copied from interface:ConfigurationParameterDeclarationsSets the configuration parameters that are common to all groups. This property is only meaningful if at least one group is defined.- Specified by:
setCommonParametersin interfaceConfigurationParameterDeclarations- Parameters:
aParams- an array containingConfigurationParameterobjects, each of which describes a parameter common to all groups.- See Also:
-
setConfigurationGroups
Description copied from interface:ConfigurationParameterDeclarationsSets the configuration parameter groups for this Resource.- Specified by:
setConfigurationGroupsin interfaceConfigurationParameterDeclarations- Parameters:
aGroups- an array containingConfigurationGroupobjects, each of which describes a configuration parameter group for this Resource.- See Also:
-
setDefaultGroupName
Description copied from interface:ConfigurationParameterDeclarationsSets the name of the default configuration group. This must refer to the names of theconfiguration groups.- Specified by:
setDefaultGroupNamein interfaceConfigurationParameterDeclarations- Parameters:
aGroupName- the name of the default configuration group- See Also:
-
setSearchStrategy
Description copied from interface:ConfigurationParameterDeclarationsSets the configuration parameter search strategy. Valid values for this property are defined by constants on this interface.- Specified by:
setSearchStrategyin interfaceConfigurationParameterDeclarations- Parameters:
aStrategy- the configuration parameter search strategy- See Also:
-
getConfigurationParameter
Description copied from interface:ConfigurationParameterDeclarationsGets a configuration parameter.- Specified by:
getConfigurationParameterin interfaceConfigurationParameterDeclarations- Parameters:
aGroupName- the name of a group, ornullfor no groupaParamName- the name of the parameter- Returns:
- the specified parameter,
nullif it does not exist - See Also:
-
getConfigurationGroupDeclarations
Description copied from interface:ConfigurationParameterDeclarationsGets 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:
getConfigurationGroupDeclarationsin interfaceConfigurationParameterDeclarations- 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:
-
addConfigurationParameter
Description copied from interface:ConfigurationParameterDeclarationsAdds a Configuration Parameter that is not in any group.- Specified by:
addConfigurationParameterin interfaceConfigurationParameterDeclarations- Parameters:
aConfigurationParameter- the Configuration Parameter to add- See Also:
-
removeConfigurationParameter
Description copied from interface:ConfigurationParameterDeclarationsRemoves an Configuration Parameter that is not in any group.- Specified by:
removeConfigurationParameterin interfaceConfigurationParameterDeclarations- Parameters:
aConfigurationParameter- the Configuration Parameter to remove (must be == with an ConfigurationParameter in this collection, or this method will do nothing).- See Also:
-
addCommonParameter
Description copied from interface:ConfigurationParameterDeclarationsAdds a Configuration Parameter that is common to all groups.- Specified by:
addCommonParameterin interfaceConfigurationParameterDeclarations- Parameters:
aConfigurationParameter- the Configuration Parameter to add- See Also:
-
removeCommonParameter
Description copied from interface:ConfigurationParameterDeclarationsRemoves an Configuration Parameter that is common to all groups.- Specified by:
removeCommonParameterin interfaceConfigurationParameterDeclarations- Parameters:
aConfigurationParameter- the Configuration Parameter to remove (must be == with an ConfigurationParameter in this collection, or this method will do nothing).- See Also:
-
addConfigurationGroup
Description copied from interface:ConfigurationParameterDeclarationsAdds a Configuration Group.- Specified by:
addConfigurationGroupin interfaceConfigurationParameterDeclarations- Parameters:
aConfigurationGroup- the Configuration Group to add- See Also:
-
removeConfigurationGroup
Description copied from interface:ConfigurationParameterDeclarationsRemoves an Configuration Group- Specified by:
removeConfigurationGroupin interfaceConfigurationParameterDeclarations- Parameters:
aConfigurationGroup- the Configuration Group to remove (must be == with an ConfigurationGroup defined on this resource, or this method will do nothing).- See Also:
-
_getConfigurationParameter
protected ConfigurationParameter _getConfigurationParameter(ConfigurationParameter[] aParams, String aName) -
buildFromXMLElement
public void buildFromXMLElement(Element aElement, XMLParser aParser, XMLParser.ParsingOptions aOptions) throws InvalidXMLException Overridden to provide custom XMLization.- Specified by:
buildFromXMLElementin interfaceXMLizable- Overrides:
buildFromXMLElementin classMetaDataObject_impl- Parameters:
aElement- the XML element that represents this object.aParser- a reference to the UIMAXMLParser. TheXMLParser.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:
-
getXMLAttributeString
Overridden to return defaultGroup and searchStrategy as XML attributes. 9/2013: superclasses don't have this method, so can't be overridden. 9/2013: method never called- Returns:
- -
-
getXMLAttributes
Description copied from class:MetaDataObject_implCalled by theMetaDataObject_impl.toXML(ContentHandler, boolean)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:
getXMLAttributesin classMetaDataObject_impl- Returns:
- an object defining the attributes to be written to the XML
- See Also:
-
getXmlizationInfo
Description copied from class:MetaDataObject_implTo be implemented by subclasses to return information describing how to represent this object in XML.- Specified by:
getXmlizationInfoin classMetaDataObject_impl- Returns:
- information defining this object's XML representation
- See Also:
-