GridDataset (NetCDF-Java 2.2 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

ucar.nc2.dt.grid
Class GridDataset

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

All Implemented Interfaces:: GridDataset, TypedDataset

public class GridDataset
extends java.lang.Object
implements GridDataset
extends java.lang.Object
implements GridDataset

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: 48 $ $Date: 2006-07-12 16:15:40Z $
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().
`Attribute`	`findGlobalAttributeIgnoreCase(java.lang.String name)` Return the global attribute with the given name, ingnoring case.
`GeoGrid`	`findGridByName(java.lang.String name)` find the named GeoGrid.
`GridDatatype`	`findGridDatatype(java.lang.String name)` find the named GridDatatype.
`LatLonRect`	`getBoundingBox()` The boundingBox for the entire dataset.
`VariableSimpleIF`	`getDataVariable(java.lang.String shortName)` Get the named data Variable.
`java.util.List`	`getDataVariables()` The data Variables available in this dataset.
`java.lang.String`	`getDescription()` Text information about this dataset.
`java.lang.String`	`getDetailInfo()` Get Details about the dataset.
`java.util.Date`	`getEndDate()` End date for the entire dataset.
`java.util.List`	`getGlobalAttributes()` List of global attributes.
`java.util.List`	`getGrids()` get the list of GeoGrid objects contained in this dataset.
`java.util.List`	`getGridsets()` Return GridDatatype objects grouped by GridCoordSys.
`java.lang.String`	`getInfo()` Show Grids and coordinate systems.
`java.lang.String`	`getLocationURI()` The URI location of the dataset
`java.lang.String`	`getName()` the name of the dataset
`NetcdfDataset`	`getNetcdfDataset()` the underlying NetcdfDataset
`NetcdfFile`	`getNetcdfFile()` Return underlying NetcdfFile, or null if none.
`java.lang.StringBuffer`	`getParseInfo()`
`java.util.Date`	`getStartDate()` Start date for the entire dataset.
`java.lang.String`	`getTitle()` Title of the dataset.
`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