Interface ConfigurationParameterSettings
-
- All Superinterfaces:
java.lang.Cloneable
,MetaDataObject
,java.io.Serializable
,XMLizable
- All Known Implementing Classes:
ConfigurationParameterSettings_impl
public interface ConfigurationParameterSettings extends MetaDataObject
The values forConfigurationParameter
s in a Resource. When the Resource has declaredConfigurationGroup
s, there may be different values for each group.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description NameValuePair[]
getParameterSettings()
Gets the settings for configuration parameters that are not in any group.java.lang.Object
getParameterValue(java.lang.String aParamName)
Looks up the value of a parameter.java.lang.Object
getParameterValue(java.lang.String aGroupName, java.lang.String aParamName)
Looks up the value of a parameter in a group.java.util.Map<java.lang.String,NameValuePair[]>
getSettingsForGroups()
Gets the settings for configuration parameters that are defined within groups.void
setParameterSettings(NameValuePair[] aSettings)
Sets the settings for configuration parameters that are not in any group.void
setParameterValue(java.lang.String aParamName, java.lang.Object aValue)
Sets the value of a parameter.void
setParameterValue(java.lang.String aGroupName, java.lang.String aParamName, java.lang.Object aValue)
Sets the value of a parameter in a group.-
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
-
-
-
-
Method Detail
-
getParameterSettings
NameValuePair[] getParameterSettings()
Gets the settings for configuration parameters that are not in any group.- Returns:
- an array of
NameValuePair
objects, each of which contains a parameter name and the value of that parameter
-
setParameterSettings
void setParameterSettings(NameValuePair[] aSettings)
Sets the settings for configuration parameters that are not in any group.- Parameters:
aSettings
- an array ofNameValuePair
objects, each of which contains a parameter name and the value of that parameter
-
getSettingsForGroups
java.util.Map<java.lang.String,NameValuePair[]> getSettingsForGroups()
Gets the settings for configuration parameters that are defined within groups.- Returns:
- a Map with
String
keys (the group names) andNameValuePair
[] values (the settings for parameters in that group.
-
getParameterValue
java.lang.Object getParameterValue(java.lang.String aParamName)
Looks up the value of a parameter. This is a "dumb" getter and does not follow any fallback strategies. It will only return the value of a parameter that is not defined in any group.- Parameters:
aParamName
- the name of a parameter that is not in any group- Returns:
- the value of the parameter with name
aParamName
-
getParameterValue
java.lang.Object getParameterValue(java.lang.String aGroupName, java.lang.String aParamName)
Looks up the value of a parameter in a group. This is a "dumb" getter and does not follow any fallback strategies.- Parameters:
aGroupName
- the name of a configuration group. If this parameter isnull
, this method will return the same value asgetParameterValue(String)
.aParamName
- the name of a parameter in the group- Returns:
- the value of the parameter in group
aGroupName
with nameaParamName
-
setParameterValue
void setParameterValue(java.lang.String aParamName, java.lang.Object aValue)
Sets the value of a parameter. This only works for a parameter that is not defined in any group.- Parameters:
aParamName
- the name of a parameter that is not in any groupaValue
- the value to assign to the parameter
-
setParameterValue
void setParameterValue(java.lang.String aGroupName, java.lang.String aParamName, java.lang.Object aValue)
Sets the value of a parameter in a group.- Parameters:
aGroupName
- the name of a configuration groupaParamName
- the name of a parameter in the groupaValue
- the value to assign to the parameter
-
-