ucar.nc2.iosp.grib
Class GribServiceProvider

java.lang.Object
  extended by ucar.nc2.iosp.AbstractIOServiceProvider
      extended by ucar.nc2.iosp.grib.GribServiceProvider
All Implemented Interfaces:
IOServiceProvider
Direct Known Subclasses:
Grib1ServiceProvider, Grib2ServiceProvider

public abstract class GribServiceProvider
extends AbstractIOServiceProvider

Superclass for grib1 and grib2 iosp.

Author:
caron

Nested Class Summary
static class GribServiceProvider.IndexExtendMode
           
 
Field Summary
static boolean addLatLon
           
static GribServiceProvider.IndexExtendMode extendMode
           
protected  FmrcCoordSys fmrcCoordSys
           
static boolean forceNewIndex
           
protected  NetcdfFile ncfile
           
protected  RandomAccessFile raf
           
static GribServiceProvider.IndexExtendMode syncMode
           
static boolean useMaximalCoordSys
           
 
Constructor Summary
GribServiceProvider()
           
 
Method Summary
protected abstract  float[] _readData(long offset1, long offset2, int decimalScale, boolean bmsExists)
           
 void close()
          Close the file.
 java.lang.String getDetailInfo()
          Show debug / underlying implementation details
protected  ucar.grib.Index getIndex(int edition, java.lang.String location)
          Open the index file.
 boolean isMissingXY(Variable v2, int timeIdx, int levIdx)
           
protected abstract  void open(ucar.grib.Index index, CancelTask cancelTask)
           
 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.
 void readLevel(Variable v2, int timeIdx, Range levelRange, Range yRange, Range xRange, IndexIterator ii)
           
 void readXY(Variable v2, int timeIdx, int levIdx, Range yRange, Range xRange, IndexIterator ii)
           
 java.lang.Object sendIospMessage(java.lang.Object special)
          A way to communicate arbitrary information to an iosp.
static void setDebugFlags(DebugFlags debugFlag)
           
static void setExtendIndex(boolean b)
           
static void setIndexAlwaysInCache(boolean b)
          Set disk cache policy for index files.
static void setIndexExtendMode(GribServiceProvider.IndexExtendMode mode)
           
static void setIndexSyncMode(GribServiceProvider.IndexExtendMode mode)
           
 boolean sync()
          Check if file has changed, and reread metadata if needed.
 java.lang.String toStringDebug(java.lang.Object o)
          Debug info for this object.
static void useMaximalCoordSys(boolean b)
           
 
Methods inherited from class ucar.nc2.iosp.AbstractIOServiceProvider
createValidNetcdfObjectName, getStructureIterator, readSection, readToByteChannel, syncExtend
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface ucar.nc2.iosp.IOServiceProvider
isValidFile
 

Field Detail

ncfile

protected NetcdfFile ncfile

raf

protected RandomAccessFile raf

fmrcCoordSys

protected FmrcCoordSys fmrcCoordSys

addLatLon

public static boolean addLatLon

forceNewIndex

public static boolean forceNewIndex

useMaximalCoordSys

public static boolean useMaximalCoordSys

extendMode

public static GribServiceProvider.IndexExtendMode extendMode

syncMode

public static GribServiceProvider.IndexExtendMode syncMode
Constructor Detail

GribServiceProvider

public GribServiceProvider()
Method Detail

useMaximalCoordSys

public static void useMaximalCoordSys(boolean b)

setIndexExtendMode

public static void setIndexExtendMode(GribServiceProvider.IndexExtendMode mode)

setIndexSyncMode

public static void setIndexSyncMode(GribServiceProvider.IndexExtendMode mode)

setExtendIndex

public static void setExtendIndex(boolean b)

setIndexAlwaysInCache

public static void setIndexAlwaysInCache(boolean b)
Set disk cache policy for index files. Default = false, meaning try to write index files in same directory as grib file. True means always use the DiskCache area. TDS sets this to true, so it wont interfere with external indexer.

Parameters:
b - set to this value

setDebugFlags

public static void setDebugFlags(DebugFlags debugFlag)

open

protected abstract void open(ucar.grib.Index index,
                             CancelTask cancelTask)
                      throws java.io.IOException
Throws:
java.io.IOException

open

public void open(RandomAccessFile raf,
                 NetcdfFile ncfile,
                 CancelTask cancelTask)
          throws java.io.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.

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:
java.io.IOException - if read error

toStringDebug

public java.lang.String toStringDebug(java.lang.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

getIndex

protected ucar.grib.Index getIndex(int edition,
                                   java.lang.String location)
                            throws java.io.IOException
Open the index file. If not exists, create it. When writing use DiskCache, to make sure location is writeable.

Parameters:
edition - which grib edition
location - location of the file. The index file has ".gbx" appended.
Returns:
ucar.grib.Index
Throws:
java.io.IOException - on io error

sync

public boolean sync()
             throws java.io.IOException
Description copied from interface: IOServiceProvider
Check if file has changed, and reread metadata if needed.

Specified by:
sync in interface IOServiceProvider
Overrides:
sync in class AbstractIOServiceProvider
Returns:
true if file was changed.
Throws:
java.io.IOException - if read error

readData

public Array readData(Variable v2,
                      Section section)
               throws java.io.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:
java.io.IOException - if read error
InvalidRangeException - if invalid section
See Also:
Range

readLevel

public void readLevel(Variable v2,
                      int timeIdx,
                      Range levelRange,
                      Range yRange,
                      Range xRange,
                      IndexIterator ii)
               throws java.io.IOException,
                      InvalidRangeException
Throws:
java.io.IOException
InvalidRangeException

readXY

public void readXY(Variable v2,
                   int timeIdx,
                   int levIdx,
                   Range yRange,
                   Range xRange,
                   IndexIterator ii)
            throws java.io.IOException,
                   InvalidRangeException
Throws:
java.io.IOException
InvalidRangeException

isMissingXY

public boolean isMissingXY(Variable v2,
                           int timeIdx,
                           int levIdx)
                    throws InvalidRangeException
Throws:
InvalidRangeException

_readData

protected abstract float[] _readData(long offset1,
                                     long offset2,
                                     int decimalScale,
                                     boolean bmsExists)
                              throws java.io.IOException
Throws:
java.io.IOException

close

public void close()
           throws java.io.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.

Throws:
java.io.IOException - if read error

sendIospMessage

public java.lang.Object sendIospMessage(java.lang.Object special)
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:
special - opaque message.
Returns:
opaque return, may be null.

getDetailInfo

public java.lang.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