ucar.nc2.dataset
Interface CoordSysBuilderIF

All Known Implementing Classes:

ADASConvention, ATDRadarConvention, AWIPSConvention, AWIPSsatConvention, CF1Convention, COARDSConvention, CoordSysBuilder, CSMConvention, EpicInsitu, GDVConvention, GIEFConvention, IFPSConvention, IridlConvention, M3IOConvention, M3IOVGGridConvention, MADISStation, NUWGConvention, UnidataObsConvention, WRFConvention, ZebraConvention

public interface CoordSysBuilderIF

Implement this interface to add Coordinate Systems to a NetcdfDataset.

Version:

$Revision:51 $ $Date:2006-07-12 17:13:13Z $

Author:

john caron

Method Summary

void	addUserAdvice(java.lang.String advice) Give advice for a user trying to figure out why things arent working
void	augmentDataset(NetcdfDataset ncDataset, CancelTask cancelTask) Make changes to the dataset, like adding new variables, attribuites, etc.
void	buildCoordinateSystems(NetcdfDataset ncDataset) Create the coordinate system objects: coordinate axes, coordinate systems, coordinate transforms.
java.lang.String	getConventionUsed() Get the name of the Convention.
void	setConventionUsed(java.lang.String convName) Pass in the name of the Convention used to locate this CoordSysBuilderIF.

Method Detail

setConventionUsed

void setConventionUsed(java.lang.String convName)

Pass in the name of the Convention used to locate this CoordSysBuilderIF.

Parameters:

convName - the name of the Convention

getConventionUsed

java.lang.String getConventionUsed()

Get the name of the Convention. In the case where the Convention attribute is not set in the file, this name cannot be used to identify the COnvention. The isMine() method is called instead.

augmentDataset

void augmentDataset(NetcdfDataset ncDataset,
                    CancelTask cancelTask)
                    throws java.io.IOException

Make changes to the dataset, like adding new variables, attribuites, etc.

Parameters:

ncDataset - modify this dataset

cancelTask - give user a chance to bail out

Throws:

java.io.IOException

buildCoordinateSystems

void buildCoordinateSystems(NetcdfDataset ncDataset)

Create the coordinate system objects: coordinate axes, coordinate systems, coordinate transforms.

Parameters:

ncDataset - add to this dataset

addUserAdvice

void addUserAdvice(java.lang.String advice)

Give advice for a user trying to figure out why things arent working