Package edu.sc.seis.seisFile.fdsnws
Class FDSNEventQueryParams
java.lang.Object
edu.sc.seis.seisFile.fdsnws.AbstractQueryParams
edu.sc.seis.seisFile.fdsnws.FDSNEventQueryParams
- All Implemented Interfaces:
Cloneable
Autogenerated by groovy FDSNQueryParamGenerator.groovy in src/metacode/groovy
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
magnitude: order by descending magnitudestatic final String
magnitude-asc : order by ascending magnitudestatic final String
time: order by origin descending timestatic final String
time-asc : order by origin ascending timestatic final String
static final String
static final String
static final String
static final String
Fields inherited from class edu.sc.seis.seisFile.fdsnws.AbstractQueryParams
DEFAULT_HOST, IRIS_HOST, NEWLINE, NO_DATA, nodata
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionarea
(float minLat, float maxLat, float minLon, float maxLon) clone()
Service name as defined by the fdsn, ie event, station or dataselect.ring
(float lat, float lon, float maxRadius) setCatalog
(String value) Limit to events from a specified catalogsetContributor
(String value) Limit to events contributed by a specified contributor.setEndTime
(Instant value) Limit to events on or before the specified end time.setEventid
(String value) Select a specific event by ID; event identifiers are data center specific.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.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.setIncludeArrivals
(boolean value) Specify if phase arrivals should be included.setLatitude
(float value) Specify the latitude to be used for a radius search.setLimit
(int value) Limit the results to the specified number of events.setLongitude
(float value) Specify the longitude to the used for a radius search.setMagnitudeType
(String value) Specify a magnitude type to use for testing the minimum and maximum limits.setMaxDepth
(float value) Limit to events with depth less than the specified maximum.setMaxLatitude
(float value) Limit to events with a latitude smaller than the specified maximum.setMaxLongitude
(float value) Limit to events with a longitude smaller than the specified maximum.setMaxMagnitude
(float value) Limit to events with a magnitude smaller than the specified maximum.setMaxRadius
(float value) Limit to events within the specified maximum number of degrees from the geographic point defined by the latitude and longitude parameters.setMinDepth
(float value) Limit to events with depth more than the specified minimum.setMinLatitude
(float value) Limit to events with a latitude larger than the specified minimum.setMinLongitude
(float value) Limit to events with a longitude larger than the specified minimum.setMinMagnitude
(float value) Limit to events with a magnitude larger than the specified minimum.setMinRadius
(float value) Limit to events within the specified minimum number of degrees from the geographic point defined by the latitude and longitude parameters.setOffset
(int value) Return results starting at the event count specified, starting at 1.setOrderBy
(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 magnitudesetPort
(int port) setStartTime
(Instant value) Limit to events on or after the specified start time.setUpdatedAfter
(Instant value) Limit to events updated after the specified time.Methods inherited from class edu.sc.seis.seisFile.fdsnws.AbstractQueryParams
appendToParam, clear, clearParam, createDateFormat, formURI, getFDSNMajorVersion, getFdsnQueryStyle, getFdsnwsPath, getHost, getParam, getParams, getPort, getScheme, setBaseURL, setFdsnQueryStyle, setFdsnwsPath, setParam, setParam, setParam, setParam, setParam, setScheme, useHTTP, useHTTPS
-
Field Details
-
STARTTIME
- See Also:
-
STARTTIME_SHORT
- See Also:
-
ENDTIME
- See Also:
-
ENDTIME_SHORT
- See Also:
-
MINLATITUDE
- See Also:
-
MINLATITUDE_SHORT
- See Also:
-
MAXLATITUDE
- See Also:
-
MAXLATITUDE_SHORT
- See Also:
-
MINLONGITUDE
- See Also:
-
MINLONGITUDE_SHORT
- See Also:
-
MAXLONGITUDE
- See Also:
-
MAXLONGITUDE_SHORT
- See Also:
-
LATITUDE
- See Also:
-
LATITUDE_SHORT
- See Also:
-
LONGITUDE
- See Also:
-
LONGITUDE_SHORT
- See Also:
-
MINRADIUS
- See Also:
-
MAXRADIUS
- See Also:
-
MINDEPTH
- See Also:
-
MAXDEPTH
- See Also:
-
MINMAGNITUDE
- See Also:
-
MINMAGNITUDE_SHORT
- See Also:
-
MAXMAGNITUDE
- See Also:
-
MAXMAGNITUDE_SHORT
- See Also:
-
MAGNITUDETYPE
- See Also:
-
MAGNITUDETYPE_SHORT
- See Also:
-
INCLUDEALLORIGINS
- See Also:
-
INCLUDEALLMAGNITUDES
- See Also:
-
INCLUDEARRIVALS
- See Also:
-
EVENTID
- See Also:
-
LIMIT
- See Also:
-
OFFSET
- See Also:
-
ORDERBY
- See Also:
-
CATALOG
- See Also:
-
CONTRIBUTOR
- See Also:
-
UPDATEDAFTER
- See Also:
-
USGS_HOST
- See Also:
-
ISC_HOST
- See Also:
-
ISC_MIRROR_HOST
- See Also:
-
ORDER_TIME
time: order by origin descending time- See Also:
-
ORDER_TIME_ASC
time-asc : order by origin ascending time- See Also:
-
ORDER_MAGNITUDE
magnitude: order by descending magnitude- See Also:
-
ORDER_MAGNITUDE_ASC
magnitude-asc : order by ascending magnitude- See Also:
-
EVENT_SERVICE
- See Also:
-
-
Constructor Details
-
FDSNEventQueryParams
public FDSNEventQueryParams() -
FDSNEventQueryParams
-
-
Method Details
-
clone
-
setHost
-
setPort
-
clearStartTime
-
setStartTime
Limit to events on or after the specified start time.- Parameters:
value
- value to set- Returns:
- the queryParams for method chaining
-
clearEndTime
-
setEndTime
Limit to events on or before the specified end time.- Parameters:
value
- value to set- Returns:
- the queryParams for method chaining
-
clearMinLatitude
-
setMinLatitude
Limit to events with a latitude larger than the specified minimum.- Parameters:
value
- value to set- Returns:
- the queryParams for method chaining
-
clearMaxLatitude
-
setMaxLatitude
Limit to events with a latitude smaller than the specified maximum.- Parameters:
value
- value to set- Returns:
- the queryParams for method chaining
-
clearMinLongitude
-
setMinLongitude
Limit to events with a longitude larger than the specified minimum.- Parameters:
value
- value to set- Returns:
- the queryParams for method chaining
-
clearMaxLongitude
-
setMaxLongitude
Limit to events with a longitude smaller than the specified maximum.- Parameters:
value
- value to set- Returns:
- the queryParams for method chaining
-
clearLatitude
-
setLatitude
Specify the latitude to be used for a radius search.- Parameters:
value
- value to set- Returns:
- the queryParams for method chaining
-
clearLongitude
-
setLongitude
Specify the longitude to the used for a radius search.- Parameters:
value
- value to set- Returns:
- the queryParams for method chaining
-
clearMinRadius
-
setMinRadius
Limit to events within the specified minimum number of degrees from the geographic point defined by the latitude and longitude parameters.- Parameters:
value
- value to set- Returns:
- the queryParams for method chaining
-
clearMaxRadius
-
setMaxRadius
Limit to events within the specified maximum number of degrees from the geographic point defined by the latitude and longitude parameters.- Parameters:
value
- value to set- Returns:
- the queryParams for method chaining
-
clearMinDepth
-
setMinDepth
Limit to events with depth more than the specified minimum.- Parameters:
value
- value to set- Returns:
- the queryParams for method chaining
-
clearMaxDepth
-
setMaxDepth
Limit to events with depth less than the specified maximum.- Parameters:
value
- value to set- Returns:
- the queryParams for method chaining
-
clearMinMagnitude
-
setMinMagnitude
Limit to events with a magnitude larger than the specified minimum.- Parameters:
value
- value to set- Returns:
- the queryParams for method chaining
-
clearMaxMagnitude
-
setMaxMagnitude
Limit to events with a magnitude smaller than the specified maximum.- Parameters:
value
- value to set- Returns:
- the queryParams for method chaining
-
clearMagnitudeType
-
setMagnitudeType
Specify a magnitude type to use for testing the minimum and maximum limits.- Parameters:
value
- value to set- Returns:
- the queryParams for method chaining
-
clearIncludeAllOrigins
-
setIncludeAllOrigins
Specify if all origins for the event should be included, default is data center dependent but is suggested to be the preferred origin only.- Parameters:
value
- value to set- Returns:
- the queryParams for method chaining
-
clearIncludeAllMagnitudes
-
setIncludeAllMagnitudes
Specify if all magnitudes for the event should be included, default is data center dependent but is suggested to be the preferred magnitude only.- Parameters:
value
- value to set- Returns:
- the queryParams for method chaining
-
clearIncludeArrivals
-
setIncludeArrivals
Specify if phase arrivals should be included.- Parameters:
value
- value to set- Returns:
- the queryParams for method chaining
-
clearEventid
-
setEventid
Select a specific event by ID; event identifiers are data center specific.- Parameters:
value
- value to set- Returns:
- the queryParams for method chaining
-
clearLimit
-
setLimit
Limit the results to the specified number of events.- Parameters:
value
- value to set- Returns:
- the queryParams for method chaining
-
clearOffset
-
setOffset
Return results starting at the event count specified, starting at 1.- Parameters:
value
- value to set- Returns:
- the queryParams for method chaining
-
clearOrderBy
-
setOrderBy
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- Parameters:
value
- value to set- Returns:
- the queryParams for method chaining
-
clearCatalog
-
setCatalog
Limit to events from a specified catalog- Parameters:
value
- value to set- Returns:
- the queryParams for method chaining
-
clearContributor
-
setContributor
Limit to events contributed by a specified contributor.- Parameters:
value
- value to set- Returns:
- the queryParams for method chaining
-
clearUpdatedAfter
-
setUpdatedAfter
Limit to events updated after the specified time.- Parameters:
value
- value to set- Returns:
- the queryParams for method chaining
-
boxArea
-
area
-
ring
-
donut
-
getServiceName
Description copied from class:AbstractQueryParams
Service name as defined by the fdsn, ie event, station or dataselect.- Specified by:
getServiceName
in classAbstractQueryParams
-