org.lsst.ccs.bus.data

Class ConfigurationInfo

java.lang.Object

org.lsst.ccs.bus.data.ConfigurationInfo

All Implemented Interfaces:

Serializable

public final class ConfigurationInfo
extends Object
implements Serializable

A Class containing the Agent's configuration information.

Author:

The LSST CCS Team

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ConfigurationInfo(ConfigurationState configState, String tagName)
	ConfigurationInfo(ConfigurationState configState, String tagName, Map<String,String> tags, Map<String,Boolean> hasCategoryChanged, List<ConfigurationParameterInfo> parametersView)
	ConfigurationInfo(ConfigurationState configState, String tagName, Map<String,String> tags, Map<String,Boolean> hasCategoryChanged, List<ConfigurationParameterInfo> parametersView, List<String> recentChanges)

Method Summary

Modifier and Type	Method and Description
List<ConfigurationParameterInfo>	getAllParameterInfo() Returns a list of ConfigurationParameterInfo.
Set<String>	getCategorySet()
String	getConfigNameForCategory(String category)
String	getConfigurationName()
ConfigurationState	getConfigurationState()
String	getCurrentValueForParameter(String pathName) Return the current value of a given configurable parameter
Map<String,String>	getCurrentValuesFor(String componentName) Returns the current value of each parameter that belong to the specified configurable component.
Map<String,String>	getCurrentValuesForCategory(String category) Returns the current value of each parameter that belong to the specified category.
Map<String,String>	getCurrentValuesForComponent(String componentName) Deprecated. the keys are componentName//parameterName
String	getDescriptionName() Returns the subsystem description name, ie the name of the description file the subsystem is started with.
List<ConfigurationParameterInfo>	getLatestChanges() Returns a list of the recent changes caused by the If a single change is processed, the returned list contains this change only.
static Map<String,List<ConfigurationParameterInfo>>	getParameterInfoGroupByCategory(List<ConfigurationParameterInfo> parmList) Groups the ConfigurationParameterInfo objects of the input list by the category they belong to.
static Map<String,List<ConfigurationParameterInfo>>	getParameterInfoGroupByComponent(List<ConfigurationParameterInfo> parmList) Groups the ConfigurationParameterInfo objects of the input list by the component they belong to.
boolean	hasCategory(String category) Tests if category is one of the subsystem parameter categories.
boolean	hasChanges()
boolean	hasChangesForCategory(String category) Returns true if there are unsaved changes for the specified category.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ConfigurationInfo

protected ConfigurationInfo(ConfigurationState configState,
                            String tagName)

ConfigurationInfo

public ConfigurationInfo(ConfigurationState configState,
                         String tagName,
                         Map<String,String> tags,
                         Map<String,Boolean> hasCategoryChanged,
                         List<ConfigurationParameterInfo> parametersView)

ConfigurationInfo

public ConfigurationInfo(ConfigurationState configState,
                         String tagName,
                         Map<String,String> tags,
                         Map<String,Boolean> hasCategoryChanged,
                         List<ConfigurationParameterInfo> parametersView,
                         List<String> recentChanges)

Method Detail

getDescriptionName

public String getDescriptionName()

Returns the subsystem description name, ie the name of the description file the subsystem is started with.

Returns:

the subsystem description name

getConfigurationName

public String getConfigurationName()

Returns:

the String representation of the configuration state

hasChangesForCategory

public boolean hasChangesForCategory(String category)

Returns true if there are unsaved changes for the specified category.

Parameters:

category -

Returns:

true if there are unsaved changes for the specified category, false otherwise.

hasChanges

public boolean hasChanges()

Returns:

true if there are no unsaved changes for all categories.

getConfigNameForCategory

public String getConfigNameForCategory(String category)

Parameters:

category -

Returns:

the base configuration name for the specified category.

hasCategory

public boolean hasCategory(String category)

Tests if category is one of the subsystem parameter categories.

Parameters:

category -

Returns:

true if category is one of the parameter categories of the subsystem.

getCategorySet

public Set<String> getCategorySet()

Returns:

the set of categories the configurable parameters of the subsystem this object stands for are splitted into.

getConfigurationState

public ConfigurationState getConfigurationState()

Returns:

the configuration state

toString

public String toString()

Overrides:

toString in class Object

Returns:

a String representation of the object

getAllParameterInfo

public List<ConfigurationParameterInfo> getAllParameterInfo()

Returns a list of ConfigurationParameterInfo. Each element of this list represents the current view of a configurable parameter.

Returns:

a List of ConfigurationParameterInfo

getLatestChanges

public List<ConfigurationParameterInfo> getLatestChanges()

Returns a list of the recent changes caused by the

• If a single change is processed, the returned list contains this change only.
• If a bulk change is processed, the returned list contains all the changes that have been submitted, validated and successfully set during this bulk change session.

Returns:

the list of recent changes.

getCurrentValuesForCategory

public Map<String,String> getCurrentValuesForCategory(String category)

Returns the current value of each parameter that belong to the specified category.

Parameters:

category -

Returns:

a Map of parameter pathName and their current value.

getCurrentValuesForComponent

@Deprecated
public Map<String,String> getCurrentValuesForComponent(String componentName)

Deprecated. the keys are componentName//parameterName

Returns the current value of each parameter that belong to the specified configurable component.

Parameters:

componentName - the path of the parameter

Returns:

a Map of parameter pathName and their current value.

getCurrentValuesFor

public Map<String,String> getCurrentValuesFor(String componentName)

Returns the current value of each parameter that belong to the specified configurable component.

Parameters:

componentName - the name of the component

Returns:

a Map of parameter names to their current value.

getCurrentValueForParameter

public String getCurrentValueForParameter(String pathName)

Return the current value of a given configurable parameter

Parameters:

pathName - the path name of a parameter

Returns:

a String representation of the parameter's value

getParameterInfoGroupByComponent

public static Map<String,List<ConfigurationParameterInfo>> getParameterInfoGroupByComponent(List<ConfigurationParameterInfo> parmList)

Groups the ConfigurationParameterInfo objects of the input list by the component they belong to.

Parameters:

parmList -

Returns:

a Map of component name to the list of their parameters.

getParameterInfoGroupByCategory

public static Map<String,List<ConfigurationParameterInfo>> getParameterInfoGroupByCategory(List<ConfigurationParameterInfo> parmList)

Groups the ConfigurationParameterInfo objects of the input list by the category they belong to.

Parameters:

parmList -

Returns:

a Map of category names to the list of parameters that belong to this category.