ch.systemsx.cisd.hdf5

Interface IHDF5FileLevelReadWriteHandler

All Superinterfaces:

IHDF5FileLevelReadOnlyHandler

public interface IHDF5FileLevelReadWriteHandler
extends IHDF5FileLevelReadOnlyHandler

An interface for handling file-level information and status of the writer.

Obtain an object implementing this interface by calling IHDF5Writer.file().

Method Summary

Modifier and Type	Method and Description
boolean	addFlushable(java.io.Flushable flushable) Adds a Flushable to the set of flushables.
void	flush() Flushes the cache to disk (without discarding it).
void	flushSyncBlocking() Flushes the cache to disk (without discarding it) and synchronizes the file with the underlying storage using a method like fsync(2), regardless of what IHDF5WriterConfigurator.SyncMode has been set for this file.
IHDF5WriterConfigurator.FileFormatVersionBounds	getFileFormatVersionBounds() Returns the IHDF5WriterConfigurator.FileFormatVersionBounds compatibility setting for this writer.
boolean	isUseExtendableDataTypes() Returns true, if the IHDF5WriterConfigurator was not configured with IHDF5WriterConfigurator.dontUseExtendableDataTypes(), that is if extendable data types are used for new data sets.
boolean	removeFlushable(java.io.Flushable flushable) Removes a Flushable from the set of flushables.

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

close, getFile, getHouseKeepingNameSuffix, hasMDCImage, isClosed, isMDCImageGenerationEnabled, isPerformNumericConversions

Method Detail

isUseExtendableDataTypes

boolean isUseExtendableDataTypes()

Returns true, if the IHDF5WriterConfigurator was not configured with IHDF5WriterConfigurator.dontUseExtendableDataTypes(), that is if extendable data types are used for new data sets.

getFileFormatVersionBounds

IHDF5WriterConfigurator.FileFormatVersionBounds getFileFormatVersionBounds()

Returns the IHDF5WriterConfigurator.FileFormatVersionBounds compatibility setting for this writer.

flush

void flush()

Flushes the cache to disk (without discarding it). Note that this may or may not trigger a fsync(2), depending on the IHDF5WriterConfigurator.SyncMode used.

flushSyncBlocking

void flushSyncBlocking()

Flushes the cache to disk (without discarding it) and synchronizes the file with the underlying storage using a method like fsync(2), regardless of what IHDF5WriterConfigurator.SyncMode has been set for this file.

This method blocks until fsync(2) has returned.

addFlushable

boolean addFlushable(java.io.Flushable flushable)

Adds a Flushable to the set of flushables. This set is flushed when flush() or flushSyncBlocking() are called and before the writer is closed.

This function is supposed to be used for in-memory caching structures that need to make it into the HDF5 file.

If the flushable implements IErrorStrategy, in case of an exception in Flushable.flush(), the method IErrorStrategy.dealWithError(Throwable) will be called to decide how do deal with the exception.

Parameters:

flushable - The Flushable to add. Needs to fulfill the Object.hashCode() contract.

Returns:

true if the set of flushables did not already contain the specified element.

removeFlushable

boolean removeFlushable(java.io.Flushable flushable)

Removes a Flushable from the set of flushables.

Parameters:

flushable - The Flushable to remove. Needs to fulfill the Object.hashCode() contract.

Returns:

true if the set of flushables contained the specified element.