org.opensha.commons.data.siteData.impl
Class CVM4BasinDepth

java.lang.Object
  org.opensha.commons.data.siteData.AbstractSiteData<Double>
      org.opensha.commons.data.siteData.impl.CVM4BasinDepth

All Implemented Interfaces:

Named, SiteData<Double>, XMLSaveable

public class CVM4BasinDepth
extends AbstractSiteData<Double>

Field Summary

protected File	dataFile
static String	DEPTH_1_0_FILE
static String	DEPTH_2_5_FILE
static double	gridSpacing
static double	minLat
static double	minLon
static String	NAME
static String	SERVLET_1_0_URL
static String	SERVLET_2_5_URL
static String	SHORT_NAME
protected boolean	useServlet

Fields inherited from class org.opensha.commons.data.siteData.AbstractSiteData

maxBasinDoubleParam, maxVs30Param, minBasinDoubleParam, minVs30Param, PARAM_MAX_BASIN_DEPTH_DOUBLE_DEFAULT, PARAM_MAX_BASIN_DEPTH_DOUBLE_MAX, PARAM_MAX_BASIN_DEPTH_DOUBLE_MIN, PARAM_MAX_BASIN_DEPTH_DOUBLE_NAME, PARAM_MAX_BASIN_INFO, PARAM_MAX_VS30_DEFAULT, PARAM_MAX_VS30_INFO, PARAM_MAX_VS30_MAX, PARAM_MAX_VS30_MIN, PARAM_MAX_VS30_NAME, PARAM_MIN_BASIN_DEPTH_DOUBLE_DEFAULT, PARAM_MIN_BASIN_DEPTH_DOUBLE_MAX, PARAM_MIN_BASIN_DEPTH_DOUBLE_MIN, PARAM_MIN_BASIN_DEPTH_DOUBLE_NAME, PARAM_MIN_BASIN_INFO, PARAM_MIN_VS30_DEFAULT, PARAM_MIN_VS30_INFO, PARAM_MIN_VS30_MAX, PARAM_MIN_VS30_MIN, PARAM_MIN_VS30_NAME, paramEdit, paramList

Fields inherited from interface org.opensha.commons.data.siteData.SiteData

TYPE_DEPTH_TO_1_0, TYPE_DEPTH_TO_2_5, TYPE_ELEVATION, TYPE_FLAG_INFERRED, TYPE_FLAG_MEASURED, TYPE_TOPOGRAPHIC_SLOPE, TYPE_VS30, TYPE_WILLS_CLASS, XML_METADATA_NAME

Constructor Summary

CVM4BasinDepth(String type)
Constructor for creating a CVM accessor using servlets

CVM4BasinDepth(String type, boolean useServlet)
Constructor for creating a CVM accessor using either servlets or default file names

CVM4BasinDepth(String type, File dataFile)
Constructor for creating a CVM accessor using the given file

CVM4BasinDepth(String type, File dataFile, boolean useServlet)

Method Summary

protected Element	addXMLParameters(Element paramsEl) If your SiteData provider has data that needs to be saved in order to be recreated from XML, then override this method.
static CVM4BasinDepth	fromXMLParams(Element paramsElem)
Region	getApplicableRegion() This gives the applicable region for this data set.
Location	getClosestDataLocation(Location loc) Get the location of the closest data point
String	getDataMeasurementType() Get the measurement type for this data, such as "Measured" or "Inferred"
String	getDataType() Get the data type of this dataset
String	getMetadata() Returns the metadata for this dataset.
String	getName() Get the name of this dataset
double	getResolution() This gives the resolution of the dataset in degrees, or 0 for infinite resolution.
String	getShortName() Get the short name of this dataset
Double	getValue(Location loc) Get the value at the closest location
ArrayList<Double>	getValues(LocationList locs) Returns a list of the values at each location.
boolean	isValueValid(Double val) Returns true if the value is valid, and not NaN, N/A, or equivelant for the data type
static void	main(String[] args)

Methods inherited from class org.opensha.commons.data.siteData.AbstractSiteData

