com.whizzosoftware.hobson.api.data

Interface DataStreamManager

All Known Implementing Classes:

DelegatingDataStreamManager, StubDataStreamManager

public interface DataStreamManager

An interface for managing data streams.

Author:

Dan Noguerol

Method Summary

Modifier and Type	Method and Description
void	addData(HubContext ctx, java.lang.String dataStreamId, long now, java.util.Map<java.lang.String,java.lang.Object> data) Adds data to a data stream.
java.lang.String	createDataStream(HubContext ctx, java.lang.String name, java.util.Collection<DataStreamField> fields, java.util.Set<java.lang.String> tags) Creates a new data stream.
void	deleteDataStream(HubContext ctx, java.lang.String dataStreamId) Deletes an existing data stream.
java.util.Collection<DataStreamValueSet>	getData(HubContext ctx, java.lang.String dataStreamId, long endTime, DataStreamInterval interval) Returns data from a data stream.
DataStream	getDataStream(HubContext ctx, java.lang.String dataStreamId) Returns a specific data stream.
java.util.Collection<DataStream>	getDataStreams(HubContext ctx) Returns the list of created data streams.
boolean	isStub() Indicates if this manager is a stub (NO-OP) implementation.

Method Detail

isStub

boolean isStub()

Indicates if this manager is a stub (NO-OP) implementation.

Returns:

a boolean

createDataStream

java.lang.String createDataStream(HubContext ctx,
                                  java.lang.String name,
                                  java.util.Collection<DataStreamField> fields,
                                  java.util.Set<java.lang.String> tags)

Creates a new data stream.

Parameters:

ctx - the hub context

name - the stream name

fields - the fields that comprise the data stream

tags - the tags associated with the data stream

Returns:

the ID of the newly created data stream

deleteDataStream

void deleteDataStream(HubContext ctx,
                      java.lang.String dataStreamId)

Deletes an existing data stream.

Parameters:

ctx - the hub context

dataStreamId - the ID of the stream to delete

getDataStreams

java.util.Collection<DataStream> getDataStreams(HubContext ctx)

Returns the list of created data streams.

Parameters:

ctx - the hub context

Returns:

a Collection of DataStream instances

getDataStream

DataStream getDataStream(HubContext ctx,
                         java.lang.String dataStreamId)

Returns a specific data stream.

Parameters:

ctx - the hub context

dataStreamId - the data stream ID

Returns:

a DataStream instance

Throws:

HobsonNotFoundException - if the data stream does not exist

addData

void addData(HubContext ctx,
             java.lang.String dataStreamId,
             long now,
             java.util.Map<java.lang.String,java.lang.Object> data)

Adds data to a data stream.

Parameters:

ctx - the hub context

dataStreamId - the data stream ID

now - the time the data point occurred

data - the data values (a map of fieldId to value)

getData

java.util.Collection<DataStreamValueSet> getData(HubContext ctx,
                                                 java.lang.String dataStreamId,
                                                 long endTime,
                                                 DataStreamInterval interval)

Returns data from a data stream.

Parameters:

ctx - the hub context

dataStreamId - the data stream ID

endTime - the end time desired

interval - the interval size of the data

Returns:

a Collection of TemporalValue instances