edu.sc.seis.seisFile.fdsnws
Class FDSNEventQueryParams

java.lang.Object
  extended by edu.sc.seis.seisFile.fdsnws.AbstractQueryParams
      extended by edu.sc.seis.seisFile.fdsnws.FDSNEventQueryParams
All Implemented Interfaces:
java.lang.Cloneable

public class FDSNEventQueryParams
extends AbstractQueryParams
implements java.lang.Cloneable

Autogenerated by groovy FDSNQueryParamGenerator.groovy in src/metacode/groovy


Field Summary
static java.lang.String CATALOG
           
static java.lang.String CONTRIBUTOR
           
static java.lang.String ENDTIME
           
static java.lang.String EVENT_SERVICE
           
static java.lang.String EVENTID
           
static java.lang.String INCLUDEALLMAGNITUDES
           
static java.lang.String INCLUDEALLORIGINS
           
static java.lang.String INCLUDEARRIVALS
           
static java.lang.String LATITUDE
           
static java.lang.String LIMIT
           
static java.lang.String LONGITUDE
           
static java.lang.String MAGNITUDETYPE
           
static java.lang.String MAXDEPTH
           
static java.lang.String MAXLATITUDE
           
static java.lang.String MAXLONGITUDE
           
static java.lang.String MAXMAGNITUDE
           
static java.lang.String MAXRADIUS
           
static java.lang.String MINDEPTH
           
static java.lang.String MINLATITUDE
           
static java.lang.String MINLONGITUDE
           
static java.lang.String MINMAGNITUDE
           
static java.lang.String MINRADIUS
           
static java.lang.String OFFSET
           
static java.lang.String ORDER_MAGNITUDE
          magnitude: order by descending magnitude
static java.lang.String ORDER_MAGNITUDE_ASC
          magnitude-asc : order by ascending magnitude
static java.lang.String ORDER_TIME
          time: order by origin descending time
static java.lang.String ORDER_TIME_ASC
          time-asc : order by origin ascending time
static java.lang.String ORDERBY
           
static java.lang.String STARTTIME
           
static java.lang.String UPDATEDAFTER
           
 
Fields inherited from class edu.sc.seis.seisFile.fdsnws.AbstractQueryParams
IRIS_HOST
 
Constructor Summary
FDSNEventQueryParams()
           
