ucar.nc2.iosp.noaa

Class Ghcnm2

java.lang.Object

ucar.nc2.iosp.AbstractIOServiceProvider

ucar.nc2.iosp.noaa.Ghcnm2

All Implemented Interfaces:

IOServiceProvider

public class Ghcnm2
extends AbstractIOServiceProvider

NOMADS Ghcnm2

Since:

Feb 26, 2011

Author:

caron

Field Summary

Fields inherited from class ucar.nc2.iosp.AbstractIOServiceProvider

raf

Constructor Summary

Constructors

Constructor and Description
Ghcnm2()

Method Summary

Methods

Modifier and Type	Method and Description
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.
StructureDataIterator	getStructureIterator(Structure s, int bufferSize)
boolean	isValidFile(RandomAccessFile raf) Check if this is a valid file for this IOServiceProvider.
void	open(RandomAccessFile raff, 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.

Methods inherited from class ucar.nc2.iosp.AbstractIOServiceProvider

getDetailInfo, readSection, readToByteChannel, sendIospMessage, streamToByteChannel, sync, syncExtend, toStringDebug

Methods inherited from class java.lang.Object

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

Constructor Detail

Ghcnm2

public Ghcnm2()

Method Detail

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"

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:

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

open

public void open(RandomAccessFile raff,
        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:

raff - 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

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 IOServiceProvider

Overrides:

close in class AbstractIOServiceProvider

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

getStructureIterator

public StructureDataIterator getStructureIterator(Structure s,
                                         int bufferSize)
                                           throws IOException

Specified by:

getStructureIterator in interface IOServiceProvider

Overrides:

getStructureIterator in class AbstractIOServiceProvider

Throws:

IOException