edu.iris.dmc.criteria
Class EventCriteria

java.lang.Object
  extended by edu.iris.dmc.criteria.EventCriteria
All Implemented Interfaces:
Criteria

public class EventCriteria
extends Object
implements Criteria

EventCriteria is a simple criteria builder to retrieve events


Constructor Summary
EventCriteria()
           
 
Method Summary
 void add(String key, String value)
          Introduce new key/value parameters
 EventCriteria includeAllMagnitudes(boolean includeAllMagnitudes)
          This will include all the magnitudes in search and print criteria.
 EventCriteria includeAllOrigins(boolean includeAllOrigins)
          This will include all the magnitudes in search and print criteria.
 EventCriteria includeArrivals(boolean includeArrivals)
          This will include all the arrival information including picks.
 EventCriteria orderBy(EventOrder orderBy)
           
 void reset()
          Will reset the criteria to its defaults
 EventCriteria setCatalog(String catalog)
          Results will include any origins which contain the specified catalog text, i.e.
 EventCriteria setContributor(String contributor)
          Results will include any origins which contain the specified contributor text, i.e.
 EventCriteria setEndTime(Date endTime)
           
 EventCriteria setEventId(String id)
           
 EventCriteria setFetchLimit(Integer limit)
          Limit the number of events retrieved depending on the orderBy attribute
 EventCriteria setLatitude(Double latitude)
          This MUST be used in conjunction with the setLongitude and setMaximumRadius parameters.
 EventCriteria setLongitude(Double longitude)
          This MUST be used in conjunction with the setLatitude and setMaximumRadius parameters.
 EventCriteria setMagnitudeType(String magnitudeType)
          Specify magnitude type.
 EventCriteria setMaximumDepth(Double maximumDepth)
          Set maximum depth in kilometers
 EventCriteria setMaximumLatitude(Double maximumLatitude)
          In degrees
 EventCriteria setMaximumLongitude(Double maximumLongitude)
          In degrees
 EventCriteria setMaximumMagnitude(Double maximumMagnitude)
           
 EventCriteria setMaximumRadius(Double maximumRadius)
          Specify the maximum radius, in degrees.
 EventCriteria setMinimumDepth(Double minumumDepth)
          Set minimum Depth in kilometers
 EventCriteria setMinimumLatitude(Double minimumLatitude)
          In degrees
 EventCriteria setMinimumLongitude(Double minimumLongitude)
          In degrees
 EventCriteria setMinimumMagnitude(Double minimumMagnitude)
           
 EventCriteria setMinimumRadius(Double minumumRadius)
          This optional parameter allows for the exclusion of events that are closer than minumumRadius degrees from the specified lat/lon point.
 EventCriteria setOffset(Integer offset)
          mark the first event offset
 EventCriteria setStartTime(Date startTime)
           
 EventCriteria setUpdatedAfter(Date updatedAfter)
          Set when origins were last updated
 List<String> toUrlParams()
          Constructs url's parameters
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

EventCriteria

public EventCriteria()
Method Detail

setStartTime

public EventCriteria setStartTime(Date startTime)

setEndTime

public EventCriteria setEndTime(Date endTime)

setUpdatedAfter

public EventCriteria setUpdatedAfter(Date updatedAfter)
Set when origins were last updated

Parameters:
updatedAfter -
Returns:

setFetchLimit

public EventCriteria setFetchLimit(Integer limit)
Limit the number of events retrieved depending on the orderBy attribute

Parameters:
numberOfEvents -
Returns:

setOffset

public EventCriteria setOffset(Integer offset)
mark the first event offset

Parameters:
offset -
Returns:

orderBy

public EventCriteria orderBy(EventOrder orderBy)

setMagnitudeType

public EventCriteria setMagnitudeType(String magnitudeType)
Specify magnitude type. Some common types (there are many) include:Ml - local (Richter) magnitude, Ms - surface magnitude, mb - body wave magnitude, Mw - moment magnitude

Parameters:
magnitudeType -
Returns:

setCatalog

public EventCriteria setCatalog(String catalog)
Results will include any origins which contain the specified catalog text, i.e. "PDE" will match "NEIC PDE"

