com.nt.udc.ndk.gui

Class DCNodeConfigGUI

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.nt.udc.ndk.gui.DCNodeConfigGUI

All Implemented Interfaces:

DCNodeConfigGUIIfc, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

Direct Known Subclasses:

EINodeConfigGUI, OINodeConfigGUI, ProcessorNodeConfigGUI

public abstract class DCNodeConfigGUI
extends javax.swing.JPanel
implements DCNodeConfigGUIIfc

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.swing.JCheckBox	backupBox Used to determine whether the raw data for this node (not NAR data) should be backed up periodically.
protected java.lang.String	backupLabel Label string for backupBox
protected javax.swing.JCheckBox	bulkIOCheckBox This field is used to determine if entire nar file data would be held in memory before writing to file or while reading from file.
protected static java.awt.Font	defaultFont
protected com.nt.udc.admin.client.gui.nodegui.NodeDestinationsGUI	destGUI Indicates whether this node is routing its output to other nodes.
protected javax.swing.JLabel	fileLevelTransactionJLable
protected static java.lang.String	fileLevelTransactionLabel Label string for fileLevelTransactionCheckBox
protected javax.swing.JCheckBox	fileLevelTransCheckBox This field is used to determine if the cartridge participates in file level transaction node chain This field will not be added to the default tab, any cartridge wanting to to have file level transaction functionality should add this field to extended UI panel
protected javax.swing.JCheckBox	inputMonitorEnableField Check to turn on silent input monitoring
protected UDCNumericField	inputMonitorTimeField Number input field, minimum silent input time interval to wait before generating an alarm
protected javax.swing.JComboBox	inputMonitorTimeUnitsField The time units used for the inputMonitorTimeField
protected javax.swing.JCheckBox	narBackupBox Used to determine whether the input NAR files for this node should be backed up.
protected SMGIntField	narBackupDaysField Number of days to retain NAR files in backup directory.
protected static java.lang.String	narBackupDaysLabel Label string for narBackupDaysField
protected static java.lang.String	narBackupLabel Label string for narBackupBox
protected DCNodeConfigData	nodeConfig Object which will contain the configuration values for a given node that were provided by the user in this GUI.
protected boolean	nodeFieldsDirty Indicates whether the user has altered any fields in this GUI.
protected javax.swing.JCheckBox	recordCountEnableField Used to turn on/off the Record Statistics Counter feature
protected javax.swing.JTabbedPane	tabbedPane Tabbed pane which contains all of the panels needed for configuring a particular node.

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
DCNodeConfigGUI() Default constructor
DCNodeConfigGUI(DCNodeConfigData ncd) Initializes nodeConfig with the given DCNodeConfigData object and sets up the GUI components.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addGUIComponents() Sets the layout for this panel to a BorderLayout.
protected void	addInputMonitoringFieldsToPanel(SMGJLCPanel panel) Adds a checkbox, a number input box, and a combo box to the general tab panel.
void	addNarBackupCheckbox(SMGJLCPanel panel) Adds the "Backup NAR Files" checkbox to the "General" tab panel
protected void	addPanel(java.lang.String label, javax.swing.JPanel new_panel) Adds a panel to tabbedPane with the given label.
protected void	addScrollPanel(java.lang.String label, javax.swing.JPanel new_panel, int height, int unit_inc) Adds a panel in a ScrollPane to tabbedPane with the given label.
boolean	allFieldsValid() Check and warn the user if the Input Stream Monitoring interval will last longer than one week.
void	defaultValue(java.lang.String name, long value, long min, long max) Sets the default value for the given configuration item, and will enforce the value to be within the specified range.
void	defaultValue(java.lang.String name, java.lang.String value) Sets the default value for the given configuration item.
protected void	disableBackupCheckbox() Hides the "Backup Node Data" checkbox in the "General" tab
protected void	enableBackupCheckbox() Displays the "Backup Node Data" checkbox in the "General" tab
abstract void	extendConfigGUI() Must be implemented in the derived class to add a node specific UI panel to the tabbed pane
boolean	getBackupValue() Indicates whether the user has checked the "Backup Node Data" checkbox
ConfigActionIfc	getConfigActionObject() Be default returns false.
DCNodeConfigData	getDCNodeConfigData() Populates the DCNodeConfigData Object with values from fields contained in the "General" tab panel which includes the debugLevel, maxLogFileSize, recordStatistics and backup fields.
java.lang.String	getDebugLevel() Retrieves the value that the user has entered for the "Debug Level" field.
java.util.Vector	getDestinations() Returns a Vector of NodeInfo objects representing the nodes that will receive output from the node being configured by this GUI.
int	getMaxLogFileSize()
int	getMaxLogSizeValue() Returns the value of the "Max Log File Size" field. If a message needs to be logged which causes this value to be exceeded, the log file will be moved to an archive file and a new log file will be started.
java.lang.Long	getMaxValue(java.lang.String name) Returns the maximum value for the given configuration item.
int	getMinLogFileSize()
java.lang.Long	getMinValue(java.lang.String name) Returns the minimum value for the given configuration item.
int	getNarBackupDaysValue() Returns the number of days to retain the NAR files in the node's backup directory
boolean	getNarBackupValue() Indicates whether the user has checked the "Backup NAR Files" checkbox
com.nt.udc.admin.client.gui.nodegui.NodeDestinationsGUI	getNodeDestinationsGUI() Returns the existing node destinations GUI
java.lang.String	getNodeId() Returns the node identifier for the node that is being configured by this DCNodeConfigGUIIfc object.
abstract void	getNodeSpecificConfigData(DCNodeConfigData nodeData) Implemented by the derived class to populate the node specific config items in the nodeData object
boolean	hasDestinations() Indicates whether the node can send output to other nodes.
protected void	init() Allows derived classes to perform any necessary initialization before any abstract methods are called.
boolean	isAnyConfigAction() If user needs to perform any config action then this method needs to be override in the NodeConfigGUI class to return true.
protected UDCIPAddressField	makeIPAddressField(java.lang.String contents, java.lang.String toolTip) Creates an editable panel, containing 4 text fields, which allows the user to enter an IP Address.
protected javax.swing.JPanel	makeNodePanel() Lays out the configuration panels for this GUI.
protected javax.swing.JTextField	makeNumericTextField(java.lang.String contents, java.lang.String toolTip) Creates an editable JTextField containing the given value with the specified tool tip.
protected javax.swing.JTextField	makeNumericTextField(java.lang.String contents, java.lang.String toolTip, int maxValue) Creates an editable JTextField containing the given value with the specified tool tip.
protected javax.swing.JTextField	makeNumericTextField(java.lang.String contents, java.lang.String toolTip, long minValue, long maxValue) Creates an editable JTextField containing the given value with the specified tool tip.
protected static javax.swing.JPanel	makePanel(java.util.Vector labels, java.util.Vector components) Creates a panel which contains the given components with the given labels.
protected static javax.swing.JPanel	makePanel(java.util.Vector labels, java.util.Vector components, int alignment) Creates a panel which contains the given components with the given labels.
protected javax.swing.JTextField	makeTextField(java.lang.String contents, int size, boolean editable, java.lang.String toolTip) Creates a JTextField of the given size with the given properties.
protected javax.swing.JTextField	makeTextField(java.lang.String contents, java.lang.String toolTip)
void	setBackupValue(boolean value) Sets the value of the "Backup Node Data" checkbox
void	setConfigRange(java.lang.String name, long min, long max) Sets the range of values for the given configuration item.
void	setDebugLevel(java.lang.String value) Sets the value to display in the "Debug Level" field.
abstract void	setDefaults() Method which sets the default configuration values for this node.
void	setDestinations(java.util.Vector inTargets) Accepts a Vector of NodeInfo objects representing one or more nodes that the user has selected as a destination for this node's output.
void	setMaxLogFileSize(int max)
void	setMaxLogSizeValue(int size) Sets the value of the "Max Log File Size" field. If a message needs to be logged which causes this value to be exceeded, the log file will be moved to an archive file and a new log file will be started.
void	setMaxValueForLogSize(int maxValue) Sets the maximum value that the user may enter in the "Max Log File Size:" field.
void	setMinLogFileSize(int min)
void	setNarBackupDaysValue(int value) Sets the value of the "NAR File Retention Period"
void	setNarBackupValue(boolean value) Sets the value of the "Backup NAR Files" checkbox
void	setNodeId(java.lang.String inNodeId) Sets the node identifier for the node that is being configured by this DCNodeConfigGUIIfc object.
void	setNodeInfo(com.nt.udc.admin.NodeInfo ni) Sets the current node info
protected void	setRangeValues() Sets the min and max values for "Debug Level" and "MaxLogFileSize" fields.
protected void	validateConfig(DCNodeConfigData config) Validates the values in the given config object, for those items which have been set with a valid range.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, 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, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

