ch.systemsx.cisd.hdf5

Interface IHDF5FileLevelReadOnlyHandler

All Known Subinterfaces:

IHDF5FileLevelReadWriteHandler

public interface IHDF5FileLevelReadOnlyHandler

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

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

Method Summary

Modifier and Type	Method and Description
void	close() Closes this object and the file referenced by this object.
java.io.File	getFile() Returns the HDF5 file that this class is reading.
java.lang.String	getHouseKeepingNameSuffix() Returns the suffix used to mark and recognize internal (house keeping) files and groups.
boolean	hasMDCImage() Returns true, if this file has an MDC image.
boolean	isClosed() Returns true if this reader has been already closed.
boolean	isMDCImageGenerationEnabled() Returns true, if the generation of a metadata cache image is enabled for this file and false otherwise.
boolean	isPerformNumericConversions() Returns true, if numeric conversions should be performed automatically, e.g.

Method Detail

isPerformNumericConversions

boolean isPerformNumericConversions()

Returns true, if numeric conversions should be performed automatically, e.g. between float and int.

isMDCImageGenerationEnabled

boolean isMDCImageGenerationEnabled()

Returns true, if the generation of a metadata cache image is enabled for this file and false otherwise.

hasMDCImage

boolean hasMDCImage()

Returns true, if this file has an MDC image.

getHouseKeepingNameSuffix

java.lang.String getHouseKeepingNameSuffix()

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

getFile

java.io.File getFile()

Returns the HDF5 file that this class is reading.

close

void close()

Closes this object and the file referenced by this object. This object must not be used after being closed. Calling this method for a second time is a no-op.

isClosed

boolean isClosed()

Returns true if this reader has been already closed.