ucar.nc2.iosp.noaa
Class Ghcnm

java.lang.Object
  extended by ucar.nc2.iosp.AbstractIOServiceProvider
      extended by ucar.nc2.iosp.noaa.Ghcnm
All Implemented Interfaces:
IOServiceProvider

public class Ghcnm
extends AbstractIOServiceProvider

Nomads GLOBAL HISTORICAL CLIMATOLOGY NETWORK MONTHLY (GHCNM) v3 Beta. Ascii file. Write index into .ncsx using protobug (experimental) IOSP can then recognize the ncsx file, so it can be passed into NetdfFile.open() instead of the ascii file. Otherwise you have to explicitly specify the iosp, eg: The index has list of stations and offsets into station file and data file. since the data file has one station's data grouped together, this efficiently answers "get all data for station". One could sort datafile by time, and add time index, to answer "get all data for time range".

 Protobuf generation:
 cd c:/dev/tds4.2/thredds/cdm/src/main/java
 protoc --proto_path=. --java_out=. ucar/nc2/iosp/noaa/GhcnmIndex.proto
 

Since:
Dec 8, 2010
Author:
caron

Field Summary
 
Fields inherited from class ucar.nc2.iosp.AbstractIOServiceProvider
raf
 
Constructor Summary
Ghcnm()
           
 
Method Summary
 void close()
          Close the file.
 String getFileTypeDescription()
          Get a human-readable description for this file type.
 String getFileTypeId()
          Get a unique stnId for this file type.
 StructureDataIterator getStructureIterator(Structure s, int bufferSize)
          Get the structure iterator
 boolean isValidFile(RandomAccessFile raf)
          Check if this is a valid file for this IOServiceProvider.
static void main(String[] args)
           
static void main2(String[] args)
           
 void open(RandomAccessFile raf, NetcdfFile ncfile, CancelTask cancelTask)
          Open existing file, and populate ncfile with it.
 Array readData(Variable v2, Section section)
          Returns an ArraySequence, no subsetting is allowed.
 
Methods inherited from class ucar.nc2.iosp.AbstractIOServiceProvider
getDetailInfo, getFileTypeVersion, readSection, readToByteChannel, sendIospMessage, sync, syncExtend, toStringDebug
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Ghcnm

public Ghcnm()
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

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

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

getFileTypeId

public String getFileTypeId()
Get a unique stnId for this file type.

Returns:
registered stnId of the file type
See Also:
"http://www.unidata.ucar.edu/software/netcdf-java/formats/FileTypes.html"

getFileTypeDescription

public String getFileTypeDescription()
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"

readData

public Array readData(Variable v2,
                      Section section)
               throws IOException,
                      InvalidRangeException
Returns an ArraySequence, no subsetting is allowed.

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:
ArraySequence
Throws:
IOException
InvalidRangeException
See Also:
Range

getStructureIterator

public StructureDataIterator getStructureIterator(Structure s,
                                                  int bufferSize)
                                           throws IOException
Get the structure iterator

Specified by:
getStructureIterator in interface IOServiceProvider
Overrides:
getStructureIterator in class AbstractIOServiceProvider
Parameters:
s - the Structure
bufferSize - the buffersize
Returns:
the data iterator
Throws:
IOException - if problem reading data

main2

public static void main2(String[] args)
                  throws IOException
Throws:
IOException

main

public static void main(String[] args)
                 throws IOException
Throws:
IOException


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