ds.granules.dataset

Interface FileDataset

All Superinterfaces:

Dataset, FormatMarshaller

All Known Implementing Classes:

FileDatasetImpl

public interface FileDataset
extends Dataset

The interface for accessing a dataset comprising files.

Author:

Shrideep Pallickara

Nested Class Summary

Nested classes/interfaces inherited from interface ds.granules.dataset.Dataset

Dataset.DatasetType

Method Summary

Modifier and Type	Method and Description
void	addFile(java.lang.String fileName, java.lang.String mode) Adds a file with the specified permission "r", "w" or "rw" to this dataset.
java.util.Collection<java.lang.String>	getFiles() Retrieves the list of files in this dataset.
long	getPosition(java.lang.String fileName) Retrieves the position of filePointer for the given dataset
long	getSize(java.lang.String fileName) Returns the current size of the file in question
boolean	hasFile(java.lang.String fileName) Checks to see if the file is part of a given dataset
int	read(java.lang.String fileName, byte[] bytesToRead) Attempts to read a set of bytes from the underlying file.
int	read(java.lang.String fileName, java.nio.ByteBuffer readBuffer) Attempts to read a set of bytes from the underlying file.
void	removeFile(java.lang.String fileName) Removes a file from this dataset.
void	setPosition(java.lang.String fileName, long newPosition) Sets the position of filePointer for one of the file in the given dataset.
int	write(java.lang.String fileName, byte[] bytesToWrite) Writes a byte[] to a give file.
int	write(java.lang.String fileName, java.nio.ByteBuffer writeBuffer) Write the specified Buffer to the file corresponding to the specified file.

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

Method Detail

getSize

long getSize(java.lang.String fileName)
      throws DatasetException

Returns the current size of the file in question

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.

getPosition

long getPosition(java.lang.String fileName)
          throws DatasetException

Retrieves the position of filePointer for the given dataset

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

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

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

Parameters:

fileName - The file

newPosition - The new position for the pointer

Throws:

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

read

int read(java.lang.String fileName,
         byte[] bytesToRead)
  throws DatasetException

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

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

read

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

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

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

write

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

Writes a byte[] to a give file.

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

write

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

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

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

addFile

void addFile(java.lang.String fileName,
             java.lang.String mode)
      throws DatasetException

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

Parameters:

fileName - The name of the file

mode - The permissions associated with this file

Throws:

java.lang.NullPointerException - If the specified filename is NULL

DatasetException - If there are problems adding this file

removeFile

void removeFile(java.lang.String fileName)
         throws DatasetException

Removes a file from this dataset.

Parameters:

fileName - The name of the file

Throws:

java.lang.NullPointerException - If the specified filename is NULL

DatasetException - If there are problems removing this file

hasFile

boolean hasFile(java.lang.String fileName)

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

Parameters:

fileName - The name of the file

Returns:

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

getFiles

java.util.Collection<java.lang.String> getFiles()

Retrieves the list of files in this dataset.

Returns:

An collection of the files in this dataset.