FDSNEventQueryParams(java.lang.String host)
           
 
Method Summary
 FDSNEventQueryParams area(float minLat, float maxLat, float minLon, float maxLon)
           
 FDSNEventQueryParams clearCatalog()
           
 FDSNEventQueryParams clearContributor()
           
 FDSNEventQueryParams clearEndTime()
           
 FDSNEventQueryParams clearEventid()
           
 FDSNEventQueryParams clearIncludeAllMagnitudes()
           
 FDSNEventQueryParams clearIncludeAllOrigins()
           
 FDSNEventQueryParams clearIncludeArrivals()
           
 FDSNEventQueryParams clearLatitude()
           
 FDSNEventQueryParams clearLimit()
           
 FDSNEventQueryParams clearLongitude()
           
 FDSNEventQueryParams clearMagnitudeType()
           
 FDSNEventQueryParams clearMaxDepth()
           
 FDSNEventQueryParams clearMaxLatitude()
           
 FDSNEventQueryParams clearMaxLongitude()
           
 FDSNEventQueryParams clearMaxMagnitude()
           
 FDSNEventQueryParams clearMaxRadius()
           
 FDSNEventQueryParams clearMinDepth()
           
 FDSNEventQueryParams clearMinLatitude()
           
 FDSNEventQueryParams clearMinLongitude()
           
 FDSNEventQueryParams clearMinMagnitude()
           
 FDSNEventQueryParams clearMinRadius()
           
 FDSNEventQueryParams clearOffset()
           
 FDSNEventQueryParams clearOrderBy()
           
 FDSNEventQueryParams clearStartTime()
           
 FDSNEventQueryParams clearUpdatedAfter()
           
 FDSNEventQueryParams clone()
           
 FDSNEventQueryParams donut(float lat, float lon, float minRadius, float maxRadius)
           
 java.lang.String getServiceName()
          Service name as defined by the fdsn, ie event, station or dataselect.
 FDSNEventQueryParams ring(float lat, float lon, float maxRadius)
           
 FDSNEventQueryParams setCatalog(java.lang.String value)
          Limit to events from a specified catalog
 FDSNEventQueryParams setContributor(java.lang.String value)
          Limit to events contributed by a specified contributor.
 FDSNEventQueryParams setEndTime(java.util.Date value)
          Limit to events on or before the specified end time.
 FDSNEventQueryParams setEventid(java.lang.String value)
          Select a specific event by ID; event identifiers are data center specific.
 FDSNEventQueryParams setHost(java.lang.String host)
           
 FDSNEventQueryParams setIncludeAllMagnitudes(boolean value)
          Specify if all magnitudes for the event should be included, default is data center dependent but is suggested to be the preferred magnitude only.
 FDSNEventQueryParams setIncludeAllOrigins(boolean value)
          Specify if all origins for the event should be included, default is data center dependent but is suggested to be the preferred origin only.
 FDSNEventQueryParams setIncludeArrivals(boolean value)
          Specify if phase arrivals should be included.
 FDSNEventQueryParams setLatitude(float value)
          Specify the latitude to be used for a radius search.
 FDSNEventQueryParams setLimit(int value)
          Limit the results to the specified number of events.
 FDSNEventQueryParams setLongitude(float value)
          Specify the longitude to the used for a radius search.
 FDSNEventQueryParams setMagnitudeType(java.lang.String value)
          Specify a magnitude type to use for testing the minimum and maximum limits.
 FDSNEventQueryParams setMaxDepth(float value)
          Limit to events with depth less than the specified maximum.
 FDSNEventQueryParams setMaxLatitude(float value)
          Limit to events with a latitude smaller than the specified maximum.
 FDSNEventQueryParams setMaxLongitude(float value)
          Limit to events with a longitude smaller than the specified maximum.
 FDSNEventQueryParams setMaxMagnitude(float value)
          Limit to events with a magnitude smaller than the specified maximum.
 FDSNEventQueryParams setMaxRadius(float value)
          Limit to events within the specified maximum number of degrees from the geographic point defined by the latitude and longitude parameters.
 FDSNEventQueryParams setMinDepth(float value)
          Limit to events with depth more than the specified minimum.
 FDSNEventQueryParams setMinLatitude(float value)
          Limit to events with a latitude larger than the specified minimum.
 FDSNEventQueryParams setMinLongitude(float value)
          Limit to events with a longitude larger than the specified minimum.
 FDSNEventQueryParams setMinMagnitude(float value)
          Limit to events with a magnitude larger than the specified minimum.
 FDSNEventQueryParams setMinRadius(float value)
          Limit to events within the specified minimum number of degrees from the geographic point defined by the latitude and longitude parameters.
 FDSNEventQueryParams setOffset(int value)
          Return results starting at the event count specified, starting at 1.
 FDSNEventQueryParams setOrderBy(java.lang.String value)
          Order the result by time or magnitude with the following possibilities: time: order by origin descending time time-asc : order by origin ascending time magnitude: order by descending magnitude magnitude-asc : order by ascending magnitude
 FDSNEventQueryParams setStartTime(java.util.Date value)
          Limit to events on or after the specified start time.
 FDSNEventQueryParams setUpdatedAfter(java.util.Date value)
          Limit to events updated after the specified time.
 
Methods inherited from class edu.sc.seis.seisFile.fdsnws.AbstractQueryParams
appendToParam, clear, clearParam, createDateFormat, formURI, getHost, getParam, getParams, setParam, setParam, setParam, setParam, setParam, setPort, setScheme
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

STARTTIME

public static final java.lang.String STARTTIME
See Also:
Constant Field Values

ENDTIME

public static final java.lang.String ENDTIME
See Also:
Constant Field Values

MINLATITUDE

public static final java.lang.String MINLATITUDE
See Also:
Constant Field Values

MAXLATITUDE

public static final java.lang.String MAXLATITUDE
See Also:
Constant Field Values

MINLONGITUDE

public static final java.lang.String MINLONGITUDE
See Also:
Constant Field Values

MAXLONGITUDE

public static final java.lang.String MAXLONGITUDE
See Also:
Constant Field Values

LATITUDE

public static final java.lang.String LATITUDE
See Also:
Constant Field Values

LONGITUDE

public static final java.lang.String LONGITUDE
See Also:
Constant Field Values

MINRADIUS

public static final java.lang.String MINRADIUS
See Also:
Constant Field Values

MAXRADIUS

public static final java.lang.String MAXRADIUS
See Also:
Constant Field Values

