ucar.nc2.iosp.misc
Class Nldn

java.lang.Object
  extended by ucar.nc2.iosp.AbstractIOServiceProvider
      extended by ucar.nc2.iosp.misc.AbstractLightningIOSP
          extended by ucar.nc2.iosp.misc.Nldn
All Implemented Interfaces:
IOServiceProvider

public class Nldn
extends AbstractLightningIOSP

National Lightning Detection Network (NLDN)

Since:
Nov 19, 2008
Author:
caron
See Also:
"http://www.unidata.ucar.edu/data/lightning.html"

Field Summary
 
Fields inherited from class ucar.nc2.iosp.misc.AbstractLightningIOSP
ECCENTRICITY, ELLIPSE_ANGLE, LAT, LON, MAJOR_AXIS, MINOR_AXIS, MULTIPLICITY, RECORD, secondsSince1970, SIGNAL, TIME
 
Fields inherited from class ucar.nc2.iosp.AbstractIOServiceProvider
raf
 
Constructor Summary
Nldn()
           
 
Method Summary
protected  void addLightningGlobalAttributes(NetcdfFile ncfile)
          Add the global attributes.
 String getFileTypeDescription()
          Get a human-readable description for this file type.
 String getFileTypeId()
          Get a unique id for this file type.
 StructureDataIterator getStructureIterator(Structure s, int bufferSize)
          Get the structure iterator
 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.
 Array readData(Variable v2, Section section)
          Read data from a top level Variable and return a memory resident Array.
 
Methods inherited from class ucar.nc2.iosp.misc.AbstractLightningIOSP
makeLightningVariable
 
Methods inherited from class ucar.nc2.iosp.AbstractIOServiceProvider
close, getDetailInfo, getFileTypeVersion, readSection, readToByteChannel, sendIospMessage, sync, syncExtend, toStringDebug
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Nldn

public Nldn()
Method Detail

isValidFile

public boolean isValidFile(RandomAccessFile raf)
                    throws IOException
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:
IOException - if read error

getFileTypeId

public String getFileTypeId()
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 String getFileTypeDescription()
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 IOException
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

addLightningGlobalAttributes

protected void addLightningGlobalAttributes(NetcdfFile ncfile)
Add the global attributes.

Overrides:
addLightningGlobalAttributes in class AbstractLightningIOSP
Parameters:
ncfile - the file to add to

readData

public Array readData(Variable v2,
                      Section section)
               throws IOException,
                      InvalidRangeException
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
Throws:
IOException - if read error
InvalidRangeException - if invalid section
See Also:
Range

getStructureIterator

public StructureDataIterator getStructureIterator(Structure s,
                                                  int bufferSize)
                                           throws IOException
Get the structure iterator

Specified by:
getStructureIterator in interface IOServiceProvider
Overrides:
getStructureIterator in class AbstractIOServiceProvider
Parameters:
s - the Structure
bufferSize - the buffersize
Returns:
the data iterator
Throws:
IOException - if problem reading data


Copyright © 1999-2011 UCAR/Unidata. All Rights Reserved.