ucar.nc2.dataset
Interface CoordSysBuilderIF

All Known Implementing Classes:
ADASConvention, ATDRadarConvention, AvhrrConvention, AWIPSConvention, AWIPSsatConvention, BUFRConvention, CF1Convention, COARDSConvention, CoordSysBuilder, CSMConvention, DefaultConvention, EpicInsitu, FslWindProfiler, GDVConvention, GIEFConvention, IFPSConvention, IridlConvention, M3IOConvention, M3IOVGGridConvention, MADISStation, ModisSatellite, Nimbus, NsslRadarMosaicConvention, NUWGConvention, UnidataObsConvention, WRFConvention, ZebraConvention

public interface CoordSysBuilderIF

Implement this interface to add Coordinate Systems to a NetcdfDataset.

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.
 java.lang.String getParseInfo()
          Detailed information when the coordinate systems were parsed
 java.lang.String getUserAdvice()
          Specific advice to a user about problems with the coordinate information in the file.
 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.

Returns:
Convention name

getParseInfo

java.lang.String getParseInfo()
Detailed information when the coordinate systems were parsed

Returns:
String containing parsing info

getUserAdvice

java.lang.String getUserAdvice()
Specific advice to a user about problems with the coordinate information in the file.

Returns:
String containing advice to a user about problems with the coordinate information in the file.

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 - on error

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

Parameters:
advice - add this advice to the User Advice String