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

Constructor Summary

Constructors

Constructor and Description
DataProviderInfo(String path, String name)
DataProviderInfo(String path, String key, 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	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.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataProviderInfo

public DataProviderInfo(String path,
                        String key,
                        Map<DataProviderInfo.Attribute,String> attributes)

DataProviderInfo

public DataProviderInfo(String path,
                        String name)

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.

getAttributes

public DataProviderInfo.Attribute[] getAttributes()

Get all the attribute names defined for this data.

Returns:

The array of attribute names.