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 Details

  • Constructor Details

    • FDSNDataSelectQueryParams

      public FDSNDataSelectQueryParams()

    • FDSNDataSelectQueryParams

      public FDSNDataSelectQueryParams​(java.lang.String host)

  • Method Details

    • clone

      public FDSNDataSelectQueryParams clone()
      Overrides:
      clone in class java.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 class AbstractQueryParams