org.lsst.ccs.config

Class SingleCategoryTagData

java.lang.Object

org.lsst.ccs.config.SingleCategoryTagData

public class SingleCategoryTagData
extends Object

A Class containing data for a single Configuration Category Tag. This object contains information for a subset of the category tag's configuration parameters, namely the value and the comments associated with the parameter. This class is meant to be used when reading or writing configuration parameters. This class is also used internally by the configuration service to chain tags together and keep track of the origin of a configuration parameter's value.

Author:

The LSST CCS Team

Constructor Summary

Constructors

Constructor and Description
SingleCategoryTagData(SingleCategoryTag singleCategoryTag)
SingleCategoryTagData(SingleCategoryTagData singleCategoryTagData)

Method Summary

Modifier and Type	Method and Description
String	fullDataString() Dump the content of this object in a String.
String	getCommentParameter(String prop)
String	getConditionParameter(String prop)
Map<String,String>	getConfigurationData()
Map<String,String>	getConfigurationDataForAgent(AgentInfo agentInfo)
SingleCategoryTag	getSingleCategoryTag()
void	load(InputStream is)
void	mergeSingleCategoryTagData(SingleCategoryTagData inputData)
boolean	needsSaving()
void	removeConfigurationParameter(String parameterPath)

Methods inherited from class java.lang.Object

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

Constructor Detail

SingleCategoryTagData

public SingleCategoryTagData(SingleCategoryTag singleCategoryTag)

SingleCategoryTagData

public SingleCategoryTagData(SingleCategoryTagData singleCategoryTagData)

Method Detail

getSingleCategoryTag

public SingleCategoryTag getSingleCategoryTag()

getConfigurationData

public Map<String,String> getConfigurationData()

getConfigurationDataForAgent

public Map<String,String> getConfigurationDataForAgent(AgentInfo agentInfo)

getCommentParameter

public String getCommentParameter(String prop)

getConditionParameter

public String getConditionParameter(String prop)

mergeSingleCategoryTagData

public void mergeSingleCategoryTagData(SingleCategoryTagData inputData)

load

public void load(InputStream is)
          throws IOException

Throws:

IOException

fullDataString

public String fullDataString()

Dump the content of this object in a String. The configuration parameters will be sorted alphabetically and the comments will be displayed above a property if available.

Returns:

The full data of this object in a String.

needsSaving

public boolean needsSaving()

removeConfigurationParameter

public void removeConfigurationParameter(String parameterPath)