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(org.lsst.ccs.config.ConfigurationDescription configDesc)
ConfigurationView(ConfigurationView view)
ConfigurationView(SingleCategoryTagData tagData)

Method Summary

Modifier and Type	Method and Description
boolean	containsPath(org.lsst.ccs.utilities.structs.ParameterPath path)
ConfigurationView	diff(ConfigurationView other) Performs a diff view between this view and the one passed as argument.
Map<org.lsst.ccs.utilities.structs.ParameterPath,String>	getAsParameterPathMap()
Properties	getAsProperties()
org.lsst.ccs.config.ConfigurationDescription	getConfigurationDescription()
String	getPathValue(org.lsst.ccs.utilities.structs.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(org.lsst.ccs.utilities.structs.ParameterPath pp)
void	setConfigurationDescription(org.lsst.ccs.config.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(org.lsst.ccs.config.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<org.lsst.ccs.utilities.structs.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(org.lsst.ccs.utilities.structs.ParameterPath path)

getPathValue

public String getPathValue(org.lsst.ccs.utilities.structs.ParameterPath path)

getConfigurationDescription

public org.lsst.ccs.config.ConfigurationDescription getConfigurationDescription()

setConfigurationDescription

public void setConfigurationDescription(org.lsst.ccs.config.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(org.lsst.ccs.utilities.structs.ParameterPath pp)