public interface StreamDataset extends Dataset
Dataset
interface to support
streaming capabilities.Dataset.DatasetType
Modifier and Type | Method and Description |
---|---|
int |
addInputStream(ds.funnel.topic.Topic topic)
Add an input stream to this dataset.
|
int |
addInputStream(ds.funnel.topic.Topic topic,
String instanceIdentifier)
Add an input stream to the data set
|
int |
addInputStreams(Collection<ds.funnel.topic.Topic> topics)
Adds a set of input streams to this dataset.
|
int |
addOutputStream(ds.funnel.topic.Topic topic)
Add an output stream to this dataset.
|
int |
addOutputStreams(Collection<ds.funnel.topic.Topic> topics)
Adds a set of output streams to this dataset.
|
Collection<ds.funnel.topic.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.
|
Collection<ds.funnel.topic.Topic> |
getOutputStreams()
Retrieve a collection of the constituent output streams.
|
ds.funnel.topic.TopicDataEvent |
getStreamingData()
Retrieves a portion of the streaming dataset when data is available.
|
boolean |
hasInputStream(ds.funnel.topic.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(ds.funnel.topic.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(ds.funnel.topic.Topic topic)
Removes an input stream from this dataset.
|
int |
removeInputStreams(Collection<ds.funnel.topic.Topic> topics)
Removes a set of input streams from this dataset.
|
int |
removeOutputStream(ds.funnel.topic.Topic topic)
Removes an output stream from this dataset.
|
int |
removeOutputStreams(Collection<ds.funnel.topic.Topic> topics)
Removes a set of output streams from this dataset.
|
void |
setDatasetDescription(String description)
Sets the dataset description
|
void |
setDatasetIdentifier(String identifier)
Sets the dataset identifier
|
void |
unmarshall(ds.funnel.data.format.FormatReader reader) |
void |
writeStreamingData(ds.funnel.topic.Topic topic,
byte[] payload)
This method writes data to the output dataset.
|
void |
writeStreamingData(ds.funnel.topic.TopicDataEvent mtdEvent)
This method writes data to the output dataset.
|
void |
writeStreamingDataAsBatch(ds.funnel.topic.Topic topic,
StreamEvent event) |
close, getDataAvailabilityNotifier, getDatasetIdentifier, getDatasetType, getDescription, getLastModificationTime, initializeDataset, isAvailable, isDataAvailable, isInitialized, supportsDataAvailabilityNotifications
ds.funnel.topic.TopicDataEvent getStreamingData() throws DatasetException
DatasetException
- If there are problems performing the operationvoid writeStreamingData(ds.funnel.topic.TopicDataEvent mtdEvent) throws DatasetException
mtdEvent
- The stream fragment that needs to be writtenDatasetException
- If there are problems performing the operationvoid writeStreamingData(ds.funnel.topic.Topic topic, byte[] payload) throws DatasetException
topic
- The stream being written topayload
- The payload for the individual stream fragmentsDatasetException
- If there are problems performing the operationvoid writeStreamingDataAsBatch(ds.funnel.topic.Topic topic, StreamEvent event) throws DatasetException
DatasetException
int addInputStream(ds.funnel.topic.Topic topic) throws DatasetException
topic
- The topic of the stream to be addedDatasetException
- If there are problems adding this stream to the set of
managed streamsint addInputStream(ds.funnel.topic.Topic topic, String instanceIdentifier) throws DatasetException
topic
- Topic of the data stream to be added.instanceIdentifier
- Instance identifier of the operation baseDatasetException
- If there are problems adding this stream to the set of
managed streamsint removeInputStream(ds.funnel.topic.Topic topic) throws DatasetException
topic
- The topic of the stream to be removedDatasetException
- If there are problems removing this stream from the set of
managed streamsint addInputStreams(Collection<ds.funnel.topic.Topic> topics) throws DatasetException
topics
- A collection of streams to be addedDatasetException
- If there are problems adding these streams to the set of
managed streamsNullPointerException
- If the specified set of streams is NULL.int removeInputStreams(Collection<ds.funnel.topic.Topic> topics) throws DatasetException
topics
- A collection of streams to be removedDatasetException
- If there are problems removing these streams to the set of
managed streamsNullPointerException
- If the specified set of streams is NULL.boolean hasInputStreams()
true
if this dataset has any registered input
streams;false
otherwise.boolean hasInputStream(ds.funnel.topic.Topic topic)
true
if this dataset has the specified input
stream;false
otherwise.int getNumberOfInputStreams()
Collection<ds.funnel.topic.Topic> getInputStreams()
int addOutputStream(ds.funnel.topic.Topic topic) throws DatasetException
topic
- The topic of the stream to be addedDatasetException
- If there are problems adding this stream to the set of
managed streamsint removeOutputStream(ds.funnel.topic.Topic topic) throws DatasetException
topic
- The topic of the stream to be removedDatasetException
- If there are problems removing this stream from the set of
managed streamsint addOutputStreams(Collection<ds.funnel.topic.Topic> topics) throws DatasetException
topics
- A collection of streams to be addedDatasetException
- If there are problems adding these streams to the set of
managed streamsNullPointerException
- If the specified set of streams is NULL.int removeOutputStreams(Collection<ds.funnel.topic.Topic> topics) throws DatasetException
topics
- A collection of streams to be removedDatasetException
- If there are problems removing these streams from the set of
managed streamsNullPointerException
- If the specified set of streams is NULL.boolean hasOutputStreams()
true
if this dataset has any registered output
streams;false
otherwise.boolean hasOutputStream(ds.funnel.topic.Topic topic)
true
if this dataset has the specified output
stream;false
otherwise.int getNumberOfOutputStreams()
Collection<ds.funnel.topic.Topic> getOutputStreams()
void setDatasetDescription(String description)
description
- Descriptionvoid setDatasetIdentifier(String identifier)
identifier
- identifiervoid unmarshall(ds.funnel.data.format.FormatReader reader) throws ds.funnel.data.format.FormatException
ds.funnel.data.format.FormatException
Copyright © 2015. All rights reserved.