tabbedPane

protected javax.swing.JTabbedPane tabbedPane

Tabbed pane which contains all of the panels needed for configuring a particular node.

narBackupBox

protected javax.swing.JCheckBox narBackupBox

Used to determine whether the input NAR files for this node should be backed up.

bulkIOCheckBox

protected javax.swing.JCheckBox bulkIOCheckBox

This field is used to determine if entire nar file data would be held in memory before writing to file or while reading from file.

fileLevelTransactionLabel

protected static java.lang.String fileLevelTransactionLabel

Label string for fileLevelTransactionCheckBox

fileLevelTransCheckBox

protected javax.swing.JCheckBox fileLevelTransCheckBox

This field is used to determine if the cartridge participates in file level transaction node chain This field will not be added to the default tab, any cartridge wanting to to have file level transaction functionality should add this field to extended UI panel

fileLevelTransactionJLable

protected javax.swing.JLabel fileLevelTransactionJLable

narBackupLabel

protected static java.lang.String narBackupLabel

Label string for narBackupBox

narBackupDaysField

protected SMGIntField narBackupDaysField

Number of days to retain NAR files in backup directory.

narBackupDaysLabel

protected static java.lang.String narBackupDaysLabel

Label string for narBackupDaysField

backupBox

protected javax.swing.JCheckBox backupBox

