ch.systemsx.cisd.hdf5

Interface IHDF5Factory

public interface IHDF5Factory

A factory for creating writers and readers of HDF5 files. For straight-forward creation, see methods open(File) and openForReading(File). If you need full control over the creation process, see the methods configure(File) and configureForReading(File).

Obtain an object implementing this interface by calling HDF5FactoryProvider.get().

Method Summary

Modifier and Type	Method and Description
IHDF5WriterConfigurator	configure(java.io.File file) Opens a configurator for an HDF5 file for writing and reading.
IHDF5ReaderConfigurator	configureForReading(java.io.File file) Opens a configurator for an HDF5 file for reading.
boolean	hasMDCImage(java.io.File file) Returns true if the HDF5 file has a metadata cache image.
boolean	isHDF5File(java.io.File file) Returns true, if the file is an HDF5 file and false otherwise.
IHDF5Writer	open(java.io.File file) Opens an HDF5 file for writing and reading.
IHDF5Reader	openForReading(java.io.File file) Opens an HDF5 file for reading.

Method Detail

open

IHDF5Writer open(java.io.File file)

Opens an HDF5 file for writing and reading. If the file does not yet exist, it will be created.

openForReading

IHDF5Reader openForReading(java.io.File file)

Opens an HDF5 file for reading. It is an error if the file does not exist.

configure

IHDF5WriterConfigurator configure(java.io.File file)

Opens a configurator for an HDF5 file for writing and reading. Configure the writer as you need and then call IHDF5WriterConfigurator.writer() in order to start reading and writing the file.

configureForReading

IHDF5ReaderConfigurator configureForReading(java.io.File file)

Opens a configurator for an HDF5 file for reading. Configure the reader as you need and then call IHDF5ReaderConfigurator.reader() in order to start reading the file.

isHDF5File

boolean isHDF5File(java.io.File file)

Returns true, if the file is an HDF5 file and false otherwise.

hasMDCImage

boolean hasMDCImage(java.io.File file)

Returns true if the HDF5 file has a metadata cache image.