ds.granules.dataset

Class StreamDatasetImplLegacy

java.lang.Object

ds.granules.dataset.StreamDatasetImplLegacy

All Implemented Interfaces:

FormatMarshaller, Dataset, StreamingAccess

Deprecated.

@Deprecated
public class StreamDatasetImplLegacy
extends java.lang.Object
implements StreamingAccess

This class is a streaming implementation of the dataset. Additionally, this class implements the StreamingAccess interface which outlines methods to access the data streams that are available.

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 java.lang.String	MODULE Deprecated.

Fields inherited from interface ds.granules.dataset.StreamingAccess

HIERARCHICAL_SYNOPSIS, REG_EXPRESSIONS_SYNOPSIS, STRING_SYNOPSIS, TAG_VALUE_PAIRS

Constructor Summary

Constructors

Constructor and Description
StreamDatasetImplLegacy(FormatReader mFormat) Deprecated.
StreamDatasetImplLegacy(java.lang.String datasetIdentifier, java.lang.String datasetDescription) 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.
boolean	close() Deprecated. Close access to this dataset.
void	commitUpdates() Deprecated. Commit any changes that have been made to the set of streams managed by this dataset.
DataAvailabilityNotifier	getDataAvailabilityNotifier() Deprecated. Retrieve the data availability notifier for this dataset.
Dataset.DatasetType	getDatasetType() Deprecated. Retrieve the type of the data set
java.lang.String	getDescription() Deprecated. Retrieve a description of the dataset
java.lang.String	getIdentifier() Deprecated. Retrieve the identifier for this dataset.
java.util.concurrent.ConcurrentHashMap<java.lang.String,java.lang.Integer>	getInputStreams() Deprecated. Retrieve a HashMap of the constituent input streams.
long	getLastModificationTime() Deprecated. Retrieve the last update to this dataset
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.
boolean	initializeDataset() Deprecated. Invokes the initialization of the dataset.
boolean	isAvailable() Deprecated. A check to see if the dataset is available
boolean	isDataAvailable() Deprecated. This polls the dataset to see if data is available for consumption.
boolean	isInitialized() Deprecated. Check to see if the dataset has been initialized
void	marshall(FormatWriter mFormat) Deprecated.
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.
boolean	supportsDataAvailabilityNotifications() Deprecated. Indicates whether this dataset supports dynamic data availability notifications
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 class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MODULE

public static final java.lang.String MODULE

Deprecated.

See Also:

Constant Field Values

Constructor Detail

StreamDatasetImplLegacy

public StreamDatasetImplLegacy(java.lang.String datasetIdentifier,
                               java.lang.String datasetDescription)

Deprecated.

StreamDatasetImplLegacy

public StreamDatasetImplLegacy(FormatReader mFormat)

Deprecated.

Method Detail

marshall

public void marshall(FormatWriter mFormat)
              throws FormatException

Deprecated.

Specified by:

marshall in interface FormatMarshaller

Parameters:

mFormat - - The format writer to write to

Throws:

FormatException - If there was a problem while writing

getDatasetType

public Dataset.DatasetType getDatasetType()

Deprecated.

Description copied from interface: Dataset

Retrieve the type of the data set

Specified by:

getDatasetType in interface Dataset

Returns:

type of the dataset

getDescription

public java.lang.String getDescription()

Deprecated.

Description copied from interface: Dataset

Retrieve a description of the dataset

Specified by:

getDescription in interface Dataset

Returns:

A description of the dataset.

getIdentifier

public java.lang.String getIdentifier()

Deprecated.

Description copied from interface: Dataset

Retrieve the identifier for this dataset. This would typically be a UUID which uniquely identifies the dataset in question.

Specified by:

getIdentifier in interface Dataset

Returns:

The unique identifier for this dataset.

isInitialized

public boolean isInitialized()

Deprecated.

Description copied from interface: Dataset

Check to see if the dataset has been initialized

Specified by:

isInitialized in interface Dataset

Returns:

true if the dataset is initialized; false otherwise.

initializeDataset

public boolean initializeDataset()
                          throws DatasetException

Deprecated.

Description copied from interface: Dataset

Invokes the initialization of the dataset. This is invoked only when the node is ready to execute the operation that will operate on this dataset.

Specified by:

initializeDataset in interface Dataset

Returns:

true if the dataset has been initialized; false otherwise.

Throws:

DatasetException

isAvailable

public boolean isAvailable()

Deprecated.

Description copied from interface: Dataset

A check to see if the dataset is available

Specified by:

isAvailable in interface Dataset

Returns:

true if the dataset is available; false otherwise.

isDataAvailable

public boolean isDataAvailable()

Deprecated.

Description copied from interface: Dataset

This polls the dataset to see if data is available for consumption.

Specified by:

isDataAvailable in interface Dataset

Returns:

true if data is available on this dataset; false otherwise.

getLastModificationTime

public long getLastModificationTime()

Deprecated.

Description copied from interface: Dataset

Retrieve the last update to this dataset

Specified by:

getLastModificationTime in interface Dataset

Returns:

The time at which this dataset was last updated. The time is returned in milliseconds.

supportsDataAvailabilityNotifications

public boolean supportsDataAvailabilityNotifications()

Deprecated.

Description copied from interface: Dataset

Indicates whether this dataset supports dynamic data availability notifications

Specified by:

supportsDataAvailabilityNotifications in interface Dataset

Returns:

true if this dataset supports data availability notifications;false otherwise.

getDataAvailabilityNotifier

