ucar.nc2.internal.iosp.netcdf3

Class N3iospNew

java.lang.Object

ucar.nc2.iosp.AbstractIOServiceProvider

ucar.nc2.internal.iosp.netcdf3.N3iospNew

All Implemented Interfaces:

IOServiceProvider

public class N3iospNew
extends AbstractIOServiceProvider
implements IOServiceProvider

Read-only using Builders for immutability.

Since:

9/29/2019.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	debug
protected boolean	debugRead
protected boolean	debugRecord
protected N3headerNew	header
protected long	lastModified
protected boolean	useRecordStructure

Fields inherited from class ucar.nc2.iosp.AbstractIOServiceProvider

location, ncfile, raf, rafOrder

Constructor Summary

Constructors

Constructor and Description
N3iospNew()

Method Summary

Modifier and Type	Method and Description
void	build(RandomAccessFile raf, Group.Builder rootGroup, CancelTask cancelTask) Open existing file, and populate it.
void	close() Close the file.
protected N3headerNew	createHeader() Create header for reading netcdf file.
void	flush()
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.
protected Optional<Charset>	getValueCharset() Return value charset if it was defined.
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	reacquire() Reacquire any resources like file handles Used when reactivating in cache.
protected Object	readData(Layout index, DataType dataType) Read data subset from file for a variable, create primitive array.
protected long	readData(Layout index, DataType dataType, WritableByteChannel out) Read data subset from file for a variable, to WritableByteChannel.
Array	readData(Variable v2, Section section) Read data from a top level Variable and return a memory resident Array.
long	readToByteChannel(Variable v2, Section section, WritableByteChannel channel) Read data from a top level Variable and send data to a WritableByteChannel.
Object	sendIospMessage(Object message) A way to communicate arbitrary information to an iosp.
protected void	setValueCharset(Charset charset) Define value charset.
boolean	syncExtend() Extend the NetcdfFile if the underlying dataset has changed in a way that is compatible with the current metadata.
String	toStringDebug(Object o) Debug info for this object.

Methods inherited from class ucar.nc2.iosp.AbstractIOServiceProvider

buildFinish, getFileTypeVersion, getLastModified, getStructureIterator, readSection, readToOutputStream, release, setNetcdfFile, streamToByteChannel

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, getFileTypeVersion, getStructureIterator, readSection, readToOutputStream, release, streamToByteChannel

Field Detail

header

protected N3headerNew header

lastModified

protected long lastModified

debug

protected boolean debug

debugRecord

protected boolean debugRecord

debugRead

protected boolean debugRead

useRecordStructure

protected boolean useRecordStructure

Constructor Detail

N3iospNew

public N3iospNew()

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

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

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

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

createHeader

protected N3headerNew createHeader()

Create header for reading netcdf file.

Returns:

readData

public Array readData(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:

readData in interface IOServiceProvider

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

InvalidRangeException - if invalid section

See Also:

Range

readToByteChannel

public long readToByteChannel(Variable v2,
                              Section section,
                              WritableByteChannel channel)
                       throws IOException,
                              InvalidRangeException

Description copied from interface: IOServiceProvider

Read data from a top level Variable and send data to a WritableByteChannel. Must be in big-endian order.

Specified by:

readToByteChannel in interface IOServiceProvider

Overrides:

readToByteChannel 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.

channel - write data to this WritableByteChannel

Returns:

the number of bytes written to the channel

Throws:

IOException - if read error

InvalidRangeException - if invalid section

syncExtend

public boolean syncExtend()
                   throws IOException

Description copied from interface: IOServiceProvider

Extend the NetcdfFile if the underlying dataset has changed in a way that is compatible with the current metadata. For example, if the unlimited dimension has grown.

Specified by:

syncExtend in interface IOServiceProvider

Overrides:

syncExtend in class AbstractIOServiceProvider

Returns:

true if the NetcdfFile was extended.

Throws:

IOException - if a read error occured when accessing the underlying dataset.

flush

public void flush()
           throws IOException

Throws:

IOException

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

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 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 return, may be null.

getValueCharset

protected Optional<Charset> getValueCharset()

Return value charset if it was defined. Definition of charset occurs by sending a charset as a message using the sendIospMessage(java.lang.Object) method.

Returns:

value charset if it was defined.

setValueCharset

protected void setValueCharset(@Nullable
                               Charset charset)

Define value charset.

Parameters:

charset - 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:

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

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

readData

protected Object readData(Layout index,
                          DataType dataType)
                   throws IOException

Read data subset from file for a variable, create primitive array.

Parameters:

index - handles skipping around in the file.

dataType - dataType of the variable

Returns:

primitive array with data read in

Throws:

IOException

readData

protected long readData(Layout index,
                        DataType dataType,
                        WritableByteChannel out)
                 throws IOException

Read data subset from file for a variable, to WritableByteChannel. Will send as bigendian, since thats what the underlying file has.

Parameters:

index - handles skipping around in the file.

dataType - dataType of the variable

Throws:

IOException