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
boolean	addPlotData(Plot plot) Adds the specified data point set to the list of plotted data for this channel.
Plot	findPlotData(TimeWindow timeWindow) Returns an existing plotted data point set 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>	getPlotDataAll() Returns a list of plotted data point sets for this channel.
Plot	makePlotData(TimeWindow timeWindow) Creates and returns a data point set for the specified time window.
boolean	refresh(Plot plot) Prepares the specified Plot object for prepareRefresh by constructing updated DataPointSet.
boolean	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.

getPlotDataAll

public List<Plot> getPlotDataAll()

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.

findPlotData

public Plot findPlotData(TimeWindow timeWindow)

Returns an existing plotted data point set for this channel. If there are several plots for this channel, returns the data point set with the specified time window, if it exist. Otherwise, returns one of the data point sets plotted on pages with minimal number of regions. If there are no plots for this channel, returns null.

makePlotData

public Plot makePlotData(TimeWindow timeWindow)

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

refresh

public boolean refresh(Plot plot)

Prepares the specified Plot object for prepareRefresh by constructing updated DataPointSet. Subsequent call to {@link PlotData#update) will use this set to update plotted data.

Parameters:

plot - Plot data to be prepared for the prepareRefresh.

Returns:

true if the prepareRefresh will change the data.

addPlotData

public boolean addPlotData(Plot plot)

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

removePlotData

public boolean removePlotData(Plot plot)

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