org.lsst.ccs.gconsole.plugins.trending

Class TrendingSource

java.lang.Object

org.lsst.ccs.gconsole.plugins.trending.TrendingSource

Direct Known Subclasses:

CompoundTrendingSource, RestServerSource

public abstract class TrendingSource
extends Object

Source of time history data that can be handled by the trending plugin. The source contains multiple channels identified by their paths.

This class accepts registration of listeners that are notified whenever the list of trending channels available from this source changes.

Author:

onoprien

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TrendingSource.Event An event fired by TrendingSource to notify listeners of changes.
static interface	TrendingSource.Listener Interface to be implemented by classes that should be notified of changes in TrendingSources.

Constructor Summary

Constructors

Constructor and Description
TrendingSource()

Method Summary

Modifier and Type	Method and Description
void	addListener(TrendingSource.Listener listener)
protected void	fireEvent(List<TrendingChannel> removedChannels, List<TrendingChannel> addedChannels)
abstract TrendData	get(TrendingChannel channel, long begin, long end, EnumSet<Trend.Meta> metadata, TrendData history) Returns the time history data for the specified channel.
abstract List<TrendingChannel>	getChannels() Returns a list of data channels accessible through this source.
void	removeListener(TrendingSource.Listener listener)

Methods inherited from class java.lang.Object

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

Constructor Detail

TrendingSource

public TrendingSource()

Method Detail

getChannels

public abstract List<TrendingChannel> getChannels()

Returns a list of data channels accessible through this source.

Returns:

The list of channels paths.

get

public abstract TrendData get(TrendingChannel channel,
                              long begin,
                              long end,
                              EnumSet<Trend.Meta> metadata,
                              TrendData history)

Returns the time history data for the specified channel. If the previously known time history is given, it may be updated and returned by this method, or a new instance of TrendData may be created.

Parameters:

channel - The channel.

begin - Beginning of the time window.

end - End of the time window.

metadata - Metadata data to be included.

history - Known history for this channel.

Returns:

The time history, or null if this source does not provide data for the specified channel.

addListener

public void addListener(TrendingSource.Listener listener)

removeListener

public void removeListener(TrendingSource.Listener listener)

fireEvent

protected void fireEvent(List<TrendingChannel> removedChannels,
                         List<TrendingChannel> addedChannels)