com.brein.domain.results

Class BreinTemporalDataResult

java.lang.Object

com.brein.domain.BreinResult

com.brein.domain.results.BreinTemporalDataResult

public class BreinTemporalDataResult
extends BreinResult

The parsed data returned from a Temporal Data request.

Constructor Summary

Constructors

Constructor and Description
BreinTemporalDataResult(BreinResult result) Build the result based on the result
BreinTemporalDataResult(java.util.Map<java.lang.String,java.lang.Object> json) Build the result based on the returned json

Method Summary

Modifier and Type	Method and Description
java.time.LocalDateTime	getEpochDateTime()
java.util.List<BreinEventResult>	getEvents()
java.util.List<BreinHolidayResult>	getHolidays()
java.time.ZonedDateTime	getLocalDateTime()
BreinLocationResult	getLocation()
BreinWeatherResult	getWeather()
boolean	hasEpochDateTime()
boolean	hasEvents()
boolean	hasHolidays()
boolean	hasLocalDateTime()
boolean	hasLocation()
boolean	hasWeather()
java.lang.String	toString()

Methods inherited from class com.brein.domain.BreinResult

get, getMap, getMessage, getNestedValue, getStatus, getValue, has, hasNestedValue, hasValue, setStatus

Methods inherited from class java.lang.Object

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

Constructor Detail

BreinTemporalDataResult

public BreinTemporalDataResult(java.util.Map<java.lang.String,java.lang.Object> json)

Build the result based on the returned json

Parameters:

json - the result from the query, parsed into a Map

BreinTemporalDataResult

public BreinTemporalDataResult(BreinResult result)

Build the result based on the result

Parameters:

result - the result from a request to the api

Method Detail

hasWeather

public boolean hasWeather()

getWeather

public BreinWeatherResult getWeather()

Returns:

The weather for the time and location requested.

hasLocalDateTime

public boolean hasLocalDateTime()

getLocalDateTime

public java.time.ZonedDateTime getLocalDateTime()

Returns:

The time localized to the resolved location

hasEpochDateTime

public boolean hasEpochDateTime()

getEpochDateTime

public java.time.LocalDateTime getEpochDateTime()

Returns:

The time in UTC

hasLocation

public boolean hasLocation()

getLocation

public BreinLocationResult getLocation()

Returns:

The resolved location for the supplied request

hasHolidays

public boolean hasHolidays()

getHolidays

public java.util.List<BreinHolidayResult> getHolidays()

Returns:

Holidays happening at the resolved time

hasEvents

public boolean hasEvents()

getEvents

public java.util.List<BreinEventResult> getEvents()

Returns:

Events happening at the resolved location around the specified time

toString

public java.lang.String toString()

Overrides:

toString in class BreinResult