Package edu.sc.seis.seisFile.fdsnws
Class FDSNDataSelectQueryParams
- java.lang.Object
-
- edu.sc.seis.seisFile.fdsnws.AbstractQueryParams
-
- edu.sc.seis.seisFile.fdsnws.FDSNDataSelectQueryParams
-
- All Implemented Interfaces:
java.lang.Cloneable
public class FDSNDataSelectQueryParams 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
CHANNEL
static java.lang.String
CHANNEL_SHORT
static java.lang.String
DATASELECT_SERVICE
static java.lang.String
ENDTIME
static java.lang.String
ENDTIME_SHORT
static java.lang.String
LOCATION
static java.lang.String
LOCATION_SHORT
static java.lang.String
LONGESTONLY
static java.lang.String
MINIMUMLENGTH
static java.lang.String
NETWORK
static java.lang.String
NETWORK_SHORT
static java.lang.String
QUALITY
static java.lang.String
STARTTIME
static java.lang.String
STARTTIME_SHORT
static java.lang.String
STATION
static java.lang.String
STATION_SHORT
-
Fields inherited from class edu.sc.seis.seisFile.fdsnws.AbstractQueryParams
DEFAULT_HOST, IRIS_HOST, NEWLINE, NO_DATA, nodata
-
-
Constructor Summary
Constructors Constructor Description FDSNDataSelectQueryParams()
FDSNDataSelectQueryParams(java.lang.String host)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description FDSNDataSelectQueryParams
appendToChannel(java.lang.String value)
FDSNDataSelectQueryParams
appendToLocation(java.lang.String value)
FDSNDataSelectQueryParams
appendToNetwork(java.lang.String value)
FDSNDataSelectQueryParams
appendToStation(java.lang.String value)
FDSNDataSelectQueryParams
clearChannel()
FDSNDataSelectQueryParams
clearEndTime()
FDSNDataSelectQueryParams
clearLocation()
FDSNDataSelectQueryParams
clearLongestOnly()
FDSNDataSelectQueryParams
clearMinimumLength()
FDSNDataSelectQueryParams
clearNetwork()
FDSNDataSelectQueryParams
clearQuality()
FDSNDataSelectQueryParams
clearStartTime()
FDSNDataSelectQueryParams
clearStation()
FDSNDataSelectQueryParams
clone()
java.util.List<ChannelTimeWindow>
createChannelTimeWindow()
Forms the list of ChannelTimeWindow for use in a POST request to the web service.java.lang.String
formPostString()
java.lang.String
formPostString(java.util.List<ChannelTimeWindow> request)
Forms the text for use in a POST request to the web service.java.lang.String
getServiceName()
Service name as defined by the fdsn, ie event, station or dataselect.FDSNDataSelectQueryParams
setChannel(java.lang.String[] value)
Select one or more SEED channel codes.FDSNDataSelectQueryParams
setEndTime(java.time.Instant value)
Limit results to time series samples on or before the specified end timeFDSNDataSelectQueryParams
setHost(java.lang.String host)
FDSNDataSelectQueryParams
setLocation(java.lang.String[] value)
Select one or more SEED location identifiers.FDSNDataSelectQueryParams
setLongestOnly(boolean value)
Limit results to the longest continuous segment per channel.FDSNDataSelectQueryParams
setMinimumLength(int value)
Limit results to continuous data segments of a minimum length specified in seconds.FDSNDataSelectQueryParams
setNetwork(java.lang.String[] value)
Select one or more network codes.FDSNDataSelectQueryParams
setPort(int port)
FDSNDataSelectQueryParams
setQuality(java.lang.String value)
Select a specific SEED quality indicator, handling is data center dependent.FDSNDataSelectQueryParams
setStartTime(java.time.Instant value)
Limit results to time series samples on or after the specified start timeFDSNDataSelectQueryParams
setStation(java.lang.String[] value)
Select one or more SEED station codes.-
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
-
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
-
QUALITY
public static final java.lang.String QUALITY
- See Also:
- Constant Field Values
-
MINIMUMLENGTH
public static final java.lang.String MINIMUMLENGTH
- See Also:
- Constant Field Values
-
LONGESTONLY
public static final java.lang.String LONGESTONLY
- See Also:
- Constant Field Values
-
DATASELECT_SERVICE
public static final java.lang.String DATASELECT_SERVICE
- See Also:
- Constant Field Values
-
-
Method Detail
-
clone
public FDSNDataSelectQueryParams clone()
- Overrides:
clone
in classjava.lang.Object
-
setHost
public FDSNDataSelectQueryParams setHost(java.lang.String host)
-
setPort
public FDSNDataSelectQueryParams setPort(int port)
-
clearStartTime
public FDSNDataSelectQueryParams clearStartTime()
-
setStartTime
public FDSNDataSelectQueryParams setStartTime(java.time.Instant value)
Limit results to time series samples on or after the specified start time- Parameters:
value
- value to set- Returns:
- the queryParams for method chaining
-
clearEndTime
public FDSNDataSelectQueryParams clearEndTime()
-
setEndTime
public FDSNDataSelectQueryParams setEndTime(java.time.Instant value)
Limit results to time series samples on or before the specified end time- Parameters:
value
- value to set- Returns:
- the queryParams for method chaining
-
clearNetwork
public FDSNDataSelectQueryParams clearNetwork()
-
setNetwork
public FDSNDataSelectQueryParams 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 FDSNDataSelectQueryParams appendToNetwork(java.lang.String value)
-
clearStation
public FDSNDataSelectQueryParams clearStation()
-
setStation
public FDSNDataSelectQueryParams setStation(java.lang.String[] value)
Select one or more SEED station codes. Multiple codes are comma-separated.
-
appendToStation
public FDSNDataSelectQueryParams appendToStation(java.lang.String value)
-
clearLocation
public FDSNDataSelectQueryParams clearLocation()
-
setLocation
public FDSNDataSelectQueryParams 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 FDSNDataSelectQueryParams appendToLocation(java.lang.String value)
-
clearChannel
public FDSNDataSelectQueryParams clearChannel()
-
setChannel
public FDSNDataSelectQueryParams setChannel(java.lang.String[] value)
Select one or more SEED channel codes. Multiple codes are comma-separated.
-
appendToChannel
public FDSNDataSelectQueryParams appendToChannel(java.lang.String value)
-
clearQuality
public FDSNDataSelectQueryParams clearQuality()
-
setQuality
public FDSNDataSelectQueryParams setQuality(java.lang.String value)
Select a specific SEED quality indicator, handling is data center dependent.- Parameters:
value
- value to set- Returns:
- the queryParams for method chaining
-
clearMinimumLength
public FDSNDataSelectQueryParams clearMinimumLength()
-
setMinimumLength
public FDSNDataSelectQueryParams setMinimumLength(int value)
Limit results to continuous data segments of a minimum length specified in seconds.- Parameters:
value
- value to set- Returns:
- the queryParams for method chaining
-
clearLongestOnly
public FDSNDataSelectQueryParams clearLongestOnly()
-
setLongestOnly
public FDSNDataSelectQueryParams setLongestOnly(boolean value)
Limit results to the longest continuous segment per channel.- Parameters:
value
- value to set- Returns:
- the queryParams for method chaining
-
createChannelTimeWindow
public java.util.List<ChannelTimeWindow> createChannelTimeWindow()
Forms the list of ChannelTimeWindow for use in a POST request to the web service. All possible combinations of Networks, Stations and Channels are combined with the start and end times to form the list of ChannelTimeWindow.- Returns:
- List of Channels paired with the time window
-
formPostString
public java.lang.String formPostString()
-
formPostString
public java.lang.String formPostString(java.util.List<ChannelTimeWindow> request)
Forms the text for use in a POST request to the web service. Channel and time window are taken from the list of ChannelTimeWindow.- Returns:
-
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
-
-