org.opensha.nshmp.sha.data
Interface HazardDataMinerAPI

All Known Implementing Classes:
HazardDataMiner, HazardDataMinerServletMode

public interface HazardDataMinerAPI

Title: HazardDataMinerAPI.java

Description: This interface is implemented by the classes which connect to server to get calculation results from the server. One of the class connects to the RMI while the other connects with the servlet.

Copyright: Copyright (c) 2002

Company:

Version:
1.0
Author:
not attributable

Method Summary
 XY_DataSetList getApprox_UHSpectrum(ArbitrarilyDiscretizedFunc func)
           
 ArbitrarilyDiscretizedFunc getBasicHazardcurve(String geographicRegion, String dataEdition, double lat, double lon, String hazCurveType)
          Gets the Basic Hazard Curve using the Lat and Lon
 ArbitrarilyDiscretizedFunc getBasicHazardcurve(String geographicRegion, String dataEdition, String zipCode, String hazCurveType)
          Gets the Basic Hazard Curve using the Lat and Lon
 double getExceedProb(double fex, double expTime)
           
 XY_DataSetList getMapSpectrum(ArbitrarilyDiscretizedFunc func)
           
 double getReturnPeriod(double exceedProb, double expTime)
           
 XY_DataSetList getSA(String geographicRegion, String dataEdition, double lat, double lon, String selectedSpectraType)
           
 XY_DataSetList getSA(String geographicRegion, String dataEdition, String zipCode, String spectraType)
          Gets the Ss and S1 when location is provided using the zipCode
 XY_DataSetList getSD_UHSpectrum(ArbitrarilyDiscretizedFunc func, float fa, float fv, String siteClass)
           
 XY_DataSetList getSDSpectrum(ArbitrarilyDiscretizedFunc func, float fa, float fv, String siteClass, String edition)
           
 ArbitrarilyDiscretizedFunc getSDSsS1(ArbitrarilyDiscretizedFunc func, float fa, float fv, String siteClass)
           
 ArbitrarilyDiscretizedFunc getSDSsS1(String edition, String region, String zipCode, String siteClass)
           
 XY_DataSetList getSM_UHSpectrum(ArbitrarilyDiscretizedFunc func, float fa, float fv, String siteClass)
           
 XY_DataSetList getSMSpectrum(ArbitrarilyDiscretizedFunc func, float fa, float fv, String siteClass, String edition)
           
 ArbitrarilyDiscretizedFunc getSMSsS1(ArbitrarilyDiscretizedFunc func, float fa, float fv, String siteClass)
           
 ArbitrarilyDiscretizedFunc getSMSsS1(String edition, String region, String zipCode, String siteClass)
           
 ArbitrarilyDiscretizedFunc getSsS1(String geographicRegion)
          Gets the Ss and S1 when geographic region provided is a territory.
 ArbitrarilyDiscretizedFunc getSsS1(String geographicRegion, String dataEdition, double lat, double lon)
          Gets the Ss and S1 when location is provided using the Lat and Lon
 ArbitrarilyDiscretizedFunc getSsS1(String geographicRegion, String dataEdition, double lat, double lon, String selectedSpectraType)
           
 ArbitrarilyDiscretizedFunc getSsS1(String geographicRegion, String dataEdition, String zipCode)
          Gets the Ss and S1 when location is provided using the zipCode
 ArbitrarilyDiscretizedFunc getSsS1(String geographicRegion, String dataEdition, String zipCode, String spectraType)
          Gets the Ss and S1 when location is provided using the zipCode
 

Method Detail

getExceedProb

double getExceedProb(double fex,
                     double expTime)
                     throws RemoteException
Parameters:
hazardCurveFunction - ArbitrarilyDiscretizedFunc
fex - double Frequency of exceedance = 1/ReturnPd
expTime - double
Returns:
double
Throws:
RemoteException

getReturnPeriod

double getReturnPeriod(double exceedProb,
                       double expTime)
                       throws RemoteException
Parameters:
exceedProb - double
expTime - double
Returns:
double
Throws:
RemoteException

getBasicHazardcurve

ArbitrarilyDiscretizedFunc getBasicHazardcurve(String geographicRegion,
                                               String dataEdition,
                                               double lat,
                                               double lon,
                                               String hazCurveType)
                                               throws RemoteException
Gets the Basic Hazard Curve using the Lat and Lon

Parameters:
geographicRegion - String
dataEdition - String
lat - double
lon - double
Returns:
ArbitrarilyDiscretizedFunc
Throws:
RemoteException

getBasicHazardcurve

ArbitrarilyDiscretizedFunc getBasicHazardcurve(String geographicRegion,
                                               String dataEdition,
                                               String zipCode,
                                               String hazCurveType)
                                               throws ZipCodeErrorException,
                                                      RemoteException
Gets the Basic Hazard Curve using the Lat and Lon

Parameters:
geographicRegion - String
dataEdition - String
zipCode - String
Returns:
DiscretizedFuncList
Throws:
ZipCodeErrorException
RemoteException

getSsS1

ArbitrarilyDiscretizedFunc getSsS1(String geographicRegion,
                                   String dataEdition,
                                   double lat,
                                   double lon)
                                   throws RemoteException
Gets the Ss and S1 when location is provided using the Lat and Lon

Parameters:
geographicRegion - String
dataEdition - String
lat - double
lon - double
Returns:
ArbitrarilyDiscretizedFunc
Throws:
RemoteException

getSsS1

ArbitrarilyDiscretizedFunc getSsS1(String geographicRegion,
                                   String dataEdition,
                                   double lat,
                                   double lon,
                                   String selectedSpectraType)
                                   throws RemoteException
