ucar.nc2

Class NCdumpW

java.lang.Object

ucar.nc2.NCdumpW

public class NCdumpW
extends java.lang.Object

Print contents of an existing netCDF file, using a Writer.

A difference with ncdump is that the nesting of multidimensional array data is represented by nested brackets, so the output is not legal CDL that can be used as input for ncgen. Also, the default is header only (-h)

Since:

Nov 4, 2007

Author:

caron

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NCdumpW.WantValues

Constructor Summary

Constructors

Constructor and Description
NCdumpW()

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	encodeString(java.lang.String s) Replace special characters '\t', '\n', '\f', '\r'.
static void	main(java.lang.String[] args) Main program.
static boolean	print(NetcdfFile nc, java.lang.String command, java.io.Writer out, CancelTask ct) ncdump, parsing command string, file already open.
static boolean	print(NetcdfFile nc, java.io.Writer out, boolean showAll, boolean showCoords, boolean ncml, boolean strict, java.lang.String varNames, CancelTask ct) ncdump-like print of netcdf file.
static boolean	print(NetcdfFile nc, java.io.Writer out, NCdumpW.WantValues showValues, boolean ncml, boolean strict, java.lang.String varNames, CancelTask ct) ncdump-like print of netcdf file.
static boolean	print(java.lang.String command, java.io.Writer out) NCdump that parses a command string, using default options.
static boolean	print(java.lang.String filename, java.io.Writer out, boolean showAll, boolean showCoords, boolean ncml, boolean strict, java.lang.String varNames, CancelTask ct) ncdump-like print of netcdf file.
static boolean	print(java.lang.String command, java.io.Writer out, CancelTask ct) ncdump that parses a command string.
static void	printArray(Array ma)
static void	printArray(Array ma, java.io.PrintWriter out) Print array as undifferentiated sequence of values.
static java.lang.String	printArray(Array array, java.lang.String name, CancelTask ct)
static void	printArray(Array array, java.lang.String name, java.io.PrintWriter out, CancelTask ct) Print the data array.
static boolean	printHeader(java.lang.String fileName, java.io.Writer out) Print netcdf "header only" in CDL.
static boolean	printNcML(java.lang.String fileName, java.io.Writer out) print NcML representation of this netcdf file, showing coordinate variable data.
static void	printStructureData(java.io.PrintWriter out, StructureData sdata) Print contents of a StructureData.
static java.lang.String	printVariableData(VariableIF v, CancelTask ct) Print all the data of the given Variable.
static java.lang.String	printVariableDataSection(Variable v, java.lang.String sectionSpec, CancelTask ct) Print a section of the data of the given Variable.
static java.lang.String	toString(Array ma)
static void	writeNcML(NetcdfFile ncfile, java.util.Formatter out, NCdumpW.WantValues showValues, java.lang.String uri)
static void	writeNcML(NetcdfFile ncfile, java.io.Writer os, boolean showCoords, java.lang.String uri) Write the NcML representation for a file.
static void	writeNcML(NetcdfFile ncfile, java.io.Writer os, NCdumpW.WantValues showValues, java.lang.String uri)
static void	writeNcMLVariable(Variable v, java.util.Formatter out)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NCdumpW

public NCdumpW()

Method Detail

printHeader

public static boolean printHeader(java.lang.String fileName,
                  java.io.Writer out)
                           throws java.io.IOException

Print netcdf "header only" in CDL.

Parameters:

fileName - open this file

out - print to this Writer

Returns:

true if successful

Throws:

java.io.IOException - on write error

printNcML

public static boolean printNcML(java.lang.String fileName,
                java.io.Writer out)
                         throws java.io.IOException

print NcML representation of this netcdf file, showing coordinate variable data.

Parameters:

fileName - open this file

out - print to this Writer

Returns:

true if successful

Throws:

java.io.IOException - on write error

print

public static boolean print(java.lang.String command,
            java.io.Writer out)
                     throws java.io.IOException

NCdump that parses a command string, using default options. Usage:

NCdump filename [-ncml] [-c | -vall] [-v varName;...]

Parameters:

command - command string

out - send output here

Returns:

true if successful

Throws:

java.io.IOException - on write error

print

public static boolean print(java.lang.String command,
            java.io.Writer out,
            CancelTask ct)
                     throws java.io.IOException

ncdump that parses a command string. Usage:

NCdump filename [-ncml] [-c | -vall] [-v varName;...]

Parameters:

command - command string

out - send output here

ct - allow task to be cancelled; may be null.

Returns:

true if successful

Throws:

java.io.IOException - on write error

print

public static boolean print(NetcdfFile nc,
            java.lang.String command,
            java.io.Writer out,
            CancelTask ct)
                     throws java.io.IOException

ncdump, parsing command string, file already open.

Parameters:

nc - apply command to this file

command - : command string

out - send output here

ct - allow task to be cancelled; may be null.

Returns:

true if successful

Throws:

java.io.IOException - on write error

print

public static boolean print(java.lang.String filename,
            java.io.Writer out,
            boolean showAll,
            boolean showCoords,
            boolean ncml,
            boolean strict,
            java.lang.String varNames,
            CancelTask ct)
                     throws java.io.IOException

ncdump-like print of netcdf file.

Parameters:

filename - NetcdfFile to open

out - print to this stream

showAll - dump all variable data

showCoords - only print header and coordinate variables

ncml - print NcML representation (other arguments are ignored)

strict - print strict CDL representation

varNames - semicolon delimited list of variables whose data should be printed

