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:
java.lang.Cloneable
public class FDSNEventQueryParams extends AbstractQueryParams implements java.lang.Cloneable
Autogenerated by groovy FDSNQueryParamGenerator.groovy in src/metacode/groovy
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
CATALOG
static java.lang.String
CONTRIBUTOR
static java.lang.String
ENDTIME
static java.lang.String
ENDTIME_SHORT
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
ISC_HOST
static java.lang.String
ISC_MIRROR_HOST
static java.lang.String
LATITUDE
static java.lang.String
LATITUDE_SHORT
static java.lang.String
LIMIT
static java.lang.String
LONGITUDE
static java.lang.String
LONGITUDE_SHORT
static java.lang.String
MAGNITUDETYPE
static java.lang.String
MAGNITUDETYPE_SHORT
static java.lang.String
MAXDEPTH
static java.lang.String
MAXLATITUDE
static java.lang.String
MAXLATITUDE_SHORT
static java.lang.String
MAXLONGITUDE
static java.lang.String
MAXLONGITUDE_SHORT
static java.lang.String
MAXMAGNITUDE
static java.lang.String
MAXMAGNITUDE_SHORT
static java.lang.String
MAXRADIUS
static java.lang.String
MINDEPTH
static java.lang.String
MINLATITUDE
static java.lang.String
MINLATITUDE_SHORT
static java.lang.String
MINLONGITUDE
static java.lang.String
MINLONGITUDE_SHORT
static java.lang.String
MINMAGNITUDE
static java.lang.String
MINMAGNITUDE_SHORT
static java.lang.String
MINRADIUS
static java.lang.String
OFFSET
static java.lang.String
ORDER_MAGNITUDE
magnitude: order by descending magnitudestatic java.lang.String
ORDER_MAGNITUDE_ASC
magnitude-asc : order by ascending magnitudestatic java.lang.String
ORDER_TIME
time: order by origin descending timestatic java.lang.String
ORDER_TIME_ASC
time-asc : order by origin ascending timestatic java.lang.String
ORDERBY
static java.lang.String
STARTTIME
static java.lang.String
STARTTIME_SHORT
static java.lang.String
UPDATEDAFTER
static java.lang.String
USGS_HOST
-
Fields inherited from class edu.sc.seis.seisFile.fdsnws.AbstractQueryParams
DEFAULT_HOST, IRIS_HOST, NEWLINE, NO_DATA, nodata
-
-
Constructor Summary
Constructors Constructor Description FDSNEventQueryParams()
FDSNEventQueryParams(java.lang.String host)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description FDSNEventQueryParams
area(float minLat, float maxLat, float minLon, float maxLon)
FDSNEventQueryParams
boxArea(BoxArea box)
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(DonutArea donut)
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 catalogFDSNEventQueryParams
setContributor(java.lang.String value)
Limit to events contributed by a specified contributor.FDSNEventQueryParams
setEndTime(java.time.Instant 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 magnitudeFDSNEventQueryParams
setPort(int port)
FDSNEventQueryParams
setStartTime(java.time.Instant value)
Limit to events on or after the specified start time.FDSNEventQueryParams
setUpdatedAfter(java.time.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, setFdsnwsPath, setParam, setParam, setParam, setParam, setParam, setScheme
-
-
-
-
Field Detail
-
STARTTIME
public static final java.lang.String STARTTIME
- See Also:
- Constant Field Values
-
STARTTIME_SHORT
public static final java.lang.String STARTTIME_SHORT
- See Also:
- Constant Field Values
-
ENDTIME
public static final java.lang.String ENDTIME
- See Also:
- Constant Field Values
-
ENDTIME_SHORT
public static final java.lang.String ENDTIME_SHORT
- See Also:
- Constant Field Values
-
MINLATITUDE
public static final java.lang.String MINLATITUDE
- See Also:
- Constant Field Values
-
MINLATITUDE_SHORT
public static final java.lang.String MINLATITUDE_SHORT
- See Also:
- Constant Field Values
-
MAXLATITUDE
public static final java.lang.String MAXLATITUDE
- See Also:
- Constant Field Values
-
MAXLATITUDE_SHORT
public static final java.lang.String MAXLATITUDE_SHORT
- See Also:
- Constant Field Values
-
MINLONGITUDE
public static final java.lang.String MINLONGITUDE
- See Also:
- Constant Field Values
-
MINLONGITUDE_SHORT
public static final java.lang.String MINLONGITUDE_SHORT
- See Also:
- Constant Field Values
-
MAXLONGITUDE
public static final java.lang.String MAXLONGITUDE
- See Also:
- Constant Field Values
-
MAXLONGITUDE_SHORT
public static final java.lang.String MAXLONGITUDE_SHORT
- See Also:
- Constant Field Values
-
LATITUDE
public static final java.lang.String LATITUDE
- See Also:
- Constant Field Values
-
LATITUDE_SHORT
public static final java.lang.String LATITUDE_SHORT
- See Also:
- Constant Field Values
-
LONGITUDE
public static final java.lang.String LONGITUDE
- See Also:
- Constant Field Values
-
LONGITUDE_SHORT
public static final java.lang.String LONGITUDE_SHORT
- 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
-
MINMAGNITUDE_SHORT
public static final java.lang.String MINMAGNITUDE_SHORT
- See Also:
- Constant Field Values
-
MAXMAGNITUDE
public static final java.lang.String MAXMAGNITUDE
- See Also:
- Constant Field Values
-
MAXMAGNITUDE_SHORT
public static final java.lang.String MAXMAGNITUDE_SHORT
- See Also:
- Constant Field Values
-
MAGNITUDETYPE
public static final java.lang.String MAGNITUDETYPE
- See Also:
- Constant Field Values
-
MAGNITUDETYPE_SHORT
public static final java.lang.String MAGNITUDETYPE_SHORT
- 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
-
USGS_HOST
public static final java.lang.String USGS_HOST
- See Also:
- Constant Field Values
-
ISC_HOST
public static final java.lang.String ISC_HOST
- See Also:
- Constant Field Values
-
ISC_MIRROR_HOST
public static final java.lang.String ISC_MIRROR_HOST
- 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
-
-
Method Detail
-
clone
public FDSNEventQueryParams clone()
- Overrides:
clone
in classjava.lang.Object
-
setHost
public FDSNEventQueryParams setHost(java.lang.String host)
-
setPort
public FDSNEventQueryParams setPort(int port)
-
clearStartTime
public FDSNEventQueryParams clearStartTime()
-
setStartTime
public FDSNEventQueryParams setStartTime(java.time.Instant value)
Limit to events on or after the specified start time.- Parameters:
value
- value to set- Returns:
- the queryParams for method chaining
-
clearEndTime
public FDSNEventQueryParams clearEndTime()
-
setEndTime
public FDSNEventQueryParams setEndTime(java.time.Instant value)
Limit to events on or before the specified end time.- Parameters:
value
- value to set- Returns:
- the queryParams for method chaining
-
clearMinLatitude
public FDSNEventQueryParams clearMinLatitude()
-
setMinLatitude
public FDSNEventQueryParams setMinLatitude(float value)
Limit to events with a latitude larger than the specified minimum.- Parameters:
value
- value to set- Returns:
- the queryParams for method chaining
-
clearMaxLatitude
public FDSNEventQueryParams clearMaxLatitude()
-
setMaxLatitude
public FDSNEventQueryParams setMaxLatitude(float value)
Limit to events with a latitude smaller than the specified maximum.- Parameters:
value
- value to set- Returns:
- the queryParams for method chaining
-
clearMinLongitude
public FDSNEventQueryParams clearMinLongitude()
-
setMinLongitude
public FDSNEventQueryParams setMinLongitude(float value)
Limit to events with a longitude larger than the specified minimum.- Parameters:
value
- value to set- Returns:
- the queryParams for method chaining
-
clearMaxLongitude
public FDSNEventQueryParams clearMaxLongitude()
-
setMaxLongitude
public FDSNEventQueryParams setMaxLongitude(float value)
Limit to events with a longitude smaller than the specified maximum.- Parameters:
value
- value to set- Returns:
- the queryParams for method chaining
-
clearLatitude
public FDSNEventQueryParams clearLatitude()
-
setLatitude
public FDSNEventQueryParams setLatitude(float value)
Specify the latitude to be used for a radius search.- Parameters:
value
- value to set- Returns:
- the queryParams for method chaining
-
clearLongitude
public FDSNEventQueryParams clearLongitude()
-
setLongitude
public FDSNEventQueryParams setLongitude(float value)
Specify the longitude to the used for a radius search.- Parameters:
value
- value to set- Returns:
- the queryParams for method chaining
-
clearMinRadius
public FDSNEventQueryParams clearMinRadius()
-
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.- Parameters:
value
- value to set- Returns:
- the queryParams for method chaining
-
clearMaxRadius
public FDSNEventQueryParams clearMaxRadius()
-
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.- Parameters:
value
- value to set- Returns:
- the queryParams for method chaining
-
clearMinDepth
public FDSNEventQueryParams clearMinDepth()
-
setMinDepth
public FDSNEventQueryParams setMinDepth(float value)
Limit to events with depth more than the specified minimum.- Parameters:
value
- value to set- Returns:
- the queryParams for method chaining
-
clearMaxDepth
public FDSNEventQueryParams clearMaxDepth()
-
setMaxDepth
public FDSNEventQueryParams setMaxDepth(float value)
Limit to events with depth less than the specified maximum.- Parameters:
value
- value to set- Returns:
- the queryParams for method chaining
-
clearMinMagnitude
public FDSNEventQueryParams clearMinMagnitude()
-
setMinMagnitude
public FDSNEventQueryParams setMinMagnitude(float value)
Limit to events with a magnitude larger than the specified minimum.- Parameters:
value
- value to set- Returns:
- the queryParams for method chaining
-
clearMaxMagnitude
public FDSNEventQueryParams clearMaxMagnitude()
-
setMaxMagnitude
public FDSNEventQueryParams setMaxMagnitude(float value)
Limit to events with a magnitude smaller than the specified maximum.- Parameters:
value
- value to set- Returns:
- the queryParams for method chaining
-
clearMagnitudeType
public FDSNEventQueryParams clearMagnitudeType()
-
setMagnitudeType
public FDSNEventQueryParams setMagnitudeType(java.lang.String value)
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
public FDSNEventQueryParams clearIncludeAllOrigins()
-
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.- Parameters:
value
- value to set- Returns:
- the queryParams for method chaining
-
clearIncludeAllMagnitudes
public FDSNEventQueryParams clearIncludeAllMagnitudes()
-
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.- Parameters:
value
- value to set- Returns:
- the queryParams for method chaining
-
clearIncludeArrivals
public FDSNEventQueryParams clearIncludeArrivals()
-
setIncludeArrivals
public FDSNEventQueryParams setIncludeArrivals(boolean value)
Specify if phase arrivals should be included.- Parameters:
value
- value to set- Returns:
- the queryParams for method chaining
-
clearEventid
public FDSNEventQueryParams clearEventid()
-
setEventid
public FDSNEventQueryParams setEventid(java.lang.String value)
Select a specific event by ID; event identifiers are data center specific.- Parameters:
value
- value to set- Returns:
- the queryParams for method chaining
-
clearLimit
public FDSNEventQueryParams clearLimit()
-
setLimit
public FDSNEventQueryParams setLimit(int value)
Limit the results to the specified number of events.- Parameters:
value
- value to set- Returns:
- the queryParams for method chaining
-
clearOffset
public FDSNEventQueryParams clearOffset()
-
setOffset
public FDSNEventQueryParams setOffset(int value)
Return results starting at the event count specified, starting at 1.- Parameters:
value
- value to set- Returns:
- the queryParams for method chaining
-
clearOrderBy
public FDSNEventQueryParams clearOrderBy()
-
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- Parameters:
value
- value to set- Returns:
- the queryParams for method chaining
-
clearCatalog
public FDSNEventQueryParams clearCatalog()
-
setCatalog
public FDSNEventQueryParams setCatalog(java.lang.String value)
Limit to events from a specified catalog- Parameters:
value
- value to set- Returns:
- the queryParams for method chaining
-
clearContributor
public FDSNEventQueryParams clearContributor()
-
setContributor
public FDSNEventQueryParams setContributor(java.lang.String value)
Limit to events contributed by a specified contributor.- Parameters:
value
- value to set- Returns:
- the queryParams for method chaining
-
clearUpdatedAfter
public FDSNEventQueryParams clearUpdatedAfter()
-
setUpdatedAfter
public FDSNEventQueryParams setUpdatedAfter(java.time.Instant value)
Limit to events updated after the specified time.- Parameters:
value
- value to set- Returns:
- the queryParams for method chaining
-
boxArea
public FDSNEventQueryParams boxArea(BoxArea box)
-
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(DonutArea donut)
-
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 classAbstractQueryParams
-
-