FIODataPoint (ForecastIO-Lib-Java 1.5.1 API)

java.lang.Object
- com.github.dvdme.ForecastIOLib.FIODataPoint

public class FIODataPoint
extends Object

Constructor Summary

Constructors
Constructor and Description

FIODataPoint()

FIODataPoint(com.eclipsesource.json.JsonObject dp)

Constructors
Constructor and Description
`FIODataPoint()`
`FIODataPoint(com.eclipsesource.json.JsonObject dp)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Double`	`apparentTemperature()` The apparent temperature at the given time using the units defined in the class ForecastIO.
`Double`	`apparentTemperatureMax()` The maximum apparent temperature expected for a given day the units defined in the class ForecastIO.
`String`	`apparentTemperatureMaxTime()` The time at which the apparent maximum temperature is expected to occur.
`Double`	`apparentTemperatureMin()` The minimum apparent temperature expected for a given day the units defined in the class ForecastIO.
`String`	`apparentTemperatureMinTime()` The time at with the minimum apparent temperature is expected to occur.
`Double`	`cloudCover()` A numerical value between 0 and 1 (inclusive) representing the percentage of sky occluded by clouds.
`Double`	`cloudCoverError()` A numerical the percentage of sky occluded by clouds error.
`Double`	`dewPoint()` The dew point for a given time with the units defined in the class ForecastIO.
`Double`	`dewPointError()` The dew point error for a given time with the units defined in the class ForecastIO.
`String`	`getByKey(String key)` Return the data point field with the corresponding key
`String`	`getFields()` Returns a String with all the Forecast.io field's available in this data point.
`String[]`	`getFieldsArray()` Returns a String array with all the Forecast.io fields available in this data point.
`String`	`getTimezone()` Allows to get the timezone in use
`Double`	`humidity()` A numerical value representing the relative humidity error.
`Double`	`humidityError()` A numerical value between 0 and 1 (inclusive) representing the relative humidity.
`String`	`icon()` Returns a machine-readable text summary of the data point, suitable for selecting an icon for display.
`Double`	`nearestStormBearing()` Nesrest Storm Bearing For more information refer to the API Docs: https://developer.forecast.io
`Double`	`nearestStormDistance()` Nesrest Storm Distance For more information refer to the API Docs: https://developer.forecast.io
`Double`	`ozone()` A numerical value representing the columnar density of total atmospheric ozone at the given time in Dobson units.
`Double`	`precipAccumulation()` The amount of snow fall accumulation expected to occur on the given day.
`Double`	`precipIntensity()` A numerical value representing the average expected intensity.
`Double`	`precipIntensityMax()` A numerical values representing the maximum expected intensity of precipitation.
`String`	`precipIntensityMaxTime()` A numerical values representing the time at which the maximum expected intensity of precipitation occurs.
`Double`	`precipProbability()` A numerical value between 0 and 1 (inclusive) representing the probability of precipitation occuring at the given time.
`String`	`precipType()` A string representing the type of precipitation occurring at the given time.
`Double`	`pressure()` A numerical value with the sea level pressure with the units defined in the class ForecastIO.
`Double`	`pressureError()` A numerical value with the sea level pressure error with the units defined in the class ForecastIO.
`void`	`setTimezone(String tz)` Allows to set the timezone.
`String`	`summary()` Returns a human-readable text summary of the data point.
`String`	`sunriseTime()` Returns the sunset time for the given day.
`String`	`sunsetTime()` Returns the sunrise time for the given day.
`Double`	`temperature()` The temperature at the given time using the units defined in the class ForecastIO.
`Double`	`temperatureError()` The temperature error at the given time using the units defined in the class ForecastIO.
`Double`	`temperatureMax()` The maximum temperature expected for a given day the units defined in the class ForecastIO.
`Double`	`temperatureMaxError()` The maximum temperature error expected for a given day the units defined in the class ForecastIO.
`String`	`temperatureMaxTime()` The time at which the maximum temperature is expected to occur.
`Double`	`temperatureMin()` The minimum temperature expected for a given day the units defined in the class ForecastIO.
`Double`	`temperatureMinError()` The minimum temperature error expected for a given day the units defined in the class ForecastIO.
`String`	`temperatureMinTime()` The time at with the minimum temperature is expected to occur.
`String`	`time()` Returns the time at which this data point occurs.
`Double`	`visibility()` A numerical value with the average visibility with the units defined in the class ForecastIO.
`Double`	`visibilityError()` A numerical value with the visibility error with the units defined in the class ForecastIO.
`Double`	`windBearing()` The wind direction for a given time in degrees.
`Double`	`windBearingError()` The wind direction error for a given time in degrees.
`Double`	`windSpeed()` The wind speed for a given time with the units defined in the class ForecastIO.
`Double`	`windSpeedError()` The wind speed error for a given time with the units defined in the class ForecastIO.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FIODataPoint
```
public FIODataPoint()
```
  - FIODataPoint
