edu.ucsb.nceas.morpho.plugins.datapackagewizard.pages
Class CodeDefnPanel

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjavax.swing.JComponent
              extended byjavax.swing.JPanel
                  extended byedu.ucsb.nceas.morpho.plugins.datapackagewizard.pages.CodeDefnPanel
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, WizardPageSubPanelAPI

public class CodeDefnPanel
extends javax.swing.JPanel
implements WizardPageSubPanelAPI

See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class javax.swing.JPanel
javax.swing.JPanel.AccessibleJPanel
 
Nested classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Nested classes inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Nested classes inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
static short CANCEL_OPTION
           
 short USER_RESPONSE
           
 
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
CodeDefnPanel()
           
CodeDefnPanel(boolean onlyDefinitionsPanel)
           
CodeDefnPanel(boolean onlyDefinitionsPanel, boolean createDataTable)
           
 
Method Summary
 java.util.List getColumnData()
          Function to retrieve the imported data from the columns selected by the user.
static java.util.List getColumnValues(java.io.File file, java.util.Vector colIndices, int numHeaderLines, java.lang.String delimiter, boolean ignoreConsequtiveDelimiters, int maxLinesNeeded)
           
static java.io.File getEntityFile(Morpho morpho, AbstractDataPackage adp, int entityIndex)
           
static java.util.List getOneColumnValue(java.io.File file, int colIndex, int numHeaderLines, java.lang.String delimiter, int maxLinesNeeded)
           
 OrderedMap getPanelData()
          gets the Map object that contains all the key/value paired settings for this particular wizard panel
 OrderedMap getPanelData(java.lang.String xPath)
          gets the Map object that contains all the key/value paired settings for this particular wizard panel, given a prefix xPath
 int getSelectedEntityIndex()
          Function to retrieve the selected entity Index
 java.lang.String getTableName()
          Function to retrieve the selected table name from where the enumerated codes are imported.
 void onLoadAction()
          The action to be executed when the page is displayed.
 void setPanelData(OrderedMap data)
          sets the fields in the wizard panel using the Map object that contains all the key/value paired
 void setPanelData(java.lang.String xPath, OrderedMap data)
          sets the fields in the wizard panel using the Map object that contains all the key/value paired and the relative xPath to be used
 void setTable(java.lang.String tableName, java.util.List columns, java.util.Vector data)
           
 boolean validateUserInput()
          checks that the user has filled in required fields - if not, highlights labels to draw attention to them
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, 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, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, 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, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, 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, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, 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
 

Field Detail

USER_RESPONSE

public short USER_RESPONSE

CANCEL_OPTION

public static final short CANCEL_OPTION
See Also:
Constant Field Values
Constructor Detail

CodeDefnPanel

public CodeDefnPanel()

CodeDefnPanel

public CodeDefnPanel(boolean onlyDefinitionsPanel)

CodeDefnPanel

public CodeDefnPanel(boolean onlyDefinitionsPanel,
                     boolean createDataTable)
Method Detail

getTableName

public java.lang.String getTableName()
Function to retrieve the selected table name from where the enumerated codes are imported. If the user chooses the option of importing the data table later, this function returns null.

Returns:
String

setTable

public void setTable(java.lang.String tableName,
                     java.util.List columns,
                     java.util.Vector data)

getSelectedEntityIndex

public int getSelectedEntityIndex()
Function to retrieve the selected entity Index

Returns:
int the entity index of the selected data table

onLoadAction

public void onLoadAction()
The action to be executed when the page is displayed. May be empty

Specified by:
onLoadAction in interface WizardPageSubPanelAPI

validateUserInput

public boolean validateUserInput()
checks that the user has filled in required fields - if not, highlights labels to draw attention to them

Specified by:
validateUserInput in interface WizardPageSubPanelAPI
Returns:
boolean true if user data validated OK. false if intervention required

getPanelData

public OrderedMap getPanelData()
gets the Map object that contains all the key/value paired settings for this particular wizard panel

Returns:
data the Map object that contains all the key/value paired settings for this particular wizard page

getPanelData

public OrderedMap getPanelData(java.lang.String xPath)
gets the Map object that contains all the key/value paired settings for this particular wizard panel, given a prefix xPath

Specified by:
getPanelData in interface WizardPageSubPanelAPI
Parameters:
xPath - the xPath that needs to be prepended to all keys that are inserted in the map
Returns:
data the Map object that contains all the key/value paired settings for this particular wizard page

setPanelData

public void setPanelData(OrderedMap data)
sets the fields in the wizard panel using the Map object that contains all the key/value paired

Parameters:
data - the Map object that contains all the key/value paired settings for this particular wizard page

setPanelData

public void setPanelData(java.lang.String xPath,
                         OrderedMap data)
sets the fields in the wizard panel using the Map object that contains all the key/value paired and the relative xPath to be used

Specified by:
setPanelData in interface WizardPageSubPanelAPI
Parameters:
xPath - the relative xPath of the keys
data - the Map object that contains all the key/value paired settings for this particular wizard page

getColumnData

public java.util.List getColumnData()
Function to retrieve the imported data from the columns selected by the user. The selected table is read and the necessary two columns are extracted and returned as a List of rows. Each row is a list of two elements

Returns:
list the list of rows containing only the selected two columns

getEntityFile

public static java.io.File getEntityFile(Morpho morpho,
                                         AbstractDataPackage adp,
                                         int entityIndex)

getColumnValues

public static java.util.List getColumnValues(java.io.File file,
                                             java.util.Vector colIndices,
                                             int numHeaderLines,
                                             java.lang.String delimiter,
                                             boolean ignoreConsequtiveDelimiters,
                                             int maxLinesNeeded)

getOneColumnValue

public static java.util.List getOneColumnValue(java.io.File file,
                                               int colIndex,
                                               int numHeaderLines,
                                               java.lang.String delimiter,
                                               int maxLinesNeeded)


Copyright © 2000 National Center for Ecological Analysis and Synthesis. All Rights Reserved.