org.lsst.ccs.plugin.jas3.trending

Class DataChannelHandler

java.lang.Object

org.lsst.ccs.plugin.jas3.trending.DataChannelHandler

public class DataChannelHandler
extends Object

Handles retrieval and caching of trending data associated with a specific DataChannel. Also holds references to plotted data point sets for this channel.

Author:

onoprien

Method Summary

Modifier and Type	Method and Description
void	addPlotData(Plot plot) Adds the specified data point set to the list of plotted data for this channel.
Plot	findPlot(TimeWindow timeWindow) Returns an existing plot for this channel.
org.lsst.ccs.localdb.statusdb.server.DataChannel	getDataChannel() Returns the underlying DataChannel.
String	getPath() Returns the path associated with the underlying DataChannel.
List<Plot>	getPlots() Returns a list of plotted data point sets for this channel.
Plot	makePlot(TimeWindow timeWindow) Creates and returns a data point set for the specified time window.
boolean	refresh(Plot plot) Prepares the specified plot for refreshing.
boolean	refresh(Plot plot, long time) Prepares the specified plot for refreshing.
void	removePlotData(Plot plot) Removes the specified data point set from the list of plotted data for this channel.

Methods inherited from class java.lang.Object

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

Method Detail

getPath

public String getPath()

Returns the path associated with the underlying DataChannel.

getDataChannel

public org.lsst.ccs.localdb.statusdb.server.DataChannel getDataChannel()

Returns the underlying DataChannel.

getPlots

public List<Plot> getPlots()

Returns a list of plotted data point sets for this channel. The list is not modifiable. Calling this method purges the list of plotted dataset, removing those associated with deleted regions.

findPlot

public Plot findPlot(TimeWindow timeWindow)

Returns an existing plot for this channel. If there are several such plots, returns the one with the specified time window, if it exist. Otherwise, returns one of plots displayed on pages with minimal number of regions. If there are no plots for this channel, returns null. Only single plot regions are considered.

makePlot

public Plot makePlot(TimeWindow timeWindow)

Creates and returns a data point set for the specified time window.

refresh

public boolean refresh(Plot plot,
                       long time)

Prepares the specified plot for refreshing. Creates updated data point sets and stores them in the specified Plot object. Subsequent call to Plot.commitRefresh() on that instance will make the new data current.

Parameters:

plot - Plot to be prepared for refreshing.

time - Current time in milliseconds.

Returns:

true if the the data has been updated.

refresh

public boolean refresh(Plot plot)

Prepares the specified plot for refreshing. Creates updated data point sets and stores them in the specified Plot object. Subsequent call to Plot.commitRefresh() on that instance will make the new data current.

Parameters:

plot - Plot to be prepared for refreshing.

Returns:

true if the the data has been updated.

addPlotData

public void addPlotData(Plot plot)

Adds the specified data point set to the list of plotted data for this channel.

removePlotData

public void removePlotData(Plot plot)

Removes the specified data point set from the list of plotted data for this channel.