ch.systemsx.cisd.hdf5

Interface IHDF5ReaderConfigurator

All Known Subinterfaces:

IHDF5WriterConfigurator

public interface IHDF5ReaderConfigurator

A configurator for a IHDF5Reader.

If you want the reader to perform numeric conversions, call performNumericConversions() before calling reader().

Method Summary

Methods

Modifier and Type	Method and Description
IHDF5ReaderConfigurator	noAutoDereference() Switches off automatic dereferencing of unresolved references.
IHDF5ReaderConfigurator	performNumericConversions() Will try to perform numeric conversions where appropriate if supported by the platform.
boolean	platformSupportsNumericConversions() Returns true, if this platform supports numeric conversions.
IHDF5Reader	reader() Returns an IHDF5Reader based on this configuration.
IHDF5ReaderConfigurator	useUTF8CharacterEncoding() Deprecated. Should not be used for the reader as it will figure that out by looking at the HDF5 file.

Method Detail

platformSupportsNumericConversions

boolean platformSupportsNumericConversions()

Returns true, if this platform supports numeric conversions.

performNumericConversions

IHDF5ReaderConfigurator 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!

useUTF8CharacterEncoding

@Deprecated
IHDF5ReaderConfigurator useUTF8CharacterEncoding()

Deprecated. Should not be used for the reader as it will figure that out by looking at the HDF5 file.

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

noAutoDereference

IHDF5ReaderConfigurator 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.

reader

IHDF5Reader reader()

Returns an IHDF5Reader based on this configuration.