```
public FIODataPoint(com.eclipsesource.json.JsonObject dp)
```
- Method Detail
  - getFields
```
public String getFields()
```
    Returns a String with all the Forecast.io field's available in this data point.
    
    Returns:
    
    the String with the field's names.
    
    See Also:
    
    String
  - getFieldsArray
```
public String[] getFieldsArray()
```
    Returns a String array with all the Forecast.io fields available in this data point. It can be usefull to iterate over all available fields in a data point.
    
    Returns:
    
    the String array with the field's names.
  - setTimezone
```
public void setTimezone(String tz)
```
    Allows to set the timezone. If none is set, default is GMT.
    
    Parameters:
    
    tz - String with the timezone such as "GMT"
  - getTimezone
```
public String getTimezone()
```
    Allows to get the timezone in use
    
    Returns:
    
    String with the timezone
  - getByKey
```
public String getByKey(String key)
```
    Return the data point field with the corresponding key
    
    Parameters:
    
    key - name of the field in the data point
    
    Returns:
    
    the field value
  - time
```
public String time()
```
    Returns the time at which this data point occurs. For more information refer to the API Docs: https://developer.forecast.io
    
    Returns:
    
    An human-readable time string formated as [dd-MM-yyyy HH:mm:ss]. Returns "no data" if the field is not defined.
  - summary
```
public String summary()
```
    Returns a human-readable text summary of the data point. For more information refer to the API Docs: https://developer.forecast.io
    
    Returns:
    
    String with the summary text. Returns "no data" if the field is not defined.
  - icon
```
public String icon()
```
    Returns a machine-readable text summary of the data point, suitable for selecting an icon for display. For more information refer to the API Docs: https://developer.forecast.io
    
    Returns:
    
    String with the icon text. Returns "no data" if the field is not defined.
  - sunriseTime
```
public String sunriseTime()
```
    Returns the sunset time for the given day. For more information refer to the API Docs: https://developer.forecast.io
    
    Returns:
    
    An human-readable time string formated as [HH:mm:ss]. Returns "no data" if the field is not defined.
  - sunsetTime
```
public String sunsetTime()
```
    Returns the sunrise time for the given day. For more information refer to the API Docs: https://developer.forecast.io
    
    Returns:
    
    An human-readable time string formated as [HH:mm:ss]. Returns "no data" if the field is not defined.
  - precipIntensity
```
public Double precipIntensity()
```
    A numerical value representing the average expected intensity. For more information refer to the API Docs: https://developer.forecast.io
    
    Returns:
    
    A Double number with the precipitation intensity. Returns -1 if the field is not defined.
  - precipIntensityMax
```
public Double precipIntensityMax()
```
    A numerical values representing the maximum expected intensity of precipitation. For more information refer to the API Docs: https://developer.forecast.io
    
    Returns:
    
    A Double number with the maximum precipitation intensity. Returns -1 if the field is not defined.
  - precipIntensityMaxTime
```
public String precipIntensityMaxTime()
```
    A numerical values representing the time at which the maximum expected intensity of precipitation occurs. For more information refer to the API Docs: https://developer.forecast.io
    
    Returns:
    
    An human-readable time string formated as [HH:mm:ss] Returns "no data" if the field is not defined.
  - precipProbability
```
public Double precipProbability()
```
    A numerical value between 0 and 1 (inclusive) representing the probability of precipitation occuring at the given time. For more information refer to the API Docs: https://developer.forecast.io
    
    Returns:
    
    A Double number with the probabily. Returns -1 if the field is not defined.
  - precipType
```
public String precipType()
```
    A string representing the type of precipitation occurring at the given time. If defined, this property will have one of the following values: rain, snow, sleet or hail. For more information refer to the API Docs: https://developer.forecast.io
    
    Returns:
    
    A string with the type of precipitation Returns "no data" if the field is not defined.
  - precipAccumulation
```
public Double precipAccumulation()
```
    The amount of snow fall accumulation expected to occur on the given day. For more information refer to the API Docs: https://developer.forecast.io
    
    Returns:
    
    A Double number with the expected value. Returns -1 if the field is not defined.
  - temperature
