ucar.nc2
Class FileWriter

java.lang.Object
  ucar.nc2.FileWriter

public class FileWriter
extends java.lang.Object

Copy a NetcdfFile to a Netcdf-3 local file. This allows you, for example, to create a "view" of another NetcdfFile using NcML, and/or to write a remote or OpenDAP file into a local netcdf file. All metadata and data is copied out of the NetcdfFile and into the NetcdfFileWritable.

The fileIn may be an NcML file which has a referenced dataset in the location URL, the underlying data (modified by the NcML) is written to the new file. If the NcML does not have a referenced dataset, then the new file is filled with fill values, like ncgen.

Use the static methods writeToFile() to copy an entire file. Create a FileWriter object to control exactly what gets written to the file.

Author:

caron, Steve Ansari

See Also:

NetcdfFile

Nested Class Summary

static class	FileWriter.ChunkingIndex An index that computes chunk shapes.
static class	FileWriter.FileWriterProgressEvent
static interface	FileWriter.FileWriterProgressListener

Constructor Summary

FileWriter(java.lang.String fileOutName, boolean fill)
For writing parts of a NetcdfFile to a new Netcdf-3 local file.

Method Summary

static double	copyVarData(NetcdfFileWriteable ncfile, java.util.List<Variable> varlist, Structure recordVar, java.util.List<FileWriter.FileWriterProgressListener> progressListeners) Write data from varList into new file.
static double	copyVarData(NetcdfFileWriteable ncfile, java.util.List<Variable> varlist, Structure recordVar, long delay) Deprecated.
void	finish() Call this when all attributes, dimensions, and variables have been added.
NetcdfFileWriteable	getNetcdf() Get underlying NetcdfFileWriteable
static void	main(java.lang.String[] arg) Main program.
static void	setDebugFlags(DebugFlags debugFlags) Set debugging flags
void	setRecordVariable(Structure recordVar) Read record data from here (when finish is called).
void	writeAttribute(java.lang.String varName, Attribute att) Write a Variable attribute to the file.
Dimension	writeDimension(Dimension dim) Add a Dimension to the file
void	writeGlobalAttribute(Attribute att) Write a global attribute to the file.
static NetcdfFile	writeToFile(NetcdfFile fileIn, java.lang.String fileOutName) Copy a NetcdfFile to a physical file, using Netcdf-3 file format.
static NetcdfFile	writeToFile(NetcdfFile fileIn, java.lang.String fileOutName, boolean fill) Copy a NetcdfFile to a physical file, using Netcdf-3 file format.
static NetcdfFile	writeToFile(NetcdfFile fileIn, java.lang.String fileOutName, boolean fill, boolean isLargeFile) Copy a NetcdfFile to a physical file, using Netcdf-3 file format.
static NetcdfFile	writeToFile(NetcdfFile fileIn, java.lang.String fileOutName, boolean fill, boolean isLargeFile, java.util.List<FileWriter.FileWriterProgressListener> progressListeners) Copy a NetcdfFile to a physical file, using Netcdf-3 file format.
static NetcdfFile	writeToFile(NetcdfFile fileIn, java.lang.String fileOutName, boolean fill, int delay) Deprecated.
static NetcdfFile	writeToFile(NetcdfFile fileIn, java.lang.String fileOutName, boolean fill, int delay, boolean isLargeFile) Deprecated.
void	writeVariable(Variable oldVar) Add a Variable to the file.
void	writeVariables(java.util.List<Variable> varList) Add a list of Variables to the file.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileWriter

public FileWriter(java.lang.String fileOutName,
                  boolean fill)
           throws java.io.IOException

For writing parts of a NetcdfFile to a new Netcdf-3 local file. To copy all the contents, the static method FileWriter.writeToFile() is preferred. These are mostly convenience methods on top of NetcdfFileWriteable.

Parameters:

fileOutName - file name to write to.

fill - use fill mode or not

Throws:

java.io.IOException

Method Detail

setDebugFlags

public static void setDebugFlags(DebugFlags debugFlags)

Set debugging flags

Parameters:

debugFlags - debug flags

writeToFile

public static NetcdfFile writeToFile(NetcdfFile fileIn,
                                     java.lang.String fileOutName)
                              throws java.io.IOException

Copy a NetcdfFile to a physical file, using Netcdf-3 file format. Cannot do groups, etc, until we get a Netcdf-4 file format.

Parameters:

fileIn - write from this NetcdfFile

fileOutName - write to this local file

Returns:

NetcdfFile that was written to. It remains open for reading or writing.

Throws:

java.io.IOException - on read or write error

writeToFile

public static NetcdfFile writeToFile(NetcdfFile fileIn,
                                     java.lang.String fileOutName,
                                     boolean fill)
                              throws java.io.IOException

Copy a NetcdfFile to a physical file, using Netcdf-3 file format. Cannot do groups, etc, until we get a Netcdf-4 file format.

