ds.granules.dataset

Interface StreamingAccess

All Superinterfaces:

Dataset, FormatMarshaller

All Known Implementing Classes:

StreamDatasetImplLegacy

Deprecated.

@Deprecated
public interface StreamingAccess
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

Field Summary

Fields

Modifier and Type	Field and Description
static int	HIERARCHICAL_SYNOPSIS Deprecated.
static int	REG_EXPRESSIONS_SYNOPSIS Deprecated.
static int	STRING_SYNOPSIS Deprecated.
static int	TAG_VALUE_PAIRS Deprecated.

Method Summary

Modifier and Type	Method and Description
int	addInputStream(java.lang.String streamSynopsis, int synopsisType) Deprecated. Add an input stream to this dataset.
int	addInputStreams(java.util.concurrent.ConcurrentHashMap<java.lang.String,java.lang.Integer> streamsToAdd) Deprecated. Adds a set of input streams to this dataset.
int	addOutputStream(java.lang.String streamSynopsis, int synopsisType) Deprecated. Add an output stream to this dataset.
int	addOutputStreams(java.util.concurrent.ConcurrentHashMap<java.lang.String,java.lang.Integer> streamsToAdd) Deprecated. Adds a set of output streams to this dataset.
void	commitUpdates() Deprecated. 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() Deprecated. Retrieve a HashMap of the constituent input streams.
int	getNumberOfInputStreams() Deprecated. Retrieve the number of input streams in this dataset
int	getNumberOfOutputStreams() Deprecated. Retrieve the number of output streams in this dataset.
java.util.concurrent.ConcurrentHashMap<java.lang.String,java.lang.Integer>	getOutputStreams() Deprecated. Retrieve a HashMap of the constituent output streams.
NBEvent	getStreamingData() Deprecated. Retrieves a portion of the streaming dataset when data is available.
boolean	hasInputStreams() Deprecated. Check to see if this dataset has any registered input streams.
boolean	hasOutputStreams() Deprecated. Check to see if this dataset has any registered output streams.
int	removeInputStream(java.lang.String streamSynopsis) Deprecated. Removes an input stream from this dataset.
int	removeInputStreams(java.util.concurrent.ConcurrentHashMap<java.lang.String,java.lang.Integer> streamsToRemove) Deprecated. Removes a set of input streams from this dataset.
int	removeOutputStream(java.lang.String streamSynopsis) Deprecated. Removes an output stream from this dataset.
int	removeOutputStreams(java.util.concurrent.ConcurrentHashMap<java.lang.String,java.lang.Integer> streamsToRemove) Deprecated. Removes a set of output streams from this dataset.
void	writeStreamingData(int synopsisType, java.lang.Object streamInfo, byte[] payload) Deprecated. This method writes data to the output dataset.
void	writeStreamingData(NBEvent nbEvent) Deprecated. This method writes data to the output dataset.
void	writeStreamingData(java.lang.Object streamInfo, byte[] payload) Deprecated. 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

Field Detail

STRING_SYNOPSIS

static final int STRING_SYNOPSIS

Deprecated.

See Also:

Constant Field Values

TAG_VALUE_PAIRS

static final int TAG_VALUE_PAIRS

Deprecated.

See Also:

Constant Field Values

REG_EXPRESSIONS_SYNOPSIS

static final int REG_EXPRESSIONS_SYNOPSIS

Deprecated.

See Also:

Constant Field Values

HIERARCHICAL_SYNOPSIS

static final int HIERARCHICAL_SYNOPSIS

Deprecated.

See Also:

Constant Field Values

Method Detail

getStreamingData

NBEvent getStreamingData()
                  throws DatasetException

Deprecated.

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(NBEvent nbEvent)
                 throws DatasetException

Deprecated.

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

Parameters:

nbEvent - The stream fragment that needs to be written

Throws:

DatasetException - If there are problems performing the operation

writeStreamingData

void writeStreamingData(java.lang.Object streamInfo,
                        byte[] payload)
                 throws DatasetException

Deprecated.

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

Parameters:

streamInfo - The stream being written to

payload - The payload for the individual stream fragments

Throws:

DatasetException - If there are problems performing the operation

writeStreamingData

void writeStreamingData(int synopsisType,
                        java.lang.Object streamInfo,
                        byte[] payload)
                 throws DatasetException

Deprecated.

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

Parameters:

synopsisType - The synopsis Type for the stream

streamInfo - 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(java.lang.String streamSynopsis,
                   int synopsisType)
            throws DatasetException

Deprecated.

Add an input stream to this dataset.

Parameters:

streamSynopsis - The synopsis of the stream

synopsisType - The type of the stream's synopsis

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(java.lang.String streamSynopsis)
               throws DatasetException

Deprecated.

Removes an input stream from this dataset.

Parameters:

streamSynopsis - The synopsis of the stream that will 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.concurrent.ConcurrentHashMap<java.lang.String,java.lang.Integer> streamsToAdd)
             throws DatasetException

Deprecated.

Adds a set of input streams to this dataset.

Parameters:

streamsToAdd - The set 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.concurrent.ConcurrentHashMap<java.lang.String,java.lang.Integer> streamsToRemove)
                throws DatasetException

Deprecated.

Removes a set of input streams from this dataset.

Parameters:

streamsToRemove - The set of streams to be added

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()

Deprecated.

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

Returns:

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

getNumberOfInputStreams

int getNumberOfInputStreams()

Deprecated.

Retrieve the number of input streams in this dataset

Returns:

The number of input streams in this dataset

getInputStreams

java.util.concurrent.ConcurrentHashMap<java.lang.String,java.lang.Integer> getInputStreams()

Deprecated.

Retrieve a HashMap of the constituent input streams.

Returns:

The HashMap of the constituent input streams.

addOutputStream

int addOutputStream(java.lang.String streamSynopsis,
                    int synopsisType)
             throws DatasetException

Deprecated.

Add an output stream to this dataset.

Parameters:

streamSynopsis - The synopsis of the stream

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(java.lang.String streamSynopsis)
                throws DatasetException

Deprecated.

Removes an output stream from this dataset.

Parameters:

streamSynopsis - The synopsis of the stream that will 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.concurrent.ConcurrentHashMap<java.lang.String,java.lang.Integer> streamsToAdd)
              throws DatasetException

Deprecated.

Adds a set of output streams to this dataset.

Parameters:

streamsToAdd - The set of output 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.concurrent.ConcurrentHashMap<java.lang.String,java.lang.Integer> streamsToRemove)
                 throws DatasetException

Deprecated.

Removes a set of output streams from this dataset.

Parameters:

streamsToRemove - The set of output 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()

Deprecated.

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

Returns:

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

getNumberOfOutputStreams

int getNumberOfOutputStreams()

Deprecated.

Retrieve the number of output streams in this dataset.

Returns:

The number of output streams in this dataset.

getOutputStreams

java.util.concurrent.ConcurrentHashMap<java.lang.String,java.lang.Integer> getOutputStreams()

Deprecated.

Retrieve a HashMap of the constituent output streams.

Returns:

The HashMap of the constituent output streams.

commitUpdates

void commitUpdates()
            throws DatasetException

Deprecated.

Commit any changes that have been made to the set of streams managed by this dataset. To reflect the changes of adding one or more streams, this method needs to be invoked. This method does not need to be invoked by the client that will be deploying an operation.

Throws:

DatasetException