org.lsst.ccs.gconsole

Class Console

java.lang.Object

org.lsst.ccs.Agent

org.lsst.ccs.Subsystem

org.lsst.ccs.gconsole.Console

All Implemented Interfaces:

org.lsst.ccs.messaging.CommandExecutor

Direct Known Subclasses:

Jas3Console

public abstract class Console
extends org.lsst.ccs.Subsystem

Graphical Console subsystem. Provides all functionality of a CCS subsystem. Specifies additional services that should be provided by specific console implementations for use by plugins and tools.

Author:

onoprien

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Console.PropertyListener

Nested classes/interfaces inherited from class org.lsst.ccs.Agent

org.lsst.ccs.Agent.RunningCommand

Field Summary

Fields inherited from class org.lsst.ccs.Agent

commandExecutorLock, currentAction, currentQueries, currentSignals, heartbeatPublisher, innerStateLock, logBusHandler, runtimeInfoPublisher

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Console()

Method Summary

Modifier and Type	Method and Description
abstract void	addMenu(Action action, String owner, String... locations) Adds an item to the graphical console menu bar.
abstract void	addPreference(String[] path, String group, String format) Adds a setter for one or more previously defined properties to the preferences menu.
abstract void	addProperty(String key, Object defaultValue) Defines a console property with the specified default value.
abstract void	addPropertyListener(Console.PropertyListener listener, String filter) Registers a listener that will be notified of property changes.
abstract void	error(String message) Notifies the user of an application error.
abstract void	error(String message, Exception x) Notifies the user of an application error.
abstract Path	getHomeDirectory() Returns the path to the graphical console home directory.
org.lsst.ccs.utilities.logging.Logger	getLogger() Returns the default logger associated with the graphical console.
abstract org.freehep.util.FreeHEPLookup	getLookup() Returns a lookup instance that can be used objects registered by various components of the graphical console.
abstract Object	getProperty(String key) Returns the value of the property with the specified key.
abstract Window	getWindow() Returns the root component for the main Graphical Console window.
abstract Object	removeProperty(String key) Removes a console property.
abstract boolean	removePropertyListener(Console.PropertyListener listener) Removes the specified property listener.
void	setProperties(Map<String,Object> properties) Sets values of a set of properties.
abstract Object	setProperty(String key, Object value) Sets the value of the specified property.
abstract void	showInBrowser(String url) Display the specified web site in a browser.

Methods inherited from class org.lsst.ccs.Subsystem

abort, abort, addClearAlertHandler, checkAllHardwareStarted, checkAllHardwareStopped, checkHardware, clearAlerts, clearAllAlerts, completeInitialization, completeInitialization, doShutdown, doStart, forceShutdown, getNumberCommandThreads, getRaisedAlertSummary, internalShutdown, internalStart, ping, postStart, printRunningCommands, raiseAlert, raiseAlert, removeLogPanicState, setBusLogHandlerLevel, setLogFormat, setLogHandlerLevel, setLogLevel, setStackTraceDepth, stop, switchToEngineeringMode, switchToNormalMode

Methods inherited from class org.lsst.ccs.Agent

addCommandSet, addCommandsFromObject, broadcastStatus, executeCommandRequest, getAgentInfo, getCCSVersions, getCommandCount, getCommandSet, getCommandTargets, getCurrentAction, getDictionaries, getDistributionInfo, getEnvironmentMessagingAccess, getMessagingAccess, getName, getScheduler, getState, getState, getStatusBroadcastPeriod, isInEngineeringMode, isInState, isInState, publishStateChange, publishSubsystemDataOnStatusBus, sendAck, sendNack, setAgentProperty, shutdown, start, updateAgentState, updateHeartBeat, updateInternalState, waitFor

Methods inherited from class java.lang.Object

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

Constructor Detail

Console

protected Console()

Method Detail

getLookup

public abstract org.freehep.util.FreeHEPLookup getLookup()

Returns a lookup instance that can be used objects registered by various components of the graphical console.

Returns:

Lookup instance.

getWindow

public abstract Window getWindow()

Returns the root component for the main Graphical Console window.

Returns:

root component for the main Graphical Console window, or null if the root component is not a Window.

getLogger

public org.lsst.ccs.utilities.logging.Logger getLogger()

Returns the default logger associated with the graphical console.

Overrides:

getLogger in class org.lsst.ccs.Subsystem

Returns:

The logger associated with the graphical console.

getHomeDirectory

public abstract Path getHomeDirectory()