Used to determine whether the raw data for this node (not NAR data) should be backed up periodically.

backupLabel

protected java.lang.String backupLabel

Label string for backupBox

inputMonitorEnableField

protected javax.swing.JCheckBox inputMonitorEnableField

Check to turn on silent input monitoring

inputMonitorTimeField

protected UDCNumericField inputMonitorTimeField

Number input field, minimum silent input time interval to wait before generating an alarm

inputMonitorTimeUnitsField

protected javax.swing.JComboBox inputMonitorTimeUnitsField

The time units used for the inputMonitorTimeField

recordCountEnableField

protected javax.swing.JCheckBox recordCountEnableField

Used to turn on/off the Record Statistics Counter feature

nodeConfig

protected DCNodeConfigData nodeConfig

Object which will contain the configuration values for a given node that were provided by the user in this GUI.

nodeFieldsDirty

protected boolean nodeFieldsDirty

Indicates whether the user has altered any fields in this GUI.

destGUI

protected com.nt.udc.admin.client.gui.nodegui.NodeDestinationsGUI destGUI

Indicates whether this node is routing its output to other nodes.

defaultFont

protected static final java.awt.Font defaultFont

Constructor Detail

DCNodeConfigGUI

public DCNodeConfigGUI()

Default constructor

DCNodeConfigGUI

public DCNodeConfigGUI(DCNodeConfigData ncd)

Initializes nodeConfig with the given DCNodeConfigData object and sets up the GUI components. This method calls init() before any abstract methods are called to allow derived classes to perform any necessary initialization. This method then calls setDefaults() and then addGUIComponents().

Parameters:

ncd - DCNodeConfigData object to be used for storing information provided by the user in this GUI.

Method Detail

init

protected void init()

Allows derived classes to perform any necessary initialization before any abstract methods are called. Base class provides an empty implementation.

makePanel

protected static javax.swing.JPanel makePanel(java.util.Vector labels,
                           java.util.Vector components)

Creates a panel which contains the given components with the given labels. Using the default label alignment of SwingConstants.RIGHT

makePanel

protected static javax.swing.JPanel makePanel(java.util.Vector labels,
                           java.util.Vector components,
                           int alignment)

Creates a panel which contains the given components with the given labels. Using the given alignment for the labels.

allFieldsValid

public boolean allFieldsValid()

Check and warn the user if the Input Stream Monitoring interval will last longer than one week.

Specified by:

