ucar.nc2.stream

Class NcStreamIosp

java.lang.Object

ucar.nc2.iosp.AbstractIOServiceProvider

ucar.nc2.stream.NcStreamIosp

All Implemented Interfaces:

Closeable, AutoCloseable, 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 and Description
class	NcStreamIosp.NcsMess

Field Summary

Fields inherited from class ucar.nc2.iosp.AbstractIOServiceProvider

location, ncfile, raf, rafOrder

Constructor Summary

Constructors

Constructor and Description
NcStreamIosp()

Method Summary

Modifier and Type	Method and Description
void	build(RandomAccessFile raf, Group.Builder rootGroup, CancelTask cancelTask) Read an existing RandomAccessFile, and populate rootGroup.
String	getFileTypeDescription() Get a human-readable description for this file type.
String	getFileTypeId() Get a unique id for this file type.
int	getVersion()
boolean	isValidFile(RandomAccessFile raf) Check if this is a valid file for this IOServiceProvider.
void	openDebugNew(RandomAccessFile raf, Group.Builder rootBuilder, List<NcStreamIosp.NcsMess> messages)
Array	readData(Variable v, Section section)

Methods inherited from class ucar.nc2.iosp.AbstractIOServiceProvider

buildFinish, close, getDetailInfo, getFileTypeVersion, getLastModified, getStructureDataArrayIterator, getStructureIterator, open, reacquire, readArrayData, readSection, readToOutputStream, release, sendIospMessage, setNetcdfFile, 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()

build

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

Description copied from interface: IOServiceProvider

Read an existing RandomAccessFile, and populate rootGroup. Note that you cannot reference the NetcdfFile within this routine, since it hasnt been created yet.

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

Throws:

IOException

InvalidRangeException

openDebugNew

public void openDebugNew(RandomAccessFile raf,
                         Group.Builder rootBuilder,
                         List<NcStreamIosp.NcsMess> messages)
                  throws IOException

Throws:

IOException