```
public Double temperature()
```
    The temperature at the given time using the units defined in the class ForecastIO. For more information refer to the API Docs: https://developer.forecast.io
    
    Returns:
    
    A Double number with the temperature. Returns null if the field is not defined.
  - temperatureError
```
public Double temperatureError()
```
    The temperature error at the given time using the units defined in the class ForecastIO. For more information refer to the API Docs: https://developer.forecast.io
    
    Returns:
    
    A Double number with the temperature. Returns null if the field is not defined.
  - temperatureMin
```
public Double temperatureMin()
```
    The minimum temperature expected for a given day the units defined in the class ForecastIO. For more information refer to the API Docs: https://developer.forecast.io
    
    Returns:
    
    A Double number with the minimum temperature. Returns null if the field is not defined.
  - temperatureMinError
```
public Double temperatureMinError()
```
    The minimum temperature error expected for a given day the units defined in the class ForecastIO. For more information refer to the API Docs: https://developer.forecast.io
    
    Returns:
    
    A Double number with the minimum temperature. Returns null if the field is not defined.
  - temperatureMinTime
```
public String temperatureMinTime()
```
    The time at with the minimum temperature is expected to occur. For more information refer to the API Docs: https://developer.forecast.io
    
    Returns:
    
    An human-readable time string formated as [HH:mm:ss] Returns "no data" if the field is not defined.
  - temperatureMax
```
public Double temperatureMax()
```
    The maximum temperature expected for a given day the units defined in the class ForecastIO. For more information refer to the API Docs: https://developer.forecast.io
    
    Returns:
    
    A Double number with the maximum temperature. Returns null if the field is not defined.
  - temperatureMaxError
```
public Double temperatureMaxError()
```
    The maximum temperature error expected for a given day the units defined in the class ForecastIO. For more information refer to the API Docs: https://developer.forecast.io
    
    Returns:
    
    A Double number with the maximum temperature. Returns null if the field is not defined.
  - temperatureMaxTime
```
public String temperatureMaxTime()
```
    The time at which the maximum temperature is expected to occur. For more information refer to the API Docs: https://developer.forecast.io
    
    Returns:
    
    An human-readable time string formated as [HH:mm:ss] Returns "no data" if the field is not defined.
  - apparentTemperature
```
public Double apparentTemperature()
```
    The apparent temperature at the given time using the units defined in the class ForecastIO. For more information refer to the API Docs: https://developer.forecast.io
    
    Returns:
    
    A Double number with the apparentTemperature. Returns null if the field is not defined.
  - apparentTemperatureMin
```
public Double apparentTemperatureMin()
```
    The minimum apparent temperature expected for a given day the units defined in the class ForecastIO. For more information refer to the API Docs: https://developer.forecast.io
    
    Returns:
    
    A Double number with the minimum apparent temperature. Returns null if the field is not defined.
  - apparentTemperatureMinTime
```
public String apparentTemperatureMinTime()
```
    The time at with the minimum apparent temperature is expected to occur. For more information refer to the API Docs: https://developer.forecast.io
    
    Returns:
    
    An human-readable time string formated as [HH:mm:ss] Returns "no data" if the field is not defined.
  - apparentTemperatureMax
```
public Double apparentTemperatureMax()
```
    The maximum apparent temperature expected for a given day the units defined in the class ForecastIO. For more information refer to the API Docs: https://developer.forecast.io
    
    Returns:
    
    A Double number with the apparent maximum temperature. Returns null if the field is not defined.
  - apparentTemperatureMaxTime
```
public String apparentTemperatureMaxTime()
```
    The time at which the apparent maximum temperature is expected to occur. For more information refer to the API Docs: https://developer.forecast.io
    
    Returns:
    
    An human-readable time string formated as [HH:mm:ss] Returns "no data" if the field is not defined.
  - dewPoint
```
public Double dewPoint()
```
    The dew point for a given time with the units defined in the class ForecastIO. For more information refer to the API Docs: https://developer.forecast.io
    
    Returns:
    
    A Double number with the dew point. Returns -1 if the field is not defined.
  - dewPointError
```
public Double dewPointError()
```
    The dew point error for a given time with the units defined in the class ForecastIO. For more information refer to the API Docs: https://developer.forecast.io
    
    Returns:
    
    A Double number with the dew point. Returns -1 if the field is not defined.
  - windSpeed
```
public Double windSpeed()
```
    The wind speed for a given time with the units defined in the class ForecastIO. For more information refer to the API Docs: https://developer.forecast.io
    
    Returns:
    
    A Double number with the wind speed. Returns -1 if the field is not defined.
  - windSpeedError
