edu.ucsb.nceas.morpho.plugins.datapackagewizard
Interface WizardPageSubPanelAPI

All Known Implementing Classes:
CodeDefnPanel, IntervalRatioPanel, TaxonImportPanel

public interface WizardPageSubPanelAPI

Interface WizardSubPanelAPI


Method Summary
 OrderedMap getPanelData(java.lang.String xPathRoot)
          gets the Map object that contains all the key/value paired
 void onLoadAction()
          The action to be executed when the panel is displayed.
 void setPanelData(java.lang.String xPathRoot, OrderedMap map)
          sets the data in the sub panel using the key/values paired Map object
 boolean validateUserInput()
          checks that the user has filled in required fields - if not, highlights labels to draw attention to them
 

Method Detail

onLoadAction

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


validateUserInput

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

Returns:
boolean true if user data validated OK. false if intervention required

getPanelData

public OrderedMap getPanelData(java.lang.String xPathRoot)
gets the Map object that contains all the key/value paired

Parameters:
xPathRoot - the string xpath to which this dialog's xpaths will be appended when making name/value pairs. For example, in the xpath: /eml:eml/dataset/keywordSet[2]/keywordThesaurus, the root would be /eml:eml/dataset/keywordSet[2] NOTE - MUST NOT END WITH A SLASH, BUT MAY END WITH AN INDEX IN SQUARE BRACKETS []
Returns:
data the OrderedMap object that contains all the key/value paired settings for this particular panel

setPanelData

public void setPanelData(java.lang.String xPathRoot,
                         OrderedMap map)
sets the data in the sub panel using the key/values paired Map object

Parameters:
xPathRoot - the string xpath to which this dialog's xpaths will be appended when making name/value pairs. For example, in the xpath: /eml:eml/dataset/keywordSet[2]/keywordThesaurus, the root would be /eml:eml/dataset/keywordSet[2] NOTE - MUST NOT END WITH A SLASH, BUT MAY END WITH AN INDEX IN SQUARE BRACKETS []
map - - OrderedMap of xPath-value pairs. xPaths in this map are absolute xPath and not the relative xPaths


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