Parameters:
geographicRegion - String
dataEdition - String
lat - double
lon - double
selectedSpectraType - String
Returns:
ArbitrarilyDiscretizedFunc
Throws:
RemoteException

getSA

XY_DataSetList getSA(String geographicRegion,
                     String dataEdition,
                     double lat,
                     double lon,
                     String selectedSpectraType)
                     throws RemoteException
Parameters:
geographicRegion - String
dataEdition - String
lat - double
lon - double
selectedSpectraType - String
Returns:
DiscretizedFuncList
Throws:
RemoteException

getSA

XY_DataSetList getSA(String geographicRegion,
                     String dataEdition,
                     String zipCode,
                     String spectraType)
                     throws ZipCodeErrorException,
                            RemoteException
Gets the Ss and S1 when location is provided using the zipCode

Parameters:
geographicRegion - String
dataEdition - String
zipCode - String
Returns:
DiscretizedFuncList
Throws:
ZipCodeErrorException
RemoteException

getSsS1

ArbitrarilyDiscretizedFunc getSsS1(String geographicRegion,
                                   String dataEdition,
                                   String zipCode,
                                   String spectraType)
                                   throws ZipCodeErrorException,
                                          RemoteException
Gets the Ss and S1 when location is provided using the zipCode

Parameters:
geographicRegion - String
dataEdition - String
zipCode - String
Returns:
DiscretizedFuncList
Throws:
ZipCodeErrorException
RemoteException

getSsS1

ArbitrarilyDiscretizedFunc getSsS1(String geographicRegion,
                                   String dataEdition,
                                   String zipCode)
                                   throws ZipCodeErrorException,
                                          RemoteException
Gets the Ss and S1 when location is provided using the zipCode

Parameters:
geographicRegion - String
dataEdition - String
zipCode - String
Returns:
DiscretizedFuncList
Throws:
ZipCodeErrorException
RemoteException

getSsS1

ArbitrarilyDiscretizedFunc getSsS1(String geographicRegion)
                                   throws RemoteException
Gets the Ss and S1 when geographic region provided is a territory.

Parameters:
geographicRegion - String
Returns:
ArbitrarilyDiscretizedFunc
Throws:
RemoteException

getSDSsS1

ArbitrarilyDiscretizedFunc getSDSsS1(ArbitrarilyDiscretizedFunc func,
                                     float fa,
                                     float fv,
                                     String siteClass)
                                     throws RemoteException
Parameters:
func - ArbitrarilyDiscretizedFunc
fa - double
fv - double
Returns:
ArbitrarilyDiscretizedFunc
Throws:
RemoteException

getSDSsS1

ArbitrarilyDiscretizedFunc getSDSsS1(String edition,
                                     String region,
                                     String zipCode,
                                     String siteClass)
                                     throws RemoteException
Throws:
RemoteException

getSMSsS1

ArbitrarilyDiscretizedFunc getSMSsS1(ArbitrarilyDiscretizedFunc func,
                                     float fa,
                                     float fv,
                                     String siteClass)
                                     throws RemoteException
Parameters:
func - ArbitrarilyDiscretizedFunc
fa - double
fv - double
Returns:
ArbitrarilyDiscretizedFunc
Throws:
RemoteException

getSMSsS1

ArbitrarilyDiscretizedFunc getSMSsS1(String edition,
                                     String region,
                                     String zipCode,
                                     String siteClass)
                                     throws RemoteException
Throws:
RemoteException

getSMSpectrum

XY_DataSetList getSMSpectrum(ArbitrarilyDiscretizedFunc func,
                             float fa,
                             float fv,
                             String siteClass,
                             String edition)
                             throws RemoteException
Parameters:
func - ArbitrarilyDiscretizedFunc
fa - double
fv - double
Returns:
DiscretizedFuncList
Throws:
RemoteException

getSDSpectrum

XY_DataSetList getSDSpectrum(ArbitrarilyDiscretizedFunc func,
                             float fa,
                             float fv,
                             String siteClass,
                             String edition)
                             throws RemoteException
Parameters:
func - ArbitrarilyDiscretizedFunc
fa - double
fv - double
Returns:
DiscretizedFuncList
Throws:
RemoteException

getMapSpectrum

XY_DataSetList getMapSpectrum(ArbitrarilyDiscretizedFunc func)
                              throws RemoteException
Parameters:
func - ArbitrarilyDiscretizedFunc
Returns:
DiscretizedFuncList
Throws:
RemoteException

getSM_UHSpectrum

XY_DataSetList getSM_UHSpectrum(ArbitrarilyDiscretizedFunc func,
                                float fa,
                                float fv,
                                String siteClass)
                                throws RemoteException
Parameters:
func - ArbitrarilyDiscretizedFunc
fa - double
fv - double
Returns:
DiscretizedFuncList
Throws:
RemoteException

getSD_UHSpectrum

XY_DataSetList getSD_UHSpectrum(ArbitrarilyDiscretizedFunc func,
                                float fa,
                                float fv,
                                String siteClass)
                                throws RemoteException
Parameters:
func - ArbitrarilyDiscretizedFunc
fa - double
fv - double
Returns:
DiscretizedFuncList
Throws:
RemoteException

getApprox_UHSpectrum

XY_DataSetList getApprox_UHSpectrum(ArbitrarilyDiscretizedFunc func)
                                    throws RemoteException
Parameters:
func - ArbitrarilyDiscretizedFunc
Returns:
DiscretizedFuncList
Throws:
RemoteException