ch.systemsx.cisd.hdf5

Interface IHDF5SimpleWriter

All Superinterfaces:

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

All Known Subinterfaces:

IHDF5Writer

public interface IHDF5SimpleWriter
extends IHDF5SimpleReader

A HDF5 writer which contains only the basic methods. If you feel overwhelmed with all the methods of IHDF5Writer, then assign the writer to a IHDF5SimpleWriter variable and let the code completion of your IDE help you find the method you are looking for.

Usage:

 float[] f = new float[100];
 ...
 IHDF5SimpleWriter writer = HDF5FactoryProvider.get().open(new File("test.h5"));
 writer.writeFloatArray("/some/path/dataset", f);
 writer.close();
 

Method Summary

Modifier and Type	Method and Description
void	delete(java.lang.String objectPath) Removes an object from the file.
void	writeBitField(java.lang.String objectPath, java.util.BitSet data) Writes out a bit field ((which can be considered the equivalent to a boolean array of rank 1), provided as a Java BitSet.
void	writeBoolean(java.lang.String objectPath, boolean value) Writes out a boolean value.
void	writeByteArray(java.lang.String objectPath, byte[] data) Writes out a byte array (of rank 1).
<T> void	writeCompound(java.lang.String objectPath, T data) Writes out a compound value.
<T> void	writeCompoundArray(java.lang.String objectPath, T[] data) Writes out an array (of rank 1) of compound values.
void	writeDate(java.lang.String objectPath, java.util.Date date) Writes out a time stamp value provided as a Date.
void	writeDateArray(java.lang.String objectPath, java.util.Date[] dates) Writes out a Date array (of rank 1).
void	writeDouble(java.lang.String objectPath, double value) Writes out a double value.
void	writeDoubleArray(java.lang.String objectPath, double[] data) Writes out a double array (of rank 1).
void	writeDoubleMatrix(java.lang.String objectPath, double[][] data) Writes out a double matrix (array of rank 2).
<T extends java.lang.Enum<T>> void	writeEnum(java.lang.String objectPath, java.lang.Enum<T> value) Writes out an enum value.
<T extends java.lang.Enum<T>> void	writeEnumArray(java.lang.String objectPath, java.lang.Enum<T>[] data) Writes out an array of enum values.
void	writeEnumArray(java.lang.String objectPath, java.lang.String[] options, java.lang.String[] data) Writes out an array of enum values.
void	writeFloat(java.lang.String objectPath, float value) Writes out a float value.
void	writeFloatArray(java.lang.String objectPath, float[] data) Writes out a float array (of rank 1).
void	writeFloatMatrix(java.lang.String objectPath, float[][] data) Writes out a float matrix (array of rank 2).
void	writeInt(java.lang.String objectPath, int value) Writes out a int value.
void	writeIntArray(java.lang.String objectPath, int[] data) Writes out a int array (of rank 1).
void	writeIntMatrix(java.lang.String objectPath, int[][] data) Writes out a int matrix (array of rank 2).
void	writeLong(java.lang.String objectPath, long value) Writes out a long value.
void	writeLongArray(java.lang.String objectPath, long[] data) Writes out a long array (of rank 1).
void	writeLongMatrix(java.lang.String objectPath, long[][] data) Writes out a long matrix (array of rank 2).
void	writeString(java.lang.String objectPath, java.lang.String data) Writes out a String with a fixed maximal length.
void	writeStringArray(java.lang.String objectPath, java.lang.String[] data) Writes out a String array (of rank 1).
void	writeTimeDuration(java.lang.String objectPath, HDF5TimeDuration timeDuration) Writes out a time duration value.
void	writeTimeDurationArray(java.lang.String objectPath, HDF5TimeDurationArray timeDurations) Writes out a time duration array (of rank 1).

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

delete

void delete(java.lang.String objectPath)

Removes an object from the file. If there is more than one link to the object, only the specified link will be removed.

writeBoolean

void writeBoolean(java.lang.String objectPath,
                  boolean value)

Writes out a boolean value.

Parameters:

objectPath - The name (including path information) of the data set object in the file.

value - The value of the data set.

writeBitField

void writeBitField(java.lang.String objectPath,
                   java.util.BitSet data)

Writes out a bit field ((which can be considered the equivalent to a boolean array of rank 1), provided as a Java BitSet.

Note that the storage form of the bit array is a long[]. However, it is marked in HDF5 to be interpreted bit-wise. Thus a data set written by this method cannot be read back by IHDF5SimpleReader.readLongArray(String) but will throw a HDF5DatatypeInterfaceException.

Parameters:

objectPath - The name (including path information) of the data set object in the file.

data - The data to write. Must not be null.

writeByteArray

void writeByteArray(java.lang.String objectPath,
                    byte[] data)

Writes out a byte array (of rank 1). Uses a compact storage layout. Should only be used for small data sets.

Parameters:

objectPath - The name (including path information) of the data set object in the file.

data - The data to write. Must not be null.

writeInt

void writeInt(java.lang.String objectPath,
              int value)

Writes out a int value.

Parameters:

objectPath - The name (including path information) of the data set object in the file.

value - The value to write.

writeIntArray

void writeIntArray(java.lang.String objectPath,
                   int[] data)

Writes out a int array (of rank 1).

Parameters:

objectPath - The name (including path information) of the data set object in the file.

data - The data to write. Must not be null.

writeIntMatrix

void writeIntMatrix(java.lang.String objectPath,
                    int[][] data)

Writes out a int matrix (array of rank 2).

Parameters:

objectPath - The name (including path information) of the data set object in the file.

data - The data to write. Must not be null. All columns need to have the same length.

writeLong

void writeLong(java.lang.String objectPath,
               long value)

Writes out a long value.

Parameters:

objectPath - The name (including path information) of the data set object in the file.

value - The value to write.

writeLongArray

void writeLongArray(java.lang.String objectPath,
                    long[] data)

Writes out a long array (of rank 1).

Parameters:

objectPath - The name (including path information) of the data set object in the file.

data - The data to write. Must not be null.

writeLongMatrix

void writeLongMatrix(java.lang.String objectPath,
                     long[][] data)

Writes out a long matrix (array of rank 2).

Parameters:

objectPath - The name (including path information) of the data set object in the file.

data - The data to write. Must not be null. All columns need to have the same length.

writeFloat

void writeFloat(java.lang.String objectPath,
                float value)

Writes out a float value.

Parameters:

objectPath - The name (including path information) of the data set object in the file.

value - The value to write.

writeFloatArray

void writeFloatArray(java.lang.String objectPath,
                     float[] data)

Writes out a float array (of rank 1).

Parameters:

objectPath - The name (including path information) of the data set object in the file.

data - The data to write. Must not be null.

writeFloatMatrix

void writeFloatMatrix(java.lang.String objectPath,
                      float[][] data)

Writes out a float matrix (array of rank 2).

Parameters:

objectPath - The name (including path information) of the data set object in the file.

data - The data to write. Must not be null. All columns need to have the same length.

writeDouble

void writeDouble(java.lang.String objectPath,
                 double value)

Writes out a double value.

Parameters:

objectPath - The name (including path information) of the data set object in the file.

value - The value to write.

writeDoubleArray

void writeDoubleArray(java.lang.String objectPath,
                      double[] data)

Writes out a double array (of rank 1).

Parameters:

objectPath - The name (including path information) of the data set object in the file.

data - The data to write. Must not be null.

writeDoubleMatrix

void writeDoubleMatrix(java.lang.String objectPath,
                       double[][] data)

Writes out a double matrix (array of rank 2).

Parameters:

objectPath - The name (including path information) of the data set object in the file.

data - The data to write. Must not be null. All columns need to have the same length.

writeDate

void writeDate(java.lang.String objectPath,
               java.util.Date date)

Writes out a time stamp value provided as a Date. The data set will be tagged as type variant HDF5DataTypeVariant.TIMESTAMP_MILLISECONDS_SINCE_START_OF_THE_EPOCH.

Note: This is a convenience method for

Parameters:

objectPath - The name (including path information) of the data set object in the file.

date - The date to write.

writeDateArray

void writeDateArray(java.lang.String objectPath,
                    java.util.Date[] dates)

Writes out a Date array (of rank 1).

Parameters:

objectPath - The name (including path information) of the data set object in the file.

dates - The dates to write.

writeTimeDuration

void writeTimeDuration(java.lang.String objectPath,
                       HDF5TimeDuration timeDuration)

Writes out a time duration value.

Note: Time durations are stored as long[] arrays and tagged as the according type variant.

Parameters:

objectPath - The name (including path information) of the data set object in the file.

timeDuration - The duration of time to write.

writeTimeDurationArray

void writeTimeDurationArray(java.lang.String objectPath,
                            HDF5TimeDurationArray timeDurations)

Writes out a time duration array (of rank 1).

Note: Time durations are stored as long[] arrays and tagged as the according type variant.

Parameters:

objectPath - The name (including path information) of the data set object in the file.

timeDurations - The time durations to write.

writeString

void writeString(java.lang.String objectPath,
                 java.lang.String data)

Writes out a String with a fixed maximal length.

Parameters:

objectPath - The name (including path information) of the data set object in the file.

data - The data to write. Must not be null.

writeStringArray

void writeStringArray(java.lang.String objectPath,
                      java.lang.String[] data)

Writes out a String array (of rank 1). Each element of the array will have a fixed maximal length which is given by the longest element.

Parameters:

objectPath - The name (including path information) of the data set object in the file.

data - The data to write. Must not be null.

writeCompound

<T> void writeCompound(java.lang.String objectPath,
                       T data)

Writes out a compound value. The type is inferred based on the values.

Parameters:

objectPath - The name (including path information) of the data set object in the file.

data - The value of the data set. May be a pojo (Data Transfer Object), a HDF5CompoundDataMap, HDF5CompoundDataList or Object[] .

See Also:

CompoundType, CompoundElement

writeCompoundArray

<T> void writeCompoundArray(java.lang.String objectPath,
                            T[] data)

Writes out an array (of rank 1) of compound values. The type is inferred based on the values.

Parameters:

objectPath - The name (including path information) of the data set object in the file.

data - The value of the data set. May be a pojo (Data Transfer Object), a HDF5CompoundDataMap, HDF5CompoundDataList or Object[] .

See Also:

CompoundType, CompoundElement

writeEnum

<T extends java.lang.Enum<T>> void writeEnum(java.lang.String objectPath,
                                             java.lang.Enum<T> value)
                                      throws HDF5JavaException

Writes out an enum value.

Parameters:

objectPath - The name (including path information) of the data set object in the file.

value - The value of the data set.

Throws:

HDF5JavaException - If the enum type of value is not a type of this file.

writeEnumArray

<T extends java.lang.Enum<T>> void writeEnumArray(java.lang.String objectPath,
                                                  java.lang.Enum<T>[] data)

Writes out an array of enum values.

Parameters:

objectPath - The name (including path information) of the data set object in the file.

data - The data to write.

writeEnumArray

void writeEnumArray(java.lang.String objectPath,
                    java.lang.String[] options,
                    java.lang.String[] data)

Writes out an array of enum values.

Parameters:

objectPath - The name (including path information) of the data set object in the file.

options - The allowed values of the enumeration type.

data - The data to write.