ch.systemsx.cisd.hdf5

Interface IHDF5WriterConfigurator

All Superinterfaces:

IHDF5ReaderConfigurator

public interface IHDF5WriterConfigurator
extends IHDF5ReaderConfigurator

The configuration of the writer is done by chaining calls to configuration methods before calling writer().

Obtain an object implementing this interface by calling IHDF5Factory.configure(java.io.File).

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IHDF5WriterConfigurator.FileFormatVersion Enum for specifying a file format version.
static class	IHDF5WriterConfigurator.FileFormatVersionBounds Enum for specifying the file format version boundaries.
static class	IHDF5WriterConfigurator.SyncMode The mode of synchronizing changes (using a method like fsync(2)) to the HDF5 file with the underlying storage.

Method Summary

Modifier and Type	Method and Description
IHDF5WriterConfigurator	dontUseExtendableDataTypes() Use data types which can not be extended later on.
IHDF5WriterConfigurator	fileFormat(IHDF5WriterConfigurator.FileFormatVersionBounds newFileFormat) Sets the file format compatibility for the writer.
IHDF5WriterConfigurator	generateMDCImage() Enables generation of a metadata cache image.
IHDF5WriterConfigurator	houseKeepingNameSuffix(java.lang.String houseKeepingNameSuffix) Sets the suffix that is used to mark and recognize house keeping files and groups.
IHDF5WriterConfigurator	keepDataSetsIfTheyExist() On writing a data set, keep the data set if it exists and only write the new data.
IHDF5WriterConfigurator	keepMDCImage() Keep an existing metadata cache image, but do not generate an MDC if the file has none already.
IHDF5WriterConfigurator	noAutoDereference() Switches off automatic dereferencing of unresolved references.
IHDF5WriterConfigurator	noGenerateMDCImage() Disables generation of a metadata cache image.
IHDF5WriterConfigurator	overwrite() The file will be truncated to length 0 if it already exists, that is its content will be deleted.
IHDF5WriterConfigurator	performNumericConversions() Will try to perform numeric conversions where appropriate if supported by the platform.
IHDF5WriterConfigurator	syncMode(IHDF5WriterConfigurator.SyncMode newSyncMode) Sets the IHDF5WriterConfigurator.SyncMode.
IHDF5WriterConfigurator	useSimpleDataSpaceForAttributes() Use simple data spaces for attributes.
IHDF5WriterConfigurator	useUTF8CharacterEncoding() Sets UTF8 character encoding for all paths and all strings in this file.
IHDF5Writer	writer() Returns an IHDF5Writer based on this configuration.

Methods inherited from interface ch.systemsx.cisd.hdf5.IHDF5ReaderConfigurator

platformSupportsNumericConversions, reader

Method Detail

overwrite

IHDF5WriterConfigurator overwrite()

The file will be truncated to length 0 if it already exists, that is its content will be deleted.

dontUseExtendableDataTypes

IHDF5WriterConfigurator dontUseExtendableDataTypes()

Use data types which can not be extended later on. This may reduce the initial size of the HDF5 file.

useSimpleDataSpaceForAttributes

IHDF5WriterConfigurator useSimpleDataSpaceForAttributes()

Use simple data spaces for attributes.

keepDataSetsIfTheyExist

IHDF5WriterConfigurator keepDataSetsIfTheyExist()

On writing a data set, keep the data set if it exists and only write the new data. This is equivalent to the _KEEP variants of HDF5GenericStorageFeatures and makes this behavior the default.

If this setting is not given, an existing data set will be deleted before the data set is written.

Note: If this configuration option is chosen, data types and storage features may only apply if the written data set does not yet exist. For example, it may lead to a string value being truncated on write if a string dataset with the same name and shorter length already exists.

fileFormat

IHDF5WriterConfigurator fileFormat(IHDF5WriterConfigurator.FileFormatVersionBounds newFileFormat)

Sets the file format compatibility for the writer.

syncMode

IHDF5WriterConfigurator syncMode(IHDF5WriterConfigurator.SyncMode newSyncMode)

Sets the IHDF5WriterConfigurator.SyncMode.

performNumericConversions

IHDF5WriterConfigurator performNumericConversions()

Will try to perform numeric conversions where appropriate if supported by the platform.

Numeric conversions can be platform dependent and are not available on all platforms. Be advised not to rely on numeric conversions if you can help it!

Specified by:

performNumericConversions in interface IHDF5ReaderConfigurator

generateMDCImage

IHDF5WriterConfigurator generateMDCImage()

Enables generation of a metadata cache image.

Use {#link keepMDCImage() to only generate an MDC image if the file already has one.

noGenerateMDCImage

IHDF5WriterConfigurator noGenerateMDCImage()

Disables generation of a metadata cache image.

Use {#link keepMDCImage() to keep an MDC image if the file already has one but disable it if it does not.

keepMDCImage

IHDF5WriterConfigurator keepMDCImage()

Keep an existing metadata cache image, but do not generate an MDC if the file has none already. This is the default.

Use {#link generateMDCImage() to generate an MDC image regardless of whether the file already has one.

useUTF8CharacterEncoding

IHDF5WriterConfigurator useUTF8CharacterEncoding()

Sets UTF8 character encoding for all paths and all strings in this file. (The default is ASCII.)

noAutoDereference

IHDF5WriterConfigurator noAutoDereference()

Switches off automatic dereferencing of unresolved references. Use this when you need to access file names that start with \0. The down-side of switching off automatic dereferencing is that you can't provide references as obtained by IHDF5ReferenceReader.read(String, boolean) with resolveName=false in places where a dataset path is required.
Note: automatic dereferencing is switched on by default.

Specified by:

noAutoDereference in interface IHDF5ReaderConfigurator

houseKeepingNameSuffix

IHDF5WriterConfigurator houseKeepingNameSuffix(java.lang.String houseKeepingNameSuffix)

Sets the suffix that is used to mark and recognize house keeping files and groups. An empty string ("") encodes for the default, which is two leading and two trailing underscores ("__NAME__").

writer

IHDF5Writer writer()

Returns an IHDF5Writer based on this configuration.