edu.iris.dmc.criteria
Class StationCriteria

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

public class StationCriteria
extends Object
implements Criteria

StationCriteria is a simple criteria builder to retrieve networks


Constructor Summary
StationCriteria()
           
 
Method Summary
 StationCriteria addChannel(String channel)
          Add channel restriction to constrain the result.
 StationCriteria addLocation(String location)
          Add location restriction to constrain the result.
 StationCriteria addNetwork(String netCode)
          Add network restriction to constrain the result.
 StationCriteria addStation(String staCode)
          Add station restriction to constrain the result.
 String[] getChannels()
           
 Date getEndAfter()
           
 Date getEndBefore()
           
 Date getEndTime()
           
 String[] getLocations()
           
 String[] getNetworks()
           
 Date getStartAfter()
           
 Date getStartBefore()
           
 Date getStartTime()
           
 String[] getStations()
           
 Date getUpdatedAfter()
           
 boolean isIncludeAvailability()
           
 boolean isIncludeRestricted()
           
 boolean isMatchTimeSeries()
           
 void reset()
          Will reset the criteria object to its defaults clearing all other properties.
 StationCriteria setEndAfter(Date date)
           
 StationCriteria setEndBefore(Date date)
           
 StationCriteria setEndTime(Date end)
           
 void setIncludeAvailability(boolean includeAvailability)
           
 void setIncludeRestricted(boolean includeRestricted)
           
 StationCriteria setLatitude(Double latitude)
          Set latitude in degrees, used in combination with radius
 StationCriteria setLongitude(Double longitude)
          Set longitude in degrees, used in combination with radius
 void setMatchTimeSeries(boolean matchTimeSeries)
           
 StationCriteria setMaximumLatitude(Double maximumLatitude)
          Set maximum latitude in degrees
 StationCriteria setMaximumLongitude(Double maximumLongitude)
          Set maximum longitude in degrees
 StationCriteria setMaximumRadius(Double maximumRadius)
          Set the maximum radius in degrees
 StationCriteria setMinimumLatitude(Double minimumLatitude)
          Set minimum latitude in degrees
 StationCriteria setMinimumLongitude(Double minimumLongitude)
          Set minimum longitude in degrees
 StationCriteria setMinimumRadius(Double minimumRadius)
          Set the minimum radius in degrees
 StationCriteria setStartAfter(Date date)
           
 StationCriteria setStartBefore(Date date)
           
 StationCriteria setStartTime(Date start)
           
 StationCriteria setUpdatedAfter(Date updatedAfter)
          Set when were stations last updated
 String toString()
           
 List<String> toUrlParams()
          Constructs url's parameters
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

StationCriteria

public StationCriteria()
Method Detail

setMinimumLatitude

public StationCriteria setMinimumLatitude(Double minimumLatitude)
Set minimum latitude in degrees

Parameters:
minimumLatitude -
Returns:

setMaximumLatitude

public StationCriteria setMaximumLatitude(Double maximumLatitude)
Set maximum latitude in degrees

Parameters:
maximumLatitude -
Returns:

setMinimumLongitude

public StationCriteria setMinimumLongitude(Double minimumLongitude)
Set minimum longitude in degrees

Parameters:
miniumumLonitude -
Returns:

setMaximumLongitude

public StationCriteria setMaximumLongitude(Double maximumLongitude)
Set maximum longitude in degrees

Parameters:
maximumLongitude -
Returns:

setUpdatedAfter

public StationCriteria setUpdatedAfter(Date updatedAfter)
Set when were stations last updated

Parameters:
updatedAfter -
Returns:

setLatitude

public StationCriteria setLatitude(Double latitude)
Set latitude in degrees, used in combination with radius

Parameters:
latitude -
Returns:

setLongitude

public StationCriteria setLongitude(Double longitude)
Set longitude in degrees, used in combination with radius

Parameters:
longitude -
Returns:

setMinimumRadius

public StationCriteria setMinimumRadius(Double minimumRadius)
Set the minimum radius in degrees

Parameters:
minumumRadius -
Returns:

setMaximumRadius

public StationCriteria setMaximumRadius(Double maximumRadius)
Set the maximum radius in degrees

Parameters:
maximumRadius -
Returns:

setStartTime

public StationCriteria setStartTime(Date start)

setEndTime

public StationCriteria setEndTime(Date end)

getStartTime

public Date getStartTime()

getEndTime

public Date getEndTime()

isIncludeAvailability

public boolean isIncludeAvailability()

setIncludeAvailability

public void setIncludeAvailability(boolean includeAvailability)

isIncludeRestricted

public boolean isIncludeRestricted()

setIncludeRestricted

public void setIncludeRestricted(boolean includeRestricted)

isMatchTimeSeries

public boolean isMatchTimeSeries()

setMatchTimeSeries

public void setMatchTimeSeries(boolean matchTimeSeries)

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

addStation

public StationCriteria addStation(String staCode)
Add station restriction to constrain the result. Wild card (* ?) accepted. This method can be chained.

Parameters:
staCode -
Returns:

addNetwork

public StationCriteria addNetwork(String netCode)
Add network restriction to constrain the result. Wild card (* ?) accepted. This method can be chained.

Parameters:
netCode -
Returns:

addChannel

public StationCriteria addChannel(String channel)
Add channel restriction to constrain the result. Wild card (* ?) accepted. This method can be chained.

Parameters:
channel -
Returns:

addLocation

public StationCriteria addLocation(String location)
Add location restriction to constrain the result. Wild card (* ?) accepted. This method can be chained.

Parameters:
location -
Returns:
criteria

setEndBefore

public StationCriteria setEndBefore(Date date)

setEndAfter

public StationCriteria setEndAfter(Date date)

setStartBefore

public StationCriteria setStartBefore(Date date)

setStartAfter

public StationCriteria setStartAfter(Date date)

reset

public void reset()
Will reset the criteria object to its defaults clearing all other properties.

Specified by:
reset in interface Criteria

getStartBefore

public Date getStartBefore()

getStartAfter

public Date getStartAfter()

getEndBefore

public Date getEndBefore()

getEndAfter

public Date getEndAfter()

getUpdatedAfter

public Date getUpdatedAfter()

getNetworks

public String[] getNetworks()

getStations

public String[] getStations()

getChannels

public String[] getChannels()

getLocations

public String[] getLocations()

toString

public String toString()
Overrides:
toString in class Object


Copyright © 2013. All Rights Reserved.