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

Version:

$Revision: 1.3 $

Author:

IDV Development Team

Nested Class Summary

protected static class

AreaServiceProvider.MakeNetcdfFile TODO: generalize this static class for testing

Field Summary

protected AreaReader

areaReader AREA file reader

Fields inherited from class ucar.nc2.iosp.AbstractIOServiceProvider

raf

Constructor Summary

AreaServiceProvider()

Method Summary

void	close() Close this IOSP
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?
static void	main(java.lang.String[] args) Test this.
void	open(RandomAccessFile raf, NetcdfFile ncfile, CancelTask cancelTask) Open the service provider for reading.
Array	readData(Variable v2, Section section) Read the data for the variable
boolean	sync() Sync and extend
boolean	syncExtend() Extend the NetcdfFile if the underlying dataset has changed in a way that is compatible with the current metadata.

Methods inherited from class ucar.nc2.iosp.AbstractIOServiceProvider

copyToByteChannel, createValidNetcdfObjectName, getDetailInfo, getFileTypeVersion, getStructureIterator, readSection, readToByteChannel, sendIospMessage, 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:

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

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

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 infomation

Returns:

Array of data

Throws:

java.io.IOException - problem reading from file

InvalidRangeException - invalid Range

See Also:

Range

syncExtend

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

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

sync

public boolean sync()

Sync and extend

Specified by:

sync in interface IOServiceProvider

Overrides:

sync in class AbstractIOServiceProvider

Returns:

false

close

public void close()
           throws java.io.IOException

Close this IOSP

Specified by:

close in interface IOServiceProvider

Overrides:

close in class AbstractIOServiceProvider

Throws:

java.io.IOException - problem closing file

main

public static void main(java.lang.String[] args)
                 throws java.io.IOException

Test this.

Parameters:

args - [0] input file name [0] output file name

Throws:

java.io.IOException - problem reading the file