Package ucar.nc2.stream

Class NcStreamIosp

java.lang.Object

ucar.nc2.iosp.AbstractIOServiceProvider

ucar.nc2.stream.NcStreamIosp

All Implemented Interfaces:

IOServiceProvider

public class NcStreamIosp
extends AbstractIOServiceProvider

IOSP to read an ncStream that has been written to a file. Proof of concept for making ncStream-encoded file into a version of the netcdf format.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	NcStreamIosp.NcsMess

Field Summary

Fields inherited from class ucar.nc2.iosp.AbstractIOServiceProvider

location, ncfile, raf, rafOrder

Constructor Summary

Constructors

Constructor	Description
NcStreamIosp()

Method Summary

Modifier and Type	Method	Description
void	build(RandomAccessFile raf, Group.Builder rootGroup, CancelTask cancelTask)	Open existing file, and populate it.
String	getFileTypeDescription()	Get a human-readable description for this file type.
String	getFileTypeId()	Get a unique id for this file type.
int	getVersion()
boolean	isBuilder()	If this iosp implements build().
boolean	isValidFile(RandomAccessFile raf)	Check if this is a valid file for this IOServiceProvider.
void	open(RandomAccessFile raf, NetcdfFile ncfile, CancelTask cancelTask)	Open existing file, and populate ncfile with it.
void	openDebug(RandomAccessFile raf, NetcdfFile ncfile, List<NcStreamIosp.NcsMess> messages)
Array	readData(Variable v, Section section)	Read data from a top level Variable and return a memory resident Array.

Methods inherited from class ucar.nc2.iosp.AbstractIOServiceProvider

buildFinish, close, getDetailInfo, getFileTypeVersion, getLastModified, getStructureIterator, 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

Constructor Detail

NcStreamIosp

public NcStreamIosp()

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

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"

getVersion

public int getVersion()

isBuilder

public boolean isBuilder()

Description copied from interface: IOServiceProvider

If this iosp implements build().

Specified by:

isBuilder in interface IOServiceProvider

Overrides:

isBuilder in class AbstractIOServiceProvider

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

build

public void build(RandomAccessFile raf,
                  Group.Builder rootGroup,
                  CancelTask cancelTask)
           throws IOException

Description copied from interface: IOServiceProvider

Open existing file, and populate it. Note that you cannot reference the NetcdfFile within this routine. This is the bridge to immutable objects that will be used exclusively in version 6.

Specified by:

build in interface IOServiceProvider

Overrides:

build in class AbstractIOServiceProvider

Parameters:

raf - the file to work on, it has already passed the isValidFile() test.

rootGroup - add objects to the root group.

cancelTask - used to monitor user cancellation; may be null.

Throws:

IOException - if read error

readData

public Array readData(Variable v,
                      Section section)
               throws 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:

v - 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

InvalidRangeException - if invalid section

See Also:

Range

openDebug

public void openDebug(RandomAccessFile raf,
                      NetcdfFile ncfile,
                      List<NcStreamIosp.NcsMess> messages)
               throws IOException

Throws:

IOException