ucar.nc2.grib.collection

Class GribCdmIndex

java.lang.Object

ucar.nc2.grib.collection.GribCdmIndex

All Implemented Interfaces:

IndexReader

public class GribCdmIndex
extends Object
implements IndexReader

Utilities for creating GRIB ncx2 files, both collections and partitions

Since:

12/5/13

Author:

John

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GribCdmIndex.GribCollectionType

Nested classes/interfaces inherited from interface thredds.inventory.partition.IndexReader

IndexReader.AddChildCallback

Constructor Summary

Constructors

Constructor and Description
GribCdmIndex(org.slf4j.Logger logger)

Method Summary

Methods

Modifier and Type	Method and Description
static GribCdmIndex.GribCollectionType	getType(RandomAccessFile raf) Find out what kind of index this is
boolean	isPartition(Path indexFile)
static void	main(String[] args)
static GribCollection	makeGribCollectionFromRaf(RandomAccessFile raf, FeatureCollectionConfig config, CollectionUpdateType updateType, org.slf4j.Logger logger)
static boolean	makeIndex(FeatureCollectionConfig config, Formatter errlog, Path topPath)
static boolean	moveCdmIndex(String indexFilename, org.slf4j.Logger logger)
static GribCollection	openCdmIndex(String indexFilename, FeatureCollectionConfig config, boolean dataOnly, org.slf4j.Logger logger)
static GribCollection	openGribCollection(FeatureCollectionConfig config, CollectionUpdateType updateType, org.slf4j.Logger logger) Open GribCollection from config.
static GribCollection	openGribCollectionFromDataFile(boolean isGrib1, MFile mfile, CollectionUpdateType updateType, FeatureCollectionConfig config, Formatter errlog, org.slf4j.Logger logger)
static GribCollection	openGribCollectionFromIndexFile(RandomAccessFile indexRaf, FeatureCollectionConfig config, boolean dataOnly, org.slf4j.Logger logger) Create a grib collection / partition collection from an existing ncx2 file.
static GribCollection	openGribCollectionFromMCollection(boolean isGrib1, MCollection dcm, CollectionUpdateType updateType, Formatter errlog, org.slf4j.Logger logger) Create a GribCollection from an MCollection.
boolean	readChildren(Path indexFile, IndexReader.AddChildCallback callback)
boolean	readMFiles(Path indexFile, List<MFile> result)
static boolean	updateGribCollection(FeatureCollectionConfig config, CollectionUpdateType updateType, org.slf4j.Logger logger) update the collection if needed
static boolean	updateGribCollectionFromMCollection(boolean isGrib1, MCollection dcm, CollectionUpdateType updateType, Formatter errlog, org.slf4j.Logger logger)

Methods inherited from class java.lang.Object

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

Constructor Detail

GribCdmIndex

public GribCdmIndex(org.slf4j.Logger logger)

Method Detail

getType

public static GribCdmIndex.GribCollectionType getType(RandomAccessFile raf)
                                               throws IOException

Find out what kind of index this is

Parameters:

raf - open RAF

Returns:

GribCollectionType

Throws:

IOException - on read error

openCdmIndex

public static GribCollection openCdmIndex(String indexFilename,
                          FeatureCollectionConfig config,
                          boolean dataOnly,
                          org.slf4j.Logger logger)

openGribCollectionFromMCollection

public static GribCollection openGribCollectionFromMCollection(boolean isGrib1,
                                               MCollection dcm,
                                               CollectionUpdateType updateType,
                                               Formatter errlog,
                                               org.slf4j.Logger logger)
                                                        throws IOException

Create a GribCollection from an MCollection. full metadata is read in.

Parameters:

isGrib1 - true if files are grib1, else grib2

dcm - the MCollection : files or other collections

updateType - should index file be used or remade?

Returns:

GribCollection

Throws:

IOException - on io error

updateGribCollectionFromMCollection

public static boolean updateGribCollectionFromMCollection(boolean isGrib1,
                                          MCollection dcm,
                                          CollectionUpdateType updateType,
                                          Formatter errlog,
                                          org.slf4j.Logger logger)
                                                   throws IOException

Throws:

IOException

updateGribCollection

public static boolean updateGribCollection(FeatureCollectionConfig config,
                           CollectionUpdateType updateType,
                           org.slf4j.Logger logger)
                                    throws IOException

update the collection if needed

Returns:

true if the collection was updated

Throws:

IOException

openGribCollection

public static GribCollection openGribCollection(FeatureCollectionConfig config,
                                CollectionUpdateType updateType,
                                org.slf4j.Logger logger)
                                         throws IOException

Open GribCollection from config. dataOnly

Throws:

IOException

makeIndex

public static boolean makeIndex(FeatureCollectionConfig config,
                Formatter errlog,
                Path topPath)
                         throws IOException

Throws:

IOException

moveCdmIndex

public static boolean moveCdmIndex(String indexFilename,
                   org.slf4j.Logger logger)
                            throws IOException

Throws:

IOException

makeGribCollectionFromRaf

public static GribCollection makeGribCollectionFromRaf(RandomAccessFile raf,
                                       FeatureCollectionConfig config,
                                       CollectionUpdateType updateType,
                                       org.slf4j.Logger logger)
                                                throws IOException

Throws:

IOException

openGribCollectionFromDataFile

public static GribCollection openGribCollectionFromDataFile(boolean isGrib1,
                                            MFile mfile,
                                            CollectionUpdateType updateType,
                                            FeatureCollectionConfig config,
                                            Formatter errlog,
                                            org.slf4j.Logger logger)
                                                     throws IOException

Throws:

IOException

openGribCollectionFromIndexFile

public static GribCollection openGribCollectionFromIndexFile(RandomAccessFile indexRaf,
                                             FeatureCollectionConfig config,
                                             boolean dataOnly,
                                             org.slf4j.Logger logger)
                                                      throws IOException

Create a grib collection / partition collection from an existing ncx2 file. PartionCollection.partition.getGribCollection().

Parameters:

indexRaf - the ncx2 file already open

config - special configuration

Returns:

the resulting GribCollection, or null on failure

Throws:

IOException - on io error

readChildren

public boolean readChildren(Path indexFile,
                   IndexReader.AddChildCallback callback)
                     throws IOException

Specified by:

readChildren in interface IndexReader

Throws:

IOException

isPartition

public boolean isPartition(Path indexFile)
                    throws IOException

Specified by:

isPartition in interface IndexReader

Throws:

IOException

readMFiles

public boolean readMFiles(Path indexFile,
                 List<MFile> result)
                   throws IOException

Specified by:

readMFiles in interface IndexReader

Throws:

IOException

main

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

Throws:

IOException