org.lsst.ccs.services

Class DataDictionaryOrdered

java.lang.Object

org.lsst.ccs.services.DataDictionaryOrdered

All Implemented Interfaces:

Serializable, DataProviderDictionary

public class DataDictionaryOrdered
extends Object
implements DataProviderDictionary

DataProviderDictionary implementation that minimizes memory footprint and serialized size at the expense of access speed. Instances of this class are immutable. Order of DataProviderInfo instances is preserved.

Implementation notes

Currently, extra complexity is added by the fact that we associate key as well as path with every data channel. This is left over from supporting both full and short paths, and is expected to be removed in later versions. For now, int keyFlag is associated with every tree node to tell how to extract path and key from the full path:

• keyFlag = NO_PATH : not a terminal node
• keyFlag = NULL_PATH : path = null, key = fullPath
• keyFlag = EMPTY_PATH : path = "", key = fullPath
• keyFlag less than 0 : abs(keyFlag) is the number of segments in key, fullPath = path + key
• others : keyFlag is the number of segments in key, fullPath ends with key

Author:

onoprien

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DataDictionaryOrdered(DataProviderDictionary other)
DataDictionaryOrdered(List<DataProviderInfo> data)

Method Summary

Modifier and Type	Method and Description
org.lsst.ccs.utilities.taitime.CCSTimeStamp	getCCSTimeStamp() Deprecated.
List<DataProviderInfo>	getDataProviderDescriptionsForGroup(String group) Deprecated.
DataProviderInfo	getDataProviderInfoForPath(String path) Get the DataProviderInfo definition for the provided path.
List<DataProviderInfo>	getDataProviderInfos()
Set<String>	getGroups() Deprecated.
int	size() Returns the size of this dictionary.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataDictionaryOrdered

public DataDictionaryOrdered(DataProviderDictionary other)

DataDictionaryOrdered

public DataDictionaryOrdered(List<DataProviderInfo> data)

Method Detail

getDataProviderInfos

public List<DataProviderInfo> getDataProviderInfos()

Specified by:

getDataProviderInfos in interface DataProviderDictionary

Returns:

the existing list of DataProviders

getDataProviderInfoForPath

public DataProviderInfo getDataProviderInfoForPath(String path)

Description copied from interface: DataProviderDictionary

Get the DataProviderInfo definition for the provided path.

Specified by:

getDataProviderInfoForPath in interface DataProviderDictionary

Parameters:

path - The path for the desired DataProviderInfo

Returns:

The corresponding DataProviderInfo, or null otherwise.

getGroups

@Deprecated
public Set<String> getGroups()

Deprecated.

Specified by:

getGroups in interface DataProviderDictionary

Returns:

the existing groups

getDataProviderDescriptionsForGroup

@Deprecated
public List<DataProviderInfo> getDataProviderDescriptionsForGroup(String group)

Deprecated.

Specified by:

getDataProviderDescriptionsForGroup in interface DataProviderDictionary

Returns:

getCCSTimeStamp

@Deprecated
public org.lsst.ccs.utilities.taitime.CCSTimeStamp getCCSTimeStamp()

Deprecated.

Description copied from interface: DataProviderDictionary

Get the CCSTimeStamp of when this dictionary was created.

Specified by:

getCCSTimeStamp in interface DataProviderDictionary

Returns:

The CCSTimeStamp when this dictionary was created.

size

public int size()

Description copied from interface: DataProviderDictionary

Returns the size of this dictionary.

Specified by:

size in interface DataProviderDictionary

Returns:

Number of entries in this dictionary.