ch.systemsx.cisd.hdf5.io

Class HDF5IOAdapterFactory

java.lang.Object

ch.systemsx.cisd.hdf5.io.HDF5IOAdapterFactory

public class HDF5IOAdapterFactory
extends java.lang.Object

A factory of I/O adapter for HDF5 data sets.

Constructor Summary

Constructors

Constructor and Description
HDF5IOAdapterFactory()

Method Summary

Modifier and Type	Method and Description
static ch.systemsx.cisd.base.io.IInputStream	asIInputStream(java.io.File hdf5File, java.lang.String dataSetPath) Creates an adapter of the hdf5File as an IInputStream.
static ch.systemsx.cisd.base.io.IInputStream	asIInputStream(IHDF5Reader reader, java.lang.String dataSetPath) Creates an adapter of the reader as an IInputStream.
static java.io.InputStream	asInputStream(java.io.File hdf5File, java.lang.String dataSetPath) Creates an adapter of the hdf5File as an InputStream.
static java.io.InputStream	asInputStream(IHDF5Reader reader, java.lang.String dataSetPath) Creates an adapter of the reader as an InputStream.
static ch.systemsx.cisd.base.io.IOutputStream	asIOutputStream(java.io.File hdf5File, java.lang.String dataSetPath) Creates an adapter of the hdf5File as an IOutputStream.
static ch.systemsx.cisd.base.io.IOutputStream	asIOutputStream(java.io.File hdf5File, java.lang.String dataSetPath, HDF5GenericStorageFeatures creationStorageFeature, int chunkSize, java.lang.String opaqueTagOrNull) Creates an adapter of the hdf5File as an IOutputStream.
static ch.systemsx.cisd.base.io.IOutputStream	asIOutputStream(IHDF5Writer writer, java.lang.String dataSetPath) Creates an adapter of the writer as an IOutputStream.
static ch.systemsx.cisd.base.io.IOutputStream	asIOutputStream(IHDF5Writer writer, java.lang.String dataSetPath, HDF5GenericStorageFeatures creationStorageFeature, int chunkSize, java.lang.String opaqueTagOrNull) Creates an adapter of the writer as an IOutputStream.
static java.io.OutputStream	asOutputStream(java.io.File hdf5File, java.lang.String dataSetPath) Creates an adapter of the hdf5File as an IOutputStream.
static java.io.OutputStream	asOutputStream(java.io.File hdf5File, java.lang.String dataSetPath, HDF5GenericStorageFeatures creationStorageFeature, int chunkSize, java.lang.String opaqueTagOrNull) Creates an adapter of the hdf5File as an OutputStream.
static java.io.OutputStream	asOutputStream(IHDF5Writer writer, java.lang.String dataSetPath) Creates an adapter of the writer as an IOutputStream.
static java.io.OutputStream	asOutputStream(IHDF5Writer writer, java.lang.String dataSetPath, HDF5GenericStorageFeatures creationStorageFeature, int chunkSize, java.lang.String opaqueTagOrNull) Creates an adapter of the writer as an OutputStream.
static HDF5DataSetRandomAccessFile	asRandomAccessFile(java.io.File hdf5File, java.lang.String dataSetPath, HDF5GenericStorageFeatures creationStorageFeature, int chunkSize, java.lang.String opaqueTagOrNull) Creates an adapter of the hdf5File as an HDF5DataSetRandomAccessFile in read/write mode.
static HDF5DataSetRandomAccessFile	asRandomAccessFile(IHDF5Reader reader, java.lang.String dataSetPath) Creates an adapter of the reader as an HDF5DataSetRandomAccessFile.
static HDF5DataSetRandomAccessFile	asRandomAccessFile(IHDF5Writer writer, java.lang.String dataSetPath) Creates an adapter of the writer as an HDF5DataSetRandomAccessFile.
static HDF5DataSetRandomAccessFile	asRandomAccessFile(IHDF5Writer writer, java.lang.String dataSetPath, HDF5GenericStorageFeatures creationStorageFeature, int chunkSize, java.lang.String opaqueTagOrNull) Creates an adapter of the writer as an HDF5DataSetRandomAccessFile.
static HDF5DataSetRandomAccessFile	asRandomAccessFileReadOnly(java.io.File hdf5File, java.lang.String dataSetPath) Creates an adapter of the hdf5File as an HDF5DataSetRandomAccessFile in read-only mode.
static HDF5DataSetRandomAccessFile	asRandomAccessFileReadWrite(java.io.File hdf5File, java.lang.String dataSetPath) Creates an adapter of the hdf5File as an HDF5DataSetRandomAccessFile in read/write mode.

