ucar.nc2.ft.fmrc
Class GridDatasetInv

java.lang.Object
  extended by ucar.nc2.ft.fmrc.GridDatasetInv

public class GridDatasetInv
extends Object

The data inventory of one GridDataset. Track grids, time, vert, ens coordinates. Grids are grouped by the time coordinated that they use. Provides serialization to/from XML. Uses dense time, vert coordinates - just the ones that are in the file. This replaces the older ucar.nc2.dt.fmrc.ForecastModelRunInventory, gets rid of the definition files. Not sure if the vert coords will ever be different across the time coords. Should be immutable, once the file is finished writing. TODO: staggered grids, other dimensions TODO: this assumes a single run date !!

Since:
Jan 11, 2010
Author:
caron

Nested Class Summary
 class GridDatasetInv.Grid
          A Grid variable has a name, timeCoord and optionally a Vertical and Ensemble Coordinate
 
Constructor Summary
GridDatasetInv(GridDataset gds, Date runDate)
           
 
Method Summary
 GridDatasetInv.Grid findGrid(String name)
           
 long getLastModified()
           
 String getLocation()
           
 Date getRunDate()
          Get the date of the ForecastModelRun
 String getRunDateString()
          Get string representation of the date of the ForecastModelRun
 List<TimeCoord> getTimeCoords()
          Get a list of unique TimeCoords, which contain the list of variables that all use that TimeCoord.
 List<VertCoord> getVertCoords()
          Get a list of unique VertCoords.
static void main(String[] args)
           
static GridDatasetInv open(CollectionManager cm, MFile mfile, org.jdom.Element ncml)
           
 String toString()
           
 String writeXML(Date lastModified)
          Write the XML representation to a String.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

GridDatasetInv

public GridDatasetInv(GridDataset gds,
                      Date runDate)
Method Detail

open

public static GridDatasetInv open(CollectionManager cm,
                                  MFile mfile,
                                  org.jdom.Element ncml)
                           throws IOException
Throws:
IOException

toString

public String toString()
Overrides:
toString in class Object

getLocation

public String getLocation()

getLastModified

public long getLastModified()

getRunDate

public Date getRunDate()
Get the date of the ForecastModelRun

Returns:
the date of the ForecastModelRun

getRunDateString

public String getRunDateString()
Get string representation of the date of the ForecastModelRun

Returns:
string representation of the date of the ForecastModelRun

getTimeCoords

public List<TimeCoord> getTimeCoords()
Get a list of unique TimeCoords, which contain the list of variables that all use that TimeCoord.

Returns:
list of TimeCoord

getVertCoords

public List<VertCoord> getVertCoords()
Get a list of unique VertCoords.

Returns:
list of VertCoord

findGrid

public GridDatasetInv.Grid findGrid(String name)

writeXML

public String writeXML(Date lastModified)
Write the XML representation to a String.

Returns:
the XML representation to a String.

main

public static void main(String[] args)


Copyright © 1999-2011 UCAR/Unidata. All Rights Reserved.