ucar.nc2.iosp.bufr

Class BufrIosp2

java.lang.Object

ucar.nc2.iosp.AbstractIOServiceProvider

ucar.nc2.iosp.bufr.BufrIosp2

All Implemented Interfaces:

IOServiceProvider

public class BufrIosp2
extends AbstractIOServiceProvider

IOSP for BUFR data - version 2, using the preprocessor.

Since:

8/8/13

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	centerId
static java.lang.String	fxyAttName
static java.lang.String	obsRecordName

Fields inherited from class ucar.nc2.iosp.AbstractIOServiceProvider

location, ncfile, raf, rafOrder

Constructor Summary

Constructors

Constructor and Description
BufrIosp2()

Method Summary

Modifier and Type	Method and Description
void	build(RandomAccessFile raf, Group.Builder rootGroup, CancelTask cancelTask) Open existing file, and populate it.
void	buildFinish(NetcdfFile ncfile) Sometimes the builder needs access to the finished objects.
BufrConfig	getConfig()
java.lang.String	getDetailInfo() Show debug / underlying implementation details
org.jdom2.Element	getElem()
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.
StructureDataIterator	getStructureIterator(Structure s, int bufferSize) Get the structure iterator.
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	open(RandomAccessFile raf, NetcdfFile ncfile, Message single)
Array	readData(Variable v2, 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.
static void	setDebugFlags(DebugFlags debugFlag)

Methods inherited from class ucar.nc2.iosp.AbstractIOServiceProvider

close, getFileTypeVersion, getLastModified, reacquire, readSection, readToByteChannel, readToOutputStream, release, setNetcdfFile, streamToByteChannel, syncExtend, toStringDebug

Methods inherited from class java.lang.Object

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

Field Detail

obsRecordName

public static final java.lang.String obsRecordName

See Also:

Constant Field Values

fxyAttName

public static final java.lang.String fxyAttName

See Also:

Constant Field Values

centerId

public static final java.lang.String centerId

See Also:

Constant Field Values

Constructor Detail

BufrIosp2

public BufrIosp2()

Method Detail

setDebugFlags

public static void setDebugFlags(DebugFlags debugFlag)

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

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

buildFinish

public void buildFinish(NetcdfFile ncfile)

Description copied from interface: IOServiceProvider

Sometimes the builder needs access to the finished objects. This is called after ncfile.build()

Specified by:

buildFinish in interface IOServiceProvider

Overrides:

buildFinish in class AbstractIOServiceProvider

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

open

public void open(RandomAccessFile raf,
                 NetcdfFile ncfile,
                 Message single)
          throws java.io.IOException

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.

getConfig

public BufrConfig getConfig()

getElem

public org.jdom2.Element getElem()

readData

public Array readData(Variable v2,
                      Section section)

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:

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

See Also:

Range

getStructureIterator

public StructureDataIterator getStructureIterator(Structure s,
                                                  int bufferSize)

Description copied from interface: IOServiceProvider

Get the structure iterator. iosps with top level sequences must override. Not threadsafe; do not use multiple StructureDataIterator for the same iosp.

Specified by:

getStructureIterator in interface IOServiceProvider

Overrides:

getStructureIterator in class AbstractIOServiceProvider

Parameters:

s - the Structure

bufferSize - the buffersize

Returns:

the data iterator

getDetailInfo

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

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"