org.tfe.console
Class Console

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--java.awt.Window
                    |
                    +--java.awt.Frame
                          |
                          +--javax.swing.JFrame
                                |
                                +--org.tfe.console.Console

All Implemented Interfaces:

javax.accessibility.Accessible, Client, java.awt.image.ImageObserver, java.awt.MenuContainer, javax.swing.RootPaneContainer, java.io.Serializable, javax.swing.WindowConstants

public class Console

extends javax.swing.JFrame

implements Client

See Also:

Serialized Form

Field Summary

static java.lang.String

VERSION The version of this release of IDEA

Fields inherited from class javax.swing.JFrame

accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Frame

CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Console()
Creates new form Console

Method Summary

void	addAlert(Alert alert) Adds an alert to the console.
static void	addAlerts(AlertList a) Adds alerts to the Console.
void	addSensorMap() Adds the Sensor Map.
AlertServer	getAlertServer() Gets the reference to the IDEA server (object reference so that we can call functions on the server).
java.lang.String[]	getDBInfo() Retrieves the database username & password.
java.net.InetAddress	getInetAddress()
ORBClient	getORBClient() Retrieves the ORBClient.
int	getRegistrationIndex() Retrieves the registration number for the IDEA server (the index at which the application registered.)
java.lang.String[]	getServerInfo() Retrieves the IDEA server username & password.
byte	getType()
User	getUser() Gets the user associated with this logon.
java.lang.String	getVersion()
static javax.swing.JComponent	getVizComponent() Gets the current visualization component.
static void	main(java.lang.String[] args)
static void	removeAlert(int ID) Removes an alert locally from the console.
void	removeSensorMap() Removes the Sensor Map.
void	setAlertHistoryView(AlertList aList) Adds alerts to the Alert History table in the alert history pane.
void	setAlertServer(AlertServer serverRef)
void	setCallBackRef(AppsCallBack callBackRef)
void	setColorized(boolean colorize) Sets the colorization model for the AlertsTable and AlertHistoryTable.
void	setORBClient(ORBClient anORBClient) Sets the ORBClient.
void	setRegistrationIndex(int index)
void	setUser(User aUser)
void	setVizComponent(javax.swing.JComponent comp) Statically sets the visualization component.
void	writeConfig() Writes the console's settings to a file in the user's home directory.

Methods inherited from class javax.swing.JFrame

addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, update

Methods inherited from class java.awt.Frame

addNotify, finalize, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setCursor, setExtendedState, setIconImage, setMaximizedBounds, setMenuBar, setResizable, setState, setTitle, setUndecorated

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, hide, isActive, isFocusableWindow, isFocusCycleRoot, isFocused, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationRelativeTo, show, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setFocusTraversalKeys, setFocusTraversalPolicy, setFont, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isOpaque, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Field Detail

VERSION

public static final java.lang.String VERSION

The version of this release of IDEA

See Also:

Constant Field Values

Constructor Detail

Console

public Console()

Creates new form Console

Method Detail

setAlertHistoryView

public void setAlertHistoryView(AlertList aList)

Adds alerts to the Alert History table in the alert history pane.

Specified by:

setAlertHistoryView in interface Client

Parameters:

aList - an AlertList of Alerts to be added to the AlertHistoryTable.

getDBInfo

public java.lang.String[] getDBInfo()

Retrieves the database username & password.

Specified by:

getDBInfo in interface Client

Returns:

String array of the username[0] and password[1] for the database.

getServerInfo

public java.lang.String[] getServerInfo()

Retrieves the IDEA server username & password.

Specified by:

getServerInfo in interface Client

Returns:

String array of the username[0] and password[1] for the IDEA server.

getRegistrationIndex

public int getRegistrationIndex()

Retrieves the registration number for the IDEA server (the index at which the application registered.)

Specified by:

getRegistrationIndex in interface Client

Returns:

int value of the registration number.

addAlert

public void addAlert(Alert alert)