allFieldsValid in interface DCNodeConfigGUIIfc

Returns:

true if either the input stream monitoring interval is less than one week, or that the user is OK with the interval longer than one week.

isAnyConfigAction

public boolean isAnyConfigAction()

If user needs to perform any config action then this method needs to be override in the NodeConfigGUI class to return true.

Specified by:

isAnyConfigAction in interface DCNodeConfigGUIIfc

getConfigActionObject

public ConfigActionIfc getConfigActionObject()

Be default returns false. If some config action needs to be performed while configuring node then this method should return the ConfigActionIfc object.

Specified by:

getConfigActionObject in interface DCNodeConfigGUIIfc

getDCNodeConfigData

public DCNodeConfigData getDCNodeConfigData()

Populates the DCNodeConfigData Object with values from fields contained in the "General" tab panel which includes the debugLevel, maxLogFileSize, recordStatistics and backup fields.
Calls the derived class's getNodeSpecificConfigData() method to pick up any derived node specific configuration items.

Specified by:

getDCNodeConfigData in interface DCNodeConfigGUIIfc

hasDestinations

public boolean hasDestinations()

Indicates whether the node can send output to other nodes.
true for EI and Processor nodes. Default returns false.

Specified by:

hasDestinations in interface DCNodeConfigGUIIfc

Returns:

false

getDestinations

public final java.util.Vector getDestinations()

Returns a Vector of NodeInfo objects representing the nodes that will receive output from the node being configured by this GUI.

Specified by:

getDestinations in interface DCNodeConfigGUIIfc

Returns:

Vector of NodeInfo objects

setDestinations

public final void setDestinations(java.util.Vector inTargets)

Description copied from interface: DCNodeConfigGUIIfc

Accepts a Vector of NodeInfo objects representing one or more nodes that the user has selected as a destination for this node's output. (That is, the node that is being configured by this DCNodeConfigGUIIfc object.)
This method will only be called if hasDestinations() returns true.

Specified by:

setDestinations in interface DCNodeConfigGUIIfc

Parameters:

inTargets - Vector of NodeInfo objects

getNodeId

public final java.lang.String getNodeId()

Description copied from interface: DCNodeConfigGUIIfc

Returns the node identifier for the node that is being configured by this DCNodeConfigGUIIfc object.

Specified by:

getNodeId in interface DCNodeConfigGUIIfc

Returns:

null, if nodeId has not been set using setNodeId()

setNodeId

public final void setNodeId(java.lang.String inNodeId)

Description copied from interface: DCNodeConfigGUIIfc

Sets the node identifier for the node that is being configured by this DCNodeConfigGUIIfc object.

Specified by:

setNodeId in interface DCNodeConfigGUIIfc

Parameters:

inNodeId - String representing the node id

setNodeInfo

public final void setNodeInfo(com.nt.udc.admin.NodeInfo ni)

Description copied from interface: DCNodeConfigGUIIfc

Sets the current node info

Specified by:

setNodeInfo in interface DCNodeConfigGUIIfc

Parameters:

ni - Current NodeInfo object

getDebugLevel

public java.lang.String getDebugLevel()

Retrieves the value that the user has entered for the "Debug Level" field. Valid values are:
OFF None - no messages are logged
ON Messages are logged with Exception trace if the cause is an Exception

setDebugLevel

public void setDebugLevel(java.lang.String value)

Sets the value to display in the "Debug Level" field. Valid values are:
OFF None - no messages are logged
ON Messages are logged with Exception trace if the cause is an Exception

addNarBackupCheckbox

public void addNarBackupCheckbox(SMGJLCPanel panel)

Adds the "Backup NAR Files" checkbox to the "General" tab panel

getNarBackupValue

public boolean getNarBackupValue()

Indicates whether the user has checked the "Backup NAR Files" checkbox

setNarBackupValue

public void setNarBackupValue(boolean value)

Sets the value of the "Backup NAR Files" checkbox

getNarBackupDaysValue

public int getNarBackupDaysValue()

Returns the number of days to retain the NAR files in the node's backup directory

setNarBackupDaysValue

public void setNarBackupDaysValue(int value)

Sets the value of the "NAR File Retention Period"

enableBackupCheckbox

protected void enableBackupCheckbox()