```
public Double windSpeedError()
```
    The wind speed error for a given time with the units defined in the class ForecastIO. For more information refer to the API Docs: https://developer.forecast.io
    
    Returns:
    
    A Double number with the wind speed. Returns -1 if the field is not defined.
  - windBearing
```
public Double windBearing()
```
    The wind direction for a given time in degrees. For more information refer to the API Docs: https://developer.forecast.io
    
    Returns:
    
    A Double number with the wind direction. Returns -1 if the field is not defined.
  - windBearingError
```
public Double windBearingError()
```
    The wind direction error for a given time in degrees. For more information refer to the API Docs: https://developer.forecast.io
    
    Returns:
    
    A Double number with the wind direction. Returns -1 if the field is not defined.
  - cloudCover
```
public Double cloudCover()
```
    A numerical value between 0 and 1 (inclusive) representing the percentage of sky occluded by clouds. For more information refer to the API Docs: https://developer.forecast.io
    
    Returns:
    
    A Double number with the cloud cover. Returns -1 if the field is not defined.
  - cloudCoverError
```
public Double cloudCoverError()
```
    A numerical the percentage of sky occluded by clouds error. For more information refer to the API Docs: https://developer.forecast.io
    
    Returns:
    
    A Double number with the cloud cover. Returns -1 if the field is not defined.
  - humidity
```
public Double humidity()
```
    A numerical value representing the relative humidity error. For more information refer to the API Docs: https://developer.forecast.io
    
    Returns:
    
    A Double number with the humidity. Returns -1 if the field is not defined.
  - humidityError
```
public Double humidityError()
```
    A numerical value between 0 and 1 (inclusive) representing the relative humidity. For more information refer to the API Docs: https://developer.forecast.io
    
    Returns:
    
    A Double number with the humidity. Returns -1 if the field is not defined.
  - pressure
```
public Double pressure()
```
    A numerical value with the sea level pressure with the units defined in the class ForecastIO. For more information refer to the API Docs: https://developer.forecast.io
    
    Returns:
    
    A Double number with the pressure. Returns -1 if the field is not defined.
  - pressureError
```
public Double pressureError()
```
    A numerical value with the sea level pressure error with the units defined in the class ForecastIO. For more information refer to the API Docs: https://developer.forecast.io
    
    Returns:
    
    A Double number with the pressure. Returns -1 if the field is not defined.
  - visibility
```
public Double visibility()
```
    A numerical value with the average visibility with the units defined in the class ForecastIO. For more information refer to the API Docs: https://developer.forecast.io
    
    Returns:
    
    A Double number with the visibility. Returns null if the field is not defined.
  - visibilityError
```
public Double visibilityError()
```
    A numerical value with the visibility error with the units defined in the class ForecastIO. For more information refer to the API Docs: https://developer.forecast.io
    
    Returns:
    
    A Double number with the visibility. Returns null if the field is not defined.
  - ozone
```
public Double ozone()
```
    A numerical value representing the columnar density of total atmospheric ozone at the given time in Dobson units. For more information refer to the API Docs: https://developer.forecast.io
    
    Returns:
    
    A Double number with the ozone. Returns -1 if the field is not defined.
  - nearestStormBearing
```
public Double nearestStormBearing()
```
    Nesrest Storm Bearing For more information refer to the API Docs: https://developer.forecast.io
    
    Returns:
    
    A Double number with the ozone. Returns -1 if the field is not defined.
  - nearestStormDistance
```
public Double nearestStormDistance()
```
    Nesrest Storm Distance For more information refer to the API Docs: https://developer.forecast.io
    
    Returns:
    
    A Double number with the ozone. Returns -1 if the field is not defined.

Class FIODataPoint

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FIODataPoint

FIODataPoint

Method Detail

getFields

getFieldsArray

setTimezone

getTimezone

getByKey

time

summary

icon

sunriseTime

sunsetTime

precipIntensity

precipIntensityMax

precipIntensityMaxTime

precipProbability

precipType

precipAccumulation

temperature

temperatureError

temperatureMin

temperatureMinError

temperatureMinTime

temperatureMax

temperatureMaxError

temperatureMaxTime

apparentTemperature

apparentTemperatureMin

apparentTemperatureMinTime

apparentTemperatureMax

apparentTemperatureMaxTime

dewPoint

dewPointError

windSpeed

windSpeedError

windBearing

windBearingError

cloudCover

cloudCoverError

humidity

humidityError

pressure

pressureError

visibility

visibilityError

ozone

nearestStormBearing

nearestStormDistance