ucar.nc2.iosp.hdf5
Class H5iosp

java.lang.Object
  extended by ucar.nc2.iosp.AbstractIOServiceProvider
      extended by ucar.nc2.iosp.hdf5.H5iosp
All Implemented Interfaces:
IOServiceProvider

public class H5iosp
extends AbstractIOServiceProvider

HDF5 I/O

Author:
caron

Field Summary
 
Fields inherited from class ucar.nc2.iosp.AbstractIOServiceProvider
raf
 
Constructor Summary
H5iosp()
           
 
Method Summary
 void close()
          Close the file.
 String getDetailInfo()
          Show debug / underlying implementation details
 String getFileTypeDescription()
          Get a human-readable description for this file type.
 String getFileTypeId()
          Get a unique id for this file type.
 boolean isValidFile(RandomAccessFile raf)
          Check if this is a valid file for this IOServiceProvider.
 void open(RandomAccessFile raf, NetcdfFile ncfile, CancelTask cancelTask)
          Open existing file, and populate ncfile with it.
 Array readData(Variable v2, Section section)
          Read data from a top level Variable and return a memory resident Array.
 Object sendIospMessage(Object message)
          A way to communicate arbitrary information to an iosp.
static void setDebugFlags(DebugFlags debugFlag)
           
 String toStringDebug(Object o)
          Debug info for this object.
 
Methods inherited from class ucar.nc2.iosp.AbstractIOServiceProvider
getFileTypeVersion, getStructureIterator, readSection, readToByteChannel, sync, syncExtend
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

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:
"http://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:
"http://www.unidata.ucar.edu/software/netcdf-java/formats/FileTypes.html"

open

public void open(RandomAccessFile raf,
                 NetcdfFile ncfile,
                 CancelTask cancelTask)
          throws IOException
Description copied from interface: IOServiceProvider
Open existing file, and populate ncfile with it. This method is only called by the NetcdfFile constructor on itself. The provided NetcdfFile object will be empty except for the location String and the IOServiceProvider associated with this NetcdfFile object.

Specified by:
open in interface IOServiceProvider
Overrides:
open in class AbstractIOServiceProvider
Parameters:
raf - the file to work on, it has already passed the isValidFile() test.
ncfile - add objects to this empty NetcdfFile
cancelTask - used to monitor user cancellation; may be null.
Throws:
IOException - if read error

readData

public Array readData(Variable v2,
                      Section section)
               throws IOException,
                      InvalidRangeException
Description copied from interface: IOServiceProvider
Read data from a top level Variable and return a memory resident Array. This Array has the same element type as the Variable, and the requested shape.

Parameters:
v2 - a top-level Variable
section - the section of data to read. There must be a Range for each Dimension in the variable, in order. Note: no nulls allowed. IOSP may not modify.
Returns:
the requested data in a memory-resident Array
Throws:
IOException - if read error
InvalidRangeException - if invalid section
See Also:
Range

close

public void close()
           throws IOException
Close the file.

Specified by:
close in interface IOServiceProvider
Overrides:
close in class AbstractIOServiceProvider
Throws:
IOException - on io error

toStringDebug

public String toStringDebug(Object o)
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

getDetailInfo

public String getDetailInfo()
Description copied from interface: IOServiceProvider
Show debug / underlying implementation details

Specified by:
getDetailInfo in interface IOServiceProvider
Overrides:
getDetailInfo in class AbstractIOServiceProvider
Returns:
debug info

sendIospMessage

public Object sendIospMessage(Object message)
Description copied from interface: IOServiceProvider
A way to communicate arbitrary information to an iosp.

Specified by:
sendIospMessage in interface IOServiceProvider
Overrides:
sendIospMessage in class AbstractIOServiceProvider
Parameters:
message - opaque message.
Returns:
opaque return, may be null.


Copyright © 1999-2011 UCAR/Unidata. All Rights Reserved.