org.lsst.ccs.gconsole.plugins.trending

Class RestServerSource

java.lang.Object

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

org.lsst.ccs.gconsole.plugins.trending.RestServerSource

public class RestServerSource
extends TrendingSource

Time history source that provides access to trending channels available through a REST server.

Author:

onoprien

Nested Class Summary

Nested classes/interfaces inherited from class org.lsst.ccs.gconsole.plugins.trending.TrendingSource

TrendingSource.Event, TrendingSource.Listener

Constructor Summary

Constructors

Constructor and Description
RestServerSource(com.sun.jersey.api.client.WebResource server, LsstTrendingPlugin plugin)

Method Summary

Modifier and Type	Method and Description
boolean	connect()
TrendData	get(TrendingChannel channel, long begin, long end, EnumSet<Trend.Meta> metadata, TrendData history) Returns the time history data for the specified channel.
List<TrendingChannel>	getChannels() Returns a list of data channels accessible through this source.

Methods inherited from class org.lsst.ccs.gconsole.plugins.trending.TrendingSource

addListener, fireEvent, removeListener

Methods inherited from class java.lang.Object

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

Constructor Detail

RestServerSource

public RestServerSource(com.sun.jersey.api.client.WebResource server,
                        LsstTrendingPlugin plugin)

Method Detail

connect

public boolean connect()

getChannels

public List<TrendingChannel> getChannels()

Description copied from class: TrendingSource

Returns a list of data channels accessible through this source.

Specified by:

getChannels in class TrendingSource

Returns:

The list of channels paths.

get

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

Description copied from class: TrendingSource

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.

Specified by:

get in class TrendingSource

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.