org.peace_tools.core.job
Class JobInfoWizardPage

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  org.peace_tools.generic.GenericWizardPage
                      org.peace_tools.core.job.JobInfoWizardPage

All Implemented Interfaces:

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

public class JobInfoWizardPage
extends GenericWizardPage

This class serves as the second interactive page in a JobWizard. This page permits the user to provide the basic information about the data set to be used, provide a brief description of the job, and decide if the job must perform clustering. When the "Next >" button is clicked this wizard creates a blank clustering data (at the job wizard level) for use by other pages if the job must perform clustering.

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

private javax.swing.JComboBox	dataSetList A combo-box to select the data set to be used for this job.
private javax.swing.JTextArea	description Field to read and edit a brief description about the job.
private static java.lang.String	INFO_MSG A generic informational message that is displayed at the top of this wizard page to provide some additional information to the user.
private static java.lang.String	INVALID_ENTRY A simple message to be displayed to the user when the user selects a data set that currently does not have a valid FASTA file associated with it.
private static java.lang.String	MASK_MSG A generic informational message that is displayed at the top of this wizard page to provide some additional information to the user.
private javax.swing.JCheckBox	maskBases Check box to permit user to mask out or process nucleotides in low-case characters.
private static long	serialVersionUID A serialization UID to keep the compiler happy.
private JobWizard	wizard A reference to the wizard dialog that logically owns this page.

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

JobInfoWizardPage(JobWizard wizard)
The constructor.

Method Summary

protected DataSet	getDataSet() Obtain the data set that has been selected by the user.
protected java.lang.String	getDescription() Obtain the description for the job.
boolean	isMaksBasesSet() Determine if base masking is enabled or disabled.
void	pageChanged(WizardDialog dialog, int currPage, int prevPage) This method is called just before this page is to be displayed.
boolean	pageChanging(WizardDialog dialog, int currPage, int nextPage) Method to veto a page change (if needed).

Methods inherited from class org.peace_tools.generic.GenericWizardPage

getPage, getSubTitle, getTitle, setTitle

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, 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, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

wizard

private final JobWizard wizard

A reference to the wizard dialog that logically owns this page. This reference is used to enable and disable buttons on this wizard appropriately.

dataSetList

private javax.swing.JComboBox dataSetList

A combo-box to select the data set to be used for this job. This field is created and populated in the constructor.

description

private javax.swing.JTextArea description

Field to read and edit a brief description about the job. This information can be anything the user desires and is meaningful only to the user.

maskBases

private javax.swing.JCheckBox maskBases

Check box to permit user to mask out or process nucleotides in low-case characters. If this check box is un-checked then "--no-mask-bases" is added to PEACE command line.

INFO_MSG

private static final java.lang.String INFO_MSG

A generic informational message that is displayed at the top of this wizard page to provide some additional information to the user.

See Also:

Constant Field Values

MASK_MSG

private static final java.lang.String MASK_MSG

A generic informational message that is displayed at the top of this wizard page to provide some additional information to the user.

See Also:

Constant Field Values

INVALID_ENTRY

private static final java.lang.String INVALID_ENTRY

A simple message to be displayed to the user when the user selects a data set that currently does not have a valid FASTA file associated with it.

See Also:

Constant Field Values

serialVersionUID

private static final long serialVersionUID

A serialization UID to keep the compiler happy.

See Also:

Constant Field Values

Constructor Detail

JobInfoWizardPage

public JobInfoWizardPage(JobWizard wizard)

The constructor. The constructor sets up the various components on this wizard page. The components include: combo box to select data set, a text area for job description, and a check box for clustering.

Parameters:

wizard - The wizard that logically owns this page.

Method Detail

isMaksBasesSet

public boolean isMaksBasesSet()

Determine if base masking is enabled or disabled. This method can be used to determine if base-masking (that is mask out atcg) is enabled or disabled.

Returns:

This method returns true if base masking is enabled. Otherwise it returns false.

pageChanged

public void pageChanged(WizardDialog dialog,
                        int currPage,
                        int prevPage)

This method is called just before this page is to be displayed. This page essentially updates the data being displayed in the GUI fields from the data stored in the in-memory Server object.

Specified by:

pageChanged in interface WizardPage

Overrides:

pageChanged in class GenericWizardPage

Parameters:

dialog - The wizard dialog that is invoking this method.

currPage - The logical (zero-based) index of the current page in the sequence of pages in the wizard that is going to be displayed.

prevPage - The logical (zero-based) index of the previous page that was displayed. For the first page this value is -1.

pageChanging

public boolean pageChanging(WizardDialog dialog,
                            int currPage,
                            int nextPage)

Description copied from class: GenericWizardPage

Method to veto a page change (if needed). This method is invoked by the core WizardDialog panel just before the user changes from this page. This method does not veto such a change and always returns true.

Specified by:

pageChanging in interface WizardPage

Overrides:

pageChanging in class GenericWizardPage

Parameters:

dialog - The wizard dialog that is invoking this method.

currPage - The logical (zero-based) index of the current page in the sequence of pages in the wizard.

nextPage - The logical (zero-based) index of the next page that is going to be displayed.

Returns:

This method always returns true to indicate that the user can navigate off from this page.

getDataSet

protected DataSet getDataSet()

Obtain the data set that has been selected by the user. This method is used by the JobWizard to add MST and Cluster data entries to the data set, if the wizard operations are successfully completed by the user.

Returns:

The data set corresponding to the selection made by the user.

getDescription

protected java.lang.String getDescription()

Obtain the description for the job.

Returns:

The description entered by the user for this job.