Package ucar.nc2.iosp.uf

Class UFiosp

java.lang.Object

ucar.nc2.iosp.AbstractIOServiceProvider

ucar.nc2.iosp.uf.UFiosp

All Implemented Interfaces:

Comparable<IOServiceProvider>, IOServiceProvider

public class UFiosp
extends AbstractIOServiceProvider

Created by IntelliJ IDEA. User: yuanho Date: Sep 25, 2008 Time: 10:23:36 AM To change this template use File | Settings | File Templates.

Nested Class Summary

Nested classes/interfaces inherited from interface ucar.nc2.iosp.IOServiceProvider

IOServiceProvider.SortGroup

Field Summary

Fields

Modifier and Type	Field	Description
protected UFheader	headerParser

Fields inherited from class ucar.nc2.iosp.AbstractIOServiceProvider

location, ncfile, raf, rafOrder

Constructor Summary

Constructors

Constructor	Description
UFiosp()

Method Summary

Modifier and Type	Method	Description
String	getFileTypeDescription()	Get a human-readable description for this file type.
String	getFileTypeId()	Get a unique id for this file type.
boolean	isValidFile(RandomAccessFile raf)	Check if this is a valid file for this IOServiceProvider.
Variable	makeVariable(NetcdfFile ncfile, String shortName, String longName, String abbrev, List<List<Ray>> groups)
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.

Methods inherited from class ucar.nc2.iosp.AbstractIOServiceProvider

build, buildFinish, close, getDetailInfo, getFileTypeVersion, getLastModified, getStructureIterator, isBuilder, reacquire, readSection, readToByteChannel, readToOutputStream, release, sendIospMessage, setNetcdfFile, 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

compareTo, getSortGroup

Field Detail

headerParser

protected UFheader headerParser

Constructor Detail

UFiosp

public UFiosp()

Method Detail

isValidFile

public boolean isValidFile(RandomAccessFile raf)

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.

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:

"https://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:

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

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

makeVariable

public Variable makeVariable(NetcdfFile ncfile,
                             String shortName,
                             String longName,
                             String abbrev,
                             List<List<Ray>> groups)

readData

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

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

See Also:

Range