org.lsst.ccs.bus.data

Class DataProviderInfo

java.lang.Object

org.lsst.ccs.bus.data.DataProviderInfo

All Implemented Interfaces:

Serializable

public class DataProviderInfo
extends Object
implements Serializable

A static description of published data.

Author:

LSST CCS Team

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DataProviderInfo.Attribute
static class	DataProviderInfo.Type

Constructor Summary

Constructors

Constructor and Description
DataProviderInfo(String path, DataProviderInfo.Type dataType, String name)
DataProviderInfo(String path, DataProviderInfo.Type dataType, String name, Map<DataProviderInfo.Attribute,String> attributes)

Method Summary

Modifier and Type	Method and Description
void	addAttribute(DataProviderInfo.Attribute attribute, String value)
DataProviderInfo.Attribute[]	getAttributes() Get all the attribute names defined for this data.
String	getAttributeValue(DataProviderInfo.Attribute attr) Get access to the different attributes attached to this data description.
String	getFullPath()
String	getKey() The key of a DataProvider is used to store the data in the trending database.
String	getPath() The path of a DataProvider is its location within an Agent.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DataProviderInfo

public DataProviderInfo(String path,
                        DataProviderInfo.Type dataType,
                        String name,
                        Map<DataProviderInfo.Attribute,String> attributes)

Parameters:

path - The path of the corresponding data provider object

dataType - The type of this data

name - The key of the data. The way the name is used in conjunction with the path depends on the data type.

attributes - A map of the Attributes for this DataProviderInfo object. The path for all dataTypes is the path of the object the DataProviderInfo applies to. The name depends on the dataType: CONFIGURATION: The name is the name of configuration parameter. STATE: the name is the name of the state enumeration. TRENDING and MONITORING the name is the trending key

DataProviderInfo

public DataProviderInfo(String path,
                        DataProviderInfo.Type dataType,
                        String name)

Parameters:

path - The path of the corresponding data provider object

dataType - The type of this data

name - The key of the data. The way the name is used in conjunction with the path depends on the data type. The path for all dataTypes is the path of the object the DataProviderInfo applies to. The name depends on the dataType: CONFIGURATION: The name is the name of configuration parameter. STATE: the name is the name of the state enumeration. TRENDING and MONITORING the name is the trending key

Method Detail

addAttribute

public void addAttribute(DataProviderInfo.Attribute attribute,
                         String value)

getAttributeValue

public String getAttributeValue(DataProviderInfo.Attribute attr)

Get access to the different attributes attached to this data description.

Parameters:

attr - the attribute

Returns:

getKey

public String getKey()

The key of a DataProvider is used to store the data in the trending database.

Returns:

The key for this data.

getPath

public String getPath()

The path of a DataProvider is its location within an Agent.

Returns:

The unique path for this data.

getFullPath

public String getFullPath()

getAttributes

public DataProviderInfo.Attribute[] getAttributes()

Get all the attribute names defined for this data.

Returns:

The array of attribute names.

toString

public String toString()

Overrides:

toString in class Object