org.lsst.ccs.gconsole.plugins.monitor

Class GroupView

java.lang.Object

org.lsst.ccs.gconsole.plugins.monitor.AbstractMonitorView

org.lsst.ccs.gconsole.plugins.monitor.GroupView

All Implemented Interfaces:

MonitorView, PersistableMonitorView, AgentStatusListener, Persistable, Savable

Direct Known Subclasses:

ComboGroupView, TabbedGroupView

public abstract class GroupView
extends AbstractMonitorView

Abstract monitoring view that splits channels into groups, and displays one group at a time in a child view.

All methods defined by this class should be called on EDT. All setter methods should be called before getPage(), install(), and uninstall().

Author:

onoprien

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GroupView.Descriptor JavaBean that contains information required to re-create this view in its current state.
protected class	GroupView.Filter Filter to be associated with a group view.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	currentGroup
protected int	depth
protected GroupView.Descriptor	descriptor
protected LinkedList<String>	selectionHistory

Fields inherited from class org.lsst.ccs.gconsole.plugins.monitor.AbstractMonitorView

compactFields, data, fields, filter, formatter

Fields inherited from interface org.lsst.ccs.gconsole.plugins.monitor.MonitorView

CATEGORY

Constructor Summary

Constructors

Constructor and Description
GroupView()

Method Summary

Modifier and Type	Method and Description
void	addChannels(List<org.lsst.ccs.bus.data.AgentInfo> agents, List<Map.Entry<String,AgentChannel>> channels) Updates views or calls addChannels(...) on a child view if it already exists.
protected AbstractMonitorView	createView(String group) Creates a view for the specified group.
GroupView.Descriptor	getDescriptor() Returns a reference to the descriptor maintained by this component.
protected String[]	getPath(String group) Splits the group name into segments.
protected String[]	getSubgroups(String parent)
protected AbstractMonitorView	getView(String group)
protected abstract void	groupsAdded(List<String> groups)
protected abstract void	groupSelected()
protected abstract void	groupsRemoved(List<String> groups)
protected boolean	hasGroup(String group)
protected String	mergeGroup(String group, String path) Reverse separateGroup(...).
void	removeChannels(List<org.lsst.ccs.bus.data.AgentInfo> agents, List<Map.Entry<String,AgentChannel>> channels) Updates views or calls removeChannels(...) on a child view if it exists.
void	restore(Persistable.Descriptor descriptor) Restores this view to the state described by the provided descriptor, to the extent possible.
GroupView.Descriptor	save() Returns a descriptor that contains information required to re-create this view in its current state.
protected void	selectGroup(String group) Selects and displays the view for the specified group.
protected String[]	separateGroup(String displayPath) Splits display path produced by the filter into group and path inside group.
void	setFormatter(MonitorFormat formatter) Associates a formatter with this view.
static AbstractChannelsFilter	test1()
void	updateChannels(List<Map.Entry<String,Map.Entry<AgentChannel,List<String>>>> channels) Forward updates to the current view, if any.

Methods inherited from class org.lsst.ccs.gconsole.plugins.monitor.AbstractMonitorView

configure, connect, createChannel, disconnect, getFilter, getFormater, getGroup, getGroupFields, getGroups, isEmpty, resetChannels, setDiscardRemovedChannels, setFilter, statusChanged, update

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.plugins.monitor.PersistableMonitorView

edit, getName

Methods inherited from interface org.lsst.ccs.gconsole.plugins.monitor.MonitorView

getPanel, install, setName, uninstall

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

getCategory, getPath, restore

Field Detail

descriptor

protected GroupView.Descriptor descriptor

depth

protected int depth

currentGroup

protected String currentGroup

selectionHistory

protected LinkedList<String> selectionHistory

Constructor Detail

GroupView

public GroupView()

Method Detail

addChannels

public final void addChannels(List<org.lsst.ccs.bus.data.AgentInfo> agents,
                              List<Map.Entry<String,AgentChannel>> channels)

