io.relayr.java.api.helpers

Class AggregatedDataHelper

java.lang.Object

io.relayr.java.api.helpers.AggregatedDataHelper

public class AggregatedDataHelper
extends java.lang.Object

Wraps History API and provides additional functionalities like 1. fetching latest data by minute, hour or day 2. fetching range of history points

Method Summary

Modifier and Type	Method and Description
AggregatedDataService	getApi()
rx.Observable<AggregatedData>	getForRange(long start, long end) Returns average readings aggregated in 5 minute interval for defined range
rx.Observable<AggregatedData>	getForRange(long start, long end, java.lang.String meaning) Returns average readings aggregated in 5 minute interval for defined range filtered by meaning
rx.Observable<AggregatedData>	getForRange(long start, long end, java.lang.String meaning, Aggregates.Interval interval) Returns average readings aggregated in specified interval for defined range filtered by meaning
rx.Observable<AggregatedData>	getForRange(long start, long end, java.lang.String meaning, java.lang.String path, Aggregates.Interval interval, Aggregates.Aggregate[] aggregates) Returns aggregated readings, filtered by meaning and path, for defined range and with defined interval
rx.Observable<AggregatedData>	getLatest(int time, java.util.concurrent.TimeUnit unit) Returns all aggregated readings for deviceId starting 'time' units ago.
rx.Observable<AggregatedData>	getLatest(java.lang.String path, java.lang.String meaning, int time, java.util.concurrent.TimeUnit unit) q Return latest results starting 'time' units ago.
rx.Observable<AggregatedData>	getLatest(java.lang.String path, java.lang.String meaning, int time, java.util.concurrent.TimeUnit unit, Aggregates.Interval interval, Aggregates.Aggregate[] aggregates) Return latest results starting 'time' units ago.
static AggregatedDataHelper	init(java.lang.String deviceId)

Methods inherited from class java.lang.Object

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

Method Detail

init

public static AggregatedDataHelper init(java.lang.String deviceId)

Parameters:

deviceId - - device identificator

Returns:

AggregatedDataHelper for specified device

getLatest

public rx.Observable<AggregatedData> getLatest(int time,
                                               java.util.concurrent.TimeUnit unit)
                                        throws java.lang.IllegalArgumentException

Returns all aggregated readings for deviceId starting 'time' units ago. For example getLatest(5, TimeUnit.MINUTES) returns all history results in past 5 minutes. Valid time units are: TimeUnit.SECONDS,TimeUnit.MINUTES, TimeUnit.HOURS, TimeUnit.DAYS

Parameters:

time - - number of time units

unit - - time unit

Throws:

java.lang.IllegalArgumentException

getLatest

public rx.Observable<AggregatedData> getLatest(java.lang.String path,
                                               java.lang.String meaning,
                                               int time,
                                               java.util.concurrent.TimeUnit unit)
                                        throws java.lang.IllegalArgumentException

q Return latest results starting 'time' units ago. For example getLatest(5, TimeUnit.MINUTES) returns all history results in past 5 minutes. Valid time units are: TimeUnit.SECONDS,TimeUnit.MINUTES, TimeUnit.HOURS, TimeUnit.DAYS Warning: Sample is not supported with complex data, but only with Integer, Number and Boolean values

Parameters:

time - - number of time units

unit - - time unit

meaning - device reading meaning Reading.meaning - optional

path - device reading path Reading.path - optional

Throws:

java.lang.IllegalArgumentException

getLatest

public rx.Observable<AggregatedData> getLatest(java.lang.String path,
                                               java.lang.String meaning,
                                               int time,
                                               java.util.concurrent.TimeUnit unit,
                                               Aggregates.Interval interval,
                                               Aggregates.Aggregate[] aggregates)
                                        throws java.lang.IllegalArgumentException

Return latest results starting 'time' units ago. For example getLatest(5, TimeUnit.MINUTES) returns all history results in past 5 minutes. Valid time units are: TimeUnit.SECONDS,TimeUnit.MINUTES, TimeUnit.HOURS, TimeUnit.DAYS Warning: Sample is not supported with complex data, but only with Integer, Number and Boolean values

Parameters:

path - - device reading path Reading.path - optional

meaning - - device reading meaning Reading.meaning - optional

time - - number of time units

unit - - time unit

interval - - Aggregates.Interval

aggregates - - Aggregates.Aggregate

Throws:

java.lang.IllegalArgumentException

getForRange

public rx.Observable<AggregatedData> getForRange(long start,
                                                 long end)
                                          throws java.lang.IllegalArgumentException

Returns average readings aggregated in 5 minute interval for defined range

Parameters:

start - - UTC timestamp in milliseconds

end - - UTC timestamp in milliseconds

Throws:

java.lang.IllegalArgumentException

getForRange

public rx.Observable<AggregatedData> getForRange(long start,
                                                 long end,
                                                 java.lang.String meaning)
                                          throws java.lang.IllegalArgumentException

Returns average readings aggregated in 5 minute interval for defined range filtered by meaning

Parameters:

start - - UTC timestamp in milliseconds

end - - UTC timestamp in milliseconds

meaning - device reading meaning Reading.meaning - optional

Throws:

java.lang.IllegalArgumentException

getForRange

public rx.Observable<AggregatedData> getForRange(long start,
                                                 long end,
                                                 java.lang.String meaning,
                                                 Aggregates.Interval interval)
                                          throws java.lang.IllegalArgumentException

Returns average readings aggregated in specified interval for defined range filtered by meaning

Parameters:

start - - UTC timestamp in milliseconds

end - - UTC timestamp in milliseconds

meaning - device reading meaning Reading.meaning - optional

Throws:

java.lang.IllegalArgumentException

getForRange

public rx.Observable<AggregatedData> getForRange(long start,
                                                 long end,
                                                 java.lang.String meaning,
                                                 java.lang.String path,
                                                 Aggregates.Interval interval,
                                                 Aggregates.Aggregate[] aggregates)
                                          throws java.lang.IllegalArgumentException

Returns aggregated readings, filtered by meaning and path, for defined range and with defined interval

Parameters:

start - - UTC timestamp in milliseconds

end - - UTC timestamp in milliseconds

meaning - device reading meaning Reading.meaning - optional

path - device reading path Reading.path - optional

Throws:

java.lang.IllegalArgumentException

getApi

public AggregatedDataService getApi()

Returns:

AggregatedDataService object.