Returns the path to the graphical console home directory. User preferences, console extensions, and miscellaneous auxiliary files saved by the graphical console are kept in this directory and its subdirectories.

Returns:

The path to the graphical console home directory.

error

public abstract void error(String message)

Notifies the user of an application error.

Parameters:

message - Message to be displayed.

error

public abstract void error(String message,
                           Exception x)

Notifies the user of an application error.

Parameters:

message - Message to be displayed.

x - Exception to be reported.

showInBrowser

public abstract void showInBrowser(String url)

Display the specified web site in a browser.

Parameters:

url - URL of the site to be displayed.

addProperty

public abstract void addProperty(String key,
                                 Object defaultValue)

Defines a console property with the specified default value. Console properties can be later modified by calls to the setProperty(String, Object) method or through the preference dialog if their keys are used in setter format strings passed to the addPreference(String[], String, String) method. Properties that have been modified from their default values are saved between the graphical console sessions.

When a property is retrieved with a call to getProperty(String) method, the type of the returned object is determined by the type of the default value supplied when the property was defined.

Parameters:

key - Property key. Can be used to retrieve the property value.

defaultValue - Default value for the property. Must be of type Boolean, Enum, Integer, Long, Double, String, or an array containing objects of these types.

Throws:

IllegalArgumentException - If the specified key already exists, and the corresponding value is incompatible with the provided default; if either key or default value is null.

removeProperty

public abstract Object removeProperty(String key)

Removes a console property. If the specified property has been previously defined through a call to addProperty(String, Object) method, the property is removed and its current value is removed from storage; calling this method for a property that has not been defined has no effect.

Parameters:

key - Property key.

Returns:

Current value of the property, or null if there was no such property.

addPreference

public abstract void addPreference(String[] path,
                                   String group,
                                   String format)

Adds a setter for one or more previously defined properties to the preferences menu. The format string contains one or more property references in the ${key#qualifiers} form. Qualifiers are separated by "#". At the moment, the only supported qualifier is "history=N".

Parameters:

path - Path in the preferences tree to the page where the property setter should be displayed.

group - Group inside the preferences page. If null, the property setter is displayed in the default group.

format - Specifies the format of the property setter.

Throws:

IllegalArgumentException - If a property with the specified key already exists, and its value is incompatible with the provided default.

getProperty

public abstract Object getProperty(String key)

Returns the value of the property with the specified key. The type of the returned object is determined by the type of the default value supplied when the property was defined. If the property with the specified key has never been defined through a call to addProperty(String, Object) but exists in the console storage, it will be returned as a String.

Parameters:

key - Property key.

Returns:

Value of the specified property, or null if the property does not exist.

setProperty

public abstract Object setProperty(String key,
                                   Object value)

Sets the value of the specified property. If the property with the specified key has never been defined through a call to addProperty(String, Object) method, the value will be converted to a String and stored. Such keys cannot be used in setter format strings passed to addPreference(String[], String, String) method.

If the property value is set to null, it is removed from storage, so subsequent calls to getProperty(String) will return the default value, if it has been set.

Parameters:

key - Property key.

value - Property value, or null if the property is being reset to its default value.

Returns:

The previous value of the specified property, or null if the property did not exist.

setProperties

public void setProperties(Map<String,Object> properties)

Sets values of a set of properties. See setProperty(String, Object) for details on setting properties.

Parameters:

properties -

addPropertyListener

public abstract void addPropertyListener(Console.PropertyListener listener,
                                         String filter)

Registers a listener that will be notified of property changes.

Parameters:

listener - The listener to be notified.

filter - Regular expression the property key has to match to trigger notification.

removePropertyListener

public abstract boolean removePropertyListener(Console.PropertyListener listener)

Removes the specified property listener.

Parameters:

listener - Listener to be removed.

Returns:

True if the specified listener was registered with this console.

addMenu

public abstract void addMenu(Action action,
                             String owner,
                             String... locations)

Adds an item to the graphical console menu bar.

The location strings specify a hierarchy of menus above the added item. Each string should be in the name[[:group]:position] format, where name is the text label of the menu the item should be added to, group is the ordinal number of the item group inside the menu, and position is the position inside the group. The first location string can also be prefixed with the desired location on the menu bar: [barPosition:]name[[:group]:position]. The menu is divided into groups by separators. If the group number is negative, items added with the same group number but different owners are put into the same group. If the group is not specified or is equal to 0, the item is added to the default group. The default group is shared by all owners.

Parameters:

action - Action for the menu item to be added.

owner - Owner of the added menu item.

locations - Strings that specifies locations of the added item at all levels in the menu hierarchy.