Updates views or calls addChannels(...) on a child view if it already exists. If there is no current group, call selectGroup(null).

Overrides:

addChannels in class AbstractMonitorView

Parameters:

agents - Newly connected agents these channels belong to.

channels - New channels, each entry contains display path and channel.

removeChannels

public final void removeChannels(List<org.lsst.ccs.bus.data.AgentInfo> agents,
                                 List<Map.Entry<String,AgentChannel>> channels)

Updates views or calls removeChannels(...) on a child view if it exists.

Overrides:

removeChannels in class AbstractMonitorView

Parameters:

agents - Names of disconnected agents.

channels - Removed channels, each entry contains display path and channel.

updateChannels

public final void updateChannels(List<Map.Entry<String,Map.Entry<AgentChannel,List<String>>>> channels)

Forward updates to the current view, if any.

Overrides:

updateChannels in class AbstractMonitorView

Parameters:

channels - Updated channels, each element contains: {display path : {channel : list of modified attributes}}.

separateGroup

protected String[] separateGroup(String displayPath)

Splits display path produced by the filter into group and path inside group. Group name can be null. If this method returns null, the channel should not be displayed.

The implementation provided by this class splits around "//" if this view has depth 0, chop off first depth segments (separated by slashes) otherwise.

Parameters:

displayPath - Display path produced by the filter.

Returns:

2-element array: [group, path inside group].

mergeGroup

protected String mergeGroup(String group,
                            String path)

Reverse separateGroup(...).

Parameters:

group - Group.

path - Local display path inside group.

Returns:

Global display path as reported by the filter associated with this view.

getPath

protected String[] getPath(String group)

Splits the group name into segments.

Parameters:

group - Group name.

Returns:

Array of segments.

createView

protected AbstractMonitorView createView(String group)

Creates a view for the specified group.

Parameters:

group - Group name.

Returns:

New monitor view.

selectGroup

protected void selectGroup(String group)

Selects and displays the view for the specified group. If a partial group is given, figures out the complete one. If "", the default group is selected. On exit from this method currentGroup is set and selectionHistory is updated.

Parameters:

group - Group or prefix that specifies a group of groups.

setFormatter

public void setFormatter(MonitorFormat formatter)

Description copied from interface: MonitorView

Associates a formatter with this view. The exact way the formatter is used - if at all - depends on specific implementation.

Specified by:

setFormatter in interface MonitorView

Overrides:

setFormatter in class AbstractMonitorView

Parameters:

formatter - Formatter to be associated with this view.

groupsAdded

protected abstract void groupsAdded(List<String> groups)

groupsRemoved

protected abstract void groupsRemoved(List<String> groups)

groupSelected

protected abstract void groupSelected()

getView

protected final AbstractMonitorView getView(String group)

hasGroup

protected final boolean hasGroup(String group)

getSubgroups

protected final String[] getSubgroups(String parent)

Parameters:

parent - Full or partial group (x0/.../xN), or null to get top-level subgroups.

Returns:

List of group segments at the next level (x[N+1]). null if parent is neither a valid group nor a partial group; empty array if parent is a valid group but not a partial group (no subgroups); contains "" if parent is both a valid group and a partial group (has subgroups).

save

public GroupView.Descriptor save()

Returns a descriptor that contains information required to re-create this view in its current state.

Specified by:

save in interface Persistable

Specified by:

save in interface Savable

Overrides:

save in class AbstractMonitorView

Returns:

View descriptor.

restore

public void restore(Persistable.Descriptor descriptor)

Restores this view to the state described by the provided descriptor, to the extent possible.

Parameters:

descriptor - View descriptor.

getDescriptor

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

Specified by:

getDescriptor in class AbstractMonitorView

Returns:

JavaBean describing this component.

test1

@Create(category="AgentChannelsFilter",
        name="Explicit group tester",
        path="Test/Explicit group",
        description="")
public static AbstractChannelsFilter test1()