Interface ConfigurationGroup
- All Superinterfaces:
Cloneable,MetaDataObject,Serializable,XMLizable
- All Known Implementing Classes:
ConfigurationGroup_impl
A group of
ConfigurationParameters. Actually, a single ConfigurationGroup
object can have multiple group names, in which case it represents multiple groups that all share
the same parameters.-
Method Summary
Modifier and TypeMethodDescriptionvoidaddConfigurationParameter(ConfigurationParameter aConfigurationParameter) Adds a Configuration Parameter to this group.Gets the configuration parameters in this group.String[]getNames()Gets the group names for thisConfigurationGroupobject.voidremoveConfigurationParameter(ConfigurationParameter aConfigurationParameter) Removes an Configuration Parameter from this group.voidsetConfigurationParameters(ConfigurationParameter[] aParams) Sets the configuration parameters in this group.voidSets the group names for thisConfigurationGroupobject.Methods inherited from interface org.apache.uima.resource.metadata.MetaDataObject
clone, equals, getAttributeValue, getSourceUrl, getSourceUrlString, isModifiable, listAttributes, setAttributeValue, setSourceUrlMethods inherited from interface org.apache.uima.util.XMLizable
buildFromXMLElement, buildFromXMLElement, toXML, toXML, toXML, toXML
-
Method Details
-
getNames
String[] getNames()Gets the group names for thisConfigurationGroupobject.- Returns:
- an array of group names. Names are not allowed to contain whitespace.
-
setNames
Sets the group names for thisConfigurationGroupobject.- Parameters:
aNames- an array of group names. Names are not allowed to contain whitespace.
-
getConfigurationParameters
ConfigurationParameter[] getConfigurationParameters()Gets the configuration parameters in this group.- Returns:
- an array containing
ConfigurationParameterobjects, each of which describes a configuration parameter in this group.
-
setConfigurationParameters
Sets the configuration parameters in this group.- Parameters:
aParams- an array containingConfigurationParameterobjects, each of which describes a configuration parameter in this group.
-
addConfigurationParameter
Adds a Configuration Parameter to this group.- Parameters:
aConfigurationParameter- the Configuration Parameter to add- Throws:
UIMA_UnsupportedOperationException- if this object is not modifiable
-
removeConfigurationParameter
Removes an Configuration Parameter from this group.- Parameters:
aConfigurationParameter- the Configuration Parameter to remove (must be == with an ConfigurationParameter in this group, or this method will do nothing).- Throws:
UIMA_UnsupportedOperationException- if this object is not modifiable
-