org.lsst.ccs.config

Class CategoryDataChain

java.lang.Object

org.lsst.ccs.config.CategoryDataChain

public class CategoryDataChain
extends Object

A Class to chain together SingleCategoryTagData entries for a given category. This class is to be used to figure out which SingleCategoryTag a configuration parameter value came from.

Author:

The LSST CCS Team

Constructor Summary

Constructors

Constructor and Description
CategoryDataChain(String category)

Method Summary

Modifier and Type	Method and Description
void	addSingleCategoryTagData(SingleCategoryTagData tagData, org.lsst.ccs.bus.data.AgentInfo ai) Add a SingleCategoryTagData to the chain of existing SingleCategoryTagData.
String	getCategory() Get the category for this CategoryDataChain.
Map<String,ConfigurationParameterTaggedValue>	getConfigurationParameterTaggedValues() Get a copy of the ConfiguraiontParameterTaggedValue map.
List<String>	getConfigurationParameterValueList(String path) For a given parameter path get the List of the ConfigurationParameterTaggedValues as defined in the data chain.
SingleCategoryTagData	getSingleCategoryTagData(org.lsst.ccs.config.SingleCategoryTag tag)
List<org.lsst.ccs.config.SingleCategoryTag>	getSingleCategoryTagList()
org.lsst.ccs.config.SingleCategoryTag	getTopMostCategoryTag()
boolean	needsSaving()

Methods inherited from class java.lang.Object

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

Constructor Detail

CategoryDataChain

public CategoryDataChain(String category)

Method Detail

addSingleCategoryTagData

public void addSingleCategoryTagData(SingleCategoryTagData tagData,
                                     org.lsst.ccs.bus.data.AgentInfo ai)

Add a SingleCategoryTagData to the chain of existing SingleCategoryTagData. If the corresponding SingleCategoryTag already exists, then its value is replaced with the input tagData at its original position, otherwise we add the new data at the end of the chain.

Parameters:

tagData - The SingleCategoryTagData to be added

getCategory

public String getCategory()

Get the category for this CategoryDataChain.

Returns:

The category for this CategoryDataChain.

getConfigurationParameterTaggedValues

public Map<String,ConfigurationParameterTaggedValue> getConfigurationParameterTaggedValues()

Get a copy of the ConfiguraiontParameterTaggedValue map. This is built based on the chain of SingleCategoryTags. This map contains the values as defined in their top-most tag.

Returns:

A copy of the Map containing the ConfigurationParameterTaggedValues

getConfigurationParameterValueList

public List<String> getConfigurationParameterValueList(String path)

For a given parameter path get the List of the ConfigurationParameterTaggedValues as defined in the data chain. The first element is the value as defined by the bottom tag, while the last element is the one defined by the top-most tag.

Parameters:

path - The configuration parameter path

Returns:

The List of ConfigurationParameterTaggedValues

getSingleCategoryTagList

public List<org.lsst.ccs.config.SingleCategoryTag> getSingleCategoryTagList()

getTopMostCategoryTag

public org.lsst.ccs.config.SingleCategoryTag getTopMostCategoryTag()

getSingleCategoryTagData

public SingleCategoryTagData getSingleCategoryTagData(org.lsst.ccs.config.SingleCategoryTag tag)

needsSaving

public boolean needsSaving()