ucar.nc2.dataset
Class CoordSysBuilder

java.lang.Object
  extended by ucar.nc2.dataset.CoordSysBuilder
All Implemented Interfaces:
CoordSysBuilderIF
Direct Known Subclasses:
ADASConvention, ATDRadarConvention, AvhrrConvention, AWIPSConvention, AWIPSsatConvention, BUFRConvention, COARDSConvention, DefaultConvention, EpicInsitu, FslWindProfiler, GIEFConvention, IFPSConvention, M3IOConvention, M3IOVGGridConvention, MADISStation, ModisSatellite, NsslRadarMosaicConvention, NUWGConvention, UnidataObsConvention, WRFConvention

public class CoordSysBuilder
extends java.lang.Object
implements CoordSysBuilderIF

Abstract class for implementing Convention-specific parsing of netCDF files.

You can use an NcML file alone (use registerNcML()) if file uses a convention attribute. If not, you must implement a class that implements isMine() to identify your files, and call wrapNcML in the augmentDataset method (see eg ATDRadarConvention class).

Subclasses Info:

 // identify which variables are coordinate axes
 // default: 1) coordinate variables 2) variables with _coordinateAxisType attribute 3) variables listed
 // in a coordinates attribute on another variable.
 findCoordinateAxes( ncDataset);
 

// identify which variables are used to describe coordinate system findCoordinateSystems( ncDataset); // identify which variables are used to describe coordinate transforms findCoordinateTransforms( ncDataset); // turn Variables into CoordinateAxis objects makeCoordinateAxes( ncDataset); // make Coordinate Systems for all Coordinate Systems Variables makeCoordinateSystems( ncDataset);

// Assign explicit CoordinateSystem objects to variables assignExplicitCoordinateSystems( ncDataset); makeCoordinateSystemsImplicit( ncDataset); if (useMaximalCoordSys) makeCoordinateSystemsMaximal( ncDataset);

makeCoordinateTransforms( ncDataset); assignCoordinateTransforms( ncDataset);

Author:
caron

Nested Class Summary
static interface CoordSysBuilder.ConventionNameOk
          Allow plug-ins to determine if it owns a file based on the file's Convention attribute.
 class CoordSysBuilder.VarProcess
          Wrap each variable in the dataset with a VarProcess object.
 
Field Summary
static java.lang.String resourcesDir
           
 
Constructor Summary
CoordSysBuilder()
           
 
Method Summary
static CoordSysBuilderIF addCoordinateSystems(NetcdfDataset ds, CancelTask cancelTask)
           
 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)
          This is where subclasses make changes to the dataset, like adding new variables, attribuites, etc.
 void buildCoordinateSystems(NetcdfDataset ncDataset)
          Heres where the work is to identify coordinate axes and coordinate systems.
static CoordSysBuilderIF factory(NetcdfDataset ds, CancelTask cancelTask)
          Get a CoordSysBuilder whose job it is to add Coordinate information to a NetcdfDataset.
 java.lang.String getConventionUsed()
          Get the name of the Convention.
 java.lang.String getParseInfo()
          Detailed information when the coordinate systems were parsed
static boolean getUseMaximalCoordSys()
          Get whether to make records into Structures.
 java.lang.String getUserAdvice()
          Specific advice to a user about problems with the coordinate information in the file.
static VariableDS makeDummyTransformVariable(NetcdfDataset ds, CoordinateTransform ct)
          Deprecated. use CoordTransBuilder.makeDummyTransformVariable
static void registerConvention(java.lang.String conventionName, java.lang.Class c)
          Register a class that implements a Convention.
static void registerConvention(java.lang.String conventionName, java.lang.Class c, CoordSysBuilder.ConventionNameOk match)
          Register a class that implements a Convention.
static void registerConvention(java.lang.String conventionName, java.lang.String className)
          Register a class that implements a Convention.
static void registerNcML(java.lang.String conventionName, java.lang.String ncmlLocation)
          Register an NcML file that implements a Convention by wrappping the dataset in the NcML.
 void setConventionUsed(java.lang.String convName)
          Pass in the name of the Convention used to locate this CoordSysBuilderIF.
static void setUseMaximalCoordSys(boolean b)
          If true, assign implicit CoordinateSystem objects to variables that dont have one yet.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

resourcesDir

public static final java.lang.String resourcesDir
See Also:
Constant Field Values
Constructor Detail

CoordSysBuilder

public CoordSysBuilder()
Method Detail

registerNcML

public static void registerNcML(java.lang.String conventionName,
                                java.lang.String ncmlLocation)
Register an NcML file that implements a Convention by wrappping the dataset in the NcML. It is then processed by CoordSysBuilder, using the _Coordinate attributes.

Parameters:
conventionName - name of Convention, must be in the "Conventions" global attribute.
ncmlLocation - location of NcML file, may be local file or URL.
See Also:
NcMLReader.wrapNcML(ucar.nc2.dataset.NetcdfDataset, java.lang.String, ucar.nc2.util.CancelTask)

