ucar.nc2.iosp.mcidas

Class AreaServiceProvider

java.lang.Object

ucar.nc2.iosp.AbstractIOServiceProvider

ucar.nc2.iosp.mcidas.AreaServiceProvider

All Implemented Interfaces:

IOServiceProvider

public class AreaServiceProvider
extends AbstractIOServiceProvider

IOServiceProvider for McIDAS AREA files

Field Summary

Fields

Modifier and Type	Field and Description
protected AreaReader	areaReader AREA file reader

Fields inherited from class ucar.nc2.iosp.AbstractIOServiceProvider

location, ncfile, raf, rafOrder

Constructor Summary

Constructors

Constructor and Description
AreaServiceProvider()

Method Summary

Modifier and Type	Method and Description
void	close() Close the file.
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.
boolean	isValidFile(RandomAccessFile raf) Is this a valid file?
void	open(RandomAccessFile raf, NetcdfFile ncfile, CancelTask cancelTask) Open the service provider for reading.
void	reacquire() Reacquire any resources like file handles Used when reactivating in cache.
Array	readData(Variable v2, Section section) Read the data for the variable
void	release() Release any system resources like file handles.

Methods inherited from class ucar.nc2.iosp.AbstractIOServiceProvider

build, buildFinish, getDetailInfo, getFileTypeVersion, getLastModified, getStructureIterator, isBuilder, readSection, readToByteChannel, readToOutputStream, sendIospMessage, setNetcdfFile, streamToByteChannel, syncExtend, toStringDebug

Methods inherited from class java.lang.Object

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

Field Detail

areaReader

protected AreaReader areaReader

AREA file reader

Constructor Detail

AreaServiceProvider

public AreaServiceProvider()

Method Detail

isValidFile

public boolean isValidFile(RandomAccessFile raf)
                    throws java.io.IOException

Is this a valid file?

Parameters:

raf - RandomAccessFile to check

Returns:

true if a valid McIDAS AREA file

Throws:

java.io.IOException - problem reading file

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"

open

public void open(RandomAccessFile raf,
                 NetcdfFile ncfile,
                 CancelTask cancelTask)
          throws java.io.IOException

Open the service provider for reading.

Specified by:

open in interface IOServiceProvider

Overrides:

open in class AbstractIOServiceProvider

Parameters:

raf - file to read from

ncfile - netCDF file we are writing to (memory)

cancelTask - task for cancelling

Throws:

java.io.IOException - problem reading file

readData

public Array readData(Variable v2,
                      Section section)
               throws java.io.IOException,
                      InvalidRangeException

Read the data for the variable

Parameters:

v2 - Variable to read

section - section information

Returns:

Array of data

Throws:

java.io.IOException - problem reading from file

InvalidRangeException - invalid Range

See Also:

Range

close

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

java.io.IOException - if read error

release

public void release()
             throws java.io.IOException

Description copied from interface: IOServiceProvider

Release any system resources like file handles. Optional, implement only if you are able to reacquire. Used when object is made inactive in cache.

Specified by:

release in interface IOServiceProvider

Overrides:

release in class AbstractIOServiceProvider

Throws:

java.io.IOException

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