certifyMinMaxBasinDepth, certifyMinMaxVs30, fromXMLMetadata, getAdjustableParameterList, getAnnotatedValue, getAnnotatedValues, getParameterListEditor, hasDataForLocation, initDefaultBasinParams, initDefaultVS30Params, initParamListEditor, toXMLMetadata, toXMLMetadata

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

SHORT_NAME

public static final String SHORT_NAME

See Also:

Constant Field Values

minLat

public static final double minLat

See Also:

Constant Field Values

minLon

public static final double minLon

See Also:

Constant Field Values

gridSpacing

public static final double gridSpacing

See Also:

Constant Field Values

DEPTH_2_5_FILE

public static final String DEPTH_2_5_FILE

See Also:

Constant Field Values

DEPTH_1_0_FILE

public static final String DEPTH_1_0_FILE

See Also:

Constant Field Values

SERVLET_2_5_URL

public static final String SERVLET_2_5_URL

SERVLET_1_0_URL

public static final String SERVLET_1_0_URL

useServlet

protected boolean useServlet

dataFile

protected File dataFile

Constructor Detail

CVM4BasinDepth

public CVM4BasinDepth(String type)
               throws IOException

Constructor for creating a CVM accessor using servlets

Parameters:

type -

Throws:

IOException

CVM4BasinDepth

public CVM4BasinDepth(String type,
                      boolean useServlet)
               throws IOException

Constructor for creating a CVM accessor using either servlets or default file names

Parameters:

type -

Throws:

IOException

CVM4BasinDepth

public CVM4BasinDepth(String type,
                      File dataFile)
               throws IOException

Constructor for creating a CVM accessor using the given file

Parameters:

type -

Throws:

IOException

CVM4BasinDepth

public CVM4BasinDepth(String type,
                      File dataFile,
                      boolean useServlet)
               throws IOException

Throws:

IOException

Method Detail

getName

public String getName()

Description copied from interface: SiteData

Get the name of this dataset

getShortName

public String getShortName()

Description copied from interface: SiteData

Get the short name of this dataset

Returns:

getMetadata

public String getMetadata()

Description copied from interface: SiteData

Returns the metadata for this dataset.

Returns:

getDataMeasurementType

public String getDataMeasurementType()

Description copied from interface: SiteData

Get the measurement type for this data, such as "Measured" or "Inferred"

Returns:

addXMLParameters

protected Element addXMLParameters(Element paramsEl)

Description copied from class: AbstractSiteData

If your SiteData provider has data that needs to be saved in order to be recreated from XML, then override this method.

Overrides:

addXMLParameters in class AbstractSiteData<Double>

Returns:

fromXMLParams

public static CVM4BasinDepth fromXMLParams(Element paramsElem)
                                    throws IOException

Throws:

IOException

main

public static void main(String[] args)
                 throws IOException

Throws:

IOException

getApplicableRegion

public final Region getApplicableRegion()

Description copied from interface: SiteData

This gives the applicable region for this data set.

Returns:

Region

getClosestDataLocation

public final Location getClosestDataLocation(Location loc)

Description copied from interface: SiteData

Get the location of the closest data point

Returns:

getResolution

public final double getResolution()

Description copied from interface: SiteData

This gives the resolution of the dataset in degrees, or 0 for infinite resolution. We could possibly add a 'units' field to allow for resolution in KM

Returns:

getDataType

public final String getDataType()

Description copied from interface: SiteData

Get the data type of this dataset

Returns:

getValue

public Double getValue(Location loc)
                throws IOException

Description copied from interface: SiteData

Get the value at the closest location

Returns:

Throws:

IOException

getValues

public final ArrayList<Double> getValues(LocationList locs)
                                  throws IOException

Description copied from class: AbstractSiteData

Returns a list of the values at each location. This should be overridden if there is a more efficient way of accessing the data, like through a servlet where you can request all of the values at once.

Specified by:

getValues in interface SiteData<Double>

Overrides:

getValues in class AbstractSiteData<Double>

Returns:

Throws:

IOException

isValueValid

public final boolean isValueValid(Double val)

Description copied from interface: SiteData

Returns true if the value is valid, and not NaN, N/A, or equivelant for the data type

Returns: