ucar.nc2.internal.iosp.hdf4

Class H4iosp

java.lang.Object

ucar.nc2.iosp.AbstractIOServiceProvider

ucar.nc2.internal.iosp.hdf4.H4iosp

All Implemented Interfaces:

IOServiceProvider

public class H4iosp
extends AbstractIOServiceProvider

HDF4 iosp

Field Summary

Fields inherited from class ucar.nc2.iosp.AbstractIOServiceProvider

location, ncfile, raf, rafOrder

Constructor Summary

Constructors

Constructor and Description
H4iosp()

Method Summary

Modifier and Type	Method and Description
void	build(RandomAccessFile raf, Group.Builder rootGroup, CancelTask cancelTask) Open existing file, and populate it.
java.lang.String	getFileTypeDescription() Get a human-readable description for this file type.
java.lang.String	getFileTypeId() Get a unique id for this file type.
java.lang.String	getFileTypeVersion() Get the version of this file type.
protected java.util.Optional<java.nio.charset.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.
Array	readData(Variable v, Section section) Read data from a top level Variable and return a memory resident Array.
java.lang.Object	sendIospMessage(java.lang.Object message) A way to communicate arbitrary information to and from an iosp.
protected void	setValueCharset(java.nio.charset.Charset charset) Define value charset.
java.lang.String	toStringDebug(java.lang.Object o) Debug info for this object.

Methods inherited from class ucar.nc2.iosp.AbstractIOServiceProvider

buildFinish, close, getDetailInfo, getLastModified, getStructureIterator, readSection, readToByteChannel, readToOutputStream, release, setNetcdfFile, streamToByteChannel, syncExtend

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

H4iosp

public H4iosp()

Method Detail

isValidFile

public boolean isValidFile(RandomAccessFile raf)
                    throws java.io.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:

java.io.IOException - if read error

getFileTypeId

public java.lang.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 java.lang.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"

getFileTypeVersion

public java.lang.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"

open

public void open(RandomAccessFile raf,
                 NetcdfFile ncfile,
                 CancelTask cancelTask)
          throws java.io.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:

java.io.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 java.io.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:

java.io.IOException - if read error

readData

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

java.io.IOException - if read error

InvalidRangeException - if invalid section

See Also:

Range

toStringDebug

public java.lang.String toStringDebug(java.lang.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

reacquire

public void reacquire()
               throws java.io.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:

java.io.IOException

sendIospMessage

public java.lang.Object sendIospMessage(java.lang.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.

getValueCharset

protected java.util.Optional<java.nio.charset.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
                               java.nio.charset.Charset charset)

Define value charset.

Parameters:

charset - may be null.