Parameters:
catalog -
Returns:
the criteria

setContributor

public EventCriteria setContributor(String contributor)
Results will include any origins which contain the specified contributor text, i.e. "NEIC" will match "NEIC PDE-Q".

Parameters:
contributor -
Returns:
the criteria

includeAllMagnitudes

public EventCriteria includeAllMagnitudes(boolean includeAllMagnitudes)
This will include all the magnitudes in search and print criteria. If magnitudes do not exist for a certain origin, the search algorithm will consider it a miss and therefore will not include the event. Default=true

Parameters:
includeallMagnitudes -
Returns:
the criteria

includeAllOrigins

public EventCriteria includeAllOrigins(boolean includeAllOrigins)
This will include all the magnitudes in search and print criteria. If magnitudes do not exist for a certain origin, the search algorithm will consider it a miss and therefore will not include the event. Default=true

Parameters:
includeallMagnitudes -
Returns:
the criteria

includeArrivals

public EventCriteria includeArrivals(boolean includeArrivals)
This will include all the arrival information including picks. Default=false

Parameters:
includeallMagnitudes -
Returns:
the criteria

setLatitude

public EventCriteria setLatitude(Double latitude)
This MUST be used in conjunction with the setLongitude and setMaximumRadius parameters.

Parameters:
latitude -
Returns:
the criteria

setLongitude

public EventCriteria setLongitude(Double longitude)
This MUST be used in conjunction with the setLatitude and setMaximumRadius parameters.

Parameters:
longitude -
Returns:
the criteria

setMinimumRadius

public EventCriteria setMinimumRadius(Double minumumRadius)
This optional parameter allows for the exclusion of events that are closer than minumumRadius degrees from the specified lat/lon point. This MUST be used in conjunction with the lat, lon, and maximumRadius parameters and is subject to the same restrictions. If this parameter isn't specified, then it defaults to 0.0 degrees.

Parameters:
minimumRadius -
Returns:
the criteria

setMaximumRadius

public EventCriteria setMaximumRadius(Double maximumRadius)
Specify the maximum radius, in degrees. Only earthquakes within maximumRadius degrees of the lat/lon point will be retrieved. This MUST be used in conjunction with the lat and lon parameters.

Parameters:
maximumRadius -
Returns:
the criteria

setMinimumDepth

public EventCriteria setMinimumDepth(Double minumumDepth)
Set minimum Depth in kilometers

Parameters:
minimumDepth -
Returns:
the criteria

setMaximumDepth

public EventCriteria setMaximumDepth(Double maximumDepth)
Set maximum depth in kilometers

Parameters:
maximumDepth -
Returns:
the criteria

setEventId

public EventCriteria setEventId(String id)

setMinimumMagnitude

public EventCriteria setMinimumMagnitude(Double minimumMagnitude)

setMaximumMagnitude

public EventCriteria setMaximumMagnitude(Double maximumMagnitude)

setMinimumLatitude

public EventCriteria setMinimumLatitude(Double minimumLatitude)
In degrees

Parameters:
minimumLatitude -
Returns:
the criteria

setMaximumLatitude

public EventCriteria setMaximumLatitude(Double maximumLatitude)
In degrees

Parameters:
maximumLatitude -
Returns:
the criteria

setMinimumLongitude

public EventCriteria setMinimumLongitude(Double minimumLongitude)
In degrees

Parameters:
minimumLongitude -
Returns:
the criteria

setMaximumLongitude

public EventCriteria setMaximumLongitude(Double maximumLongitude)
In degrees

Parameters:
maximumLongitude -
Returns:
the criteria

add

public void add(String key,
                String value)
Introduce new key/value parameters

Parameters:
key -
value -

toUrlParams

public List<String> toUrlParams()
                         throws CriteriaException
Description copied from interface: Criteria
Constructs url's parameters

Specified by:
toUrlParams in interface Criteria
Returns:
Throws:
CriteriaException

reset

public void reset()
Description copied from interface: Criteria
Will reset the criteria to its defaults

Specified by:
reset in interface Criteria


Copyright © 2013. All Rights Reserved.