Adds an alert to the console. This function is called by ORBClient every time a new alert is received from the RTA server. This function can also be called by the AlertParser class if the console is being run in standalone mode. It adds the new alert to a local memory buffer (AlertList).

Specified by:

addAlert in interface Client

Parameters:

alert - Alert to be added to the console

See Also:

Alert, AlertList

addAlerts

public static void addAlerts(AlertList a)

Adds alerts to the Console. This function is called at startup once alerts are retrieved from the RTA server. It is useful for adding a semi-large number of alerts to the AlertsTable all at once. It adds the alerts to a local buffer (AlertList), and then adds them to the AlertsTable. AlertsTable sorts itself after every insert to ensure that the data is displayed in the proper order.

Parameters:

a - an ArrayList of Alerts

See Also:

Alert, ArrayList

writeConfig

public void writeConfig()

Writes the console's settings to a file in the user's home directory. This function writes three config files to the user's home directory. The three files that it writes are:

• IDEAConsole.cfg
• sensors.cfg
• ips.cfg

If these files are not found, an exception will be generated but the console will continue to run.

setColorized

public void setColorized(boolean colorize)

Sets the colorization model for the AlertsTable and AlertHistoryTable. This method is used to turn colorization on or off for the tables that display alert information.

Specified by:

setColorized in interface Client

Parameters:

colorize - whether or not to colorize the tables

getVizComponent

public static javax.swing.JComponent getVizComponent()

Gets the current visualization component.

Returns:

JComponent object that is currently in the Visualization window, or null if none is set.

setVizComponent

public void setVizComponent(javax.swing.JComponent comp)

Statically sets the visualization component. This method sets the visualization component to be used in the visualization window. This method can be statically called by other classes.

Parameters:

comp - the component to be displayed in the visualization window (JScrollPane)

addSensorMap

public void addSensorMap()

Adds the Sensor Map. This method checks several parameters in the settings Hashtable and then invokes the proper commands to add a Sensor Map to the visualization tools window. This function was created to avoid duplicating code. It is currently called in the readConfig function and in the action handler for the SensorMap menu item.

removeSensorMap

public void removeSensorMap()

Removes the Sensor Map. Reusable code for the SensorMap action handler and the addSensorMap method. This method is called when a user disables the SensorMap.

removeAlert

public static void removeAlert(int ID)

Removes an alert locally from the console. This method will remove an alert from the alertBuffer, the AlertsTable, and the corresponding Sensor. When complete, it forces a repaint of the VizComponent if one is in use.

Parameters:

ID - the ID of the alert to be removed

getInetAddress

public java.net.InetAddress getInetAddress()

Specified by:

getInetAddress in interface Client

getType

public byte getType()

Specified by:

getType in interface Client

getVersion

public java.lang.String getVersion()

Specified by:

getVersion in interface Client

setUser

public void setUser(User aUser)

Specified by:

setUser in interface Client

getUser

public User getUser()

Gets the user associated with this logon.

Specified by:

getUser in interface Client

Returns:

User that has logged on to the IDEA server

setORBClient

public void setORBClient(ORBClient anORBClient)

Sets the ORBClient.

Specified by:

setORBClient in interface Client

Parameters:

anORBClient - the ORBClient to be used by this Client.

getORBClient

public ORBClient getORBClient()

Retrieves the ORBClient.

Specified by:

getORBClient in interface Client

Returns:

ORBClient reference.

setAlertServer

public void setAlertServer(AlertServer serverRef)

Specified by:

setAlertServer in interface Client

getAlertServer

public AlertServer getAlertServer()

Gets the reference to the IDEA server (object reference so that we can call functions on the server).

Specified by:

getAlertServer in interface Client

Returns:

AlertServer object reference.

setCallBackRef

public void setCallBackRef(AppsCallBack callBackRef)

Specified by:

setCallBackRef in interface Client

setRegistrationIndex

public void setRegistrationIndex(int index)

Specified by:

setRegistrationIndex in interface Client

main

public static void main(java.lang.String[] args)