ucar.nc2.grib

Class GribIndex

java.lang.Object

ucar.nc2.grib.GribIndex

Direct Known Subclasses:

Grib1Index, Grib2Index

public abstract class GribIndex
extends Object

Abstract superclass for Grib1Index and Grib2Index. Handles gbx9 index for grib.

Static methods for creating gbx9 and ncx indices for a single file.

Since:

9/5/11

Author:

John

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	debug
static String	GBX9_IDX

Constructor Summary

Constructors

Constructor and Description
GribIndex()

Method Summary

Methods

Modifier and Type	Method and Description
static CollectionManager.ChangeChecker	getChangeChecker()
abstract int	getNRecords() The number of records in the index.
static GribCollection	makeGribCollectionFromSingleFile(boolean isGrib1, RandomAccessFile dataRaf, FeatureCollectionConfig.GribConfig config, CollectionManager.Force force, org.slf4j.Logger logger) Create a gbx9 and ncx index and a grib collection from a single grib1 or grib2 file.
abstract boolean	makeIndex(String location, RandomAccessFile dataRaf) Make the gbx9 index file.
abstract boolean	readIndex(String location, long dataModified, CollectionManager.Force force) Read the gbx9 index file.
static GribIndex	readOrCreateIndexFromSingleFile(boolean isGrib1, boolean createCollectionIndex, MFile mfile, FeatureCollectionConfig.GribConfig config, CollectionManager.Force force, org.slf4j.Logger logger) Create a gbx9 and ncx index from a single grib1 or grib2 file.

Methods inherited from class java.lang.Object

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

Field Detail

GBX9_IDX

public static final String GBX9_IDX

See Also:

Constant Field Values

debug

public static final boolean debug

See Also:

Constant Field Values

Constructor Detail

GribIndex

public GribIndex()

Method Detail

getChangeChecker

public static CollectionManager.ChangeChecker getChangeChecker()

makeGribCollectionFromSingleFile

public static GribCollection makeGribCollectionFromSingleFile(boolean isGrib1,
                                              RandomAccessFile dataRaf,
                                              FeatureCollectionConfig.GribConfig config,
                                              CollectionManager.Force force,
                                              org.slf4j.Logger logger)
                                                       throws IOException

Create a gbx9 and ncx index and a grib collection from a single grib1 or grib2 file. Use the existing index is it already exists.

Parameters:

isGrib1 - true if grib1

dataRaf - the grib file already open

config - special configuration

force - force writing index

Returns:

the resulting GribCollection

Throws:

IOException - on io error

readOrCreateIndexFromSingleFile

public static GribIndex readOrCreateIndexFromSingleFile(boolean isGrib1,
                                        boolean createCollectionIndex,
                                        MFile mfile,
                                        FeatureCollectionConfig.GribConfig config,
                                        CollectionManager.Force force,
                                        org.slf4j.Logger logger)
                                                 throws IOException

Create a gbx9 and ncx index from a single grib1 or grib2 file. Use the existing index is it already exists.

Parameters:

isGrib1 - true if grib1

createCollectionIndex - true is you also want the ncx file to be created

mfile - the grib file

config - special configuration

force - force writing index

Returns:

the resulting GribIndex

Throws:

IOException - on io error

readIndex

public abstract boolean readIndex(String location,
                long dataModified,
                CollectionManager.Force force)
                           throws IOException

Read the gbx9 index file.

Parameters:

location - location of the data file

dataModified - last modified date of the data file

force - always, test or nocheck

Returns:

true if index was successfully read, false if index must be (re)created

Throws:

IOException - on io error

makeIndex

public abstract boolean makeIndex(String location,
                RandomAccessFile dataRaf)
                           throws IOException

Make the gbx9 index file.

Parameters:

location - location of the data file

dataRaf - already opened data raf; may be null

Returns:

true

Throws:

IOException - on io error

getNRecords

public abstract int getNRecords()

The number of records in the index.

Returns:

The number of records in the index.