/*
* Copyright 1998-2010 University Corporation for Atmospheric Research/Unidata
*
* Portions of this software were developed by the Unidata Program at the
* University Corporation for Atmospheric Research.
*
* Access and use of this software shall impose the following obligations
* and understandings on the user. The user is granted the right, without
* any fee or cost, to use, copy, modify, alter, enhance and distribute
* this software, and any derivative works thereof, and its supporting
* documentation for any purpose whatsoever, provided that this entire
* notice appears in all copies of the software, derivative works and
* supporting documentation. Further, UCAR requests that the user credit
* UCAR/Unidata in any publications that result from the use of this
* software or in any product that includes this software. The names UCAR
* and/or Unidata, however, may not be used in any advertising or publicity
* to endorse or promote any products or commercial entity unless specific
* written permission is obtained from UCAR/Unidata. The user also
* understands that UCAR/Unidata is not obligated to provide the user with
* any support, consulting, training or assistance of any kind with regard
* to the use, operation and performance of this software nor to provide
* the user with any updates, revisions, new versions or "bug fixes."
*
* THIS SOFTWARE IS PROVIDED BY UCAR/UNIDATA "AS IS" AND ANY EXPRESS OR
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL UCAR/UNIDATA BE LIABLE FOR ANY SPECIAL,
* INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
* FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
* NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
* WITH THE ACCESS, USE OR PERFORMANCE OF THIS SOFTWARE.
*/
package ucar.nc2.iosp.gempak;
import ucar.grid.GridIndex;
import ucar.grid.GridRecord;
import ucar.ma2.*;
import ucar.nc2.*;
import ucar.nc2.dt.fmr.FmrcCoordSys;
import ucar.nc2.iosp.IOServiceProvider;
import ucar.nc2.iosp.grid.GridIndexToNC;
import ucar.nc2.iosp.grid.GridServiceProvider;
import ucar.nc2.util.CancelTask;
import ucar.unidata.io.RandomAccessFile;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.util.Calendar;
import java.util.Date;
import java.util.List;
/**
* An IOSP for GEMPAK Grid data
*
* @author Don Murray
*/
public class GempakGridServiceProvider extends GridServiceProvider {
/** GEMPAK file reader */
protected GempakGridReader gemreader;
/** Reread the file on a sync */
public static boolean extendIndex = true; // check if index needs to be extended
/**
* Is this a valid file?
*
* @param raf RandomAccessFile to check
*
* @return true if a valid GEMPAK grid file
*
* @throws IOException problem reading file
*/
public boolean isValidFile(RandomAccessFile raf) throws IOException {
try {
gemreader = new GempakGridReader(raf.getLocation());
gemreader.init(raf, false);
} catch (Exception ioe) {
return false;
}
return true;
}
public String getFileTypeId() {
return "GempakGrid";
}
public String getFileTypeDescription() {
return "GEMPAK Gridded Data";
}
/**
* Open the service provider for reading.
* @param raf file to read from
* @param ncfile netCDF file we are writing to (memory)
* @param cancelTask task for cancelling
*
* @throws IOException problem reading file
*/
public void open(RandomAccessFile raf, NetcdfFile ncfile,
CancelTask cancelTask)
throws IOException {
super.open(raf, ncfile, cancelTask);
// debugProj = true;
long start = System.currentTimeMillis();
if (gemreader == null) {
gemreader = new GempakGridReader(raf.getLocation());
}
initTables();
gemreader.init(raf, true);
GridIndex index = gemreader.getGridIndex();
open(index, cancelTask);
if (debugOpen) {
System.out.println(" GridServiceProvider.open "
+ ncfile.getLocation() + " took "
+ (System.currentTimeMillis() - start));
}
}
/**
* Open the index and create the netCDF file from that
*
* @param index GridIndex to use
* @param cancelTask cancel task
*
* @throws IOException problem reading the file
*/
protected void open(GridIndex index, CancelTask cancelTask)
throws IOException {
GempakLookup lookup =
new GempakLookup(
(GempakGridRecord) index.getGridRecords().get(0));
GridIndexToNC delegate = new GridIndexToNC(index.filename);
//delegate.setUseDescriptionForVariableName(false);
delegate.open(index, lookup, 4, ncfile, fmrcCoordSys, cancelTask);
ncfile.finish();
}
/**
* Sync the file
*
* @return true if needed to sync
*
* @throws IOException problem synching the file
*/
public boolean sync() throws IOException {
if ((gemreader.getInitFileSize() < raf.length()) && extendIndex) {
gemreader.init(true);
GridIndex index = gemreader.getGridIndex();
// reconstruct the ncfile objects
ncfile.empty();
open(index, null);
return true;
}
return false;
}
/**
* Read the data for this GridRecord
*
* @param gr grid identifier
*
* @return the data (or null)
*
* @throws IOException problem reading the data
*/
protected float[] _readData(GridRecord gr) throws IOException {
return gemreader.readGrid((GempakGridRecord) gr);
}
/**
* Test this class and possibly write out a netCDF file
*
* @param args arg1 input GEMPAK grid to read,
* arg2 output Netcdf file (optional)
* @throws java.io.IOException on io error
*
* @throws IOException problem reading or writing file
*/
public static void main(String args[]) throws IOException {
// Function References
GempakGridServiceProvider ggsp = new GempakGridServiceProvider();
String className = ggsp.getClass().getName();
// Test usage
if (args.length < 1) {
System.out.println("\nUsage of " + className + ":\n");
System.out.println("Parameters:");
System.out.println(
"\t<GEMPAK Grid File> GEMPAK grid file to read");
System.out.println(
"\t<NetCDF output file> file to store results (optional)\n");
System.out.println("java -Xmx256m " + className
+ " <GEMPAK Grid File> <NetCDF output file>");
System.exit(0);
}
// Say hello
Date now = Calendar.getInstance().getTime();
System.out.println(now.toString() + " ... Start of " + className);
try {
System.out.println("reading GEMPAK grid file=" + args[0]);
RandomAccessFile rf = new RandomAccessFile(args[0], "r", 2048);
NetcdfFile ncfile = new MakeNetcdfFile(ggsp, rf, args[0], null);
if (args.length == 2) {
System.out.print("writing to netCDF file=" + args[1]);
NetcdfFile nc = FileWriter.writeToFile(ncfile, args[1]);
nc.close();
}
rf.close(); // done reading
// Catch thrown errors from ncFile
} catch (FileNotFoundException noFileError) {
System.err.println("FileNotFoundException : " + noFileError);
} catch (IOException ioError) {
System.err.println("IOException : " + ioError);
}
// Goodbye message
now = Calendar.getInstance().getTime();
System.out.println(now.toString() + " ... End of " + className + "!");
} // end main
/**
* TODO: generalize this
* static class for testing
*/
protected static class MakeNetcdfFile extends NetcdfFile {
/**
* Ctor
*
* @param spi IOServiceProvider
* @param raf RandomAccessFile
* @param location location of file?
* @param cancelTask CancelTask
*
* @throws IOException problem opening the file
*/
MakeNetcdfFile(IOServiceProvider spi, RandomAccessFile raf,
String location, CancelTask cancelTask)
throws IOException {
super(spi, raf, location, cancelTask);
}
}
/**
* Initialize the parameter tables.
*/
private void initTables() {
try {
GempakGridParameterTable.addParameters(
"resources/nj22/tables/gempak/wmogrib3.tbl");
GempakGridParameterTable.addParameters(
"resources/nj22/tables/gempak/ncepgrib2.tbl");
} catch (Exception e) {
System.out.println("unable to init tables");
}
}
/**
* Extend the list of grid
* @param b true to reread the grid on a sync
*/
public static void setExtendIndex(boolean b) {
extendIndex = b;
}
}