com.sri.emo.wizard.creation
Class RelationWizardPage

java.lang.Object
  com.sri.emo.wizard.defaults.EmoWizardPage
      com.sri.emo.wizard.creation.CreationPartsPage
          com.sri.emo.wizard.creation.RelationWizardPage

All Implemented Interfaces:

WizardPage, Serializable

public class RelationWizardPage
extends CreationPartsPage

Wizard page that handles the selection of various relations available.

Version:

1.0

Author:

Michael Rimov

See Also:

Serialized Form

Field Summary

static String

PARAM_PREFIX The prefix of all ids that this class culls from the parameters.

Constructor Summary

RelationWizardPage(Integer newId, PageMetadata pageMetadata)
Standard constructor for a wizard page.

Method Summary

int	getNumAvailableRelations()
ValidValueWithComment[]	getRelatedNodesMenu() Retrieve the menu.
protected CreationPageMetadata	getRelationPageMetadata() Type safe page getter.
Map	getSelectedRelations()
void	setData(Serializable newData) Intercepts the setData call (which is a Map), grabs the parameters we're interested in, and calls the super.setData() with a Set of all relations that are listed as 'checked'.
void	setNumAvailableRelations(int numAvailableRelations)

Methods inherited from class com.sri.emo.wizard.defaults.EmoWizardPage

addError, equals, getData, getId, getMenu, getMetadata, getPageErrors, getPrintableData, hashCode, removeErrors, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

PARAM_PREFIX

public static final String PARAM_PREFIX

The prefix of all ids that this class culls from the parameters. They are of the form of WIZ_DATA_ID + "_" + SomeNumber

See Also:

Constant Field Values

Constructor Detail

RelationWizardPage

public RelationWizardPage(Integer newId,
                          PageMetadata pageMetadata)

Standard constructor for a wizard page.

Parameters:

newId - Integer

pageMetadata - PageMetadata

Method Detail

setData

public void setData(Serializable newData)
             throws WizardException

Intercepts the setData call (which is a Map), grabs the parameters we're interested in, and calls the super.setData() with a Set of all relations that are listed as 'checked'.

Specified by:

setData in interface WizardPage

Overrides:

setData in class EmoWizardPage

Parameters:

newData - the new data for the page. (Should be a map)

Throws:

WizardException - upon error.

getSelectedRelations

public Map getSelectedRelations()
                         throws WizardException

Throws:

WizardException

getRelatedNodesMenu

public ValidValueWithComment[] getRelatedNodesMenu()
                                            throws DBException

Retrieve the menu.

Returns:

ValidValueWithComment[]

Throws:

DBException

getRelationPageMetadata

protected CreationPageMetadata getRelationPageMetadata()

Type safe page getter.

Returns:

RelationPageMetadata

setNumAvailableRelations

public void setNumAvailableRelations(int numAvailableRelations)

getNumAvailableRelations

public int getNumAvailableRelations()