org.lsst.ccs.gconsole.plugins.trending

Class TrendData

java.lang.Object

org.lsst.ccs.gconsole.plugins.trending.TrendData

public class TrendData
extends Object

Time history dataset for a specific channel and a specific time window. Includes all metadata.

Author:

onoprien

Method Summary

Modifier and Type	Method and Description
long	getHighT() Returns latest time for data points contained in this dataset.
long	getLowT() Returns earliest time for data points contained in this dataset.
String[]	getMetadata(String key) Returns an array of string values contained in this dataset for the specified off-point metadata type.
Set<String>	getOnPointKeys() Returns the set of keys for on-point data and metadata present in this dataset.
String	getSingleValueMetadata(String key) Returns off-point metadata value for the specified key if it is valid for the entire time window covered by this dataset.
long[]	getTimeRange() Returns the time range of this data set.
long[]	getTimes() Returns an array of timestamps for points in this dataset.
long[]	getTimes(String key) Returns an array of timestamps available in this dataset for the specified data or metadata.
double[]	getValues() Returns an array of values for data in this dataset.
double[]	getValues(String key) Returns an array of values contained in this dataset for the specified metadata type.
boolean	isRaw() Reports the type of data.

Methods inherited from class java.lang.Object

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

Method Detail

getTimes

public long[] getTimes()

Returns an array of timestamps for points in this dataset. Shared by data and on-point metadata.

Returns:

An array of times, in milliseconds.

getValues

public double[] getValues()

Returns an array of values for data in this dataset.

Returns:

Data values.

getTimes

public long[] getTimes(String key)

Returns an array of timestamps available in this dataset for the specified data or metadata.

Parameters:

key - String that identifies the data or metadata.

Returns:

An array of times, in milliseconds, or null if there is no such data or metadata.

getValues

public double[] getValues(String key)

Returns an array of values contained in this dataset for the specified metadata type.

Parameters:

key - String that identifies the metadata.

Returns:

An array of values for the specified metadata, or null if there is no such data or metadata that could be converted to double values.

getMetadata

public String[] getMetadata(String key)

Returns an array of string values contained in this dataset for the specified off-point metadata type.

Parameters:

key - String that identifies the metadata.

Returns:

An array of metadata values, or null if there is no such metadata in this dataset.

getSingleValueMetadata

public String getSingleValueMetadata(String key)

Returns off-point metadata value for the specified key if it is valid for the entire time window covered by this dataset. Note that the current implementation does not require validity throughout time window, it returns a non-null value for any single value metadata. This is to work around LSSTCCS-2253.

Parameters:

key - String that identifies the metadata.

Returns:

Value, or null if there is no such single-value metadata.

getOnPointKeys

public Set<String> getOnPointKeys()

Returns the set of keys for on-point data and metadata present in this dataset. The set includes VALUE_KEY.

Returns:

Set of keys.

getLowT

public long getLowT()

Returns earliest time for data points contained in this dataset.

Returns:

Lowest time for data points contained in this dataset.

getHighT

public long getHighT()

Returns latest time for data points contained in this dataset.

Returns:

Highest time for data points contained in this dataset.

getTimeRange

public long[] getTimeRange()

Returns the time range of this data set. Callers should not modify the returned array.

Returns:

two-element array containing the bounds of the time range of this data set.

isRaw

public boolean isRaw()

Reports the type of data.

Returns:

true if unbinned raw data.