ucar.nc2.jni.netcdf

Class Nc4Iosp

java.lang.Object

ucar.nc2.iosp.AbstractIOServiceProvider

ucar.nc2.jni.netcdf.Nc4Iosp

All Implemented Interfaces:

IOServiceProvider, IOServiceProviderWriter

public class Nc4Iosp
extends AbstractIOServiceProvider
implements IOServiceProviderWriter

IOSP for reading netcdf files through jni interface to netcdf4 library

Since:

Oct 30, 2008

Author:

caron

See Also:

"http://www.unidata.ucar.edu/software/netcdf/docs/netcdf-c.html", "http://earthdata.nasa.gov/sites/default/files/field/document/ESDS-RFC-022v1.pdf", "http://www.unidata.ucar.edu/software/netcdf/docs/faq.html#fv15" hdf5 features not supported, "http://www.unidata.ucar.edu/software/netcdf/win_netcdf/"

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	DEFAULTNETCDF4LIBNAME
static String	JNA_PATH
static String	JNA_PATH_ENV
protected static String	netcdf4libname

Fields inherited from class ucar.nc2.iosp.AbstractIOServiceProvider

raf

Constructor Summary

Constructors

Constructor and Description
Nc4Iosp()
Nc4Iosp(NetcdfFileWriter.Version version)

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
void	create(String filename, NetcdfFile ncfile, int extra, long preallocateSize, boolean largeFile)
protected static String	defaultNetcdf4Library() Use the default path to try to set jna.library.path
void	flush()
String	getFileTypeDescription()
String	getFileTypeId()
static boolean	isClibraryPresent() Test if the netcdf C library is present and loaded
boolean	isValidFile(RandomAccessFile raf)
static void	main(String[] args)
protected static String	nullify(String s) Convert a zero-length string to null
void	open(RandomAccessFile raf, NetcdfFile ncfile, CancelTask cancelTask)
NetcdfFile	open(String location)
void	openForWriting(RandomAccessFile raf, NetcdfFile ncfile, CancelTask cancelTask)
Array	readData(Variable v2, Section section)
boolean	rewriteHeader(boolean largeFile)
void	setChunker(Nc4Chunking chunker)
static void	setDebugFlags(DebugFlags flags)
void	setFill(boolean fill)
static void	setLibraryAndPath(String jna_path, String lib_name) set the path and name of the netcdf c library.
static void	setWarnOff() Suppress warning messages
void	updateAttribute(Variable v2, Attribute att)
void	writeData(Variable v2, Section section, Array values)

Methods inherited from class ucar.nc2.iosp.AbstractIOServiceProvider

getDetailInfo, getFileTypeVersion, getLastModified, getStructureIterator, readSection, readToByteChannel, readToOutputStream, sendIospMessage, streamToByteChannel, syncExtend, toStringDebug

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

getDetailInfo, getFileTypeVersion, getStructureIterator, readSection, readToByteChannel, readToOutputStream, sendIospMessage, streamToByteChannel, syncExtend, toStringDebug

Field Detail

JNA_PATH

public static final String JNA_PATH

See Also:

Constant Field Values

JNA_PATH_ENV

public static final String JNA_PATH_ENV

See Also:

Constant Field Values

DEFAULTNETCDF4LIBNAME

protected static String DEFAULTNETCDF4LIBNAME

netcdf4libname

protected static String netcdf4libname

Constructor Detail

Nc4Iosp

public Nc4Iosp()

Nc4Iosp

public Nc4Iosp(NetcdfFileWriter.Version version)

Method Detail

isClibraryPresent

public static boolean isClibraryPresent()

Test if the netcdf C library is present and loaded

Returns:

true if present

defaultNetcdf4Library

protected static String defaultNetcdf4Library()

Use the default path to try to set jna.library.path

Returns:

true if we set jna.library.path

setLibraryAndPath

public static void setLibraryAndPath(String jna_path,
                     String lib_name)

set the path and name of the netcdf c library. must be called before load() is called.

Parameters:

jna_path - path to shared libraries

lib_name - library name

nullify

protected static String nullify(String s)

Convert a zero-length string to null

Parameters:

s - the string to check for length

Returns:

null if s.length() == 0, s otherwise

setWarnOff

public static void setWarnOff()

Suppress warning messages

setDebugFlags

public static void setDebugFlags(DebugFlags flags)

setChunker

public void setChunker(Nc4Chunking chunker)

isValidFile

public boolean isValidFile(RandomAccessFile raf)
                    throws IOException

Specified by:

isValidFile in interface IOServiceProvider

Throws:

IOException

getFileTypeId

public String getFileTypeId()

Specified by:

getFileTypeId in interface IOServiceProvider

getFileTypeDescription

public String getFileTypeDescription()

Specified by:

getFileTypeDescription in interface IOServiceProvider

close

public void close()
           throws IOException

Specified by:

close in interface IOServiceProvider

Overrides:

close in class AbstractIOServiceProvider

Throws:

IOException

open

public void open(RandomAccessFile raf,
        NetcdfFile ncfile,
        CancelTask cancelTask)
          throws IOException

Specified by:

open in interface IOServiceProvider

Overrides:

open in class AbstractIOServiceProvider

Throws:

IOException

openForWriting

public void openForWriting(RandomAccessFile raf,
                  NetcdfFile ncfile,
                  CancelTask cancelTask)
                    throws IOException

Specified by:

openForWriting in interface IOServiceProviderWriter

Throws:

IOException

readData

public Array readData(Variable v2,
             Section section)
               throws IOException,
                      InvalidRangeException

Specified by:

readData in interface IOServiceProvider

Throws:

IOException

InvalidRangeException

create

public void create(String filename,
          NetcdfFile ncfile,
          int extra,
          long preallocateSize,
          boolean largeFile)
            throws IOException

Specified by:

create in interface IOServiceProviderWriter

Throws:

IOException

writeData

public void writeData(Variable v2,
             Section section,
             Array values)
               throws IOException,
                      InvalidRangeException

Specified by:

writeData in interface IOServiceProviderWriter

Throws:

IOException

InvalidRangeException

flush

public void flush()
           throws IOException

Specified by:

flush in interface IOServiceProviderWriter

Throws:

IOException

setFill

public void setFill(boolean fill)

Specified by:

setFill in interface IOServiceProviderWriter

rewriteHeader

public boolean rewriteHeader(boolean largeFile)
                      throws IOException

Specified by:

rewriteHeader in interface IOServiceProviderWriter

Throws:

IOException

updateAttribute

public void updateAttribute(Variable v2,
                   Attribute att)
                     throws IOException

Specified by:

updateAttribute in interface IOServiceProviderWriter

Throws:

IOException

open

public NetcdfFile open(String location)
                throws Exception

Throws:

Exception

main

public static void main(String[] args)
                 throws Exception

Throws:

Exception