ucar.nc2

Class FileWriter2

java.lang.Object

ucar.nc2.FileWriter2

public class FileWriter2
extends Object

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

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 a NetcdfFileWriter object for a lower level API.

Author:

caron

See Also:

CFGridWriter2, CFPointWriter

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
FileWriter2(NetcdfFile fileIn, String fileOutName, NetcdfFileWriter.Version version, Nc4Chunking chunker) Use this constructor to copy entire file.
FileWriter2(NetcdfFileWriter fileWriter) Use this constructor to copy specific variables to new file.

Method Summary

Methods

Modifier and Type	Method and Description
Variable	addVariable(Variable oldVar) Specify which variable will get written
double	copyVarData(List<Variable> oldVars, Structure recordVar, CancelTask cancel) Write data from varList into new file.
NetcdfFileWriter	getNetcdfFileWriter()
static void	main(String[] arg) Better to use ucar.nc.dataset.NetcdfDataset main program instead.
static void	setDebugFlags(DebugFlags debugFlags) Set debugging flags
void	setN3StructureStrategy(FileWriter2.N3StructureStrategy n3StructureStrategy)
NetcdfFile	write()
NetcdfFile	write(CancelTask cancel) Write the input file to the output file.

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.Version version,
           Nc4Chunking chunker)
            throws IOException

Use this constructor to copy entire file. Use this.write() to do actual copy.

Parameters:

fileIn - copy this file

fileOutName - to this output file

version - output file version

chunker - chunking strategy (netcdf4 only)

Throws:

IOException - on read/write error

FileWriter2

public FileWriter2(NetcdfFileWriter fileWriter)
            throws IOException

Use this constructor to copy specific variables to new file. Only supports classic mode

Use addVariable() to load in variables, then this.write().

Parameters:

fileWriter - this encapsolates new file.

Throws:

IOException - on read/write error

Method Detail

setDebugFlags

public static void setDebugFlags(DebugFlags debugFlags)

Set debugging flags

Parameters:

debugFlags - debug flags

setN3StructureStrategy

public void setN3StructureStrategy(FileWriter2.N3StructureStrategy n3StructureStrategy)

getNetcdfFileWriter

public NetcdfFileWriter getNetcdfFileWriter()

addVariable

public Variable addVariable(Variable oldVar)

Specify which variable will get written

Parameters:

oldVar - add this variable, and all parent groups

Returns:

new Variable.

write

public NetcdfFile write()
                 throws IOException

Throws:

IOException

write

public NetcdfFile write(CancelTask cancel)
                 throws IOException

Write the input file to the output file.

Parameters:

cancel - allow user to cancel; may be null.

Returns:

the open output file.

Throws:

IOException

copyVarData

public double copyVarData(List<Variable> oldVars,
                 Structure recordVar,
                 CancelTask cancel)
                   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:

oldVars - list of variables from the original file, with data in them

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

cancel - allow user to cancel, may be null.

Returns:

total number of bytes written

Throws:

IOException - if I/O error

main

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

Better to use ucar.nc.dataset.NetcdfDataset main program instead.

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

Parameters:

arg - -in fileIn -out fileOut [-netcdf4]

Throws:

IOException - on read or write error