MINDEPTH

public static final java.lang.String MINDEPTH
See Also:
Constant Field Values

MAXDEPTH

public static final java.lang.String MAXDEPTH
See Also:
Constant Field Values

MINMAGNITUDE

public static final java.lang.String MINMAGNITUDE
See Also:
Constant Field Values

MAXMAGNITUDE

public static final java.lang.String MAXMAGNITUDE
See Also:
Constant Field Values

MAGNITUDETYPE

public static final java.lang.String MAGNITUDETYPE
See Also:
Constant Field Values

INCLUDEALLORIGINS

public static final java.lang.String INCLUDEALLORIGINS
See Also:
Constant Field Values

INCLUDEALLMAGNITUDES

public static final java.lang.String INCLUDEALLMAGNITUDES
See Also:
Constant Field Values

INCLUDEARRIVALS

public static final java.lang.String INCLUDEARRIVALS
See Also:
Constant Field Values

EVENTID

public static final java.lang.String EVENTID
See Also:
Constant Field Values

LIMIT

public static final java.lang.String LIMIT
See Also:
Constant Field Values

OFFSET

public static final java.lang.String OFFSET
See Also:
Constant Field Values

ORDERBY

public static final java.lang.String ORDERBY
See Also:
Constant Field Values

CATALOG

public static final java.lang.String CATALOG
See Also:
Constant Field Values

CONTRIBUTOR

public static final java.lang.String CONTRIBUTOR
See Also:
Constant Field Values

UPDATEDAFTER

public static final java.lang.String UPDATEDAFTER
See Also:
Constant Field Values

ORDER_TIME

public static final java.lang.String ORDER_TIME
time: order by origin descending time

See Also:
Constant Field Values

ORDER_TIME_ASC

public static final java.lang.String ORDER_TIME_ASC
time-asc : order by origin ascending time

See Also:
Constant Field Values

ORDER_MAGNITUDE

public static final java.lang.String ORDER_MAGNITUDE
magnitude: order by descending magnitude

See Also:
Constant Field Values

ORDER_MAGNITUDE_ASC

public static final java.lang.String ORDER_MAGNITUDE_ASC
magnitude-asc : order by ascending magnitude

See Also:
Constant Field Values

EVENT_SERVICE

public static final java.lang.String EVENT_SERVICE
See Also:
Constant Field Values
Constructor Detail

FDSNEventQueryParams

public FDSNEventQueryParams()

FDSNEventQueryParams

public FDSNEventQueryParams(java.lang.String host)
Method Detail

clone

public FDSNEventQueryParams clone()
Overrides:
clone in class java.lang.Object

setHost

public FDSNEventQueryParams setHost(java.lang.String host)

setStartTime

public FDSNEventQueryParams setStartTime(java.util.Date value)
Limit to events on or after the specified start time.


clearStartTime

public FDSNEventQueryParams clearStartTime()

setEndTime

public FDSNEventQueryParams setEndTime(java.util.Date value)
Limit to events on or before the specified end time.


clearEndTime

public FDSNEventQueryParams clearEndTime()

setMinLatitude

public FDSNEventQueryParams setMinLatitude(float value)
Limit to events with a latitude larger than the specified minimum.


clearMinLatitude

public FDSNEventQueryParams clearMinLatitude()

setMaxLatitude

public FDSNEventQueryParams setMaxLatitude(float value)
Limit to events with a latitude smaller than the specified maximum.


clearMaxLatitude

public FDSNEventQueryParams clearMaxLatitude()

setMinLongitude

public FDSNEventQueryParams setMinLongitude(float value)
Limit to events with a longitude larger than the specified minimum.


clearMinLongitude

public FDSNEventQueryParams clearMinLongitude()

setMaxLongitude

public FDSNEventQueryParams setMaxLongitude(float value)
Limit to events with a longitude smaller than the specified maximum.


clearMaxLongitude

public FDSNEventQueryParams clearMaxLongitude()

setLatitude

public FDSNEventQueryParams setLatitude(float value)
Specify the latitude to be used for a radius search.


clearLatitude

public FDSNEventQueryParams clearLatitude()

setLongitude

public FDSNEventQueryParams setLongitude(float value)
Specify the longitude to the used for a radius search.


clearLongitude

public FDSNEventQueryParams clearLongitude()

setMinRadius

public FDSNEventQueryParams setMinRadius(float value)
Limit to events within the specified minimum number of degrees from the geographic point defined by the latitude and longitude parameters.