Parameters:

fileIn - write from this NetcdfFile

fileOutName - write to this local file

fill - use fill mode

Returns:

NetcdfFile that was written to. It remains open for reading or writing.

Throws:

java.io.IOException - on read or write error

writeToFile

public static NetcdfFile writeToFile(NetcdfFile fileIn,
                                     java.lang.String fileOutName,
                                     boolean fill,
                                     boolean isLargeFile)
                              throws java.io.IOException

Copy a NetcdfFile to a physical file, using Netcdf-3 file format. Cannot do groups, etc, until we get a Netcdf-4 file format.

Parameters:

fileIn - write from this NetcdfFile

fileOutName - write to this local file

Returns:

NetcdfFile that was written to. It remains open for reading or writing.

Throws:

java.io.IOException - on read or write error

writeToFile

public static NetcdfFile writeToFile(NetcdfFile fileIn,
                                     java.lang.String fileOutName,
                                     boolean fill,
                                     boolean isLargeFile,
                                     java.util.List<FileWriter.FileWriterProgressListener> progressListeners)
                              throws java.io.IOException

Copy a NetcdfFile to a physical file, using Netcdf-3 file format.

Parameters:

fileIn - write from this NetcdfFile

fileOutName - write to this local file

fill - use fill mode

isLargeFile - if true, make large file format (> 2Gb offsets)

progressListeners - List of progress listeners, use null or empty list if there are none.

Returns:

NetcdfFile that was written. It remains open for reading or writing.

Throws:

java.io.IOException - on read or write error

copyVarData

public static double copyVarData(NetcdfFileWriteable ncfile,
                                 java.util.List<Variable> varlist,
                                 Structure recordVar,
                                 java.util.List<FileWriter.FileWriterProgressListener> progressListeners)
                          throws java.io.IOException

Write data from varList into new file. Read/Write a maximum of maxSize bytes at a time. When theres a record variable, its much more efficient to use it.

Parameters:

ncfile - write tot this file

varlist - list of varibles from the original file, with data in them

recordVar - the record variable from the original file, or null means dont use record variables

progressListeners - List of progress event listeners

Returns:

total number of bytes written

Throws:

java.io.IOException - if I/O error

getNetcdf

public NetcdfFileWriteable getNetcdf()

Get underlying NetcdfFileWriteable

Returns:

underlying NetcdfFileWriteable

writeGlobalAttribute

public void writeGlobalAttribute(Attribute att)

Write a global attribute to the file.

Parameters:

att - take attribute name, value, from here

writeAttribute

public void writeAttribute(java.lang.String varName,
                           Attribute att)

Write a Variable attribute to the file.

Parameters:

varName - name of variable to attach attribute to

att - take attribute name, value, from here

writeDimension

public Dimension writeDimension(Dimension dim)

Add a Dimension to the file

Parameters:

dim - copy this dimension

Returns:

the new Dimension

writeVariable

public void writeVariable(Variable oldVar)

Add a Variable to the file. The data is copied when finish() is called. The variable's Dimensions are added for you, if not already been added.

Parameters:

oldVar - copy this Variable to new file.

writeVariables

public void writeVariables(java.util.List<Variable> varList)

Add a list of Variables to the file. The data is copied when finish() is called. The Variables' Dimensions are added for you, if not already been added.

Parameters:

varList - list of Variable

setRecordVariable

public void setRecordVariable(Structure recordVar)

Read record data from here (when finish is called). Typically much more efficient. LOOK: Not sure if this allows subsetting, use with caution!!

Parameters:

recordVar - the record Variable.

finish

public void finish()
            throws java.io.IOException

Call this when all attributes, dimensions, and variables have been added. The data from all Variables will be written to the file. You cannot add any other attributes, dimensions, or variables after this call.

Throws:

java.io.IOException - on read or write error

copyVarData

public static double copyVarData(NetcdfFileWriteable ncfile,
                                 java.util.List<Variable> varlist,
                                 Structure recordVar,
                                 long delay)
                          throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

writeToFile

public static NetcdfFile writeToFile(NetcdfFile fileIn,
                                     java.lang.String fileOutName,
                                     boolean fill,
                                     int delay)
                              throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

writeToFile

public static NetcdfFile writeToFile(NetcdfFile fileIn,
                                     java.lang.String fileOutName,
                                     boolean fill,
                                     int delay,
                                     boolean isLargeFile)
                              throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

main

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

Main program.

ucar.nc2.FileWriter -in fileIn -out fileOut [-delay millisecs].

where:

• fileIn : path of any CDM readable file
• fileOut: local pathname where netdf-3 file will be written
• delay: if set and file has record dimension, delay between writing each record, for testing files that are growing

  Parameters:

  arg - -in fileIn -out fileOut

  Throws:

  java.io.IOException - on read or write error