ch.systemsx.cisd.hdf5.h5ar

Class HDF5ArchiverFactory

java.lang.Object

ch.systemsx.cisd.hdf5.h5ar.HDF5ArchiverFactory

public class HDF5ArchiverFactory
extends java.lang.Object

A factory for IHDF5Archiver

Constructor Summary

Constructors

Constructor and Description
HDF5ArchiverFactory()

Method Summary

Modifier and Type	Method and Description
static IHDF5Archiver	open(java.io.File file) Opens an HDF5 archive file for writing and reading.
static IHDF5Archiver	open(java.io.File file, boolean noSync, IHDF5WriterConfigurator.FileFormatVersionBounds fileFormat, ch.systemsx.cisd.base.exceptions.IErrorStrategy errorStrategyOrNull) Opens an HDF5 archive file for writing and reading.
static IHDF5Archiver	open(java.io.File file, ch.systemsx.cisd.base.exceptions.IErrorStrategy errorStrategyOrNull) Opens an HDF5 archive file for writing and reading.
static IHDF5Archiver	open(IHDF5Writer writer) Opens an HDF5 archive file based on an HDF writer for writing and reading.
static IHDF5Archiver	open(IHDF5Writer writer, ch.systemsx.cisd.base.exceptions.IErrorStrategy errorStrategy) Opens an HDF5 archive file based on an HDF writer for writing and reading.
static IHDF5Archiver	open(java.lang.String filePath) Opens an HDF5 archive file named filePath for writing and reading.
static IHDF5Archiver	open(java.lang.String filePath, boolean noSync, IHDF5WriterConfigurator.FileFormatVersionBounds fileFormat, ch.systemsx.cisd.base.exceptions.IErrorStrategy errorStrategyOrNull) Opens an HDF5 archive file named filePath for writing and reading.
static IHDF5Archiver	open(java.lang.String filePath, ch.systemsx.cisd.base.exceptions.IErrorStrategy errorStrategyOrNull) Opens an HDF5 archive file named filePath for writing and reading.
static IHDF5ArchiveReader	openForReading(java.io.File file) Opens an HDF5 archive file for reading.
static IHDF5ArchiveReader	openForReading(java.io.File file, ch.systemsx.cisd.base.exceptions.IErrorStrategy errorStrategy) Opens an HDF5 archive file for reading.
static IHDF5ArchiveReader	openForReading(IHDF5Reader reader) Opens an HDF5 archive file based on an HDF5 reader.
static IHDF5ArchiveReader	openForReading(IHDF5Reader reader, ch.systemsx.cisd.base.exceptions.IErrorStrategy errorStrategy) Opens an HDF5 archive file based on an HDF5 reader.
static IHDF5ArchiveReader	openForReading(java.lang.String filePath) Opens an HDF5 archive file named filePath for reading.
static IHDF5ArchiveReader	openForReading(java.lang.String filePath, ch.systemsx.cisd.base.exceptions.IErrorStrategy errorStrategy) Opens an HDF5 archive file named filePath for reading.

Methods inherited from class java.lang.Object

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

Constructor Detail

HDF5ArchiverFactory

public HDF5ArchiverFactory()

Method Detail

open

public static IHDF5Archiver open(java.io.File file)

Opens an HDF5 archive file for writing and reading.

Parameters:

file - The archive file to open. If the archive file does not yet exist, it will be created.

open

public static IHDF5Archiver open(java.io.File file,
                                 ch.systemsx.cisd.base.exceptions.IErrorStrategy errorStrategyOrNull)

Opens an HDF5 archive file for writing and reading.

Parameters:

file - The archive file to open. If the archive file does not yet exist, it will be created.

errorStrategyOrNull - The IErrorStrategy to use on errors when accessing the archive. May be null, in which case every error just causes an exception.

open

public static IHDF5Archiver open(java.io.File file,
                                 boolean noSync,
                                 IHDF5WriterConfigurator.FileFormatVersionBounds fileFormat,
                                 ch.systemsx.cisd.base.exceptions.IErrorStrategy errorStrategyOrNull)

Opens an HDF5 archive file for writing and reading.

Parameters:

file - The archive file to open. If the archive file does not yet exist, it will be created.

