TrendData (LSST CCS Graphical User Interface 4.3.1 API)

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. Immutable.
The data is intended to be directly displayable by the plotter, possibly with scaling (for strings) but without adding or removing points. Correspondence between points received from the REST server and those contained in this dataset:
- Raw unbinned trending (numeric or string) datasets: one-to-one, nothing is added or removed.
- Raw binned or stat numeric trending: one-to-one. Do not use as cache.
- Raw binned or stat string trending: remove some or all intermediate points in series of same values. Add endpoints if known. Can be used as cache if new request is not for raw data.
- Each state change is turned into a pair of points if the previous state is known. Endpoints are added if known.
In case of raw trending (numeric or string) datasets, each point is received from the REST server, nothing is added or removed.
Author:

onoprien

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`getBegin()` Returns the beginning of the time range of this data set.
`int`	`getBins()` Returns the number of bins specified in the request in response to which this dataset was created.
`long`	`getEnd()` Returns the end of the time range of this data set.
`long`	`getHighT()` Returns latest time for data points contained in this dataset (excluding added endpoints).
`long`	`getLowT()` Returns earliest time for data points contained in this dataset (excluding added endpoints).
`String[]`	`getMetadata(String key)` Returns an array of string values contained in this dataset for the specified off-point metadata type.
`String[]`	`getNames()` Returns names of String constants that can be included in this dataset, indexed by value.
`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.
`String`	`getType()` Returns data type in this dataset (see `RestSource`).
`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`	`isNumeric()` Returns `true` if this is a numeric dataset (as opposed to string or state).
`boolean`	`isRaw()` True if this dataset was created in response to request for raw (binned or unbinned) data.
`boolean`	`isRawUnbinned()` Returns `true` if this dataset contains unbinned raw 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 (excluding added endpoints).
    
    Returns:
    
    Earliest time for data contained in this dataset, or -1 if empty.
  - getHighT
```
public long getHighT()
```
    Returns latest time for data points contained in this dataset (excluding added endpoints).
    
    Returns:
    
    Latest time for data contained in this dataset, or -1 if empty.
  - getTimeRange
```
public long[] getTimeRange()
```
    Returns the time range of this data set.
    
    Returns:
    
    two-element array containing the bounds of the time range of this data set.
  - getBegin
```
public long getBegin()
```
    Returns the beginning of the time range of this data set.
    
    Returns:
    
    Beginning of time window covered by this dataset.
  - getEnd
```
public long getEnd()
```
    Returns the end of the time range of this data set.
    
    Returns:
    
    End of time window covered by this dataset.
  - isRawUnbinned
```
public boolean isRawUnbinned()
```
    Returns true if this dataset contains unbinned raw data.
    
    Returns:
    
    true if unbinned raw data.
  - isRaw
```
public boolean isRaw()
```
    True if this dataset was created in response to request for raw (binned or unbinned) data.
    
    Returns:
    
    Requested data kind.
  - getBins
```
public int getBins()
```
    Returns the number of bins specified in the request in response to which this dataset was created.
    
    Returns:
    
    Requested number of bins.
  - getNames
```
public String[] getNames()
```
    Returns names of String constants that can be included in this dataset, indexed by value.
    
    Returns:
    
    Possible String values.
    
    Throws:
    
    UnsupportedOperationException - if this is a numeric dataset.
  - isNumeric
```
public boolean isNumeric()
```
    Returns true if this is a numeric dataset (as opposed to string or state).
    
    Returns:
    
    True if this is a numeric dataset.
  - getType
```
public String getType()
```
    Returns data type in this dataset (see RestSource).
    
    Returns:
    
    Data type.

Class TrendData

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getTimes

getValues

getTimes

getValues

getMetadata

getSingleValueMetadata

getOnPointKeys

getLowT

getHighT

getTimeRange

getBegin

getEnd

isRawUnbinned

isRaw

getBins

getNames

isNumeric

getType