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 Details

  • Constructor Details

    • FDSNEventQueryParams

      public FDSNEventQueryParams()

    • FDSNEventQueryParams

      public FDSNEventQueryParams​(java.lang.String host)

  • Method Details

    • clone

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