org.kepler.gis.actor.pylaski

Class PylaskiUtilities.Settings

java.lang.Object

org.kepler.gis.actor.pylaski.PylaskiUtilities.Settings

Enclosing class:

PylaskiUtilities

public static class PylaskiUtilities.Settings
extends java.lang.Object

Configure settings for sending REST API requests.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	host

Constructor Summary

Constructors

Constructor and Description
Settings() Constructor

Method Summary

Modifier and Type	Method and Description
void	addObservable(java.lang.String observable) Adds an observable to be requested from the API.
java.net.URI	getDataURI() Generates the REST URI for retrieving past and present observable data.
java.net.URI	getForecastURI() Generates the REST URI for retrieving future/forecast observable data.
java.net.URI	getForecastURI(boolean hrrrx) Generates the REST URI for retrieving future/forecast observable data.
PylaskiUtilities.Selection	getSelectionType() The selection type (inferred from the location settings).
void	removeDate() Removes the date range filter.
void	removeObservable(java.lang.String observable) Removes a previously added observable.
void	setDate(java.util.Date at) Sets the date around a central time.
void	setDate(java.util.Date from, java.util.Date to) Sets the date range for data search.
void	setDate(java.util.Date at, int buffer) Sets the date around a central time.
void	setLocation(double lat, double lon) Sets the location to a single coordinate.
void	setLocation(double lat, double lon, double radius) Sets the location to within a radius around a single coordinate.
void	setLocation(double minLat, double minLon, double maxLat, double maxLon) Sets the location to within a rectangle.
void	setObservables(java.lang.String[] observables) Sets the list of observables.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

host

public java.lang.String host

Constructor Detail

Settings

public Settings()

Constructor

Method Detail

getSelectionType

public PylaskiUtilities.Selection getSelectionType()

The selection type (inferred from the location settings).

Returns:

Selection enum

setLocation

public void setLocation(double lat,
                        double lon)

Sets the location to a single coordinate. This creates a "closest to" selection search.

Parameters:

lat - Latitude

lon - Longitude

setLocation

public void setLocation(double lat,
                        double lon,
                        double radius)

Sets the location to within a radius around a single coordinate. This creates a "within radius" selection search.

Parameters:

lat - Latitude

lon - Longitude

radius - Radius (in meters)

setLocation

public void setLocation(double minLat,
                        double minLon,
                        double maxLat,
                        double maxLon)

Sets the location to within a rectangle. This creates a "bounding box" selection search.

Parameters:

minLat - Minimum latitude

minLon - Minimum longitude

maxLat - Maximum latitude

maxLon - Maximum longitude

setDate

public void setDate(java.util.Date from,
                    java.util.Date to)
             throws java.lang.Exception

Sets the date range for data search. If the "to" date exceeds the current date, a forecast URI will be possible to generate (see below). If both "from" and "to" dates excee the current date, a data URI will not be possible to generate.

Parameters:

from - A date object to search from

to - A date object to search to - must be after the "from" date

Throws:

java.lang.Exception - Raised if "to" date is at or before the "from" date

setDate

public void setDate(java.util.Date at,
                    int buffer)
             throws java.lang.Exception

Sets the date around a central time.

Parameters:

at - A date object to search around

buffer - A buffer to pad the date with (in milliseconds)

Throws:

java.lang.Exception - An exception that should never be raised when using this particular method

setDate

public void setDate(java.util.Date at)
             throws java.lang.Exception

Sets the date around a central time. Uses a default buffer of +/- 2 hours.

Parameters:

at - A date object to search around

Throws:

java.lang.Exception - An exception that should never be raised when using this particular method

removeDate

public void removeDate()

Removes the date range filter. This will result in the REST API returning the latest readings.

addObservable

public void addObservable(java.lang.String observable)

Adds an observable to be requested from the API.

Parameters:

observable - An observable as a string - refer to the Pylaski documentation (link above)

removeObservable

public void removeObservable(java.lang.String observable)

Removes a previously added observable.

Parameters:

observable - An observable as a string

setObservables

public void setObservables(java.lang.String[] observables)

Sets the list of observables.

Parameters:

observables - A list of observables - refer to the Pylaski documentation (link above)

getDataURI

public java.net.URI getDataURI()
                        throws java.net.URISyntaxException

Generates the REST URI for retrieving past and present observable data.

Returns:

A request URI

Throws:

java.net.URISyntaxException - If the URI is invalid

getForecastURI

public java.net.URI getForecastURI(boolean hrrrx)
                            throws java.net.URISyntaxException

Generates the REST URI for retrieving future/forecast observable data.

Parameters:

hrrrx - Whether to use the HRRRx forecast data

Returns:

A request URI

Throws:

java.net.URISyntaxException - If the URI is invalid

getForecastURI

public java.net.URI getForecastURI()
                            throws java.net.URISyntaxException

Generates the REST URI for retrieving future/forecast observable data. Defaults the HRRRx setting to false.

Returns:

A request URI

Throws:

java.net.URISyntaxException - If the URI is invalid