registerConvention

public static void registerConvention(java.lang.String conventionName,
                                      java.lang.Class c)
Register a class that implements a Convention. Will match (ignoring case) the COnvention name.

Parameters:
conventionName - name of Convention. This name will be used to look in the "Conventions" global attribute. Otherwise, you must implement the isMine() static method.
c - implementation of CoordSysBuilderIF that parses those kinds of netcdf files.

registerConvention

public static void registerConvention(java.lang.String conventionName,
                                      java.lang.Class c,
                                      CoordSysBuilder.ConventionNameOk match)
Register a class that implements a Convention.

Parameters:
conventionName - name of Convention. This name will be used to look in the "Conventions" global attribute. Otherwise, you must implement the isMine() static method.
match - pass in your own matcher. if null, equalsIgnoreCase() will be used.
c - implementation of CoordSysBuilderIF that parses those kinds of netcdf files.

registerConvention

public static void registerConvention(java.lang.String conventionName,
                                      java.lang.String className)
                               throws java.lang.ClassNotFoundException
Register a class that implements a Convention.

Parameters:
conventionName - name of Convention. This name will be used to look in the "Conventions" global attribute. Otherwise, you must implement the isMine() static method.
className - name of class that implements CoordSysBuilderIF.
Throws:
java.lang.ClassNotFoundException - if class could not be loaded

setUseMaximalCoordSys

public static void setUseMaximalCoordSys(boolean b)
If true, assign implicit CoordinateSystem objects to variables that dont have one yet. Default value is false.

Parameters:
b - true if if you want to guess at Coordinate Systems
See Also:
makeCoordinateSystemsMaximal(ucar.nc2.dataset.NetcdfDataset)

getUseMaximalCoordSys

public static boolean getUseMaximalCoordSys()
Get whether to make records into Structures.

Returns:
whether to make records into Structures.

factory

public static CoordSysBuilderIF factory(NetcdfDataset ds,
                                        CancelTask cancelTask)
                                 throws java.io.IOException
Get a CoordSysBuilder whose job it is to add Coordinate information to a NetcdfDataset.

Parameters:
ds - the NetcdfDataset to modify
cancelTask - allow user to bail out.
Returns:
the builder used
Throws:
java.io.IOException - on io error
See Also:
NetcdfDataset.enhance(ucar.nc2.dataset.NetcdfDataset, java.util.Set, ucar.nc2.util.CancelTask)

addCoordinateSystems

public static CoordSysBuilderIF addCoordinateSystems(NetcdfDataset ds,
                                                     CancelTask cancelTask)
                                              throws java.io.IOException
Throws:
java.io.IOException

setConventionUsed

public void setConventionUsed(java.lang.String convName)
Description copied from interface: CoordSysBuilderIF
Pass in the name of the Convention used to locate this CoordSysBuilderIF.

Specified by:
setConventionUsed in interface CoordSysBuilderIF
Parameters:
convName - the name of the Convention

getConventionUsed

public java.lang.String getConventionUsed()
Description copied from interface: CoordSysBuilderIF
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.

Specified by:
getConventionUsed in interface CoordSysBuilderIF
Returns:
Convention name

addUserAdvice

public void addUserAdvice(java.lang.String advice)
Description copied from interface: CoordSysBuilderIF
Give advice for a user trying to figure out why things arent working

Specified by:
addUserAdvice in interface CoordSysBuilderIF
Parameters:
advice - add this advice to the User Advice String

getParseInfo

public java.lang.String getParseInfo()
Description copied from interface: CoordSysBuilderIF
Detailed information when the coordinate systems were parsed

Specified by:
getParseInfo in interface CoordSysBuilderIF
Returns:
String containing parsing info

getUserAdvice

public java.lang.String getUserAdvice()
Description copied from interface: CoordSysBuilderIF
Specific advice to a user about problems with the coordinate information in the file.

Specified by:
getUserAdvice in interface CoordSysBuilderIF
Returns:
String containing advice to a user about problems with the coordinate information in the file.

augmentDataset

public void augmentDataset(NetcdfDataset ncDataset,
                           CancelTask cancelTask)
                    throws java.io.IOException
This is where subclasses make changes to the dataset, like adding new variables, attribuites, etc.

Specified by:
augmentDataset in interface CoordSysBuilderIF
Parameters:
ncDataset - modify this dataset
cancelTask - give user a chance to bail out
Throws:
java.io.IOException

buildCoordinateSystems

public void buildCoordinateSystems(NetcdfDataset ncDataset)
Heres where the work is to identify coordinate axes and coordinate systems.

Specified by:
buildCoordinateSystems in interface CoordSysBuilderIF
Parameters:
ncDataset - modify this dataset

makeDummyTransformVariable

public static VariableDS makeDummyTransformVariable(NetcdfDataset ds,
                                                    CoordinateTransform ct)
Deprecated. use CoordTransBuilder.makeDummyTransformVariable