org.lsst.ccs.config

Class ConfigurationView

java.lang.Object

org.lsst.ccs.config.ConfigurationView

All Implemented Interfaces:

Serializable

public class ConfigurationView
extends Object
implements Serializable

A view of the configuration parameters values, ordered by the component they belong to. It is used as the result of a request for loading a configuration.

Author:

LSST CCS Team

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ConfigurationView()
ConfigurationView(ConfigurationDescription configDesc)
ConfigurationView(ConfigurationView view)
ConfigurationView(SingleCategoryTagData tagData)

Method Summary

Modifier and Type	Method and Description
boolean	containsPath(ParameterPath path)
ConfigurationView	diff(ConfigurationView other) Performs a diff view between this view and the one passed as argument.
Map<ParameterPath,String>	getAsParameterPathMap()
Properties	getAsProperties()
ConfigurationDescription	getConfigurationDescription()
String	getPathValue(ParameterPath path)
Map<String,String>	getValuesForComponent(String componentName)
boolean	isEmpty()
void	putAll(ConfigurationView cv)
void	putParameterValue(String parameterFullName, String value)
void	putParameterValue(String componentName, String parmName, String value)
void	putValuesForComponent(String componentName, Map<String,String> values)
void	removeValueForPath(ParameterPath pp)
void	setConfigurationDescription(ConfigurationDescription configDesc)

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurationView

public ConfigurationView()

ConfigurationView

public ConfigurationView(ConfigurationView view)

ConfigurationView

public ConfigurationView(ConfigurationDescription configDesc)

ConfigurationView

public ConfigurationView(SingleCategoryTagData tagData)

Method Detail

putParameterValue

public final void putParameterValue(String parameterFullName,
                                    String value)

Parameters:

parameterFullName - the full parameter name, such as compName/parmName

value - a String representation of the parameter value.

putParameterValue

public void putParameterValue(String componentName,
                              String parmName,
                              String value)

putAll

public void putAll(ConfigurationView cv)

getAsParameterPathMap

public Map<ParameterPath,String> getAsParameterPathMap()

getAsProperties

public Properties getAsProperties()

diff

public ConfigurationView diff(ConfigurationView other)

Performs a diff view between this view and the one passed as argument. Parameters that are not present in the other view or that are assigned a different value are added to the resulting map.

Parameters:

other -

Returns:

containsPath

public boolean containsPath(ParameterPath path)

getPathValue

public String getPathValue(ParameterPath path)

getConfigurationDescription

public ConfigurationDescription getConfigurationDescription()

setConfigurationDescription

public void setConfigurationDescription(ConfigurationDescription configDesc)

isEmpty

public boolean isEmpty()

getValuesForComponent

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

putValuesForComponent

public void putValuesForComponent(String componentName,
                                  Map<String,String> values)

removeValueForPath

public void removeValueForPath(ParameterPath pp)