org.lsst.ccs.gconsole.plugins.trending

Class TrendPlotter

java.lang.Object

org.lsst.ccs.gconsole.plugins.trending.TrendPlotter

All Implemented Interfaces:

org.freehep.jas.services.Plotter, Persistable, Savable

public final class TrendPlotter
extends Object
implements org.freehep.jas.services.Plotter, Persistable

Plotter for Trend objects. All methods should be called on EDT.

Author:

onoprien

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TrendPlotter.Descriptor
static class	TrendPlotter.Style

Field Summary

Fields

Modifier and Type	Field and Description
static String	CATEGORY
static String	NO_META Option to not plot any off-point metadata.

Fields inherited from interface org.freehep.jas.services.Plotter

ADD, NORMAL, OVERLAY, STACK

Constructor Summary

Constructors

Constructor and Description
TrendPlotter()

Method Summary

Modifier and Type	Method and Description
void	clear() Removes all plotted data and resets properties.
List<Object>	getData() Returns the list of trends displayed by this plotter.
TrendPlotter.Descriptor	getDescriptor() Returns a reference to the descriptor maintained by this component.
EnumSet<Meta>	getMeta()
org.freehep.jas.services.PlotRegion	getRegion()
List<Trend>	getTrends() Lists trends currently displayed by this plotter.
boolean	isActive() Returns true if this plotter is currently managed by the graphical console.
boolean	isEmpty() Returns true if this plotter is empty.
void	plot(List<Trend> trendList, int mode) Plot the specified trends.
void	plot(Object timeHistory, int mode) Plots a trend.
void	plot(Object timeHistory, int mode, Object style, String options) Plots a trend.
void	remove(Object data) Not implemented.
void	restore(Persistable.Descriptor d) Restores this component to the state specified by the provided JavaBean.
TrendPlotter.Descriptor	save() Returns JavaBean describing the current state of this component.
void	setMeta(EnumSet<Meta> extras)
void	setRegion(org.freehep.jas.services.PlotRegion region)
void	toFront() Makes sure the page and region that contain this plotter are visible and selected.
Component	viewable() Returns the graphic component of this plotter.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.lsst.ccs.gconsole.services.persist.Persistable

edit, getCategory, getPath, restore

Field Detail

CATEGORY

public static String CATEGORY

NO_META

public static final String NO_META

Option to not plot any off-point metadata.

See Also:

Constant Field Values

Constructor Detail

TrendPlotter

public TrendPlotter()

Method Detail

getRegion

public org.freehep.jas.services.PlotRegion getRegion()

setRegion

public void setRegion(org.freehep.jas.services.PlotRegion region)

getMeta

public EnumSet<Meta> getMeta()

setMeta

public void setMeta(EnumSet<Meta> extras)

isActive

public boolean isActive()

Returns true if this plotter is currently managed by the graphical console. The plotter's viewable component does not have to be visible for the plotter to be active.

Returns:

True if this plotter is active.

getTrends

public List<Trend> getTrends()

Lists trends currently displayed by this plotter.

Returns:

The list of currently displayed trends.

isEmpty

public boolean isEmpty()

Returns true if this plotter is empty.

Returns:

true if this plotter does not display any trends.

plot

public void plot(Object timeHistory,
                 int mode)

Plots a trend. No style or options. See plot(Object timeHistory, int mode, Object style, String options) for details.

Specified by:

plot in interface org.freehep.jas.services.Plotter

Parameters:

timeHistory - An instance of Trend to be plotted.

mode - Plotter.NORMAL or Plotter.OVERLAY.

plot

public void plot(List<Trend> trendList,
                 int mode)

Plot the specified trends.

Parameters:

trendList - The list of trends to plot.

mode - Plotter.NORMAL or Plotter.OVERLAY. See plot(Object timeHistory, int mode, Object style, String options) for details.

plot

public void plot(Object timeHistory,
                 int mode,
                 Object style,
                 String options)

Plots a trend.

If a trend is plotted in NORMAL mode, the existing content of this plotter is erased and all properties are reset. In OVERLAY mode, the existing content and custom properties are retained except that any datasets representing off-point metadata are removed.

Specified by:

plot in interface org.freehep.jas.services.Plotter

Parameters:

timeHistory - An instance of Trend to be plotted.

mode - Plotter.NORMAL or Plotter.OVERLAY.

style - Ignored at the moment.

options - Comma-separated list of options:
NO_META ("no-meta") - do not plot any off-point metadata.

remove

public void remove(Object data)

Not implemented.

Specified by:

remove in interface org.freehep.jas.services.Plotter

Parameters:

data - Trend to remove.

clear

public void clear()

Removes all plotted data and resets properties.

Specified by:

clear in interface org.freehep.jas.services.Plotter

viewable

public Component viewable()

Returns the graphic component of this plotter.

Specified by:

viewable in interface org.freehep.jas.services.Plotter

Returns:

The GUI component that contains the plot.

getData

public List<Object> getData()

Returns the list of trends displayed by this plotter.

Specified by:

getData in interface org.freehep.jas.services.Plotter

Returns:

The list of Trend instances displayed by this plotter.

toFront

public void toFront()

Makes sure the page and region that contain this plotter are visible and selected.

getDescriptor

public TrendPlotter.Descriptor getDescriptor()

Description copied from interface: Persistable

Returns a reference to the descriptor maintained by this component. Implementations are expected to ensure that this method never returns null, and that any properties set on the descriptor returned by this method are reflected by descriptors subsequently returned by save(), unless modified between the two calls.

Specified by:

getDescriptor in interface Persistable

Returns:

JavaBean describing this component.

save

public TrendPlotter.Descriptor save()

Description copied from interface: Persistable

Returns JavaBean describing the current state of this component. The default implementation returns a clone of getDescriptor().

Specified by:

save in interface Persistable

Specified by:

save in interface Savable

Returns:

JavaBean encapsulating the state, or null if no state information needs to be saved.

restore

public void restore(Persistable.Descriptor d)

Description copied from interface: Persistable

Restores this component to the state specified by the provided JavaBean. The default implementation does nothing.

Specified by:

restore in interface Persistable

Parameters:

d - JavaBean encapsulating the state.