ucar.grib.grib1
Class Grib1WriteIndex

java.lang.Object
  ucar.grib.grib1.Grib1WriteIndex

public class Grib1WriteIndex
extends Object

Creates an index for a Grib1 file; optionally makes an in-memory one.

Author:

Robb Kambic

Nested Class Summary

protected class

Grib1WriteIndex.CompareKeyDescend

Constructor Summary

Grib1WriteIndex()

Method Summary

GridIndex	extendGribIndex(File grib, File gbx, String gbxName, RandomAccessFile raf, boolean makeIndex) extend a Grib file index; optionally create an in-memory index.
GridIndex	extendGribIndex(File grib, File gbx, String gribName, String gbxName, boolean makeIndex) extend a Grib file index; optionally create an in-memory index.
boolean	extendGribIndex(String gbxName, RandomAccessFile inputRaf, long rafLastModified, DataOutputStream out) extend a Grib file index; optionally create an in-memory index.
static void	main(String[] args) creates a Grib1 index for given Grib1 file.
void	setCheckPDS(boolean flag)
void	setDebug(boolean flag)
void	setLogPDS(Grib2WriteIndex.pdsLogType flag)
void	setVerbose(boolean flag)
GridIndex	writeGribIndex(File grib, String gbxName, RandomAccessFile raf, boolean makeIndex) extend a Grib file index; optionally create an in-memory index.
GridIndex	writeGribIndex(File grib, String gribName, String gbxName, boolean makeIndex) create a Grib1 file index.
boolean	writeGribIndex(RandomAccessFile inputRaf, long rafLastModified, DataOutputStream out) Write a Grib file index.

Methods inherited from class java.lang.Object

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

Constructor Detail

Grib1WriteIndex

public Grib1WriteIndex()

Method Detail

writeGribIndex

public final GridIndex writeGribIndex(File grib,
                                      String gribName,
                                      String gbxName,
                                      boolean makeIndex)
                               throws IOException

create a Grib1 file index.

Parameters:

grib - as File handle

gribName - gribName

gbxName - gbxName

makeIndex - make an in-memory index if true

Returns:

Index if makeIndex is true, else null

Throws:

IOException - on Grib read

writeGribIndex

public final GridIndex writeGribIndex(File grib,
                                      String gbxName,
                                      RandomAccessFile raf,
                                      boolean makeIndex)
                               throws IOException

extend a Grib file index; optionally create an in-memory index.

Parameters:

grib - Grib file

gbxName - Index name

raf - RandomAccessFile

makeIndex - make an in-memory index if true

Returns:

Index if makeIndex is true, else null

Throws:

IOException - on Grib file read

writeGribIndex

public final boolean writeGribIndex(RandomAccessFile inputRaf,
                                    long rafLastModified,
                                    DataOutputStream out)
                             throws IOException

Write a Grib file index.

Parameters:

inputRaf - GRIB file raf

rafLastModified - long

out - DataOutputStream

Returns:

success boolean.

Throws:

IOException - on Grib file read

extendGribIndex

public final GridIndex extendGribIndex(File grib,
                                       File gbx,
                                       String gribName,
                                       String gbxName,
                                       boolean makeIndex)
                                throws IOException

extend a Grib file index; optionally create an in-memory index.

Parameters:

grib - as a File

gbx - as a File

gribName - as a String

gbxName - as a String

makeIndex - make an in-memory index if true

Returns:

GridIndex if makeIndex is true, else null

Throws:

IOException - on gbx write

extendGribIndex

public final GridIndex extendGribIndex(File grib,
                                       File gbx,
                                       String gbxName,
                                       RandomAccessFile raf,
                                       boolean makeIndex)
                                throws IOException

extend a Grib file index; optionally create an in-memory index.

Parameters:

grib - as a File

gbx - as a File

gbxName - as a String

raf - RandomAccessFile

makeIndex - make an in-memory index if true

Returns:

GridIndex if makeIndex is true, else null

Throws:

IOException - gbx write

extendGribIndex

public final boolean extendGribIndex(String gbxName,
                                     RandomAccessFile inputRaf,
                                     long rafLastModified,
                                     DataOutputStream out)
                              throws IOException

extend a Grib file index; optionally create an in-memory index.

Parameters:

gbxName - a GridIndex is used to extend/create a new GridIndex

inputRaf - GRIB file raf

rafLastModified - of the raf

out - where to write

Returns:

Index if makeIndex is true, else null

Throws:

IOException - on gbx write

setCheckPDS

public void setCheckPDS(boolean flag)

setLogPDS

public void setLogPDS(Grib2WriteIndex.pdsLogType flag)

setDebug

public void setDebug(boolean flag)

setVerbose

public void setVerbose(boolean flag)

main

public static void main(String[] args)
                 throws IOException

creates a Grib1 index for given Grib1 file.

Parameters:

args - 2 if Grib file and index file name given

Throws:

IOException - on raf read