public DataAvailabilityNotifier getDataAvailabilityNotifier()

Deprecated.

Description copied from interface: Dataset

Retrieve the data availability notifier for this dataset. This method will return a NULL if the underlying dataset does not support availability notifications.

Specified by:

getDataAvailabilityNotifier in interface Dataset

Returns:

The data availability notifier for this dataset.

close

public boolean close()
              throws DatasetException

Deprecated.

Description copied from interface: Dataset

Close access to this dataset. This method returns true if a graceful closure of the dataset was possible. This method will try its best to close the dataset. If it fails to close the dataset an exception, outlining the problems that were encountered will, be thrown.

Specified by:

close in interface Dataset

Returns:

true if a graceful closure of this dataset was performed;false otherwise.

Throws:

DatasetException

getStreamingData

public NBEvent getStreamingData()
                         throws DatasetException

Deprecated.

Description copied from interface: StreamingAccess

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.

Specified by:

getStreamingData in interface StreamingAccess

Returns:

A fragment of the streaming dataset

Throws:

DatasetException - If there are problems performing the operation

writeStreamingData

public void writeStreamingData(NBEvent nbEvent)
                        throws DatasetException

Deprecated.

Description copied from interface: StreamingAccess

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

Specified by:

writeStreamingData in interface StreamingAccess

Parameters:

nbEvent - The stream fragment that needs to be written

Throws:

DatasetException - If there are problems performing the operation

writeStreamingData

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

Deprecated.

Description copied from interface: StreamingAccess

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

Specified by:

writeStreamingData in interface StreamingAccess

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

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

Deprecated.

Description copied from interface: StreamingAccess

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

Specified by:

writeStreamingData in interface StreamingAccess

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

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

Deprecated.

Description copied from interface: StreamingAccess

Add an input stream to this dataset.

Specified by:

addInputStream in interface StreamingAccess

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

public int removeInputStream(java.lang.String streamSynopsis)
                      throws DatasetException

Deprecated.

Description copied from interface: StreamingAccess

Removes an input stream from this dataset.

Specified by:

removeInputStream in interface StreamingAccess

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

public int addInputStreams(java.util.concurrent.ConcurrentHashMap<java.lang.String,java.lang.Integer> streamsToAdd)
                    throws DatasetException

Deprecated.

Description copied from interface: StreamingAccess

Adds a set of input streams to this dataset.

Specified by:

addInputStreams in interface StreamingAccess

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

removeInputStreams

public int removeInputStreams(java.util.concurrent.ConcurrentHashMap<java.lang.String,java.lang.Integer> streamsToRemove)
                       throws DatasetException

Deprecated.

Description copied from interface: StreamingAccess

Removes a set of input streams from this dataset.

Specified by:

removeInputStreams in interface StreamingAccess

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

hasInputStreams

public boolean hasInputStreams()

Deprecated.

Description copied from interface: StreamingAccess

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

Specified by:

hasInputStreams in interface StreamingAccess

Returns:

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

getNumberOfInputStreams

public int getNumberOfInputStreams()

Deprecated.

Description copied from interface: StreamingAccess

Retrieve the number of input streams in this dataset

Specified by:

getNumberOfInputStreams in interface StreamingAccess

Returns:

The number of input streams in this dataset

getInputStreams

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

Deprecated.

Description copied from interface: StreamingAccess

Retrieve a HashMap of the constituent input streams.

Specified by:

getInputStreams in interface StreamingAccess

Returns:

The HashMap of the constituent input streams.

addOutputStream

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

Deprecated.

Description copied from interface: StreamingAccess

Add an output stream to this dataset.

Specified by:

addOutputStream in interface StreamingAccess

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

public int removeOutputStream(java.lang.String streamSynopsis)
                       throws DatasetException

Deprecated.

Description copied from interface: StreamingAccess

Removes an output stream from this dataset.

Specified by:

removeOutputStream in interface StreamingAccess

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

public int addOutputStreams(java.util.concurrent.ConcurrentHashMap<java.lang.String,java.lang.Integer> streamsToAdd)
                     throws DatasetException

Deprecated.

Description copied from interface: StreamingAccess

Adds a set of output streams to this dataset.

Specified by:

addOutputStreams in interface StreamingAccess

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

removeOutputStreams

public int removeOutputStreams(java.util.concurrent.ConcurrentHashMap<java.lang.String,java.lang.Integer> streamsToRemove)
                        throws DatasetException

Deprecated.

Description copied from interface: StreamingAccess

Removes a set of output streams from this dataset.

Specified by:

removeOutputStreams in interface StreamingAccess

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

hasOutputStreams

public boolean hasOutputStreams()

Deprecated.

Description copied from interface: StreamingAccess

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

Specified by:

hasOutputStreams in interface StreamingAccess

Returns:

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

getNumberOfOutputStreams

public int getNumberOfOutputStreams()

Deprecated.

Description copied from interface: StreamingAccess

Retrieve the number of output streams in this dataset.

Specified by:

getNumberOfOutputStreams in interface StreamingAccess

Returns:

The number of output streams in this dataset.

getOutputStreams

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

Deprecated.

Description copied from interface: StreamingAccess

Retrieve a HashMap of the constituent output streams.

Specified by:

getOutputStreams in interface StreamingAccess

Returns:

The HashMap of the constituent output streams.

commitUpdates

public void commitUpdates()
                   throws DatasetException

Deprecated.

Description copied from interface: StreamingAccess

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.

Specified by:

commitUpdates in interface StreamingAccess

Throws:

DatasetException