ucar.nc2

Class FileWriter2

java.lang.Object

ucar.nc2.FileWriter2

public class FileWriter2
extends Object

Utility class for writing a NetcdfFile object to a netcdf-3 or netcdf-4 disk file. Uses NetcdfFileWriter. This handles entire CDM model (groups, etc) if you are writing to netcdf-4

Copy a NetcdfFile to a Netcdf-3 or Netcdf-4 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

Nested Classes

Modifier and Type	Class and Description
static class	FileWriter2.ChunkingIndex An index that computes chunk shapes.
static class	FileWriter2.FileWriterProgressEvent
static interface	FileWriter2.FileWriterProgressListener

Constructor Summary

Constructors

Constructor and Description
FileWriter2(NetcdfFile fileIn, String fileOutName, NetcdfFileWriter.NetcdfVersion version)
FileWriter2(NetcdfFile fileIn, String fileOutName, NetcdfFileWriter.NetcdfVersion version, boolean fill, boolean isLargeFile, int extraHeaderBytes, List<FileWriter2.FileWriterProgressListener> progressListeners) Copy a NetcdfFile to a physical file, using Netcdf-3 or 4 file format.

Method Summary

Methods

Modifier and Type	Method and Description
double	copyVarData(List<Variable> varlist, Structure recordVar) Write data from varList into new file.
static void	main(String[] arg) Main program.
static void	setDebugFlags(DebugFlags debugFlags) Set debugging flags
NetcdfFile	write()

Methods inherited from class java.lang.Object

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

Constructor Detail

FileWriter2

public FileWriter2(NetcdfFile fileIn,
           String fileOutName,
           NetcdfFileWriter.NetcdfVersion version)
            throws IOException

Throws:

IOException

FileWriter2

public FileWriter2(NetcdfFile fileIn,
           String fileOutName,
           NetcdfFileWriter.NetcdfVersion version,
           boolean fill,
           boolean isLargeFile,
           int extraHeaderBytes,
           List<FileWriter2.FileWriterProgressListener> progressListeners)
            throws IOException

Copy a NetcdfFile to a physical file, using Netcdf-3 or 4 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.

Throws:

IOException - on read or write error

Method Detail

setDebugFlags

public static void setDebugFlags(DebugFlags debugFlags)

Set debugging flags

Parameters:

debugFlags - debug flags

write

public NetcdfFile write()
                 throws IOException

Throws:

IOException

copyVarData

public double copyVarData(List<Variable> varlist,
                 Structure recordVar)
                   throws 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:

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

Returns:

total number of bytes written

Throws:

IOException - if I/O error

main

public static void main(String[] arg)
                 throws IOException

Main program.

ucar.nc2.FileWriter -in fileIn -out fileOut.

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 [-netcdf4]

Throws:

IOException - on read or write error