noSync - if true, no sync call will be performed on closing the file.

fileFormat - The HDF5 file format to use for the archive.

errorStrategyOrNull - The IErrorStrategy to use on errors when accessing the archive. May be null, in which case every error just causes an exception.

open

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

Opens an HDF5 archive file named filePath for writing and reading.

Parameters:

filePath - The path of the archive file to open. If the archive file does not yet exist, it will be created.

open

public static IHDF5Archiver open(java.lang.String filePath,
                                 ch.systemsx.cisd.base.exceptions.IErrorStrategy errorStrategyOrNull)

Opens an HDF5 archive file named filePath for writing and reading.

Parameters:

filePath - The path of the archive file to open. If the archive file does not yet exist, it will be created.

errorStrategyOrNull - The IErrorStrategy to use on errors when accessing the archive. May be null, in which case every error just causes an exception.

open

public static IHDF5Archiver open(java.lang.String filePath,
                                 boolean noSync,
                                 IHDF5WriterConfigurator.FileFormatVersionBounds fileFormat,
                                 ch.systemsx.cisd.base.exceptions.IErrorStrategy errorStrategyOrNull)

Opens an HDF5 archive file named filePath for writing and reading.

Parameters:

filePath - The path of the archive file to open. If the archive file does not yet exist, it will be created.

noSync - if true, no sync call will be performed on closing the file.

fileFormat - The HDF5 file format to use for the archive.

errorStrategyOrNull - The IErrorStrategy to use on errors when accessing the archive. May be null, in which case every error just causes an exception.

open

public static IHDF5Archiver open(IHDF5Writer writer)

Opens an HDF5 archive file based on an HDF writer for writing and reading.

Parameters:

writer - The HDF5 writer to base the archive file on. Closing the archive writer will not close the HDF5 writer.

open

public static IHDF5Archiver open(IHDF5Writer writer,
                                 ch.systemsx.cisd.base.exceptions.IErrorStrategy errorStrategy)

Opens an HDF5 archive file based on an HDF writer for writing and reading.

Parameters:

writer - The HDF5 writer to base the archive file on. Closing the archive writer will not close the HDF5 writer. It is recommended that you configure the writer with IHDF5WriterConfigurator.houseKeepingNameSuffix("\\1\\0)") so that internal house-keeping files cannot overwrite archived files. .

errorStrategy - The IErrorStrategy to use on errors when accessing the archive.

openForReading

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

Opens an HDF5 archive file for reading.

Parameters:

file - The archive file to open. It is an error if the archive file does not exist.

openForReading

public static IHDF5ArchiveReader openForReading(java.io.File file,
                                                ch.systemsx.cisd.base.exceptions.IErrorStrategy errorStrategy)

Opens an HDF5 archive file for reading.

Parameters:

file - The archive file to open. It is an error if the archive file does not exist.

errorStrategy - The IErrorStrategy to use on errors when accessing the archive.

openForReading

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

Opens an HDF5 archive file named filePath for reading.

Parameters:

filePath - The path of the archive file to open. It is an error if the archive file does not exist.

openForReading

public static IHDF5ArchiveReader openForReading(java.lang.String filePath,
                                                ch.systemsx.cisd.base.exceptions.IErrorStrategy errorStrategy)

Opens an HDF5 archive file named filePath for reading.

Parameters:

filePath - The path of the archive file to open. It is an error if the archive file does not exist.

errorStrategy - The IErrorStrategy to use on errors when accessing the archive.

openForReading

public static IHDF5ArchiveReader openForReading(IHDF5Reader reader,
                                                ch.systemsx.cisd.base.exceptions.IErrorStrategy errorStrategy)

Opens an HDF5 archive file based on an HDF5 reader.

Parameters:

reader - The HDF5 reader to use as the source of the archive. Closing the archive reader will not close the HDF5 reader.

errorStrategy - The IErrorStrategy to use on errors when accessing the archive.

openForReading

public static IHDF5ArchiveReader openForReading(IHDF5Reader reader)

Opens an HDF5 archive file based on an HDF5 reader.

Parameters:

reader - The HDF5 reader to use as the source of the archive. Closing the archive reader will not close the HDF5 reader.