Methods inherited from class java.lang.Object

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

Constructor Detail

HDF5IOAdapterFactory

public HDF5IOAdapterFactory()

Method Detail

asIOutputStream

public static ch.systemsx.cisd.base.io.IOutputStream asIOutputStream(java.io.File hdf5File,
                                                                     java.lang.String dataSetPath)

Creates an adapter of the hdf5File as an IOutputStream.

If the dataset does not yet exist, it will create a chunked opaque dataset with a chunk size of 1MB and an opaque tag FILE.

Parameters:

hdf5File - The HDF5 file to create the adapter for.

dataSetPath - The path of the HDF5 dataset in the HDF5 container to use as a file.

Returns:

The IOutputStream.

asIOutputStream

public static ch.systemsx.cisd.base.io.IOutputStream asIOutputStream(java.io.File hdf5File,
                                                                     java.lang.String dataSetPath,
                                                                     HDF5GenericStorageFeatures creationStorageFeature,
                                                                     int chunkSize,
                                                                     java.lang.String opaqueTagOrNull)

Creates an adapter of the hdf5File as an IOutputStream.

Parameters:

hdf5File - The HDF5 file to create the adapter for.

dataSetPath - The path of the HDF5 dataset in the HDF5 container to use as a file.

creationStorageFeature - If the dataset does not yet exist, use this value as the storage features when creating it.

chunkSize - If the dataset does not yet exist, use this value as the chunk size.

opaqueTagOrNull - If the dataset does not yet exist and this value is not null, then an opaque dataset will be created using this value will be used as opaque tag.

Returns:

The IOutputStream.

asRandomAccessFileReadWrite

public static HDF5DataSetRandomAccessFile asRandomAccessFileReadWrite(java.io.File hdf5File,
                                                                      java.lang.String dataSetPath)

Creates an adapter of the hdf5File as an HDF5DataSetRandomAccessFile in read/write mode.

Parameters:

hdf5File - The HDF5 file to create the adapter for.

dataSetPath - The path of the HDF5 dataset in the HDF5 container to use as a file.

Returns:

The HDF5DataSetRandomAccessFile.

asOutputStream

public static java.io.OutputStream asOutputStream(java.io.File hdf5File,
                                                  java.lang.String dataSetPath,
                                                  HDF5GenericStorageFeatures creationStorageFeature,
                                                  int chunkSize,
                                                  java.lang.String opaqueTagOrNull)

Creates an adapter of the hdf5File as an OutputStream.

Parameters:

hdf5File - The HDF5 file to create the adapter for.

dataSetPath - The path of the HDF5 dataset in the HDF5 container to use as a file.

creationStorageFeature - If the dataset does not yet exist, use this value as the storage features when creating it.

chunkSize - If the dataset does not yet exist, use this value as the chunk size.

opaqueTagOrNull - If the dataset does not yet exist and this value is not null, then an opaque dataset will be created using this value will be used as opaque tag.

Returns:

The OutputStream.

asOutputStream

public static java.io.OutputStream asOutputStream(java.io.File hdf5File,
                                                  java.lang.String dataSetPath)

Creates an adapter of the hdf5File as an IOutputStream.

If the dataset does not yet exist, it will create a chunked opaque dataset with a chunk size of 1MB and an opaque tag FILE.

Parameters:

hdf5File - The HDF5 file to create the adapter for.

dataSetPath - The path of the HDF5 dataset in the HDF5 container to use as a file.

Returns:

The OutputStream.

asRandomAccessFile

public static HDF5DataSetRandomAccessFile asRandomAccessFile(java.io.File hdf5File,
                                                             java.lang.String dataSetPath,
                                                             HDF5GenericStorageFeatures creationStorageFeature,
                                                             int chunkSize,
                                                             java.lang.String opaqueTagOrNull)

