org.lsst.ccs.gconsole.plugins.tracer

Class Tracer

java.lang.Object

org.lsst.ccs.gconsole.plugins.tracer.Tracer

All Implemented Interfaces:

Persistable, Savable

public class Tracer
extends Object
implements Persistable

Configurable message viewer that manages a single page displaying filtered bus messages.

Implementation notes.
Persistency. Two kinds of Tracer instances exist: those created by Creator, and those created by TracerEditor. For the first kind, the descriptor will always have valid creator property and null filter property. For the second kind, creator property is null. These instances are created by the default constructor and a call to restore(...).

Author:

onoprien

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Tracer.Descriptor

Field Summary

Fields

Modifier and Type	Field and Description
static String	CATEGORY

Constructor Summary

Constructors

Constructor and Description
Tracer()

Method Summary

Modifier and Type	Method and Description
Tracer	edit(String title, Component parent) Takes user input and returns a modified Persistable instance.
Tracer.Descriptor	getDescriptor() Returns a reference to the descriptor maintained by this component.
MessageFilter	getFilter()
JComponent	getPanel() Returns the graphical component that displays messages, creating it if it does not already exist.
void	onMessage(org.lsst.ccs.bus.messages.BusMessage message)
void	restore(Persistable.Descriptor d) Restores this component to the state specified by the provided JavaBean.
Tracer.Descriptor	save() Returns JavaBean describing the current state of this component.
void	setFilter(MessageFilter filter)

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

getCategory, getPath, restore

Field Detail

CATEGORY

public static final String CATEGORY

See Also:

Constant Field Values

Constructor Detail

Tracer

public Tracer()

Method Detail

getPanel

public JComponent getPanel()

Returns the graphical component that displays messages, creating it if it does not already exist. This method should be called on EDT.

Returns:

Graphical component of this viewer.

getFilter

public MessageFilter getFilter()

setFilter

public void setFilter(MessageFilter filter)

onMessage

public void onMessage(org.lsst.ccs.bus.messages.BusMessage message)

getDescriptor

public Tracer.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 Tracer.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.

edit

public Tracer edit(String title,
                   Component parent)

Description copied from interface: Persistable

Takes user input and returns a modified Persistable instance. This method should be called on EDT. The default implementation returns null.

Specified by:

edit in interface Persistable

Parameters:

title - User-interaction dialog title, or null if the default title should be used.

parent - Graphical component to be use as a parent for user-interaction dialog(s).

Returns:

Modified instance (may or may not be this). May return null to indicate that the Persistable should be re-instantiated, letting the user select among available Creator factories for the given category.