com.whizzosoftware.hobson.api.data

Interface DataStreamMetaStore

public interface DataStreamMetaStore

An interface for storage of data stream meta data.

Author:

Dan Noguerol

Method Summary

Modifier and Type	Method and Description
java.lang.String	createDataStream(java.lang.String hubId, java.lang.String name, java.util.Collection<DataStreamField> fields, java.util.Collection<java.lang.String> tags) Creates a new data stream.
void	deleteDataStream(java.lang.String dataStreamId) Deletes a new data stream.
DataStream	getDataStream(java.lang.String dataStreamId) Retrieves a specific data stream for a user.
java.util.Collection<DataStream>	getDataStreams(java.lang.String hubId) Retrieves all data streams for a user.

Method Detail

createDataStream

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

Creates a new data stream.

Parameters:

hubId - the hub ID

name - the name of the data stream

fields - the fields that comprise the data stream

tags - a list of tags associated with the data stream

Returns:

the ID of the new data stream

deleteDataStream

void deleteDataStream(java.lang.String dataStreamId)

Deletes a new data stream.

Parameters:

dataStreamId - the ID of the data stream to delete

getDataStreams

java.util.Collection<DataStream> getDataStreams(java.lang.String hubId)

Retrieves all data streams for a user.

Parameters:

hubId - the hub ID

Returns:

a Collection of DataStream objects (will be an empty collection if the user has no streams)

getDataStream

DataStream getDataStream(java.lang.String dataStreamId)

Retrieves a specific data stream for a user.

Parameters:

dataStreamId - the data stream ID

Returns:

a DataStream instance (returns null if the data stream does not exist)