org.opensha.sha.gui.beans
Interface EqkRupSelectorGuiBeanAPI

All Known Implementing Classes:
EqkRuptureCreationPanel, EqkRuptureFromERFSelectorPanel

public interface EqkRupSelectorGuiBeanAPI

Title: EqkRupSelectorGuiBeanAPI

Description: This class defines methods that any class providing the user the functionality of getting EqkRupture to EqkRupSelectorGuiBean.

Since:
Dec 03,2004
Version:
1.0
Author:
: Ned Field, Nitin Gupta and Vipin Gupta

Method Summary
 EqkRupSelectorGuiBeanAPI getEqkRuptureSelectorPanel()
           
 Location getHypocenterLocation()
           
 Parameter getParameter(String paramName)
           
 ParameterEditor getParameterEditor(String paramName)
           
 ParameterListEditor getParameterListEditor()
           
 String getParameterListMetadataString()
           
 EqkRupture getRupture()
           
 String getTimespanMetadataString()
           
 ParameterList getVisibleParameterList()
           
 

Method Detail

getHypocenterLocation

Location getHypocenterLocation()
Returns:
the Hypocenter Location if selected else return null

getEqkRuptureSelectorPanel

EqkRupSelectorGuiBeanAPI getEqkRuptureSelectorPanel()
Returns:
the panel which allows user to select Eqk rupture from existing ERF models

getParameterListMetadataString

String getParameterListMetadataString()
Returns:
the Metadata String of parameters that constitute the making of this ERF_RupSelectorGUI bean.

getTimespanMetadataString

String getTimespanMetadataString()
Returns:
the timespan Metadata for the selected Rupture. If no timespan exists for the rupture then it returns the Message: "No Timespan exists for the selected Rupture".

getRupture

EqkRupture getRupture()
Returns:
the EqkRupture Object

getParameter

Parameter getParameter(String paramName)
Parameters:
paramName -
Returns:
the parameter from the parameterList with paramName.

getParameterEditor

ParameterEditor getParameterEditor(String paramName)
Parameters:
paramName -
Returns:
the ParameterEditor associated with paramName

getVisibleParameterList

ParameterList getVisibleParameterList()
Returns:
the visible parameters in the list

getParameterListEditor

ParameterListEditor getParameterListEditor()
Returns:
the parameterlist editor