Displays the "Backup Node Data" checkbox in the "General" tab

disableBackupCheckbox

protected void disableBackupCheckbox()

Hides the "Backup Node Data" checkbox in the "General" tab

getBackupValue

public boolean getBackupValue()

Indicates whether the user has checked the "Backup Node Data" checkbox

setBackupValue

public void setBackupValue(boolean value)

Sets the value of the "Backup Node Data" checkbox

getMaxLogSizeValue

public int getMaxLogSizeValue()

Returns the value of the "Max Log File Size" field.
If a message needs to be logged which causes this value to be exceeded, the log file will be moved to an archive file and a new log file will be started.

Default maximum value is DCNodeConfigDefaults.MAX_LOG_FILE_SIZE

setMaxLogSizeValue

public void setMaxLogSizeValue(int size)

Sets the value of the "Max Log File Size" field.
If a message needs to be logged which causes this value to be exceeded, the log file will be moved to an archive file and a new log file will be started.

Default maximum value is DCNodeConfigDefaults.MAX_LOG_FILE_SIZE

setMaxValueForLogSize

public void setMaxValueForLogSize(int maxValue)

Sets the maximum value that the user may enter in the "Max Log File Size:" field.

getNodeDestinationsGUI

public com.nt.udc.admin.client.gui.nodegui.NodeDestinationsGUI getNodeDestinationsGUI()

Description copied from interface: DCNodeConfigGUIIfc

Returns the existing node destinations GUI

Specified by:

getNodeDestinationsGUI in interface DCNodeConfigGUIIfc

getMinLogFileSize

public int getMinLogFileSize()

getMaxLogFileSize

public int getMaxLogFileSize()

setMinLogFileSize

public void setMinLogFileSize(int min)

setMaxLogFileSize

public void setMaxLogFileSize(int max)

addGUIComponents

protected void addGUIComponents()

Sets the layout for this panel to a BorderLayout. Calls makeNodePanel to layout the necessary panels for this GUI, including any node specific panels, and adds tabbedPane as the BorderLayout.CENTER component and calls validate().

addPanel

protected void addPanel(java.lang.String label,
            javax.swing.JPanel new_panel)

Adds a panel to tabbedPane with the given label.

Parameters:

new_panel - Panel to be added

label - Name for the panel

addScrollPanel

protected void addScrollPanel(java.lang.String label,
                  javax.swing.JPanel new_panel,
                  int height,
                  int unit_inc)

Adds a panel in a ScrollPane to tabbedPane with the given label.

Parameters:

new_panel - Panel to be added

label - Name for the panel

height - Preferred Height for the Scroll Pane

unit_inc - Unit Increment value for the scroll bars (if non-zero)

makeNodePanel

protected javax.swing.JPanel makeNodePanel()

Lays out the configuration panels for this GUI.
Allows the user to set values for the following fields:

• "Debug Level:", which is populated from DCNodeConfigData#DEBUG; and
• "Max Log File Size:", which is populated from DCNodeConfigData.LOGFILESIZE
• "Record Statistics Counting:", which is populated from DCNodeConfigData.RECORDSTATS
  using the DCNodeConfigData object that was passed in to the constructor.

addInputMonitoringFieldsToPanel

protected void addInputMonitoringFieldsToPanel(SMGJLCPanel panel)

Adds a checkbox, a number input box, and a combo box to the general tab panel. These 3 fields are the input to the Input Monitoring feature.

Parameters:

panel - This should be the General Tab Panel.

makeTextField

protected javax.swing.JTextField makeTextField(java.lang.String contents,
                                   java.lang.String toolTip)

Returns:

value of makeTextField() with a size of 5 and editable set to true

makeTextField

protected javax.swing.JTextField makeTextField(java.lang.String contents,
                                   int size,
                                   boolean editable,
                                   java.lang.String toolTip)

Creates a JTextField of the given size with the given properties.

Parameters:

contents - Text, if any, to display in the text field

size - Width of the text field

editable - Indicates whether the contents of the field may be changed by the user

toolTip - String to display when the user's cursor lingers over the field

defaultValue

public void defaultValue(java.lang.String name,
                java.lang.String value)

Sets the default value for the given configuration item.

defaultValue

