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 Details

  • Constructor Details

    • FDSNStationQueryParams

      public FDSNStationQueryParams()

    • FDSNStationQueryParams

      public FDSNStationQueryParams​(java.lang.String host)

  • Method Details

    • clone

      public FDSNStationQueryParams clone()
      Overrides:
      clone in class java.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: AbstractQueryParams
      Service name as defined by the fdsn, ie event, station or dataselect.
      Specified by:
      getServiceName in class AbstractQueryParams