Package net.solarnetwork.domain.datum

Class BasicObjectDatumStreamDataSet<T extends StreamDatum>

java.lang.Object

net.solarnetwork.domain.datum.BasicObjectDatumStreamDataSet<T>

Type Parameters:

T - the stream datum type

All Implemented Interfaces:

Iterable<T>, ObjectDatumStreamDataSet<T>, ObjectDatumStreamMetadataProvider

public class BasicObjectDatumStreamDataSet<T extends StreamDatum>
extends Object
implements ObjectDatumStreamDataSet<T>

Basic implementation of ObjectDatumStreamDataSet.

Since:

2.4

Version:

1.0

Author:

matt

Constructor Summary

Constructors

Constructor	Description
BasicObjectDatumStreamDataSet(ObjectDatumStreamMetadataProvider provider, Iterable<T> data)	Constructor.
BasicObjectDatumStreamDataSet(ObjectDatumStreamMetadataProvider provider, Iterable<T> data, Long totalResultCount, Integer startingOffset, Integer returnedResultCount)	Constructor.

Method Summary

Modifier and Type	Method	Description
static final <T extends StreamDatum> BasicObjectDatumStreamDataSet<T>	dataSet(Iterable<ObjectDatumStreamMetadata> metadatas, Iterable<T> data)	Create a new data set instance out of a set of metadata.
static final <T extends StreamDatum> BasicObjectDatumStreamDataSet<T>	dataSet(Iterable<ObjectDatumStreamMetadata> metadatas, Iterable<T> data, Long totalResultCount, Integer startingOffset, Integer returnedResultCount)	Create a new data set instance out of a set of metadata.
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.
Iterator<T>	iterator()
ObjectDatumStreamMetadata	metadataForObjectSource(Long objectId, String sourceId)	Get stream metadata for a given object and source ID combination.
ObjectDatumStreamMetadata	metadataForStreamId(UUID streamId)	Get stream metadata for a given stream ID.
Collection<UUID>	metadataStreamIds()	Get a collection of all the available stream IDs this result instance has metadata available for.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

BasicObjectDatumStreamDataSet

public BasicObjectDatumStreamDataSet(ObjectDatumStreamMetadataProvider provider,
 Iterable<T> data)

Constructor.

Parameters:

provider - the provider to delegate to

data - the data

Throws:

IllegalArgumentException - if any argument is null

BasicObjectDatumStreamDataSet

public BasicObjectDatumStreamDataSet(ObjectDatumStreamMetadataProvider provider,
 Iterable<T> data,
 Long totalResultCount,
 Integer startingOffset,
 Integer returnedResultCount)

Constructor.

Parameters:

provider - the provider to delegate to

data - the data

totalResultCount - the total result count, or null if not known

startingOffset - the starting offset within the total result set, or null if not known

returnedResultCount - the number of results available in data or null if not known

Throws:

IllegalArgumentException - if either provider or data is null

Method Details

dataSet

public static final <T extends StreamDatum>
BasicObjectDatumStreamDataSet<T> dataSet(Iterable<ObjectDatumStreamMetadata> metadatas,
 Iterable<T> data)

Create a new data set instance out of a set of metadata.

Type Parameters:

T - the stream datum type

Parameters:

metadatas - the metadata

data - the data

Returns:

the new instance

dataSet

public static final <T extends StreamDatum>
BasicObjectDatumStreamDataSet<T> dataSet(Iterable<ObjectDatumStreamMetadata> metadatas,
 Iterable<T> data,
 Long totalResultCount,
 Integer startingOffset,
 Integer returnedResultCount)

Create a new data set instance out of a set of metadata.

Type Parameters:

T - the stream datum type

Parameters:

metadatas - the metadata

data - the data

totalResultCount - the total result count, or null if not known

startingOffset - the starting offset within the total result set, or null if not known

returnedResultCount - the number of results available in data or null if not known

Returns:

the new instance

metadataStreamIds

public Collection<UUID> metadataStreamIds()

Description copied from interface: ObjectDatumStreamMetadataProvider

Get a collection of all the available stream IDs this result instance has metadata available for.

Specified by:

metadataStreamIds in interface ObjectDatumStreamMetadataProvider

Returns:

the set of stream IDs that ObjectDatumStreamMetadataProvider.metadataForStreamId(UUID) will return a value for, or null it not known

metadataForStreamId

public ObjectDatumStreamMetadata metadataForStreamId(UUID streamId)

Description copied from interface: ObjectDatumStreamMetadataProvider

Get stream metadata for a given stream ID.

Specified by:

metadataForStreamId in interface ObjectDatumStreamMetadataProvider

Parameters:

streamId - the stream ID

Returns:

the stream metadata, or null if not available

metadataForObjectSource

public ObjectDatumStreamMetadata metadataForObjectSource(Long objectId,
 String sourceId)

Description copied from interface: ObjectDatumStreamMetadataProvider

Get stream metadata for a given object and source ID combination.

Specified by:

metadataForObjectSource in interface ObjectDatumStreamMetadataProvider

Parameters:

objectId - the object ID, e.g. node or location ID

sourceId - the source ID

Returns:

the stream metadata, or null if not available

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T extends StreamDatum>

getResults

public Iterable<T> getResults()

Description copied from interface: ObjectDatumStreamDataSet

Get the actual results.

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

Specified by:

getResults in interface ObjectDatumStreamDataSet<T extends StreamDatum>

Returns:

the results, never null

getTotalResultCount

public Long getTotalResultCount()

Description copied from interface: ObjectDatumStreamDataSet

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.

Specified by:

getTotalResultCount in interface ObjectDatumStreamDataSet<T extends StreamDatum>

Returns:

total available results, or null if not known

getStartingOffset

public Integer getStartingOffset()

Description copied from interface: ObjectDatumStreamDataSet

Get the starting offset of the returned results.

Specified by:

getStartingOffset in interface ObjectDatumStreamDataSet<T extends StreamDatum>

Returns:

the starting offset, or null if not known

getReturnedResultCount

public Integer getReturnedResultCount()

Description copied from interface: ObjectDatumStreamDataSet

Get the number of results that matched the query.

Specified by:

getReturnedResultCount in interface ObjectDatumStreamDataSet<T extends StreamDatum>

Returns:

the number of returned results, or null if not known