ct - allow task to be cancelled; may be null.

Returns:

true if successful

Throws:

java.io.IOException - on write error

print

public static boolean print(NetcdfFile nc,
            java.io.Writer out,
            boolean showAll,
            boolean showCoords,
            boolean ncml,
            boolean strict,
            java.lang.String varNames,
            CancelTask ct)
                     throws java.io.IOException

ncdump-like print of netcdf file.

Parameters:

nc - already opened NetcdfFile

out - print to this stream

showAll - dump all variable data

showCoords - only print header and coordinate variables

ncml - print NcML representation (other arguments are ignored)

strict - print strict CDL representation

varNames - semicolon delimited list of variables whose data should be printed. May have Fortran90 like selector: eg varName(1:2,*,2)

ct - allow task to be cancelled; may be null.

Returns:

true if successful

Throws:

java.io.IOException - on write error

print

public static boolean print(NetcdfFile nc,
            java.io.Writer out,
            NCdumpW.WantValues showValues,
            boolean ncml,
            boolean strict,
            java.lang.String varNames,
            CancelTask ct)
                     throws java.io.IOException

ncdump-like print of netcdf file.

Parameters:

nc - already opened NetcdfFile

out - print to this stream

showValues - do you want the variable values printed?

ncml - print NcML representation (other arguments are ignored)

strict - print strict CDL representation

varNames - semicolon delimited list of variables whose data should be printed. May have Fortran90 like selector: eg varName(1:2,*,2)

ct - allow task to be cancelled; may be null.

Returns:

true if successful

Throws:

java.io.IOException - on write error

printVariableData

public static java.lang.String printVariableData(VariableIF v,
                                 CancelTask ct)
                                          throws java.io.IOException

Print all the data of the given Variable.

Parameters:

v - variable to print

ct - allow task to be cancelled; may be null.

Returns:

String result

Throws:

java.io.IOException - on write error

printVariableDataSection

public static java.lang.String printVariableDataSection(Variable v,
                                        java.lang.String sectionSpec,
                                        CancelTask ct)
                                                 throws java.io.IOException,
                                                        InvalidRangeException

Print a section of the data of the given Variable.

Parameters:

v - variable to print

sectionSpec - string specification

ct - allow task to be cancelled; may be null.

Returns:

String result formatted data ouptut

Throws:

java.io.IOException - on write error

InvalidRangeException - is specified section doesnt match variable shape

printArray

public static void printArray(Array array,
              java.lang.String name,
              java.io.PrintWriter out,
              CancelTask ct)
                       throws java.io.IOException

Print the data array.

Parameters:

array - data to print.

name - title the output.

out - send output here.

ct - allow task to be cancelled; may be null.

Throws:

java.io.IOException - on read error

printArray

public static java.lang.String printArray(Array array,
                          java.lang.String name,
                          CancelTask ct)
                                   throws java.io.IOException

Throws:

java.io.IOException

printStructureData

public static void printStructureData(java.io.PrintWriter out,
                      StructureData sdata)
                               throws java.io.IOException

Print contents of a StructureData.

Parameters:

out - send output here.

sdata - StructureData to print.

Throws:

java.io.IOException - on read error

printArray

public static void printArray(Array ma,
              java.io.PrintWriter out)

Print array as undifferentiated sequence of values.

Parameters:

ma - any Array except ArrayStructure

out - print to here

printArray

public static void printArray(Array ma)

toString

public static java.lang.String toString(Array ma)
                                 throws java.io.IOException

Throws:

java.io.IOException

writeNcML

public static void writeNcML(NetcdfFile ncfile,
             java.io.Writer os,
             boolean showCoords,
             java.lang.String uri)
                      throws java.io.IOException

Write the NcML representation for a file. Note that ucar.nc2.dataset.NcMLWriter has a JDOM implementation, for complete NcML. This method implements only the "core" NcML for plain ole netcdf files.

Parameters:

ncfile - write NcML for this file

os - write to this Writer. Must be using UTF-8 encoding (where applicable)

showCoords - show coordinate variable values.

uri - use this for the uri attribute; if null use getLocation(). // ??

Throws:

java.io.IOException - on write error

writeNcML

public static void writeNcML(NetcdfFile ncfile,
             java.io.Writer os,
             NCdumpW.WantValues showValues,
             java.lang.String uri)
                      throws java.io.IOException

Throws:

java.io.IOException

writeNcML

public static void writeNcML(NetcdfFile ncfile,
             java.util.Formatter out,
             NCdumpW.WantValues showValues,
             java.lang.String uri)
                      throws java.io.IOException

Throws:

java.io.IOException

writeNcMLVariable

public static void writeNcMLVariable(Variable v,
                     java.util.Formatter out)
                              throws java.io.IOException

Throws:

java.io.IOException

encodeString

public static java.lang.String encodeString(java.lang.String s)

Replace special characters '\t', '\n', '\f', '\r'.

Parameters:

s - string to quote

Returns:

equivilent string replacing special chars

main

public static void main(java.lang.String[] args)

Main program.

ucar.nc2.NCdump filename [-cdl | -ncml] [-c | -vall] [-v varName1;varName2;..] [-v varName(0:1,:,12)]

where:

• filename : path of any CDM readable file
• cdl or ncml: output format is CDL or NcML
• -vall : dump all variable data
• -c : dump coordinate variable data
• -v varName1;varName2; : dump specified variable(s)
• -v varName(0:1,:,12) : dump specified variable section

Default is to dump the header info only.

Parameters:

args - arguments