Creates an adapter of the hdf5File as an HDF5DataSetRandomAccessFile in read/write mode.

Parameters:

hdf5File - The HDF5 file to create the adapter for.

dataSetPath - The path of the HDF5 dataset in the HDF5 container to use as a file.

creationStorageFeature - If the dataset does not yet exist, use this value as the storage features when creating it.

chunkSize - If the dataset does not yet exist, use this value as the chunk size.

opaqueTagOrNull - If the dataset does not yet exist and this value is not null, then an opaque dataset will be created using this value will be used as opaque tag.

Returns:

The HDF5DataSetRandomAccessFile.

asIInputStream

public static ch.systemsx.cisd.base.io.IInputStream asIInputStream(java.io.File hdf5File,
                                                                   java.lang.String dataSetPath)

Creates an adapter of the hdf5File as an IInputStream.

Parameters:

hdf5File - The HDF5 file to create the adapter for.

dataSetPath - The path of the HDF5 dataset in the HDF5 container to use as a file.

Returns:

The IInputStream.

asInputStream

public static java.io.InputStream asInputStream(java.io.File hdf5File,
                                                java.lang.String dataSetPath)

Creates an adapter of the hdf5File as an InputStream.

Parameters:

hdf5File - The HDF5 file to create the adapter for.

dataSetPath - The path of the HDF5 dataset in the HDF5 container to use as a file.

Returns:

The InputStream.

asRandomAccessFileReadOnly

public static HDF5DataSetRandomAccessFile asRandomAccessFileReadOnly(java.io.File hdf5File,
                                                                     java.lang.String dataSetPath)

Creates an adapter of the hdf5File as an HDF5DataSetRandomAccessFile in read-only mode.

Parameters:

hdf5File - The HDF5 file to create the adapter for.

dataSetPath - The path of the HDF5 dataset in the HDF5 container to use as a file.

Returns:

The HDF5DataSetRandomAccessFile.

asIOutputStream

public static ch.systemsx.cisd.base.io.IOutputStream asIOutputStream(IHDF5Writer writer,
                                                                     java.lang.String dataSetPath)

Creates an adapter of the writer as an IOutputStream.

If the dataset does not yet exist, it will create a chunked opaque dataset with a chunk size of 1MB and an opaque tag FILE.

Note that returned object is buffered. Do not access dataSetPath by directly accessing writer while this object is used or else the behavior is undefined!

Parameters:

writer - The HDF5 writer to create the adapter for. The writer will not be closed when the returned object is closed.

dataSetPath - The path of the HDF5 dataset in the HDF5 container to use as a file.

Returns:

The IOutputStream.

asIOutputStream

public static ch.systemsx.cisd.base.io.IOutputStream asIOutputStream(IHDF5Writer writer,
                                                                     java.lang.String dataSetPath,
                                                                     HDF5GenericStorageFeatures creationStorageFeature,
                                                                     int chunkSize,
                                                                     java.lang.String opaqueTagOrNull)

Creates an adapter of the writer as an IOutputStream.

Note that returned object is buffered. Do not access dataSetPath by directly accessing writer while this object is used or else the behavior is undefined!

Parameters:

writer - The HDF5 writer to create the adapter for. The writer will not be closed when the returned object is closed.

dataSetPath - The path of the HDF5 dataset in the HDF5 container to use as a file.

creationStorageFeature - If the dataset does not yet exist, use this value as the storage features when creating it.

chunkSize - If the dataset does not yet exist, use this value as the chunk size.

opaqueTagOrNull - If the dataset does not yet exist and this value is not null, then an opaque dataset will be created using this value will be used as opaque tag.

Returns:

The IOutputStream.

asOutputStream

public static java.io.OutputStream asOutputStream(IHDF5Writer writer,
                                                  java.lang.String dataSetPath)

Creates an adapter of the writer as an IOutputStream.

If the dataset does not yet exist, it will create a chunked opaque dataset with a chunk size of 1MB and an opaque tag FILE.

Note that returned object is buffered. Do not access dataSetPath by directly accessing writer while this object is used or else the behavior is undefined!

Parameters:

writer - The HDF5 writer to create the adapter for. The writer will not be closed when the returned object is closed.

