ds.granules.dataset

Interface StreamDataset

All Superinterfaces:

Dataset, FormatMarshaller

All Known Implementing Classes:

StreamDatasetImpl

public interface StreamDataset
extends Dataset

The interface which augments the Dataset interface to support streaming capabilities.

Author:

Shrideep Pallickara

Nested Class Summary

Nested classes/interfaces inherited from interface ds.granules.dataset.Dataset

Dataset.DatasetType

Method Summary

Modifier and Type	Method and Description
int	addInputStream(Topic topic) Add an input stream to this dataset.
int	addInputStreams(java.util.Collection<Topic> topics) Adds a set of input streams to this dataset.
int	addOutputStream(Topic topic) Add an output stream to this dataset.
int	addOutputStreams(java.util.Collection<Topic> topics) Adds a set of output streams to this dataset.
java.util.Collection<Topic>	getInputStreams() Retrieve a collection of the constituent input streams.
int	getNumberOfInputStreams() Retrieve the number of input streams in this dataset
int	getNumberOfOutputStreams() Retrieve the number of output streams in this dataset.
java.util.Collection<Topic>	getOutputStreams() Retrieve a collection of the constituent output streams.
TopicDataEvent	getStreamingData() Retrieves a portion of the streaming dataset when data is available.
boolean	hasInputStream(Topic topic) Check to see if this dataset has a specified input stream.
boolean	hasInputStreams() Check to see if this dataset has any registered input streams.
boolean	hasOutputStream(Topic topic) Check to see if this dataset has a specified output stream.
boolean	hasOutputStreams() Check to see if this dataset has any registered output streams.
int	removeInputStream(Topic topic) Removes an input stream from this dataset.
int	removeInputStreams(java.util.Collection<Topic> topics) Removes a set of input streams from this dataset.
int	removeOutputStream(Topic topic) Removes an output stream from this dataset.
int	removeOutputStreams(java.util.Collection<Topic> topics) Removes a set of output streams from this dataset.
void	writeStreamingData(Topic topic, byte[] payload) This method writes data to the output dataset.
void	writeStreamingData(TopicDataEvent mtdEvent) This method writes data to the output dataset.

Methods inherited from interface ds.granules.dataset.Dataset

close, getDataAvailabilityNotifier, getDatasetType, getDescription, getIdentifier, getLastModificationTime, initializeDataset, isAvailable, isDataAvailable, isInitialized, supportsDataAvailabilityNotifications

Methods inherited from interface ds.funnel.data.format.FormatMarshaller

marshall

Method Detail

getStreamingData

TopicDataEvent getStreamingData()
                         throws DatasetException

Retrieves a portion of the streaming dataset when data is available. This method will return a NULL if data is not available. In general, this method should be used in tandem with the DataAvailabilityNotifier.

Returns:

A fragment of the streaming dataset

Throws:

DatasetException - If there are problems performing the operation

writeStreamingData

void writeStreamingData(TopicDataEvent mtdEvent)
                 throws DatasetException

This method writes data to the output dataset. This method throws an exception if the Stream producers have not been configured appropriately.

Parameters:

mtdEvent - The stream fragment that needs to be written

Throws:

DatasetException - If there are problems performing the operation

writeStreamingData

void writeStreamingData(Topic topic,
                        byte[] payload)
                 throws DatasetException

This method writes data to the output dataset. This method throws an exception if the Stream producers have not been configured appropriately.

Parameters:

topic - The stream being written to

payload - The payload for the individual stream fragments

Throws:

DatasetException - If there are problems performing the operation

addInputStream

int addInputStream(Topic topic)
            throws DatasetException

Add an input stream to this dataset.

Parameters:

topic - The topic of the stream to be added

Returns:

The total number of input streams in this dataset

Throws:

DatasetException - If there are problems adding this stream to the set of managed streams

removeInputStream

int removeInputStream(Topic topic)
               throws DatasetException

Removes an input stream from this dataset.

Parameters:

topic - The topic of the stream to be removed

Returns:

The total number of input streams that remain in this dataset

Throws:

DatasetException - If there are problems removing this stream from the set of managed streams

addInputStreams

int addInputStreams(java.util.Collection<Topic> topics)
             throws DatasetException

Adds a set of input streams to this dataset.

Parameters:

topics - A collection of streams to be added

Returns:

The total number of input streams in this dataset

Throws:

DatasetException - If there are problems adding these streams to the set of managed streams

java.lang.NullPointerException - If the specified set of streams is NULL.

removeInputStreams

int removeInputStreams(java.util.Collection<Topic> topics)
                throws DatasetException

Removes a set of input streams from this dataset.

Parameters:

topics - A collection of streams to be removed

Returns:

The total number of input streams in this dataset

Throws:

DatasetException - If there are problems removing these streams to the set of managed streams

java.lang.NullPointerException - If the specified set of streams is NULL.

hasInputStreams

boolean hasInputStreams()

Check to see if this dataset has any registered input streams.

Returns:

true if this dataset has any registered input streams;false otherwise.

hasInputStream

boolean hasInputStream(Topic topic)

Check to see if this dataset has a specified input stream.

Returns:

true if this dataset has the specified input stream;false otherwise.

getNumberOfInputStreams

int getNumberOfInputStreams()

Retrieve the number of input streams in this dataset

Returns:

The number of input streams in this dataset

getInputStreams

java.util.Collection<Topic> getInputStreams()

Retrieve a collection of the constituent input streams.

Returns:

The collection of the constituent input streams.

addOutputStream

int addOutputStream(Topic topic)
             throws DatasetException

Add an output stream to this dataset.

Parameters:

topic - The topic of the stream to be added

synopsisType - The type of the stream's synopsis

Returns:

The total number of output streams in this dataset

Throws:

DatasetException - If there are problems adding this stream to the set of managed streams

removeOutputStream

int removeOutputStream(Topic topic)
                throws DatasetException

Removes an output stream from this dataset.

Parameters:

topic - The topic of the stream to be removed

Returns:

The total number of output streams that remain in this dataset

Throws:

DatasetException - If there are problems removing this stream from the set of managed streams

addOutputStreams

int addOutputStreams(java.util.Collection<Topic> topics)
              throws DatasetException

Adds a set of output streams to this dataset.

Parameters:

topics - A collection of streams to be added

Returns:

The total number of output streams in this dataset

Throws:

DatasetException - If there are problems adding these streams to the set of managed streams

java.lang.NullPointerException - If the specified set of streams is NULL.

removeOutputStreams

int removeOutputStreams(java.util.Collection<Topic> topics)
                 throws DatasetException

Removes a set of output streams from this dataset.

Parameters:

topics - A collection of streams to be removed

Returns:

The total number of output streams in this dataset

Throws:

DatasetException - If there are problems removing these streams from the set of managed streams

java.lang.NullPointerException - If the specified set of streams is NULL.

hasOutputStreams

boolean hasOutputStreams()

Check to see if this dataset has any registered output streams.

Returns:

true if this dataset has any registered output streams;false otherwise.

hasOutputStream

boolean hasOutputStream(Topic topic)

Check to see if this dataset has a specified output stream.

Returns:

true if this dataset has the specified output stream;false otherwise.

getNumberOfOutputStreams

int getNumberOfOutputStreams()

Retrieve the number of output streams in this dataset.

Returns:

The number of output streams in this dataset.

getOutputStreams

java.util.Collection<Topic> getOutputStreams()

Retrieve a collection of the constituent output streams.

Returns:

The collection of the constituent output streams.