Package edu.sc.seis.seisFile.fdsnws
Class FDSNStationQueryParams
- java.lang.Object
-
- edu.sc.seis.seisFile.fdsnws.AbstractQueryParams
-
- edu.sc.seis.seisFile.fdsnws.FDSNStationQueryParams
-
- All Implemented Interfaces:
java.lang.Cloneable
public class FDSNStationQueryParams 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.StringCHANNELstatic java.lang.StringCHANNEL_SHORTstatic java.lang.StringENDAFTERstatic java.lang.StringENDBEFOREstatic java.lang.StringENDTIMEstatic java.lang.StringENDTIME_SHORTstatic java.lang.StringINCLUDEAVAILABILITYstatic java.lang.StringINCLUDERESTRICTEDstatic java.lang.StringLATITUDEstatic java.lang.StringLATITUDE_SHORTstatic java.lang.StringLEVELstatic java.lang.StringLEVEL_CHANNELstatic java.lang.StringLEVEL_NETWORKstatic java.lang.StringLEVEL_RESPONSEstatic java.lang.StringLEVEL_STATIONstatic java.lang.StringLOCATIONstatic java.lang.StringLOCATION_SHORTstatic java.lang.StringLONGITUDEstatic java.lang.StringLONGITUDE_SHORTstatic java.lang.StringMATCHTIMESERIESstatic java.lang.StringMAXLATITUDEstatic java.lang.StringMAXLATITUDE_SHORTstatic java.lang.StringMAXLONGITUDEstatic java.lang.StringMAXLONGITUDE_SHORTstatic java.lang.StringMAXRADIUSstatic java.lang.StringMINLATITUDEstatic java.lang.StringMINLATITUDE_SHORTstatic java.lang.StringMINLONGITUDEstatic java.lang.StringMINLONGITUDE_SHORTstatic java.lang.StringMINRADIUSstatic java.lang.StringNETWORKstatic java.lang.StringNETWORK_SHORTstatic java.lang.StringSTARTAFTERstatic java.lang.StringSTARTBEFOREstatic java.lang.StringSTARTTIMEstatic java.lang.StringSTARTTIME_SHORTstatic java.lang.StringSTATIONstatic java.lang.StringSTATION_SERVICEstatic java.lang.StringSTATION_SHORTstatic java.lang.StringUPDATEDAFTER-
Fields inherited from class edu.sc.seis.seisFile.fdsnws.AbstractQueryParams
DEFAULT_HOST, IRIS_HOST, NEWLINE, NO_DATA, nodata
-
-
Constructor Summary
Constructors Constructor Description FDSNStationQueryParams()FDSNStationQueryParams(java.lang.String host)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description FDSNStationQueryParamsappendToChannel(java.lang.String value)FDSNStationQueryParamsappendToLocation(java.lang.String value)FDSNStationQueryParamsappendToNetwork(java.lang.String value)FDSNStationQueryParamsappendToStation(java.lang.String value)FDSNStationQueryParamsarea(float minLat, float maxLat, float minLon, float maxLon)FDSNStationQueryParamsboxArea(BoxArea box)FDSNStationQueryParamsclearChannel()FDSNStationQueryParamsclearEndAfter()FDSNStationQueryParamsclearEndBefore()FDSNStationQueryParamsclearEndTime()FDSNStationQueryParamsclearIncludeAvailability()FDSNStationQueryParamsclearIncludeRestricted()FDSNStationQueryParamsclearLatitude()FDSNStationQueryParamsclearLevel()FDSNStationQueryParamsclearLocation()FDSNStationQueryParamsclearLongitude()FDSNStationQueryParamsclearMatchTimeseries()FDSNStationQueryParamsclearMaxLatitude()FDSNStationQueryParamsclearMaxLongitude()FDSNStationQueryParamsclearMaxRadius()FDSNStationQueryParamsclearMinLatitude()FDSNStationQueryParamsclearMinLongitude()FDSNStationQueryParamsclearMinRadius()FDSNStationQueryParamsclearNetwork()FDSNStationQueryParamsclearStartAfter()FDSNStationQueryParamsclearStartBefore()FDSNStationQueryParamsclearStartTime()FDSNStationQueryParamsclearStation()FDSNStationQueryParamsclearUpdatedAfter()FDSNStationQueryParamsclone()FDSNStationQueryParamsdonut(DonutArea donut)java.lang.StringgetServiceName()Service name as defined by the fdsn, ie event, station or dataselect.FDSNStationQueryParamsring(float lat, float lon, float maxRadius)FDSNStationQueryParamssetChannel(java.lang.String[] value)Select one or more SEED channel codes.FDSNStationQueryParamssetEndAfter(java.time.Instant value)Limit to metadata epochs ending after specified time.FDSNStationQueryParamssetEndBefore(java.time.Instant value)Limit to metadata epochs ending before specified time.FDSNStationQueryParamssetEndTime(java.time.Instant value)Limit to metadata epochs ending on or before the specified end time.FDSNStationQueryParamssetHost(java.lang.String host)FDSNStationQueryParamssetIncludeAvailability(boolean value)Specify if results should include information about time series data availability.FDSNStationQueryParamssetIncludeRestricted(boolean value)Specify if results should include information for restricted stations.FDSNStationQueryParamssetLatitude(float value)Specify the latitude to be used for a radius search.FDSNStationQueryParamssetLevel(java.lang.String value)Specify the level of detail for the results.FDSNStationQueryParamssetLocation(java.lang.String[] value)Select one or more SEED location identifiers.FDSNStationQueryParamssetLongitude(float value)Specify the longitude to the used for a radius search.FDSNStationQueryParamssetMatchTimeseries(boolean value)Limit to metadata where selection criteria matches time series data availability.FDSNStationQueryParamssetMaxLatitude(float value)Limit to stations with a latitude smaller than the specified maximum.FDSNStationQueryParamssetMaxLongitude(float value)Limit to stations with a longitude smaller than the specified maximum.FDSNStationQueryParamssetMaxRadius(float value)Limit results to stations within the specified maximum number of degrees from the geographic point defined by the latitude and longitude parameters.FDSNStationQueryParamssetMinLatitude(float value)Limit to stations with a latitude larger than the specified minimum.FDSNStationQueryParamssetMinLongitude(float value)Limit to stations with a longitude larger than the specified minimum.FDSNStationQueryParamssetMinRadius(float value)Limit results to stations within the specified minimum number of degrees from the geographic point defined by the latitude and longitude parameters.FDSNStationQueryParamssetNetwork(java.lang.String[] value)Select one or more network codes.FDSNStationQueryParamssetPort(int port)FDSNStationQueryParamssetStartAfter(java.time.Instant value)Limit to metadata epochs starting after specified time.FDSNStationQueryParamssetStartBefore(java.time.Instant value)Limit to metadata epochs starting before specified time.FDSNStationQueryParamssetStartTime(java.time.Instant value)Limit to metadata epochs starting on or after the specified start time.FDSNStationQueryParamssetStation(java.lang.String[] value)Select one or more SEED station codes.FDSNStationQueryParamssetUpdatedAfter(java.time.Instant value)Limit to metadata updated after specified date; updates are data center specific.-
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
-
STARTBEFORE
public static final java.lang.String STARTBEFORE
- See Also:
- Constant Field Values
-
STARTAFTER
public static final java.lang.String STARTAFTER
- See Also:
- Constant Field Values
-
ENDBEFORE
public static final java.lang.String ENDBEFORE
- See Also:
- Constant Field Values
-
ENDAFTER
public static final java.lang.String ENDAFTER
- See Also:
- Constant Field Values
-
NETWORK
public static final java.lang.String NETWORK
- See Also:
- Constant Field Values
-
NETWORK_SHORT
public static final java.lang.String NETWORK_SHORT
- See Also:
- Constant Field Values
-
STATION
public static final java.lang.String STATION
- See Also:
- Constant Field Values
-
STATION_SHORT
public static final java.lang.String STATION_SHORT
- See Also:
- Constant Field Values
-
LOCATION
public static final java.lang.String LOCATION
- See Also:
- Constant Field Values
-
LOCATION_SHORT
public static final java.lang.String LOCATION_SHORT
- See Also:
- Constant Field Values
-
CHANNEL
public static final java.lang.String CHANNEL
- See Also:
- Constant Field Values
-
CHANNEL_SHORT
public static final java.lang.String CHANNEL_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
-
LEVEL
public static final java.lang.String LEVEL
- See Also:
- Constant Field Values
-
INCLUDERESTRICTED
public static final java.lang.String INCLUDERESTRICTED
- See Also:
- Constant Field Values
-
INCLUDEAVAILABILITY
public static final java.lang.String INCLUDEAVAILABILITY
- See Also:
- Constant Field Values
-
MATCHTIMESERIES
public static final java.lang.String MATCHTIMESERIES
- See Also:
- Constant Field Values
-
UPDATEDAFTER
public static final java.lang.String UPDATEDAFTER
- See Also:
- Constant Field Values
-
LEVEL_NETWORK
public static final java.lang.String LEVEL_NETWORK
-
LEVEL_STATION
public static final java.lang.String LEVEL_STATION
-
LEVEL_CHANNEL
public static final java.lang.String LEVEL_CHANNEL
-
LEVEL_RESPONSE
public static final java.lang.String LEVEL_RESPONSE
-
STATION_SERVICE
public static final java.lang.String STATION_SERVICE
- See Also:
- Constant Field Values
-
-
Method Detail
-
clone
public FDSNStationQueryParams clone()
- Overrides:
clonein classjava.lang.Object
-
setHost
public FDSNStationQueryParams setHost(java.lang.String host)
-
setPort
public FDSNStationQueryParams setPort(int port)
-
clearStartTime
public FDSNStationQueryParams clearStartTime()
-
setStartTime
public FDSNStationQueryParams setStartTime(java.time.Instant value)
Limit to metadata epochs starting on or after the specified start time.- Parameters:
value- value to set- Returns:
- the queryParams for method chaining
-
clearEndTime
public FDSNStationQueryParams clearEndTime()
-
setEndTime
public FDSNStationQueryParams setEndTime(java.time.Instant value)
Limit to metadata epochs ending on or before the specified end time.- Parameters:
value- value to set- Returns:
- the queryParams for method chaining
-
clearStartBefore
public FDSNStationQueryParams clearStartBefore()
-
setStartBefore
public FDSNStationQueryParams setStartBefore(java.time.Instant value)
Limit to metadata epochs starting before specified time.- Parameters:
value- value to set- Returns:
- the queryParams for method chaining
-
clearStartAfter
public FDSNStationQueryParams clearStartAfter()
-
setStartAfter
public FDSNStationQueryParams setStartAfter(java.time.Instant value)
Limit to metadata epochs starting after specified time.- Parameters:
value- value to set- Returns:
- the queryParams for method chaining
-
clearEndBefore
public FDSNStationQueryParams clearEndBefore()
-
setEndBefore
public FDSNStationQueryParams setEndBefore(java.time.Instant value)
Limit to metadata epochs ending before specified time.- Parameters:
value- value to set- Returns:
- the queryParams for method chaining
-
clearEndAfter
public FDSNStationQueryParams clearEndAfter()
-
setEndAfter
public FDSNStationQueryParams setEndAfter(java.time.Instant value)
Limit to metadata epochs ending after specified time.- Parameters:
value- value to set- Returns:
- the queryParams for method chaining
-
clearNetwork
public FDSNStationQueryParams clearNetwork()
-
setNetwork
public FDSNStationQueryParams setNetwork(java.lang.String[] value)
Select one or more network codes. Can be SEED network codes or data center defined codes. Multiple codes are comma-separated.
-
appendToNetwork
public FDSNStationQueryParams appendToNetwork(java.lang.String value)
-
clearStation
public FDSNStationQueryParams clearStation()
-
setStation
public FDSNStationQueryParams setStation(java.lang.String[] value)
Select one or more SEED station codes. Multiple codes are comma-separated.
-
appendToStation
public FDSNStationQueryParams appendToStation(java.lang.String value)
-
clearLocation
public FDSNStationQueryParams clearLocation()
-
setLocation
public FDSNStationQueryParams setLocation(java.lang.String[] value)
Select one or more SEED location identifiers. Multiple identifiers are comma-separated. As a special case -- (two dashes) will be translated to a string of two space characters to match blank location IDs.
-
appendToLocation
public FDSNStationQueryParams appendToLocation(java.lang.String value)
-
clearChannel
public FDSNStationQueryParams clearChannel()
-
setChannel
public FDSNStationQueryParams setChannel(java.lang.String[] value)
Select one or more SEED channel codes. Multiple codes are comma-separated.
-
appendToChannel
public FDSNStationQueryParams appendToChannel(java.lang.String value)
-
clearMinLatitude
public FDSNStationQueryParams clearMinLatitude()
-
setMinLatitude
public FDSNStationQueryParams setMinLatitude(float value)
Limit to stations with a latitude larger than the specified minimum.- Parameters:
value- value to set- Returns:
- the queryParams for method chaining
-
clearMaxLatitude
public FDSNStationQueryParams clearMaxLatitude()
-
setMaxLatitude
public FDSNStationQueryParams setMaxLatitude(float value)
Limit to stations with a latitude smaller than the specified maximum.- Parameters:
value- value to set- Returns:
- the queryParams for method chaining
-
clearMinLongitude
public FDSNStationQueryParams clearMinLongitude()
-
setMinLongitude
public FDSNStationQueryParams setMinLongitude(float value)
Limit to stations with a longitude larger than the specified minimum.- Parameters:
value- value to set- Returns:
- the queryParams for method chaining
-
clearMaxLongitude
public FDSNStationQueryParams clearMaxLongitude()
-
setMaxLongitude
public FDSNStationQueryParams setMaxLongitude(float value)
Limit to stations with a longitude smaller than the specified maximum.- Parameters:
value- value to set- Returns:
- the queryParams for method chaining
-
clearLatitude
public FDSNStationQueryParams clearLatitude()
-
setLatitude
public FDSNStationQueryParams 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 FDSNStationQueryParams clearLongitude()
-
setLongitude
public FDSNStationQueryParams 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 FDSNStationQueryParams clearMinRadius()
-
setMinRadius
public FDSNStationQueryParams setMinRadius(float value)
Limit results to stations 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 FDSNStationQueryParams clearMaxRadius()
-
setMaxRadius
public FDSNStationQueryParams setMaxRadius(float value)
Limit results to stations 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
-
clearLevel
public FDSNStationQueryParams clearLevel()
-
setLevel
public FDSNStationQueryParams setLevel(java.lang.String value)
Specify the level of detail for the results.- Parameters:
value- value to set- Returns:
- the queryParams for method chaining
-
clearIncludeRestricted
public FDSNStationQueryParams clearIncludeRestricted()
-
setIncludeRestricted
public FDSNStationQueryParams setIncludeRestricted(boolean value)
Specify if results should include information for restricted stations.- Parameters:
value- value to set- Returns:
- the queryParams for method chaining
-
clearIncludeAvailability
public FDSNStationQueryParams clearIncludeAvailability()
-
setIncludeAvailability
public FDSNStationQueryParams setIncludeAvailability(boolean value)
Specify if results should include information about time series data availability.- Parameters:
value- value to set- Returns:
- the queryParams for method chaining
-
clearMatchTimeseries
public FDSNStationQueryParams clearMatchTimeseries()
-
setMatchTimeseries
public FDSNStationQueryParams setMatchTimeseries(boolean value)
Limit to metadata where selection criteria matches time series data availability.- Parameters:
value- value to set- Returns:
- the queryParams for method chaining
-
clearUpdatedAfter
public FDSNStationQueryParams clearUpdatedAfter()
-
setUpdatedAfter
public FDSNStationQueryParams setUpdatedAfter(java.time.Instant value)
Limit to metadata updated after specified date; updates are data center specific.- Parameters:
value- value to set- Returns:
- the queryParams for method chaining
-
boxArea
public FDSNStationQueryParams boxArea(BoxArea box)
-
area
public FDSNStationQueryParams area(float minLat, float maxLat, float minLon, float maxLon)
-
ring
public FDSNStationQueryParams ring(float lat, float lon, float maxRadius)
-
donut
public FDSNStationQueryParams donut(DonutArea donut)
-
getServiceName
public java.lang.String getServiceName()
Description copied from class:AbstractQueryParamsService name as defined by the fdsn, ie event, station or dataselect.- Specified by:
getServiceNamein classAbstractQueryParams
-
-