ds.granules.dataset

Class FileDatasetImplLegacy

java.lang.Object

ds.granules.dataset.FileDatasetImplLegacy

All Implemented Interfaces:

FormatMarshaller, Dataset, FileAccess

Deprecated.

@Deprecated
public class FileDatasetImplLegacy
extends java.lang.Object
implements FileAccess

An implementation of the FileAccess dataset interface.

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.

Constructor Summary

Constructors

Constructor and Description
FileDatasetImplLegacy(FormatReader mFormat) Deprecated.
FileDatasetImplLegacy(java.lang.String datasetIdentifier, java.lang.String datasetDescription) Deprecated.

Method Summary

Modifier and Type	Method and Description
void	addFile(java.lang.String filename, java.lang.String permissions) Deprecated. Adds a file with the specified permission "r", "w" or "rw" to this dataset.
boolean	close() Deprecated. Close access to 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.util.Enumeration<java.lang.Object>	getFilenames() Deprecated. Retrieves the list of files in this dataset
java.lang.String	getIdentifier() Deprecated. Retrieve the identifier for this dataset.
java.util.Properties	getInitializationDirectives() Deprecated.
long	getLastModificationTime() Deprecated. Retrieve the last update to this dataset
long	getPosition(java.lang.String fileName) Deprecated. Retrieves the position of filePointer for the given dataset
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
boolean	isPartOfDataset(java.lang.String fileName) Deprecated. Checks to see if the file is part of a given dataset
static void	main(java.lang.String[] args) Deprecated.
void	marshall(FormatWriter mFormat) Deprecated.
int	read(java.lang.String filename, byte[] bytesToRead) Deprecated. Attempts to read a set of bytes from the underlying file.
int	read(java.lang.String fileName, java.nio.ByteBuffer readBuffer) Deprecated. Attempts to read a set of bytes from the underlying file.
void	removeFile(java.lang.String filename) Deprecated. Removes a file from this dataset.
void	setPosition(java.lang.String fileName, long newPosition) Deprecated. Sets the position of filePointer for one of the file in the given dataset.
long	size(java.lang.String fileName) Deprecated. Returns the current size of the file in question
boolean	supportsDataAvailabilityNotifications() Deprecated. Indicates whether this dataset supports dynamic data availability notifications
int	write(java.lang.String fileName, byte[] bytesToWrite) Deprecated. Writes a byte[] to a give file.
int	write(java.lang.String fileName, java.nio.ByteBuffer writeBuffer) Deprecated. Write the specified Buffer to the file corresponding to the specified file.

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

FileDatasetImplLegacy

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

Deprecated.

FileDatasetImplLegacy

public FileDatasetImplLegacy(FormatReader mFormat)
                      throws java.io.IOException,
                             DatasetException

Deprecated.

Throws:

java.io.IOException

DatasetException

Method Detail

marshall

public void marshall(FormatWriter mFormat)

Deprecated.

Specified by:

marshall in interface FormatMarshaller

Parameters:

mFormat - - The format writer to write to

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

getFilenames

public java.util.Enumeration<java.lang.Object> getFilenames()

Deprecated.

Description copied from interface: FileAccess

Retrieves the list of files in this dataset

Specified by:

getFilenames in interface FileAccess

Returns:

An enumeration of the files in 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

addFile

public void addFile(java.lang.String filename,
                    java.lang.String permissions)
             throws DatasetException

Deprecated.

Description copied from interface: FileAccess

Adds a file with the specified permission "r", "w" or "rw" to this dataset.

Specified by:

addFile in interface FileAccess

Parameters:

filename - The name of the file

permissions - The permissions associated with this file

Throws:

DatasetException - If there are problems adding this file

removeFile

public void removeFile(java.lang.String filename)
                throws DatasetException

Deprecated.

Description copied from interface: FileAccess

Removes a file from this dataset.

Specified by:

removeFile in interface FileAccess

Parameters:

filename - The name of the file

Throws:

DatasetException - If there are problems removing this file

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.

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.

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.

getInitializationDirectives

public java.util.Properties getInitializationDirectives()

Deprecated.

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.

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.

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.

read

