biggests.gui
Class PanelBasicIOValidation

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by javax.swing.JPanel
                  extended by biggests.gui.PanelBasicIOValidation
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible
Direct Known Subclasses:
PanelBiclustering, PanelPostProcessing, PanelPreProcessing

public abstract class PanelBasicIOValidation
extends javax.swing.JPanel

Title: Panel with Basic Input/Output Validation

Description: Extends JPanel class with some methods to perform basic validations over data input by the user. Abstract class. Non abstract subclasses must implement readParameter(String parameterToRead) method, which actually gets the parameter entered by the user as a String. All remaining methods of this class call readParameter method, convert the String to some number format and perform extra validations.

Copyright: Copyright (C) 2007 Joana Gonçalves This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

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 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
PanelBasicIOValidation()
           
 
Method Summary
abstract  java.lang.String readParameter(java.lang.String parameterToRead)
          Abstract method.
 double readParameterDouble(double min, double max, java.lang.String parameterToRead)
          Reads parameterToRead entered by the user, converts it to a floating point value (double and checks if the resulting value is in [min, max] range.
 double readParameterDouble(double min, java.lang.String parameterToRead)
          Reads parameterToRead entered by the user, converts it to a floating point value (double) and checks if the resulting value is above min value.
 double readParameterDouble(java.lang.String parameterToRead)
          Reads parameterToRead entered by the user and converts it to a floating point (double) value.
 float readParameterFloat(float min, float max, java.lang.String parameterToRead)
          Reads parameterToRead entered by the user, converts it to a floating point value (float and checks if the resulting value is in [min, max] range.
 float readParameterFloat(float min, java.lang.String parameterToRead)
          Reads parameterToRead entered by the user, converts it to a floating point value (float) and checks if the resulting value is above min value.
 float readParameterFloat(java.lang.String parameterToRead)
          Reads parameterToRead entered by the user and converts it to a floating point (float) value.
 int readParameterInteger(int min, int max, java.lang.String parameterToRead)
          Reads parameterToRead entered by the user, converts it to an integer value and checks if the resulting value is in [min, max] range.
 int readParameterInteger(int min, java.lang.String parameterToRead)
          Reads parameterToRead entered by the user, converts it to an integer value and checks if the resulting value is above min value.
 int readParameterInteger(java.lang.String parameterToRead)
          Reads parameterToRead entered by the user and converts it to an integer value.
 
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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, 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, 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, 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, hide, 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, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

PanelBasicIOValidation

public PanelBasicIOValidation()
Method Detail

readParameter

public abstract java.lang.String readParameter(java.lang.String parameterToRead)
                                        throws java.lang.Exception
Abstract method. Should be implemented by non abstract subclasses of this class. Reads a specific parameter entered by the user (the selected location and methodology of reading the parameter is delegated to subclasses, that actually know how it should be done).

Parameters:
parameterToRead - String the name of the parameter to read (specially important when displaying error messages to user)
Returns:
String the parameter read
Throws:
java.lang.Exception - if it was not possible to read the parameter

readParameterInteger

public int readParameterInteger(java.lang.String parameterToRead)
                         throws java.lang.Exception
Reads parameterToRead entered by the user and converts it to an integer value. Displays an error message if parameter could not be read or converted to integer. Also throws an exception in these cases.

Parameters:
parameterToRead - String the name of the parameter to read
Returns:
int the parameter read
Throws:
java.lang.Exception - if parameter could not be read or could not be converted to an integer value

readParameterInteger

public int readParameterInteger(int min,
                                int max,
                                java.lang.String parameterToRead)
                         throws java.lang.Exception
Reads parameterToRead entered by the user, converts it to an integer value and checks if the resulting value is in [min, max] range. Displays an error message if parameter could not be read, could not be converted to integer or if it's under the minimum (min) or over the maximum (max) given thresholds. Also throws an exception in these cases.

Parameters:
min - int minimum threshold
max - int maximum threshold
parameterToRead - String the name of the parameter to read
Returns:
int the parameter read
Throws:
java.lang.Exception - if parameter could not be read, could not be converted to an integer value or if its under the minimum or over the maximum value

readParameterInteger

public int readParameterInteger(int min,
                                java.lang.String parameterToRead)
                         throws java.lang.Exception
Reads parameterToRead entered by the user, converts it to an integer value and checks if the resulting value is above min value. Displays an error message if parameter could not be read, could not be cconverted to integer or if it's under the minimum given threshold (min). Also throws an exception in these cases.

Parameters:
min - int minimum threshold
parameterToRead - String the name of the parameter to read
Returns:
int the parameter read
Throws:
java.lang.Exception - if parameter could not be read, could not be converted to an integer value or if its under the minimum

readParameterFloat

public float readParameterFloat(java.lang.String parameterToRead)
                         throws java.lang.Exception
Reads parameterToRead entered by the user and converts it to a floating point (float) value. Displays an error message if parameter could not be read or converted to float. Also throws an exception in these cases.

Parameters:
parameterToRead - String the name of the parameter to read
Returns:
float the parameter read
Throws:
java.lang.Exception - if parameter could not be read or could not be converted to a float value

readParameterFloat

public float readParameterFloat(float min,
                                float max,
                                java.lang.String parameterToRead)
                         throws java.lang.Exception
Reads parameterToRead entered by the user, converts it to a floating point value (float and checks if the resulting value is in [min, max] range. Displays an error message if parameter could not be read, could not be converted to float or if it's under the minimum (min) or over the maximum (max) given thresholds. Also throws an exception in these cases.

Parameters:
min - float minimum threshold
max - float maximum threshold
parameterToRead - String the name of the parameter to read
Returns:
float the parameter read
Throws:
java.lang.Exception - if parameter could not be read, could not be converted to a float value or if its under the minimum or over the maximum value

readParameterFloat

public float readParameterFloat(float min,
                                java.lang.String parameterToRead)
                         throws java.lang.Exception
Reads parameterToRead entered by the user, converts it to a floating point value (float) and checks if the resulting value is above min value. Displays an error message if parameter could not be read, could not be converted to float or if it's under the minimum given threshold (min). Also throws an exception in these cases.

Parameters:
min - float minimum threshold
parameterToRead - String the name of the parameter to read
Returns:
float the parameter read
Throws:
java.lang.Exception - if parameter could not be read, could not be converted to a float value or if its under the minimum value (min)

readParameterDouble

public double readParameterDouble(java.lang.String parameterToRead)
                           throws java.lang.Exception
Reads parameterToRead entered by the user and converts it to a floating point (double) value. Displays an error message if parameter could not be read or converted to double. Also throws an exception in these cases.

Parameters:
parameterToRead - String the name of the parameter to read
Returns:
double the parameter read
Throws:
java.lang.Exception - if parameter could not be read or could not be converted to a double value

readParameterDouble

public double readParameterDouble(double min,
                                  double max,
                                  java.lang.String parameterToRead)
                           throws java.lang.Exception
Reads parameterToRead entered by the user, converts it to a floating point value (double and checks if the resulting value is in [min, max] range. Displays an error message if parameter could not be read, could not be converted to double or if it's under the minimum (min) or over the maximum (max) given thresholds. Also throws an exception in these cases.

Parameters:
min - double minimum threshold
max - double maximum threshold
parameterToRead - String the name of the parameter to read
Returns:
double the parameter read
Throws:
java.lang.Exception - if parameter could not be read, could not be converted to a double value or if its under the minimum or over the maximum value

readParameterDouble

public double readParameterDouble(double min,
                                  java.lang.String parameterToRead)
                           throws java.lang.Exception
Reads parameterToRead entered by the user, converts it to a floating point value (double) and checks if the resulting value is above min value. Displays an error message if parameter could not be read, could not be converted to double or if it's under the minimum given threshold (min). Also throws an exception in these cases.

Parameters:
min - double minimum threshold
parameterToRead - String the name of the parameter to read
Returns:
double the parameter read
Throws:
java.lang.Exception - if parameter could not be read, could not be converted to a double value or if its under the minimum value (min)