public interface StreamingAccess extends Dataset
Dataset
interface to support
streaming capabilities.Modifier and Type | Field and Description |
---|---|
static int |
HIERARCHICAL_SYNOPSIS |
static int |
REG_EXPRESSIONS_SYNOPSIS |
static int |
STRING_SYNOPSIS |
static int |
TAG_VALUE_PAIRS |
Modifier and Type | Method and Description |
---|---|
int |
addInputStream(java.lang.String streamSynopsis,
int synopsisType)
Add an input stream to this dataset.
|
int |
addInputStreams(java.util.concurrent.ConcurrentHashMap<java.lang.String,java.lang.Integer> streamsToAdd)
Adds a set of input streams to this dataset.
|
int |
addOutputStream(java.lang.String streamSynopsis,
int synopsisType)
Add an output stream to this dataset.
|
int |
addOutputStreams(java.util.concurrent.ConcurrentHashMap<java.lang.String,java.lang.Integer> streamsToAdd)
Adds a set of output streams to this dataset.
|
void |
commitUpdates()
Commit any changes that have been made to the set of streams managed by
this dataset.
|
java.util.concurrent.ConcurrentHashMap<java.lang.String,java.lang.Integer> |
getInputStreams()
Retrieve a HashMap 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.concurrent.ConcurrentHashMap<java.lang.String,java.lang.Integer> |
getOutputStreams()
Retrieve a HashMap of the constituent output streams.
|
NBEvent |
getStreamingData()
Retrieves a portion of the streaming dataset when data is available.
|
boolean |
hasInputStreams()
Check to see if this dataset has any registered input streams.
|
boolean |
hasOutputStreams()
Check to see if this dataset has any registered output streams.
|
int |
removeInputStream(java.lang.String streamSynopsis)
Removes an input stream from this dataset.
|
int |
removeInputStreams(java.util.concurrent.ConcurrentHashMap<java.lang.String,java.lang.Integer> streamsToRemove)
Removes a set of input streams from this dataset.
|
int |
removeOutputStream(java.lang.String streamSynopsis)
Removes an output stream from this dataset.
|
int |
removeOutputStreams(java.util.concurrent.ConcurrentHashMap<java.lang.String,java.lang.Integer> streamsToRemove)
Removes a set of output streams from this dataset.
|
void |
writeStreamingData(int synopsisType,
java.lang.Object streamInfo,
byte[] payload)
This method writes data to the output dataset.
|
void |
writeStreamingData(NBEvent nbEvent)
This method writes data to the output dataset.
|
void |
writeStreamingData(java.lang.Object streamInfo,
byte[] payload)
This method writes data to the output dataset.
|
close, getBytes, getDataAvailabilityNotifier, getDatasetType, getDescription, getIdentifier, getLastModificationTime, initializeDataset, isAvailable, isDataAvailable, isInitialized, needsInitialization, supportsDataAvailabilityNotifications
static final int STRING_SYNOPSIS
static final int TAG_VALUE_PAIRS
static final int REG_EXPRESSIONS_SYNOPSIS
static final int HIERARCHICAL_SYNOPSIS
NBEvent getStreamingData() throws DatasetException
DatasetException
- If there are problems performing the operationvoid writeStreamingData(NBEvent nbEvent) throws DatasetException
nbEvent
- The stream fragment that needs to be writtenDatasetException
- If there are problems performing the operationvoid writeStreamingData(java.lang.Object streamInfo, byte[] payload) throws DatasetException
streamInfo
- The stream being written topayload
- The payload for the individual stream fragmentsDatasetException
- If there are problems performing the operationvoid writeStreamingData(int synopsisType, java.lang.Object streamInfo, byte[] payload) throws DatasetException
synopsisType
- The synopsis Type for the streamstreamInfo
- The stream being written topayload
- The payload for the individual stream fragmentsDatasetException
- If there are problems performing the operationint addInputStream(java.lang.String streamSynopsis, int synopsisType) throws DatasetException
streamSynopsis
- The synopsis of the streamsynopsisType
- The type of the stream's synopsisDatasetException
- If there are problems adding this stream to the set of
managed streamsint removeInputStream(java.lang.String streamSynopsis) throws DatasetException
streamSynopsis
- The synopsis of the stream that will be removed.DatasetException
- If there are problems removing this stream from the set of
managed streamsint addInputStreams(java.util.concurrent.ConcurrentHashMap<java.lang.String,java.lang.Integer> streamsToAdd) throws DatasetException
streamsToAdd
- The set of streams to be addedDatasetException
- If there are problems adding these streams to the set of
managed streamsjava.lang.NullPointerException
- If the specified set of streams is NULL.int removeInputStreams(java.util.concurrent.ConcurrentHashMap<java.lang.String,java.lang.Integer> streamsToRemove) throws DatasetException
streamsToRemove
- The set of streams to be addedDatasetException
- If there are problems removing these streams to the set of
managed streamsjava.lang.NullPointerException
- If the specified set of streams is NULL.boolean hasInputStreams()
true
if this dataset has any registered input
streams;false
otherwise.int getNumberOfInputStreams()
java.util.concurrent.ConcurrentHashMap<java.lang.String,java.lang.Integer> getInputStreams()
int addOutputStream(java.lang.String streamSynopsis, int synopsisType) throws DatasetException
streamSynopsis
- The synopsis of the streamsynopsisType
- The type of the stream's synopsisDatasetException
- If there are problems adding this stream to the set of
managed streamsint removeOutputStream(java.lang.String streamSynopsis) throws DatasetException
streamSynopsis
- The synopsis of the stream that will be removed.DatasetException
- If there are problems removing this stream from the set of
managed streamsint addOutputStreams(java.util.concurrent.ConcurrentHashMap<java.lang.String,java.lang.Integer> streamsToAdd) throws DatasetException
streamsToAdd
- The set of output streams to be addedDatasetException
- If there are problems adding these streams to the set of
managed streamsjava.lang.NullPointerException
- If the specified set of streams is NULL.int removeOutputStreams(java.util.concurrent.ConcurrentHashMap<java.lang.String,java.lang.Integer> streamsToRemove) throws DatasetException
streamsToRemove
- The set of output streams to be removedDatasetException
- If there are problems removing these streams from the set of
managed streamsjava.lang.NullPointerException
- If the specified set of streams is NULL.boolean hasOutputStreams()
true
if this dataset has any registered output
streams;false
otherwise.int getNumberOfOutputStreams()
java.util.concurrent.ConcurrentHashMap<java.lang.String,java.lang.Integer> getOutputStreams()
void commitUpdates() throws DatasetException
DatasetException