ch.systemsx.cisd.hdf5

Class HDF5Factory

java.lang.Object

ch.systemsx.cisd.hdf5.HDF5Factory

public final class HDF5Factory
extends java.lang.Object

A static wrapper for the IHDF5Factory 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).

Constructor Summary

Constructors

Constructor and Description
HDF5Factory()

Method Summary

Methods

Modifier and Type	Method and Description
static IHDF5WriterConfigurator	configure(java.io.File file) Opens a configurator for an HDF5 file for writing and reading.
static IHDF5WriterConfigurator	configure(java.lang.String filePath) Opens a configurator for an HDF5 file named filePath for writing and reading.
static IHDF5ReaderConfigurator	configureForReading(java.io.File file) Opens a configurator for an HDF5 file for reading.
static IHDF5ReaderConfigurator	configureForReading(java.lang.String filePath) Opens a configurator for an HDF5 file named filePath for reading.
static boolean	isHDF5File(java.io.File file) Returns true, if the file is an HDF5 file and false otherwise.
static boolean	isHDF5File(java.lang.String filePath) Returns true, if the file named filePath is an HDF5 file and false otherwise.
static IHDF5Writer	open(java.io.File file) Opens an HDF5 file for writing and reading.
static IHDF5Writer	open(java.lang.String filePath) Opens an HDF5 file named filePath for writing and reading.
static IHDF5Reader	openForReading(java.io.File file) Opens an HDF5 file for reading.
static IHDF5Reader	openForReading(java.lang.String filePath) Opens an HDF5 file named filePath for reading.

Methods inherited from class java.lang.Object

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

Constructor Detail

HDF5Factory

public HDF5Factory()

Method Detail

open

public static 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.

open

public static IHDF5Writer open(java.lang.String filePath)

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

openForReading

public static IHDF5Reader openForReading(java.io.File file)

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

openForReading

public static IHDF5Reader openForReading(java.lang.String filePath)

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

configure

public static 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.

configure

public static IHDF5WriterConfigurator configure(java.lang.String filePath)

Opens a configurator for an HDF5 file named filePath 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

public static 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.

configureForReading

public static IHDF5ReaderConfigurator configureForReading(java.lang.String filePath)

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

isHDF5File

public static boolean isHDF5File(java.io.File file)

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

isHDF5File

public static boolean isHDF5File(java.lang.String filePath)

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