IHDF5Reader (jhdf5 19.04.1 API)

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, IHDF5SimpleReader

All Known Subinterfaces:

IHDF5Writer
```
public interface IHDF5Reader
extends IHDF5SimpleReader
```
An interface for reading HDF5 files (HDF5 1.10.x and older).
Obtain an object implementing this interface by calling HDF5Factory.openForReading(String) or IHDF5ReaderConfigurator.reader().
The interface focuses on ease of use instead of completeness. As a consequence not all features of HDF5 are supported by this class, however it covers a large subset. In particular all information written by IHDF5Writer can be read by this class.
The functionality is being made available in two ways:
1. IHDF5SimpleReader contains the most important methods in one interface. If you are new to the library, this is a good starting point, see the example code below.
2. The hierarchical ("quasi-fluent") API provides the full functionality. It is designed along the data types supported by JHDF5.
  - file(): File-level information and operations, has e.g. the IHDF5FileLevelReadOnlyHandler.close() method.
  - object(): Object-level information, where "objects" can be data sets, links, groups or data types, following the concept of an HDF5 object. Here you can find for example the method IHDF5ObjectReadOnlyInfoProviderHandler.getGroupMemberInformation(String, boolean) which gives you information on the members of a group and the method IHDF5ObjectReadOnlyInfoProviderHandler.tryGetSymbolicLinkTarget(String) for resolving a symbolic link.
  - bool(): Reader methods for boolean data sets, including bit fields.
  - int8() / int16() / int16() / int32() / int64(): Reader methods for integer data sets, where the number as part of the method name denotes the size of the integer type. The methods will always read signed integers, if you need unsigned integers, you need to convert them with one of the methods in UnsignedIntUtils.
  - float32() / float64(): Reader methods for float data sets, where the number as part of the name sets the size of the float type.
  - time() / duration(): Reader methods for time stamp (or date) and for time duration data sets.
  - string(): Reader methods for string data sets.
  - enumeration(): Reader methods for enumeration data sets.
  - compound(): Reader methods for compound data sets.
  - opaque(): Reader methods for data sets that are "black boxes" to HDF5 which are called "opaque data sets" in HDF5 jargon. Here you can also find methods of reading arbitrary data sets as byte arrays.
  - reference(): Reader methods for HDF5 object references. Note that object references, though similar to hard links and symbolic links on the first glance, are quite different for HDF5.
Usage example for IHDF5SimpleReader:
```
 IHDF5Reader reader = HDF5FactoryProvider.get().openForReading(new File("test.h5"));
 float[] f = reader.readFloatArray("/some/path/dataset");
 String s = reader.getStringAttribute("/some/path/dataset", "some key");
 reader.close();
 
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`IHDF5BooleanReader`	`bool()` Returns the full reader for boolean values.
`IHDF5CompoundReader`	`compound()` Returns the full reader for compounds.
`IHDF5TimeDurationReader`	`duration()` Returns the full reader for time durations.
`IHDF5EnumReader`	`enumeration()` Returns the full reader for enumerations.
`IHDF5FileLevelReadOnlyHandler`	`file()` Returns the handler for file-level information and status.
`IHDF5FloatReader`	`float32()` Returns the full reader for float / float32.
`IHDF5DoubleReader`	`float64()` Returns the full reader for long / float64.
`IHDF5ShortReader`	`int16()` Returns the full reader for short / int16.
`IHDF5IntReader`	`int32()` Returns the full reader for int / int32.
`IHDF5LongReader`	`int64()` Returns the full reader for long / int64.
`IHDF5ByteReader`	`int8()` Returns the full reader for byte / int8.
`IHDF5ObjectReadOnlyInfoProviderHandler`	`object()` Returns an info provider for HDF5 objects like links, groups, data sets and data types.
`IHDF5OpaqueReader`	`opaque()` Returns the full reader for reading data sets and attributes as byte arrays ('opaque') and obtaining opaque types.
`IHDF5ReferenceReader`	`reference()` Returns the full reader for object references.
`IHDF5StringReader`	`string()` Returns the full reader for strings.
`IHDF5DateTimeReader`	`time()` Returns the full reader for date and times.
`IHDF5ShortReader`	`uint16()` Returns the full reader for unsigned short / uint16.
`IHDF5IntReader`	`uint32()` Returns the full reader for unsigned int / uint32.
`IHDF5LongReader`	`uint64()` Returns the full reader for unsigned long / uint64.
`IHDF5ByteReader`	`uint8()` Returns the full reader for unsigned byte / uint8.

Methods inherited from interface ch.systemsx.cisd.hdf5.IHDF5SimpleReader
close, exists, getDataSetInformation, getGroupMembers, isGroup, readAsByteArray, readBitField, readBoolean, readCompound, readCompoundArray, readDate, readDateArray, readDouble, readDoubleArray, readDoubleMatrix, readEnum, readEnumArray, readEnumArrayAsString, readEnumAsString, readFloat, readFloatArray, readFloatMatrix, readInt, readIntArray, readIntMatrix, readLong, readLongArray, readLongMatrix, readString, readStringArray, readTimeDuration, readTimeDurationArray

- Method Detail
  - file
```
IHDF5FileLevelReadOnlyHandler file()
```
    Returns the handler for file-level information and status.
  - object
```
IHDF5ObjectReadOnlyInfoProviderHandler object()
```
    Returns an info provider for HDF5 objects like links, groups, data sets and data types.
  - opaque
```
IHDF5OpaqueReader opaque()
```
    Returns the full reader for reading data sets and attributes as byte arrays ('opaque') and obtaining opaque types.
  - bool
```
IHDF5BooleanReader bool()
```
    Returns the full reader for boolean values.
  - int8
```
IHDF5ByteReader int8()
```
    Returns the full reader for byte / int8.
  - uint8
```
IHDF5ByteReader uint8()
```
    Returns the full reader for unsigned byte / uint8.
  - int16
```
IHDF5ShortReader int16()
```
    Returns the full reader for short / int16.
  - uint16
```
IHDF5ShortReader uint16()
```
    Returns the full reader for unsigned short / uint16.
  - int32
```
IHDF5IntReader int32()
```
    Returns the full reader for int / int32.
  - uint32
```
IHDF5IntReader uint32()
```
    Returns the full reader for unsigned int / uint32.
  - int64
```
IHDF5LongReader int64()
```
    Returns the full reader for long / int64.
  - uint64
```
IHDF5LongReader uint64()
```
    Returns the full reader for unsigned long / uint64.
  - float32
```
IHDF5FloatReader float32()
```
    Returns the full reader for float / float32.
  - float64
```
IHDF5DoubleReader float64()
```
    Returns the full reader for long / float64.
  - enumeration
```
IHDF5EnumReader enumeration()
```
    Returns the full reader for enumerations.
  - compound
```
IHDF5CompoundReader compound()
```
    Returns the full reader for compounds.
  - string
```
IHDF5StringReader string()
```
    Returns the full reader for strings.
  - time
```
IHDF5DateTimeReader time()
```
    Returns the full reader for date and times.
  - duration
```
IHDF5TimeDurationReader duration()
```
    Returns the full reader for time durations.
  - reference
```
IHDF5ReferenceReader reference()
```
    Returns the full reader for object references.

Interface IHDF5Reader

Method Summary

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

Method Detail

file

object

opaque

bool

int8

uint8

int16

uint16

int32

uint32

int64

uint64

float32

float64

enumeration

compound

string

time

duration

reference