ucar.nc2.internal.iosp.netcdf3

Class N3iosp

java.lang.Object

ucar.nc2.iosp.AbstractIOServiceProvider

ucar.nc2.internal.iosp.netcdf3.N3iosp

All Implemented Interfaces:

Closeable, AutoCloseable, IOServiceProvider

Direct Known Subclasses:

N3iospWriter

public class N3iosp
extends AbstractIOServiceProvider
implements IOServiceProvider

Netcdf 3 version iosp, using Builders for immutability.

Field Summary

Fields

Modifier and Type	Field and Description
protected N3header	header
protected long	lastModified
protected static org.slf4j.Logger	log

Fields inherited from class ucar.nc2.iosp.AbstractIOServiceProvider

location, ncfile, raf, rafOrder

Constructor Summary

Constructors

Constructor and Description
N3iosp()

Method Summary

Modifier and Type	Method and Description
void	build(RandomAccessFile raf, Group.Builder rootGroup, CancelTask cancelTask) Read an existing RandomAccessFile, and populate rootGroup.
void	close() Close the file.
String	getDetailInfo() Show debug / underlying implementation details
String	getFileTypeDescription() Get a human-readable description for this file type.
String	getFileTypeId() Get a unique id for this file type.
String	getFileTypeVersion() Get the version of this file type.
boolean	isValidFile(RandomAccessFile raf) Check if this is a valid file for this IOServiceProvider.
void	reacquire() Reacquire any resources like file handles Used when reactivating in cache.
Array<?>	readArrayData(Variable v2, Section section) Read data from a top level Variable and return a memory resident Array.
Array	readData(Variable v2, Section section)
Object	sendIospMessage(Object message) A way to communicate arbitrary information to and from an iosp.
String	toStringDebug(Object o) Debug info for this object.

Methods inherited from class ucar.nc2.iosp.AbstractIOServiceProvider

buildFinish, getLastModified, getStructureDataArrayIterator, getStructureIterator, open, readSection, readToOutputStream, release, setNetcdfFile

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

buildFinish, getLastModified, getStructureDataArrayIterator, getStructureIterator, readSection, readToOutputStream, release

Field Detail

log

protected static org.slf4j.Logger log

header

protected N3header header

lastModified

protected long lastModified

Constructor Detail

N3iosp

public N3iosp()

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.

Specified by:

isValidFile in interface IOServiceProvider

Parameters:

raf - RandomAccessFile

Returns:

true if valid.

Throws:

IOException - if read error

getDetailInfo

public String getDetailInfo()

Description copied from interface: IOServiceProvider

Show debug / underlying implementation details

Specified by:

getDetailInfo in interface IOServiceProvider

Overrides:

getDetailInfo in class AbstractIOServiceProvider

Returns:

debug info

close

public void close()
           throws IOException

Description copied from interface: IOServiceProvider

Close the file. It is the IOServiceProvider's job to close the file (even though it didnt open it), and to free any other resources it has used.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface IOServiceProvider

Overrides:

close in class AbstractIOServiceProvider

Throws:

IOException - if read error

reacquire

public void reacquire()
               throws IOException

Description copied from interface: IOServiceProvider

Reacquire any resources like file handles Used when reactivating in cache.

Specified by:

reacquire in interface IOServiceProvider

Overrides:

reacquire in class AbstractIOServiceProvider

Throws:

IOException

toStringDebug

public String toStringDebug(Object o)

Description copied from interface: IOServiceProvider

Debug info for this object.

Specified by:

toStringDebug in interface IOServiceProvider

Overrides:

toStringDebug in class AbstractIOServiceProvider

Parameters:

o - which object

Returns:

debug info for this object

sendIospMessage

public Object sendIospMessage(Object message)

Description copied from interface: IOServiceProvider

A way to communicate arbitrary information to and from an iosp.

Specified by:

sendIospMessage in interface IOServiceProvider

Overrides:

sendIospMessage in class AbstractIOServiceProvider

Parameters:

message - opaque message sent to the IOSP object when its opened (not when isValidFile() is called)

Returns:

opaque Object, may be null.

getFileTypeId

public String getFileTypeId()

Description copied from interface: IOServiceProvider

Get a unique id for this file type.

Specified by:

getFileTypeId in interface IOServiceProvider

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.

Specified by:

getFileTypeDescription in interface IOServiceProvider

Returns:

description of the file type

See Also:

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

getFileTypeVersion

public String getFileTypeVersion()

Description copied from interface: IOServiceProvider

Get the version of this file type.

Specified by:

getFileTypeVersion in interface IOServiceProvider

Overrides:

getFileTypeVersion in class AbstractIOServiceProvider

Returns:

version of the file type

See Also:

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

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.

Specified by:

build in interface IOServiceProvider

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 v2,
                      Section section)
               throws IOException,
                      InvalidRangeException

Specified by:

readData in interface IOServiceProvider

Throws:

IOException

InvalidRangeException

readArrayData

public Array<?> readArrayData(Variable v2,
                              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.

Specified by:

readArrayData in interface IOServiceProvider

Overrides:

readArrayData in class AbstractIOServiceProvider

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

InvalidRangeException