ucar.nc2.internal.iosp.hdf5

Class H5header

java.lang.Object

ucar.nc2.internal.iosp.hdf5.H5header

All Implemented Interfaces:

HdfHeaderIF

public class H5header
extends Object
implements HdfHeaderIF

Read all of the metadata of an HD5 file.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	H5header.TypeInfo
class	H5header.Vinfo

Field Summary

Fields

Modifier and Type	Field and Description
static String	HDF5_CLASS
static String	HDF5_DIMENSION_LABELS
static String	HDF5_DIMENSION_LIST
static String	HDF5_DIMENSION_NAME
static String	HDF5_DIMENSION_SCALE
static String	HDF5_REFERENCE_LIST

Method Summary

Modifier and Type	Method and Description
void	close()
protected Array	convertEnums(Map<Integer,String> map, DataType dataType, Array values)
List<H5objects.DataObject>	getDataObjects()
void	getEosInfo(Formatter f)
long	getFileOffset(long address)
int	getNumBytesFromMax(long maxNumber)
RandomAccessFile	getRandomAccessFile()
Group.Builder	getRootGroup()
byte	getSizeLengths()
byte	getSizeOffsets()
protected Charset	getValueCharset() Return defined value charset that will be used when reading HDF5 header.
boolean	isOffsetLong()
static boolean	isValidFile(RandomAccessFile raf)
int	makeIntFromBytes(byte[] bb, int start, int n)
void	makeVinfoForDimensionMapVariable(Group.Builder parent, Variable.Builder<?> v)
void	read(PrintWriter debugPS)
long	readAddress()
long	readLength()
long	readOffset()
String	readStructMetadata(Variable.Builder<?> structMetadataVar)
long	readVariableSizeUnsigned(int size)
static void	setDebugFlags(DebugFlags debugFlag)
static void	setWarnings(boolean warn)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

HDF5_CLASS

public static final String HDF5_CLASS

See Also:

Constant Field Values

HDF5_DIMENSION_LIST

public static final String HDF5_DIMENSION_LIST

See Also:

Constant Field Values

HDF5_DIMENSION_SCALE

public static final String HDF5_DIMENSION_SCALE

See Also:

Constant Field Values

HDF5_DIMENSION_LABELS

public static final String HDF5_DIMENSION_LABELS

See Also:

Constant Field Values

HDF5_DIMENSION_NAME

public static final String HDF5_DIMENSION_NAME

See Also:

Constant Field Values

HDF5_REFERENCE_LIST

public static final String HDF5_REFERENCE_LIST

See Also:

Constant Field Values

Method Detail

setWarnings

public static void setWarnings(boolean warn)

setDebugFlags

public static void setDebugFlags(DebugFlags debugFlag)

isValidFile

public static boolean isValidFile(RandomAccessFile raf)
                           throws IOException

Throws:

IOException

getValueCharset

protected Charset getValueCharset()

Return defined value charset that will be used when reading HDF5 header.

read

public void read(PrintWriter debugPS)
          throws IOException

Throws:

IOException

convertEnums

protected Array convertEnums(Map<Integer,String> map,
                             DataType dataType,
                             Array values)

getRootGroup

public Group.Builder getRootGroup()

Specified by:

getRootGroup in interface HdfHeaderIF

makeVinfoForDimensionMapVariable

public void makeVinfoForDimensionMapVariable(Group.Builder parent,
                                             Variable.Builder<?> v)

Specified by:

makeVinfoForDimensionMapVariable in interface HdfHeaderIF

readStructMetadata

public String readStructMetadata(Variable.Builder<?> structMetadataVar)
                          throws IOException

Specified by:

readStructMetadata in interface HdfHeaderIF

Throws:

IOException

makeIntFromBytes

public int makeIntFromBytes(byte[] bb,
                            int start,
                            int n)

isOffsetLong

public boolean isOffsetLong()

readLength

public long readLength()
                throws IOException

Throws:

IOException

readOffset

public long readOffset()
                throws IOException

Throws:

IOException

readAddress

public long readAddress()
                 throws IOException

Throws:

IOException

getSizeLengths

public byte getSizeLengths()

getNumBytesFromMax

public int getNumBytesFromMax(long maxNumber)

readVariableSizeUnsigned

public long readVariableSizeUnsigned(int size)
                              throws IOException

Throws:

IOException

getRandomAccessFile

public RandomAccessFile getRandomAccessFile()

getFileOffset

public long getFileOffset(long address)

getSizeOffsets

public byte getSizeOffsets()

close

public void close()

getEosInfo

public void getEosInfo(Formatter f)
                throws IOException

Throws:

IOException

getDataObjects

public List<H5objects.DataObject> getDataObjects()