ucar.nc2.dt.fmrc

Class FmrcInventory

java.lang.Object

ucar.nc2.dt.fmrc.FmrcInventory

public class FmrcInventory
extends java.lang.Object

A collection of ForecastModelRun (aka "run"). The Set if {Run, TimeCoord, Grid} are grouped into "run Sequences" {{Run, TimeCoord} X {Grid}} The FmrcDefinition object defines what is to be expected. The TimeMatrixDataset object keeps an inventory for all variables for the ForecastModelRunCollection. The set of possible valid times vs run times is thought of as a 2D time matrix. All this rigamorole is because NCEP grid files are so irregular.

 Data Structures

  List RunTime Date
  List ForecastTime Date
  List Offsets Double

  List VertTimeCoord
    double[] values

  List TimeCoord
    double[] offsetHour

  List RunSeq    // sequence of runs; ie sequence of TimeCoords; ie actual time coord
    List Run run;
      Date runDate
      TimeCoord

    List UberGrid
     String name
     List RunExpected  // corresponds to the runs in the RunSeq, matches to expected inventory
       Run run;                              //  actual time coord
       ForecastModelRun.Grid grid;           //  contains actual vert coord for this Run
       ForecastModelRun.TimeCoord expected;  // expected time coord
       FmrcDefinition.Grid expectedGrid;     // expected grid, vertCoord

 

Author:

caron

Method Summary

Methods

Modifier and Type	Method and Description
static void	doOne(java.lang.String cat, int n)
FmrcDefinition	getDefinition()
java.lang.String	getDefinitionPath()
java.util.List<ForecastModelRunInventory.EnsCoord>	getEnsCoords()
java.lang.String	getName()
java.util.List<ucar.nc2.dt.fmrc.FmrcInventory.RunSeq>	getRunSequences()
java.lang.String	getSuffixFilter()
java.util.List<ForecastModelRunInventory.TimeCoord>	getTimeCoords()
java.util.List<ForecastModelRunInventory.VertCoord>	getVertCoords()
static void	main(java.lang.String[] args)
static void	main2(java.lang.String[] args)
static void	main4(java.lang.String[] args)
static FmrcInventory	makeFromCatalog(DiskCache2 cache, java.lang.String catURL, java.lang.String collectionName, int maxDatasets, int mode)
static FmrcInventory	makeFromCatalog(java.lang.String catURL, java.lang.String collectionName, int maxDatasets, int mode) Create a ForecastModelRun Collection from the datasets in a catalog.
static FmrcInventory	makeFromDirectory(java.lang.String fmrcDefinitionPath, java.lang.String collectionName, DiskCache2 fmr_cache, java.lang.String dirName, java.lang.String suffix, int mode) Create a ForecastModelRun Collection from the files in a directory.
org.jdom.Document	makeMatrixDocument() Create an XML document for the entire collection
org.jdom.Document	makeMatrixDocument(java.lang.String varName) Create an XML document for a variable
java.lang.String	showOffsetHour(java.lang.String varName, java.lang.String offsetHour)
static void	writeDefinitionFromCatalog(java.lang.String catURL, java.lang.String collectionName, int maxDatasets) Create a ForecastModelRun Collection from the datasets in a catalog.
java.lang.String	writeMatrixXML(java.lang.String varName)
void	writeMatrixXML(java.lang.String varName, java.io.OutputStream os)

Methods inherited from class java.lang.Object

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

Method Detail

getName

public java.lang.String getName()

getDefinitionPath

public java.lang.String getDefinitionPath()

getTimeCoords

public java.util.List<ForecastModelRunInventory.TimeCoord> getTimeCoords()

getRunSequences

public java.util.List<ucar.nc2.dt.fmrc.FmrcInventory.RunSeq> getRunSequences()

getEnsCoords

public java.util.List<ForecastModelRunInventory.EnsCoord> getEnsCoords()

getVertCoords

public java.util.List<ForecastModelRunInventory.VertCoord> getVertCoords()

getSuffixFilter

public java.lang.String getSuffixFilter()

getDefinition

public FmrcDefinition getDefinition()

writeMatrixXML

public java.lang.String writeMatrixXML(java.lang.String varName)

writeMatrixXML

public void writeMatrixXML(java.lang.String varName,
                  java.io.OutputStream os)
                    throws java.io.IOException

Throws:

java.io.IOException

makeMatrixDocument

public org.jdom.Document makeMatrixDocument()

Create an XML document for the entire collection

makeMatrixDocument

public org.jdom.Document makeMatrixDocument(java.lang.String varName)

Create an XML document for a variable

showOffsetHour

public java.lang.String showOffsetHour(java.lang.String varName,
                              java.lang.String offsetHour)

makeFromDirectory

public static FmrcInventory makeFromDirectory(java.lang.String fmrcDefinitionPath,
                              java.lang.String collectionName,
                              DiskCache2 fmr_cache,
                              java.lang.String dirName,
                              java.lang.String suffix,
                              int mode)
                                       throws java.lang.Exception

Create a ForecastModelRun Collection from the files in a directory.

Parameters:

fmrcDefinitionPath - put/look for fmrc definition files in this directory, may be null

collectionName - the definition file = "name.fmrcDefinition.xml";

fmr_cache - cache fmr inventory files here, may be null

dirName - scan this directory

suffix - filter on this suffix

mode - one of the ForecastModelRun.OPEN_ modes

Returns:

ForecastModelRunCollection or null if no files exist

Throws:

java.lang.Exception - on bad

main2

public static void main2(java.lang.String[] args)
                  throws java.lang.Exception

Throws:

java.lang.Exception

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

Throws:

java.lang.Exception

doOne

public static void doOne(java.lang.String cat,
         int n)
                  throws java.lang.Exception

Throws:

java.lang.Exception

writeDefinitionFromCatalog

public static void writeDefinitionFromCatalog(java.lang.String catURL,
                              java.lang.String collectionName,
                              int maxDatasets)
                                       throws java.lang.Exception

Create a ForecastModelRun Collection from the datasets in a catalog.

Parameters:

catURL - scan this catalog

Throws:

java.lang.Exception - on bad

makeFromCatalog

public static FmrcInventory makeFromCatalog(java.lang.String catURL,
                            java.lang.String collectionName,
                            int maxDatasets,
                            int mode)
                                     throws java.lang.Exception

Create a ForecastModelRun Collection from the datasets in a catalog.

Parameters:

catURL - scan this catalog

Throws:

java.lang.Exception - on bad

makeFromCatalog

public static FmrcInventory makeFromCatalog(DiskCache2 cache,
                            java.lang.String catURL,
                            java.lang.String collectionName,
                            int maxDatasets,
                            int mode)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

main4

public static void main4(java.lang.String[] args)
                  throws java.lang.Exception

Throws:

java.lang.Exception