public void defaultValue(java.lang.String name,
                long value,
                long min,
                long max)

Sets the default value for the given configuration item, and will enforce the value to be within the specified range.

Parameters:

name - name of the configuration item to be set

value - desired "default" value for this item

min - minimum value for this item

max - maximum value for this item

setConfigRange

public void setConfigRange(java.lang.String name,
                  long min,
                  long max)

Sets the range of values for the given configuration item.

Parameters:

name - name of the configuration item to set the range for

min - minimum value for this item

max - maximum value for this item

See Also:

#getMinValue(String ), #getMaxValue( String )

getMinValue

public java.lang.Long getMinValue(java.lang.String name)

Returns the minimum value for the given configuration item. Returns null, if no range has been set for the specified item.

getMaxValue

public java.lang.Long getMaxValue(java.lang.String name)

Returns the maximum value for the given configuration item. Returns null, if no range has been set for the specified item.

makeNumericTextField

protected javax.swing.JTextField makeNumericTextField(java.lang.String contents,
                                          java.lang.String toolTip)

Creates an editable JTextField containing the given value with the specified tool tip. By default, the column width is 5, minimum value is 0, and maximum is Long.MAX_VALUE.

Parameters:

contents - Text, if any, to display in the text field

toolTip - String to display when the user's cursor lingers over the field

makeNumericTextField

protected javax.swing.JTextField makeNumericTextField(java.lang.String contents,
                                          java.lang.String toolTip,
                                          int maxValue)

Creates an editable JTextField containing the given value with the specified tool tip. The column width is 5, and the given maximum value is imposed. The minimum value is 0.

Parameters:

contents - Text, if any, to display in the text field

toolTip - String to display when the user's cursor lingers over the field

maxValue - Indicates the maximum value that the user may enter in the field.

makeNumericTextField

protected javax.swing.JTextField makeNumericTextField(java.lang.String contents,
                                          java.lang.String toolTip,
                                          long minValue,
                                          long maxValue)

Creates an editable JTextField containing the given value with the specified tool tip. The column width is 5, and the given minimum or maximum values are imposed.

Validation is performed when the component loses focus. If the user enters a value that is non-numeric or is less than the given minimum value, the minimum value will be used (and displayed in the textfield). If the user enters a value greater than the maximum value, the maximum value will be used.

If the given minValue is greater than the given maxValue, then minValue value will be equal to maxValue.

Parameters:

contents - Text, if any, to display in the text field

toolTip - String to display when the user's cursor lingers over the field

minValue - Indicates the minimum value that the user may enter in the field.

maxValue - Indicates the maximum value that the user may enter in the field.

makeIPAddressField

protected UDCIPAddressField makeIPAddressField(java.lang.String contents,
                                   java.lang.String toolTip)

Creates an editable panel, containing 4 text fields, which allows the user to enter an IP Address. If contents is null, a default of "0.0.0.0" is used to initially populate the fields.

Parameters:

contents - IP Address, if any, to display in the text field

toolTip - String to display when the user's cursor lingers over the component

validateConfig

protected void validateConfig(DCNodeConfigData config)

Validates the values in the given config object, for those items which have been set with a valid range.

If a range has been specified for a configuration item, and the current value of that item is outside the given range, the current value will be updated to reflect either the minimum or maximum value. If the current value is less than the minimum, the value in the config will be updated to reflect the minimum value of the range. The maximum value will be used if the value is greater than the maximum value of the range. If the current value is invalid (i.e. text instead of a number), the minimum value will be used.

See Also:

defaultValue(String, long, long, long )

setRangeValues

protected void setRangeValues()

Sets the min and max values for "Debug Level" and "MaxLogFileSize" fields.

getNodeSpecificConfigData

public abstract void getNodeSpecificConfigData(DCNodeConfigData nodeData)

Implemented by the derived class to populate the node specific config items in the nodeData object

Specified by:

getNodeSpecificConfigData in interface DCNodeConfigGUIIfc

extendConfigGUI

public abstract void extendConfigGUI()

Must be implemented in the derived class to add a node specific UI panel to the tabbed pane

Specified by:

extendConfigGUI in interface DCNodeConfigGUIIfc

setDefaults

public abstract void setDefaults()

Method which sets the default configuration values for this node.