ucar.nc2.dataset
Class NetcdfDatasetInfo

java.lang.Object
  extended by ucar.nc2.dataset.NetcdfDatasetInfo

public class NetcdfDatasetInfo
extends java.lang.Object

Helper class for obtaining information about a NetcdfDataset. Creates a "netcdfDatasetInfo" XML document, used by the TDS "Common Data Model Coordinate System Validation".

Author:
john caron

Constructor Summary
NetcdfDatasetInfo(java.lang.String location)
           
 
Method Summary
 void close()
           
 java.lang.String getConventionUsed()
          Get the name of the CoordSysBuilder that parses this file.
 ucar.nc2.dt.grid.GridCoordSys getGridCoordSys(VariableEnhanced ve)
           
 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.
static void main(java.lang.String[] args)
          debug
 org.jdom.Document makeDocument()
          Create an XML document from this info
 java.lang.String writeXML()
          Write the information as an XML document
 void writeXML(java.io.OutputStream os)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

NetcdfDatasetInfo

public NetcdfDatasetInfo(java.lang.String location)
                  throws java.io.IOException
Throws:
java.io.IOException
Method Detail

close

public void close()
           throws java.io.IOException
Throws:
java.io.IOException

getParseInfo

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

Returns:
String containing parsing info

getUserAdvice

public 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.

getConventionUsed

public java.lang.String getConventionUsed()
Get the name of the CoordSysBuilder that parses this file.

Returns:
the name of the CoordSysBuilder that parses this file.

writeXML

public java.lang.String writeXML()
Write the information as an XML document

Returns:
String contining netcdfDatasetInfo XML

getGridCoordSys

public ucar.nc2.dt.grid.GridCoordSys getGridCoordSys(VariableEnhanced ve)

writeXML

public void writeXML(java.io.OutputStream os)
              throws java.io.IOException
Throws:
java.io.IOException

makeDocument

public org.jdom.Document makeDocument()
Create an XML document from this info

Returns:
netcdfDatasetInfo XML document

main

public static void main(java.lang.String[] args)
                 throws java.io.IOException
debug

Throws:
java.io.IOException