clearMinRadius

public FDSNEventQueryParams clearMinRadius()

setMaxRadius

public FDSNEventQueryParams setMaxRadius(float value)
Limit to events within the specified maximum number of degrees from the geographic point defined by the latitude and longitude parameters.


clearMaxRadius

public FDSNEventQueryParams clearMaxRadius()

setMinDepth

public FDSNEventQueryParams setMinDepth(float value)
Limit to events with depth more than the specified minimum.


clearMinDepth

public FDSNEventQueryParams clearMinDepth()

setMaxDepth

public FDSNEventQueryParams setMaxDepth(float value)
Limit to events with depth less than the specified maximum.


clearMaxDepth

public FDSNEventQueryParams clearMaxDepth()

setMinMagnitude

public FDSNEventQueryParams setMinMagnitude(float value)
Limit to events with a magnitude larger than the specified minimum.


clearMinMagnitude

public FDSNEventQueryParams clearMinMagnitude()

setMaxMagnitude

public FDSNEventQueryParams setMaxMagnitude(float value)
Limit to events with a magnitude smaller than the specified maximum.


clearMaxMagnitude

public FDSNEventQueryParams clearMaxMagnitude()

setMagnitudeType

public FDSNEventQueryParams setMagnitudeType(java.lang.String value)
Specify a magnitude type to use for testing the minimum and maximum limits.


clearMagnitudeType

public FDSNEventQueryParams clearMagnitudeType()

setIncludeAllOrigins

public FDSNEventQueryParams setIncludeAllOrigins(boolean value)
Specify if all origins for the event should be included, default is data center dependent but is suggested to be the preferred origin only.


clearIncludeAllOrigins

public FDSNEventQueryParams clearIncludeAllOrigins()

setIncludeAllMagnitudes

public FDSNEventQueryParams setIncludeAllMagnitudes(boolean value)
Specify if all magnitudes for the event should be included, default is data center dependent but is suggested to be the preferred magnitude only.


clearIncludeAllMagnitudes

public FDSNEventQueryParams clearIncludeAllMagnitudes()

setIncludeArrivals

public FDSNEventQueryParams setIncludeArrivals(boolean value)
Specify if phase arrivals should be included.


clearIncludeArrivals

public FDSNEventQueryParams clearIncludeArrivals()

setEventid

public FDSNEventQueryParams setEventid(java.lang.String value)
Select a specific event by ID; event identifiers are data center specific.


clearEventid

public FDSNEventQueryParams clearEventid()

setLimit

public FDSNEventQueryParams setLimit(int value)
Limit the results to the specified number of events.


clearLimit

public FDSNEventQueryParams clearLimit()

setOffset

public FDSNEventQueryParams setOffset(int value)
Return results starting at the event count specified, starting at 1.


clearOffset

public FDSNEventQueryParams clearOffset()

setOrderBy

public FDSNEventQueryParams setOrderBy(java.lang.String value)
Order the result by time or magnitude with the following possibilities: time: order by origin descending time time-asc : order by origin ascending time magnitude: order by descending magnitude magnitude-asc : order by ascending magnitude


clearOrderBy

public FDSNEventQueryParams clearOrderBy()

setCatalog

public FDSNEventQueryParams setCatalog(java.lang.String value)
Limit to events from a specified catalog


clearCatalog

public FDSNEventQueryParams clearCatalog()

setContributor

public FDSNEventQueryParams setContributor(java.lang.String value)
Limit to events contributed by a specified contributor.


clearContributor

public FDSNEventQueryParams clearContributor()

setUpdatedAfter

public FDSNEventQueryParams setUpdatedAfter(java.util.Date value)
Limit to events updated after the specified time.


clearUpdatedAfter

public FDSNEventQueryParams clearUpdatedAfter()

area

public FDSNEventQueryParams area(float minLat,
                                 float maxLat,
                                 float minLon,
                                 float maxLon)

ring

public FDSNEventQueryParams ring(float lat,
                                 float lon,
                                 float maxRadius)

donut

public FDSNEventQueryParams donut(float lat,
                                  float lon,
                                  float minRadius,
                                  float maxRadius)

getServiceName

public java.lang.String getServiceName()
Description copied from class: AbstractQueryParams
Service name as defined by the fdsn, ie event, station or dataselect.

Specified by:
getServiceName in class AbstractQueryParams