com.siemens.mindsphere.sdk.iot.timeseries.iterator.model

Class TimeseriesPageIterator

Object

TimeseriesPageIterator

All Implemented Interfaces:

PageIterator<List<TimeseriesData>>

public class TimeseriesPageIterator
extends Object
implements PageIterator<List<TimeseriesData>>

Field Summary

Fields inherited from interface PageIterator

DEFAULT_PAGE_NUMBER, DEFAULT_PAGE_SIZE

Constructor Summary

Constructors

Constructor and Description
TimeseriesPageIterator(TimeseriesClient timeseriesClient, String entity, String propertySetName, String from, String to) Returns an TimeseriesPageIterator instance initialized with the timeseriesClient
TimeseriesPageIterator(TimeseriesClient timeseriesClient, String entity, String propertySetName, String from, String to, Integer pageSize) Returns an TimeseriesPageIterator instance initialized with the timeseriesClient
TimeseriesPageIterator(TimeseriesClient timeseriesClient, String entity, String propertySetName, String from, String to, Integer pageSize, String select) Returns an TimeseriesPageIterator instance initialized with the timeseriesClient

Method Summary

Modifier and Type	Method and Description
List<TimeseriesData>	getPage(int pageNumber) Returns the list of TimeseriesData at a requested page number
List<TimeseriesData>	next() Returns the list of TimeseriesData at next page of TimeseriesData
List<TimeseriesData>	previous() Returns the list of TimeseriesData at previous page of TimeseriesData

Methods inherited from class Object

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

Constructor Detail

TimeseriesPageIterator

public TimeseriesPageIterator(TimeseriesClient timeseriesClient,
                              String entity,
                              String propertySetName,
                              String from,
                              String to)
                       throws MindsphereClientException

Returns an TimeseriesPageIterator instance initialized with the timeseriesClient

Parameters:

timeseriesClient - timeseriesClient that will be used to make API calls to fetch the timeseries data

entity - Unique identifier of the entity

propertySetName - Name of the propertyset

from - Beginning of the time range to read (exclusive)

to - End of the time range to read (inclusive)

Throws:

MindsphereClientException - thrown if error encountered while creating the instance

TimeseriesPageIterator

public TimeseriesPageIterator(TimeseriesClient timeseriesClient,
                              String entity,
                              String propertySetName,
                              String from,
                              String to,
                              Integer pageSize)
                       throws MindsphereClientException

Returns an TimeseriesPageIterator instance initialized with the timeseriesClient

Parameters:

timeseriesClient - timeseriesClient that will be used to make API calls to fetch the timeseries data

entity - Unique identifier of the entity

propertySetName - Name of the propertyset

from - Beginning of the time range to read (exclusive)

to - End of the time range to read (inclusive)

pageSize - number of records that should be available in each page. Default is 2000

Throws:

MindsphereClientException - thrown if error encountered while creating the instance

TimeseriesPageIterator

public TimeseriesPageIterator(TimeseriesClient timeseriesClient,
                              String entity,
                              String propertySetName,
                              String from,
                              String to,
                              Integer pageSize,
                              String select)
                       throws MindsphereClientException

Returns an TimeseriesPageIterator instance initialized with the timeseriesClient

Parameters:

timeseriesClient - timeseriesClient that will be used to make API calls to fetch the timeseries data

entity - Unique identifier of the entity

propertySetName - Name of the propertyset

from - Beginning of the time range to read (exclusive)

to - End of the time range to read (inclusive)

pageSize - number of records that should be available in each page. Default is 2000

select - Select fields to return

Throws:

MindsphereClientException - thrown if error encountered while creating the instance

Method Detail

next

public List<TimeseriesData> next()
                          throws MindsphereException

Returns the list of TimeseriesData at next page of TimeseriesData

Specified by:

next in interface PageIterator<List<TimeseriesData>>

Returns:

List of TimeseriesData

Throws:

MindsphereException - thrown if an error occurs while attempting to invoke the API

previous

public List<TimeseriesData> previous()
                              throws MindsphereException

Returns the list of TimeseriesData at previous page of TimeseriesData

Specified by:

previous in interface PageIterator<List<TimeseriesData>>

Returns:

List of TimeseriesData

Throws:

MindsphereException - thrown if an error occurs while attempting to invoke the API

getPage

public List<TimeseriesData> getPage(int pageNumber)
                             throws MindsphereException

Returns the list of TimeseriesData at a requested page number

Specified by:

getPage in interface PageIterator<List<TimeseriesData>>

Returns:

List of TimeseriesData

Throws:

MindsphereException - thrown if an error occurs while attempting to invoke the API