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

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 void	garbageCollect() H5garbage_collect walks through all the garbage collection routines of the library, freeing any unused memory.
static int	getOpenHDF5FileCount() Returns the number of open HDF5 files in the library.
static boolean	hasMDCImage(java.io.File file) Returns true if the HDF5 file has a metadata cache image.
static boolean	hasMDCImage(java.lang.String filePath) Returns true if the HDF5 file has a metadata cache image.
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.
static boolean	reset() This function flushes all data to disk, closes all file identifiers, and cleans up all memory used by the library.

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.

hasMDCImage

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

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

hasMDCImage

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

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

getOpenHDF5FileCount

public static int getOpenHDF5FileCount()

Returns the number of open HDF5 files in the library.

reset

public static boolean reset()

This function flushes all data to disk, closes all file identifiers, and cleans up all memory used by the library. This function is generally called when the application calls exit(), but may be called earlier in event of an emergency shutdown or out of desire to free all resources used by the HDF5 library.

The reset will only be performed if the library has no open files.

Returns:

true If the reset has been performed and false otherwise.

garbageCollect

public static void garbageCollect()

H5garbage_collect walks through all the garbage collection routines of the library, freeing any unused memory.

It is not required that H5garbage_collect be called at any particular time; it is only necessary in certain situations where the application has performed actions that cause the library to allocate many objects. The application should call H5garbage_collect if it eventually releases those objects and wants to reduce the memory used by the library from the peak usage required.

The library automatically garbage collects all the free lists when the application ends.