org.myrobotlab.service

Class OpenWeatherMap

java.lang.Object

org.myrobotlab.framework.MessageService

org.myrobotlab.framework.Service

org.myrobotlab.service.HttpClient

org.myrobotlab.service.OpenWeatherMap

All Implemented Interfaces:

java.io.Serializable, java.lang.Runnable, Attachable, Invoker, LoggingSink, MessageSender, MessageSubscriber, NameProvider, NameTypeProvider, ServiceInterface, ServiceQueue, StateSaver, TypeProvider, HttpDataListener, HttpResponseListener, QueueReporter

public class OpenWeatherMap
extends HttpClient

A service to query into OpenWeatherMap to get the current weather. For more info check out http://openweathermap.org This service requires an API key that is free to register for from Open Weather Map.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static org.slf4j.Logger	log

Fields inherited from class org.myrobotlab.framework.Service

cfgDir, dnaPool, MESSAGE_RECORDING_FORMAT_BINARY, MESSAGE_RECORDING_FORMAT_XML

Constructor Summary

Constructors

Constructor and Description
OpenWeatherMap(java.lang.String reservedKey)

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	fetchForecast(java.lang.String location) retrieve a string list of weather for the period indicated by hourPeriod 1 >= hourPeriod is 3 hours per index -> 24 hours is 8.
java.lang.String[]	fetchForecast(java.lang.String location, int hourPeriod)
java.lang.String	fetchWeather(java.lang.String location) Deprecated.
java.lang.String	getApiBase()
java.lang.String	getApiKey()
static ServiceType	getMetaData() This static method returns all the details of the class without it having to be constructed.
java.lang.String	getUnits()
static void	main(java.lang.String[] args)
void	setApiBase(java.lang.String apiBase)
void	setApiKey(java.lang.String apiKey)
void	setLang(java.lang.String lang)
void	setUnits(java.lang.String units)

Methods inherited from class org.myrobotlab.service.HttpClient

addFormField, addHttpDataListener, addHttpResponseListener, clearForm, get, getBytes, onHttpData, onHttpResponse, post, post, postBytes, processResponse, publishHttpData, publishHttpResponse, startService

Methods inherited from class org.myrobotlab.framework.Service

addListener, addListener, addTask, addTask, addTask, addTaskOneShot, allowDisplay, allowDisplay, attach, attach, broadcastState, buildDna, buildDna, buildDnaKeys, buildDnaNames, clearLastError, close, containsTask, copyShallowFrom, createPeer, createPeer, createRootReserved, detach, detach, detach, echoHeartbeat, error, error, error, getAttached, getCfgDir, getComm, getDeclaredMethodNames, getDeclaredMethods, getDescription, getDna, getDnaString, getHostName, getInbox, getInstanceId, getIntanceName, getInterfaceSet, getLastError, getMessageSet, getMetaData, getMethodMap, getMethodNames, getMethods, getMethodToolTip, getMsg, getName, getNotifyList, getNotifyListKeySet, getOutbox, getPeerKey, getPeerName, getServiceResourceFile, getSimpleName, getTasks, getThisThread, getType, hasError, hasPeers, help, help, in, info, info, invoke, invoke, invoke, invokeOn, isAttached, isAttached, isLocal, isReady, isRunning, isRuntime, isVirtual, load, load, logTimeEnable, mergeDna, mergeDna, mergePeerDna, movePeerDna, out, out, preProcessHook, preRoutingHook, publishError, publishQueueStats, publishState, publishStats, publishStatus, purgeTask, purgeTasks, releasePeers, releaseService, removeAllListeners, removeListener, requiresSecurity, reserve, reserve, reserveRoot, reserveRoot, reserveRootAs, run, save, save, save, send, send, send, send, sendBlocking, sendBlocking, sendBlocking, sendBlocking, sendPeer, setInstanceId, setName, setPeer, setSecurityProvider, setState, setThisThread, setVirtual, sleep, stackToString, startHeartbeat, startPeer, startPeer, startRecording, stopHeartbeat, stopMsgRecording, stopService, subscribe, subscribe, subscribe, toString, unsubscribe, unsubscribe, unsubscribe, updateStats, warn, warn

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

log

public static final org.slf4j.Logger log

Constructor Detail

OpenWeatherMap

public OpenWeatherMap(java.lang.String reservedKey)

Method Detail

fetchForecast

public java.lang.String[] fetchForecast(java.lang.String location)
                                 throws org.apache.http.client.ClientProtocolException,
                                        java.io.IOException,
                                        org.json.JSONException

retrieve a string list of weather for the period indicated by hourPeriod 1 >= hourPeriod is 3 hours per index -> 24 hours is 8. {"city":{"id":2802985,"name":"location","coord":{"lon":5.8581,"lat":50.7019},"country":"FR","population":0}, "cod":"200", "message":0.1309272, "cnt":3, "list":[ {"dt":1505386800, "temp":{"day":11.62,"min":10.59,"max":12.39,"night":11.01,"eve":10.59,"morn":10.98}, "pressure":1006.58, "humidity":100, "weather":[{"id":502,"main":"Rain","description":"heavy intensity rain","icon":"10d"}], "speed":6.73, "deg":259, "clouds":92, "rain":17.33}, {"dt":1505473200, "temp":{"day":14.96,"min":8.43,"max":14.96,"night":8.43,"eve":12.71,"morn":9.46}, "pressure":1014.87, "humidity":89, "weather":[{"id":500,"main":"Rain","description":"light rain","icon":"10d"}], "speed":4.8, "deg":249, "clouds":20, "rain":0.36}, {"dt":1505559600, "temp":{"day":13.85,"min":8.09,"max":14.5,"night":8.44,"eve":12.5,"morn":8.09}, "pressure":1013.37, "humidity":95, "weather":[{"id":501,"main":"Rain","description":"moderate rain","icon":"10d"}], "speed":5.38, "deg":241, "clouds":44, "rain":5.55} ]}

Throws:

org.json.JSONException

java.io.IOException

org.apache.http.client.ClientProtocolException

fetchForecast

public java.lang.String[] fetchForecast(java.lang.String location,
                                        int hourPeriod)
                                 throws org.apache.http.client.ClientProtocolException,
                                        java.io.IOException,
                                        org.json.JSONException

Throws:

org.apache.http.client.ClientProtocolException

java.io.IOException

org.json.JSONException

fetchWeather

@Deprecated
public java.lang.String fetchWeather(java.lang.String location)
                                          throws org.apache.http.client.ClientProtocolException,
                                                 java.io.IOException,
                                                 org.json.JSONException

Deprecated.

Throws:

org.apache.http.client.ClientProtocolException

java.io.IOException

org.json.JSONException

getApiBase

public java.lang.String getApiBase()

setApiBase

public void setApiBase(java.lang.String apiBase)

Parameters:

apiBase - The base url that is assocaited with the open weather map api.

getUnits

public java.lang.String getUnits()

setUnits

public void setUnits(java.lang.String units)

Parameters:

units - The units, can be either imperial or metric.

getApiKey

public java.lang.String getApiKey()

setApiKey

public void setApiKey(java.lang.String apiKey)

Parameters:

apiKey - REQUIRED: specify your API key with this method.

setLang

public void setLang(java.lang.String lang)

getMetaData

public static ServiceType getMetaData()

This static method returns all the details of the class without it having to be constructed. It has description, categories, dependencies, and peer definitions.

Returns:

ServiceType - returns all the data

main

public static void main(java.lang.String[] args)