ucar.nc2.dataset.grid
Class GridDataset

java.lang.Object
  ucar.nc2.dataset.grid.GridDataset

public class GridDataset
extends java.lang.Object

Make a NetcdfDataset into a collection of GeoGrids with Georeferencing coordinate systems.

A variable will be made into a GeoGrid if it has a Georeferencing coordinate system, using GridCoordSys.isGridCoordSys(), and it has no extra dimensions, ie GridCoordSys.isComplete( var) is true. If it has multiple Georeferencing coordinate systems, any one that is a product set will be given preference. Example:

    GridDataset gridDs = GridDataset.factory (uriString);
    List grids = gridDs.getGrids();
    for (int i=0; i<grids.size(); i++) {
      GeoGrid grid = (Geogrid) grids.get(i);
    }
   

Version:

$Revision: 1.17 $ $Date: 2006/05/25 20:15:26 $

Author:

caron

Nested Class Summary

class

GridDataset.Gridset This is a set of GeoGrids with the same GeoCoordSys.

Constructor Summary

GridDataset(NetcdfDataset ds)
Create a GridDataset from a NetcdfDataset.

Method Summary

void	close() Close all resources associated with this dataset.
static GridDataset	factory(java.lang.String netcdfFileURI) Deprecated. : use GridDataset.open().
GeoGrid	findGridByName(java.lang.String name) find the named GeoGrid.
java.lang.String	getDetailInfo() Get Details about the dataset.
java.util.List	getGrids() get the list of GeoGrid objects contained in this dataset.
java.util.Collection	getGridSets() Return GeoGrid objects grouped by GridCoordSys.
java.lang.String	getInfo() Show Grids and coordinate systems.
java.lang.String	getName() the name of the dataset
NetcdfDataset	getNetcdfDataset() the underlying NetcdfDataset
java.lang.StringBuffer	getParseInfo()
static void	main(java.lang.String[] arg) testing
static GridDataset	open(java.lang.String netcdfFileURI) Open a netcdf dataset, parse Conventions, find all the geoGrids, return a GridDataset.

Methods inherited from class java.lang.Object

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

Constructor Detail

GridDataset

public GridDataset(NetcdfDataset ds)

Create a GridDataset from a NetcdfDataset.

Parameters:

ds - underlying NetcdfDataset.

Method Detail

open

public static GridDataset open(java.lang.String netcdfFileURI)
                        throws java.io.IOException

Open a netcdf dataset, parse Conventions, find all the geoGrids, return a GridDataset.

Parameters:

netcdfFileURI - netcdf dataset to open. May have a dods:, http: or file: prefix, or just a local filename. If it ends with ".xml", its assumed to be a NetcdfDataset Definition XML file

Returns:

GridDataset

Throws:

java.io.IOException

See Also:

NetcdfFile.open(java.lang.String)

factory

public static GridDataset factory(java.lang.String netcdfFileURI)
                           throws java.io.IOException

Deprecated. : use GridDataset.open().

Open a netcdf dataset, parse Conventions, find all the geoGrids, return a GridDataset.

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Close all resources associated with this dataset.

Throws:

java.io.IOException

getName

public java.lang.String getName()

the name of the dataset

getNetcdfDataset

public NetcdfDataset getNetcdfDataset()

the underlying NetcdfDataset

getGrids

public java.util.List getGrids()

get the list of GeoGrid objects contained in this dataset.

getGridSets

public java.util.Collection getGridSets()

Return GeoGrid objects grouped by GridCoordSys. All GeoGrids in a Gridset have the same GridCoordSys.

Returns:

Collection of type GridDataset.Gridset

findGridByName

public GeoGrid findGridByName(java.lang.String name)

find the named GeoGrid.

getInfo

public java.lang.String getInfo()

Show Grids and coordinate systems.

getParseInfo

public java.lang.StringBuffer getParseInfo()

getDetailInfo

public java.lang.String getDetailInfo()

Get Details about the dataset.

main

public static void main(java.lang.String[] arg)

testing