ucar.nc2.internal.iosp.hdf5

Class H5iosp

java.lang.Object

ucar.nc2.iosp.AbstractIOServiceProvider

ucar.nc2.internal.iosp.hdf5.H5iosp

All Implemented Interfaces:

Closeable, AutoCloseable, IOServiceProvider

Direct Known Subclasses:

H5iospArrays

public class H5iosp
extends AbstractIOServiceProvider

HDF5 I/O

Field Summary

Fields

Modifier and Type	Field and Description
static String	IOSP_MESSAGE_INCLUDE_ORIGINAL_ATTRIBUTES

Fields inherited from class ucar.nc2.iosp.AbstractIOServiceProvider

location, ncfile, raf, rafOrder

Constructor Summary

Constructors

Constructor and Description
H5iosp()

Method Summary

Modifier and Type	Method and Description
void	build(RandomAccessFile raf, Group.Builder rootGroup, CancelTask cancelTask) Read an existing RandomAccessFile, and populate rootGroup.
void	close() Close the file.
String	getFileTypeDescription() Get a human-readable description for this file type.
String	getFileTypeId() Get a unique id for this file type.
String	getFileTypeVersion() Get the version of this file type.
H5header	getHeader()
boolean	isValidFile(RandomAccessFile raf) Check if this is a valid file for this IOServiceProvider.
void	reacquire() Reacquire any resources like file handles Used when reactivating in cache.
Array	readData(Variable v2, Section section)
Object	sendIospMessage(Object message) A way to communicate arbitrary information to and from an iosp.
static void	setDebugFlags(DebugFlags debugFlag)
String	toStringDebug(Object o) Debug info for this object.
static void	useHdfEos(boolean val)

Methods inherited from class ucar.nc2.iosp.AbstractIOServiceProvider

buildFinish, getDetailInfo, getLastModified, getStructureDataArrayIterator, getStructureIterator, open, readArrayData, readSection, readToOutputStream, release, setNetcdfFile

Methods inherited from class java.lang.Object

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

Field Detail

IOSP_MESSAGE_INCLUDE_ORIGINAL_ATTRIBUTES

public static final String IOSP_MESSAGE_INCLUDE_ORIGINAL_ATTRIBUTES

See Also:

Constant Field Values

Constructor Detail

H5iosp

public H5iosp()

Method Detail

setDebugFlags

public static void setDebugFlags(DebugFlags debugFlag)

isValidFile

public boolean isValidFile(RandomAccessFile raf)
                    throws IOException

Description copied from interface: IOServiceProvider

Check if this is a valid file for this IOServiceProvider. You must make this method thread safe, ie dont keep any state.

Parameters:

raf - RandomAccessFile

Returns:

true if valid.

Throws:

IOException - if read error

getFileTypeId

public String getFileTypeId()

Description copied from interface: IOServiceProvider

Get a unique id for this file type.

Returns:

registered id of the file type

See Also:

"https://www.unidata.ucar.edu/software/netcdf-java/formats/FileTypes.html"

getFileTypeDescription

public String getFileTypeDescription()

Description copied from interface: IOServiceProvider

Get a human-readable description for this file type.

Returns:

description of the file type

See Also:

"https://www.unidata.ucar.edu/software/netcdf-java/formats/FileTypes.html"

useHdfEos

public static void useHdfEos(boolean val)

getFileTypeVersion

public String getFileTypeVersion()

Description copied from interface: IOServiceProvider

Get the version of this file type.

Specified by:

getFileTypeVersion in interface IOServiceProvider

Overrides:

getFileTypeVersion in class AbstractIOServiceProvider

Returns:

version of the file type

See Also:

"https://www.unidata.ucar.edu/software/netcdf-java/formats/FileTypes.html"

build

public void build(RandomAccessFile raf,
                  Group.Builder rootGroup,
                  CancelTask cancelTask)
           throws IOException

Description copied from interface: IOServiceProvider

Read an existing RandomAccessFile, and populate rootGroup. Note that you cannot reference the NetcdfFile within this routine, since it hasnt been created yet.

Parameters:

raf - the file to work on, it has already passed the isValidFile() test.

rootGroup - add objects to the root group.

cancelTask - used to monitor user cancellation; may be null.

Throws:

IOException - if read error

sendIospMessage

public Object sendIospMessage(Object message)

Description copied from interface: IOServiceProvider

A way to communicate arbitrary information to and from an iosp.

Specified by:

sendIospMessage in interface IOServiceProvider

Overrides:

sendIospMessage in class AbstractIOServiceProvider

Parameters:

message - opaque message sent to the IOSP object when its opened (not when isValidFile() is called)

Returns:

opaque Object, may be null.

getHeader

public H5header getHeader()

readData

public Array readData(Variable v2,
                      Section section)
               throws IOException,
                      InvalidRangeException

Throws:

IOException

InvalidRangeException

close

public void close()
           throws IOException

Description copied from interface: IOServiceProvider

Close the file. It is the IOServiceProvider's job to close the file (even though it didnt open it), and to free any other resources it has used.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface IOServiceProvider

Overrides:

close in class AbstractIOServiceProvider

Throws:

IOException - if read error

reacquire

public void reacquire()
               throws IOException

Description copied from interface: IOServiceProvider

Reacquire any resources like file handles Used when reactivating in cache.

Specified by:

reacquire in interface IOServiceProvider

Overrides:

reacquire in class AbstractIOServiceProvider

Throws:

IOException

toStringDebug

public String toStringDebug(Object o)

Description copied from interface: IOServiceProvider

Debug info for this object.

Specified by:

toStringDebug in interface IOServiceProvider

Overrides:

toStringDebug in class AbstractIOServiceProvider

Parameters:

o - which object

Returns:

debug info for this object