ucar.nc2.ft.fmrc

Class GridDatasetInv

java.lang.Object

ucar.nc2.ft.fmrc.GridDatasetInv

public class GridDatasetInv
extends java.lang.Object

The data inventory of one GridDataset. Track grids, time, vert, ens coordinates. Grids are grouped by the time coordinated that they use. Uses dense time, vert coordinates - just the ones that are in the file. Note: Not sure if the vert coords will ever be different across the time coords. Should be immutable, once the file is finished writing.

Since:

Jan 11, 2010

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	GridDatasetInv.Grid A Grid variable has a name, timeCoord and optionally a Vertical and Ensemble Coordinate

Constructor Summary

Constructors

Constructor and Description
GridDatasetInv(GridDataset gds, CalendarDate runDate)

Method Summary

Modifier and Type	Method and Description
GridDatasetInv.Grid	findGrid(java.lang.String name)
long	getLastModified()
java.lang.String	getLocation()
CalendarDate	getRunDate() Get the date of the ForecastModelRun
java.lang.String	getRunDateString() Get string representation of the date of the ForecastModelRun
java.util.List<TimeCoord>	getTimeCoords() Get a list of unique TimeCoords, which contain the list of variables that all use that TimeCoord.
java.util.List<VertCoord>	getVertCoords() Get a list of unique VertCoords.
boolean	isXmlVersionCompatible() Check if the GribDatasetInv xml format can be fully understood by this code.
static GridDatasetInv	open(MCollection cm, MFile mfile, org.jdom2.Element ncml)
static GridDatasetInv	readXML(byte[] xmlString) Construct a GridDatasetInv from its XML representation
java.lang.String	toString()
java.lang.String	writeCompactXML(java.util.Date lastModified) Write the XML representation to a compact String.
java.lang.String	writeXML(java.util.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,
                      CalendarDate runDate)

Method Detail

open

public static GridDatasetInv open(MCollection cm,
                                  MFile mfile,
                                  org.jdom2.Element ncml)
                           throws java.io.IOException

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

isXmlVersionCompatible

public boolean isXmlVersionCompatible()

Check if the GribDatasetInv xml format can be fully understood by this code.

Returns:

true if version can be fully understood, otherwise false.

getLocation

public java.lang.String getLocation()

getLastModified

public long getLastModified()

getRunDate

public CalendarDate getRunDate()

Get the date of the ForecastModelRun

Returns:

the date of the ForecastModelRun

getRunDateString

public java.lang.String getRunDateString()

Get string representation of the date of the ForecastModelRun

Returns:

string representation of the date of the ForecastModelRun

getTimeCoords

public java.util.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 java.util.List<VertCoord> getVertCoords()

Get a list of unique VertCoords.

Returns:

list of VertCoord

findGrid

public GridDatasetInv.Grid findGrid(java.lang.String name)

writeCompactXML

public java.lang.String writeCompactXML(java.util.Date lastModified)

Write the XML representation to a compact String.

Returns:

the compact XML representation to a String.

writeXML

public java.lang.String writeXML(java.util.Date lastModified)

Write the XML representation to a String.

Returns:

the XML representation to a String.

readXML

public static GridDatasetInv readXML(byte[] xmlString)
                              throws java.io.IOException

Construct a GridDatasetInv from its XML representation

Parameters:

xmlString - the xml string

Returns:

ForecastModelRun

Throws:

java.io.IOException - on io error