dataSetPath - The path of the HDF5 dataset in the HDF5 container to use as a file.

Returns:

The OutputStream.

asOutputStream

public static java.io.OutputStream asOutputStream(IHDF5Writer writer,
                                                  java.lang.String dataSetPath,
                                                  HDF5GenericStorageFeatures creationStorageFeature,
                                                  int chunkSize,
                                                  java.lang.String opaqueTagOrNull)

Creates an adapter of the writer as an OutputStream.

Note that returned object is buffered. Do not access dataSetPath by directly accessing writer while this object is used or else the behavior is undefined!

Parameters:

writer - The HDF5 writer to create the adapter for. The writer will not be closed when the returned object is closed.

dataSetPath - The path of the HDF5 dataset in the HDF5 container to use as a file.

creationStorageFeature - If the dataset does not yet exist, use this value as the storage features when creating it.

chunkSize - If the dataset does not yet exist, use this value as the chunk size.

opaqueTagOrNull - If the dataset does not yet exist and this value is not null, then an opaque dataset will be created using this value will be used as opaque tag.

Returns:

The OutputStream.

asRandomAccessFile

public static HDF5DataSetRandomAccessFile asRandomAccessFile(IHDF5Writer writer,
                                                             java.lang.String dataSetPath,
                                                             HDF5GenericStorageFeatures creationStorageFeature,
                                                             int chunkSize,
                                                             java.lang.String opaqueTagOrNull)

Creates an adapter of the writer as an HDF5DataSetRandomAccessFile.

Note that returned object is buffered. Do not access dataSetPath by directly accessing writer while this object is used or else the behavior is undefined!

Parameters:

writer - The HDF5 writer to create the adapter for. The writer will not be closed when the returned object is closed.

dataSetPath - The path of the HDF5 dataset in the HDF5 container to use as a file.

creationStorageFeature - If the dataset does not yet exist, use this value as the storage features when creating it.

chunkSize - If the dataset does not yet exist, use this value as the chunk size.

opaqueTagOrNull - If the dataset does not yet exist and this value is not null, then an opaque dataset will be created using this value will be used as opaque tag.

Returns:

The HDF5DataSetRandomAccessFile.

asRandomAccessFile

public static HDF5DataSetRandomAccessFile asRandomAccessFile(IHDF5Writer writer,
                                                             java.lang.String dataSetPath)

Creates an adapter of the writer as an HDF5DataSetRandomAccessFile.

Note that returned object is buffered. Do not access dataSetPath by directly accessing writer while this object is used or else the behavior is undefined!

Parameters:

writer - The HDF5 writer to create the adapter for. The writer will not be closed when the returned object is closed.

dataSetPath - The path of the HDF5 dataset in the HDF5 container to use as a file.

Returns:

The HDF5DataSetRandomAccessFile.

asIInputStream

public static ch.systemsx.cisd.base.io.IInputStream asIInputStream(IHDF5Reader reader,
                                                                   java.lang.String dataSetPath)

Creates an adapter of the reader as an IInputStream.

Parameters:

reader - The HDF5 reader to create the adapter for. The reader will not be closed when the returned object is closed.

dataSetPath - The path of the HDF5 dataset in the HDF5 container to use as a file.

Returns:

The IInputStream.

asInputStream

public static java.io.InputStream asInputStream(IHDF5Reader reader,
                                                java.lang.String dataSetPath)

Creates an adapter of the reader as an InputStream.

Parameters:

reader - The HDF5 reader to create the adapter for. The reader will not be closed when the returned object is closed.

dataSetPath - The path of the HDF5 dataset in the HDF5 container to use as a file.

Returns:

The InputStream.

asRandomAccessFile

public static HDF5DataSetRandomAccessFile asRandomAccessFile(IHDF5Reader reader,
                                                             java.lang.String dataSetPath)

Creates an adapter of the reader as an HDF5DataSetRandomAccessFile.

Parameters:

reader - The HDF5 reader to create the adapter for. The reader will not be closed when the returned object is closed.

dataSetPath - The path of the HDF5 dataset in the HDF5 container to use as a file.

Returns:

The HDF5DataSetRandomAccessFile.