Package net.solarnetwork.domain.datum

Interface ObjectDatumStreamDataSet<T extends StreamDatum>

Type Parameters:

T - the stream datum type

All Superinterfaces:

Iterable<T>, ObjectDatumStreamMetadataProvider

All Known Implementing Classes:

BasicObjectDatumStreamDataSet

public interface ObjectDatumStreamDataSet<T extends StreamDatum>
extends ObjectDatumStreamMetadataProvider, Iterable<T>

A set of StreamDatum with associated metadata.

Since:

2.4

Version:

1.0

Author:

matt

Method Summary

Modifier and Type	Method	Description
Iterable<T>	getResults()	Get the actual results.
Integer	getReturnedResultCount()	Get the number of results that matched the query.
Integer	getStartingOffset()	Get the starting offset of the returned results.
Long	getTotalResultCount()	Get a total number of available results, if known.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface net.solarnetwork.domain.datum.ObjectDatumStreamMetadataProvider

metadataForObjectSource, metadataForStreamId, metadataStreamIds

Method Details

getResults

Iterable<T> getResults()

Get the actual results.

These are the same results returned by Iterable.iterator().

Returns:

the results, never null

getTotalResultCount

Long getTotalResultCount()

Get a total number of available results, if known.

If this result represents partial results and the total count of available results is known, this value represents that total count of available results.

Returns:

total available results, or null if not known

getStartingOffset

Integer getStartingOffset()

Get the starting offset of the returned results.

Returns:

the starting offset, or null if not known

getReturnedResultCount

Integer getReturnedResultCount()

Get the number of results that matched the query.

Returns:

the number of returned results, or null if not known