gov.noaa.pmel.tmap.iosp

Class FerretIOServiceProvider

java.lang.Object

gov.noaa.pmel.tmap.iosp.FerretIOServiceProvider

All Implemented Interfaces:

ucar.nc2.iosp.IOServiceProvider

public class FerretIOServiceProvider
extends java.lang.Object
implements ucar.nc2.iosp.IOServiceProvider

This is the implementation of the netCDF Java IO Service Provider interface that turns Ferret scripts and the variables it accesses and defines into an OPeNDAP netCDF data source. The variables that are defined by the script must be associated with an existing open data set. E.g. use levitus_climatology let/d=levitus_climatology temp_20 = temp[d=levitus_climatology,z=0:20@sum] set var/title="surface heat content"/units="deg C" temp_20[d=levitus_climatology] use coads_climatology let/d=coads_climatology sst_5 = SST[d=coads_climatology]*5.0

Author:

Roland Schweitzer

Constructor Summary

Constructors

Constructor and Description
FerretIOServiceProvider() The default constructor, warms up the FerretTool that will be used to run Ferret.

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
java.lang.String	getDataDir()
java.lang.String	getDetailInfo()
java.lang.String	getFileTypeDescription()
java.lang.String	getFileTypeId()
java.lang.String	getFileTypeVersion()
ucar.ma2.StructureDataIterator	getStructureIterator(ucar.nc2.Structure arg0, int arg1)
boolean	isValidFile(ucar.unidata.io.RandomAccessFile raf)
static void	main(java.lang.String[] args)
void	open(ucar.unidata.io.RandomAccessFile raf, ucar.nc2.NetcdfFile ncfile, ucar.nc2.util.CancelTask cancelTask)
ucar.ma2.Array	readData(ucar.nc2.Variable v2, ucar.ma2.Section section)
ucar.ma2.Array	readNestedData(ucar.nc2.Variable v2, java.util.List section)
ucar.ma2.Array	readSection(ucar.nc2.ParsedSectionSpec arg0)
long	readToByteChannel(ucar.nc2.Variable arg0, ucar.ma2.Section arg1, java.nio.channels.WritableByteChannel arg2)
java.lang.Object	sendIospMessage(java.lang.Object arg0)
void	setSpecial(java.lang.Object special)
boolean	sync()
boolean	syncExtend()
java.lang.String	toStringDebug(java.lang.Object o)

Methods inherited from class java.lang.Object

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

Constructor Detail

FerretIOServiceProvider

public FerretIOServiceProvider()

The default constructor, warms up the FerretTool that will be used to run Ferret.

Method Detail

close

public void close()
           throws java.io.IOException

Specified by:

close in interface ucar.nc2.iosp.IOServiceProvider

Throws:

java.io.IOException

getDetailInfo

public java.lang.String getDetailInfo()

Specified by:

getDetailInfo in interface ucar.nc2.iosp.IOServiceProvider

isValidFile

public boolean isValidFile(ucar.unidata.io.RandomAccessFile raf)
                    throws java.io.IOException

Specified by:

isValidFile in interface ucar.nc2.iosp.IOServiceProvider

Throws:

java.io.IOException

open

public void open(ucar.unidata.io.RandomAccessFile raf,
        ucar.nc2.NetcdfFile ncfile,
        ucar.nc2.util.CancelTask cancelTask)
          throws java.io.IOException

Specified by:

open in interface ucar.nc2.iosp.IOServiceProvider

Throws:

java.io.IOException

readData

public ucar.ma2.Array readData(ucar.nc2.Variable v2,
                      ucar.ma2.Section section)
                        throws java.io.IOException,
                               ucar.ma2.InvalidRangeException

Specified by:

readData in interface ucar.nc2.iosp.IOServiceProvider

Throws:

java.io.IOException

ucar.ma2.InvalidRangeException

readNestedData

public ucar.ma2.Array readNestedData(ucar.nc2.Variable v2,
                            java.util.List section)
                              throws java.io.IOException,
                                     ucar.ma2.InvalidRangeException

Throws:

java.io.IOException

ucar.ma2.InvalidRangeException

setSpecial

public void setSpecial(java.lang.Object special)

sync

public boolean sync()
             throws java.io.IOException

Specified by:

sync in interface ucar.nc2.iosp.IOServiceProvider

Throws:

java.io.IOException

syncExtend

public boolean syncExtend()
                   throws java.io.IOException

Specified by:

syncExtend in interface ucar.nc2.iosp.IOServiceProvider

Throws:

java.io.IOException

toStringDebug

public java.lang.String toStringDebug(java.lang.Object o)

Specified by:

toStringDebug in interface ucar.nc2.iosp.IOServiceProvider

readSection

public ucar.ma2.Array readSection(ucar.nc2.ParsedSectionSpec arg0)
                           throws java.io.IOException,
                                  ucar.ma2.InvalidRangeException

Specified by:

readSection in interface ucar.nc2.iosp.IOServiceProvider

Throws:

java.io.IOException

ucar.ma2.InvalidRangeException

readToByteChannel

public long readToByteChannel(ucar.nc2.Variable arg0,
                     ucar.ma2.Section arg1,
                     java.nio.channels.WritableByteChannel arg2)
                       throws java.io.IOException,
                              ucar.ma2.InvalidRangeException

Specified by:

readToByteChannel in interface ucar.nc2.iosp.IOServiceProvider

Throws:

java.io.IOException

ucar.ma2.InvalidRangeException

sendIospMessage

public java.lang.Object sendIospMessage(java.lang.Object arg0)

Specified by:

sendIospMessage in interface ucar.nc2.iosp.IOServiceProvider

getFileTypeDescription

public java.lang.String getFileTypeDescription()

Specified by:

getFileTypeDescription in interface ucar.nc2.iosp.IOServiceProvider

getFileTypeId

public java.lang.String getFileTypeId()

Specified by:

getFileTypeId in interface ucar.nc2.iosp.IOServiceProvider

getFileTypeVersion

public java.lang.String getFileTypeVersion()

Specified by:

getFileTypeVersion in interface ucar.nc2.iosp.IOServiceProvider

getDataDir

public java.lang.String getDataDir()

main

public static void main(java.lang.String[] args)

getStructureIterator

public ucar.ma2.StructureDataIterator getStructureIterator(ucar.nc2.Structure arg0,
                                                  int arg1)
                                                    throws java.io.IOException

Specified by:

getStructureIterator in interface ucar.nc2.iosp.IOServiceProvider

Throws:

java.io.IOException