public int read(java.lang.String filename,
                byte[] bytesToRead)
         throws DatasetException,
                java.io.IOException

Deprecated.

Description copied from interface: FileAccess

Attempts to read a set of bytes from the underlying file.

Specified by:

read in interface FileAccess

Parameters:

filename - The file to be read

bytesToRead - The byte[] to be read into

Returns:

The number of bytes read, possibly zero, or -1 if the channel has reached end-of-stream

Throws:

DatasetException - If there are problems retrieving the FileChannel corresponding to the file

java.io.IOException - If there are IO problems in performing the operation

read

public int read(java.lang.String fileName,
                java.nio.ByteBuffer readBuffer)
         throws DatasetException,
                java.io.IOException

Deprecated.

Description copied from interface: FileAccess

Attempts to read a set of bytes from the underlying file.

Specified by:

read in interface FileAccess

Parameters:

fileName - The file to be read

readBuffer - The buffer to be read into

Returns:

The number of bytes read, possibly zero, or -1 if the channel has reached end-of-stream

Throws:

DatasetException - If there are problems retrieving the FileChannel corresponding to the file

java.io.IOException - If there are IO problems in performing the operation

write

public int write(java.lang.String fileName,
                 byte[] bytesToWrite)
          throws DatasetException,
                 java.io.IOException

Deprecated.

Description copied from interface: FileAccess

Writes a byte[] to a give file.

Specified by:

write in interface FileAccess

Parameters:

fileName - The file to be written to

bytesToWrite - The byte[] to be written.

Returns:

The number of bytes written, possibly zero

Throws:

DatasetException - If there are problems retrieving the FileChannel corresponding to the file

java.io.IOException - If there are IO problems in performing the operation

write

public int write(java.lang.String fileName,
                 java.nio.ByteBuffer writeBuffer)
          throws DatasetException,
                 java.io.IOException

Deprecated.

Description copied from interface: FileAccess

Write the specified Buffer to the file corresponding to the specified file.

Specified by:

write in interface FileAccess

Parameters:

fileName - The file to be written to

writeBuffer - The buffer holding the bytes to be written

Returns:

The number of bytes written, possibly zero

Throws:

DatasetException - If there are problems retrieving the FileChannel corresponding to the file

java.io.IOException - If there are IO problems in performing the operation

getPosition

public long getPosition(java.lang.String fileName)
                 throws DatasetException,
                        java.io.IOException

Deprecated.

Description copied from interface: FileAccess

Retrieves the position of filePointer for the given dataset

Specified by:

getPosition in interface FileAccess

Parameters:

fileName - The name of the file.

Returns:

The position of filePointer for the given dataset

Throws:

DatasetException - If there are problems retrieving the FileChannel corresponding to the file

java.io.IOException - If there are IO problems in performing the operation

setPosition

public void setPosition(java.lang.String fileName,
                        long newPosition)
                 throws DatasetException,
                        java.io.IOException

Deprecated.

Description copied from interface: FileAccess

Sets the position of filePointer for one of the file in the given dataset.

Specified by:

setPosition in interface FileAccess

Parameters:

fileName - The file

newPosition - The new position for the pointer

Throws:

DatasetException - If there are problems retrieving the FileChannel corresponding to the file

java.io.IOException - If there are IO problems in performing the operation

size

public long size(java.lang.String fileName)
          throws DatasetException,
                 java.io.IOException

Deprecated.

Description copied from interface: FileAccess

Returns the current size of the file in question

Specified by:

size in interface FileAccess

Parameters:

fileName - The name of the file

Returns:

The current size of the file

Throws:

DatasetException - If there are problems retrieving the FileChannel corresponding to the file

java.io.IOException - If there are IO problems in completing the operation.

isPartOfDataset

public boolean isPartOfDataset(java.lang.String fileName)

Deprecated.

Description copied from interface: FileAccess

Checks to see if the file is part of a given dataset

Specified by:

isPartOfDataset in interface FileAccess

Parameters:

fileName - The name of the file

Returns:

true if the file is a part of the dataset; false otherwise.

main

public static void main(java.lang.String[] args)

Deprecated.

Parameters:

args -