ucar.nc2.write

Class NetcdfFormatWriter

java.lang.Object

ucar.nc2.write.NetcdfFormatWriter

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class NetcdfFormatWriter
extends java.lang.Object
implements java.io.Closeable

Writes Netcdf 3 or 4 formatted files to disk. Note that there is no redefine mode. Once you call build(), you cannot add new metadata, you can only write data.

 NetcdfFormatWriter.Builder writerb = NetcdfFormatWriter.createNewNetcdf3(testFile.getPath());
 writerb.addDimension(Dimension.builder().setName("vdim").setIsUnlimited(true).build());
 writerb.addVariable("v", DataType.BYTE, "vdim");
 try (NetcdfFormatWriter writer = writerb.build()) {
   writer.write("v", dataArray);
 }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NetcdfFormatWriter.Builder

Method Summary

Modifier and Type	Method and Description
void	abort() Abort writing to this file.
int	appendStructureData(Structure s, StructureData sdata)
static NetcdfFormatWriter.Builder	builder() Obtain a Builder to set custom options
long	calcSize()
void	close() close the file.
static NetcdfFileFormat	convertToNetcdfFileFormat(NetcdfFileWriter.Version version)
static NetcdfFileWriter.Version	convertToNetcdfFileWriterVersion(NetcdfFileFormat format)
static NetcdfFormatWriter.Builder	createNewNetcdf3(java.lang.String location) Create a new Netcdf3 file.
static NetcdfFormatWriter.Builder	createNewNetcdf4(NetcdfFileFormat format, java.lang.String location, Nc4Chunking chunker) Create a new Netcdf4 file.
Dimension	findDimension(java.lang.String dimName)
Attribute	findGlobalAttribute(java.lang.String attName)
Variable	findVariable(java.lang.String fullNameEscaped)
void	flush() Flush anything written to disk.
NetcdfFileFormat	getFormat()
NetcdfFile	getOutputFile()
static NetcdfFormatWriter.Builder	openExisting(java.lang.String location) Open an existing Netcdf file for writing data.
void	updateAttribute(Variable v2, Attribute att) Update the value of an existing attribute.
void	write(java.lang.String varName, Array values) Write data to the named variable, origin assumed to be 0.
void	write(java.lang.String varName, int[] origin, Array values) Write data to the named variable.
void	write(Variable v, Array values) Write data to the given variable, origin assumed to be 0.
void	write(Variable v, int[] origin, Array values) Write data to the given variable.
void	writeStringDataToChar(Variable v, Array values) Write String data to a CHAR variable, origin assumed to be 0.
void	writeStringDataToChar(Variable v, int[] origin, Array values) Write String data to a CHAR variable.

Methods inherited from class java.lang.Object

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

Method Detail

openExisting

public static NetcdfFormatWriter.Builder openExisting(java.lang.String location)

Open an existing Netcdf file for writing data. Cannot add new objects, you can only read/write data to existing Variables.

Parameters:

location - name of existing file to open.

Returns:

existing file that can be written to

Throws:

java.io.IOException - on I/O error

createNewNetcdf3

public static NetcdfFormatWriter.Builder createNewNetcdf3(java.lang.String location)

Create a new Netcdf3 file.

Parameters:

location - name of new file to open; if it exists, will overwrite it.

Returns:

new NetcdfFormatWriter

createNewNetcdf4

public static NetcdfFormatWriter.Builder createNewNetcdf4(NetcdfFileFormat format,
                                                          java.lang.String location,
                                                          Nc4Chunking chunker)

Create a new Netcdf4 file.

Parameters:

format - One of the netcdf-4 NetcdfFileFormat.

location - name of new file to open; if it exists, will overwrite it.

chunker - used only for netcdf4, or null for default chunking algorithm

Returns:

new NetcdfFormatWriter

builder

public static NetcdfFormatWriter.Builder builder()

Obtain a Builder to set custom options

convertToNetcdfFileWriterVersion

public static NetcdfFileWriter.Version convertToNetcdfFileWriterVersion(NetcdfFileFormat format)

convertToNetcdfFileFormat

public static NetcdfFileFormat convertToNetcdfFileFormat(NetcdfFileWriter.Version version)

getOutputFile

public NetcdfFile getOutputFile()

getFormat

public NetcdfFileFormat getFormat()

findVariable

@Nullable
public Variable findVariable(java.lang.String fullNameEscaped)

findDimension

@Nullable
public Dimension findDimension(java.lang.String dimName)

findGlobalAttribute

@Nullable
public Attribute findGlobalAttribute(java.lang.String attName)

calcSize

public long calcSize()

write

public void write(Variable v,
                  Array values)
           throws java.io.IOException,
                  InvalidRangeException

Write data to the given variable, origin assumed to be 0.

Parameters:

v - variable to write to

values - write this array; must be same type and rank as Variable

Throws:

java.io.IOException - if I/O error

InvalidRangeException - if values Array has illegal shape

write

public void write(java.lang.String varName,
                  Array values)
           throws java.io.IOException,
                  InvalidRangeException

Write data to the named variable, origin assumed to be 0.

Throws:

java.io.IOException

InvalidRangeException

write

public void write(Variable v,
                  int[] origin,
                  Array values)
           throws java.io.IOException,
                  InvalidRangeException

Write data to the given variable.

Parameters:

v - variable to write to

origin - offset within the variable to start writing.

values - write this array; must be same type and rank as Variable

Throws:

java.io.IOException - if I/O error

InvalidRangeException - if values Array has illegal shape

write

public void write(java.lang.String varName,
                  int[] origin,
                  Array values)
           throws java.io.IOException,
                  InvalidRangeException

Write data to the named variable.

Parameters:

varName - name of variable to write to

origin - offset within the variable to start writing.

values - write this array; must be same type and rank as Variable

Throws:

java.io.IOException - if I/O error

InvalidRangeException - if values Array has illegal shape

writeStringDataToChar

public void writeStringDataToChar(Variable v,
                                  Array values)
                           throws java.io.IOException,
                                  InvalidRangeException

Write String data to a CHAR variable, origin assumed to be 0.

Parameters:

v - variable to write to

values - write this array; must be ArrayObject of String

Throws:

java.io.IOException - if I/O error

InvalidRangeException - if values Array has illegal shape

writeStringDataToChar

public void writeStringDataToChar(Variable v,
                                  int[] origin,
                                  Array values)
                           throws java.io.IOException,
                                  InvalidRangeException

Write String data to a CHAR variable.

Parameters:

v - variable to write to

origin - offset to start writing, ignore the strlen dimension.

values - write this array; must be ArrayObject of String

Throws:

java.io.IOException - if I/O error

InvalidRangeException - if values Array has illegal shape

appendStructureData

public int appendStructureData(Structure s,
                               StructureData sdata)
                        throws java.io.IOException,
                               InvalidRangeException

Throws:

java.io.IOException

InvalidRangeException

updateAttribute

public void updateAttribute(Variable v2,
                            Attribute att)
                     throws java.io.IOException

Update the value of an existing attribute. Attribute is found by name, which must match exactly. You cannot make an attribute longer, or change the number of values. For strings: truncate if longer, zero fill if shorter. Strings are padded to 4 byte boundaries, ok to use padding if it exists. For numerics: must have same number of values. This is really a netcdf-3 writing only. netcdf-4 attributes can be changed without rewriting.

Parameters:

v2 - variable, or null for global attribute

att - replace with this value

Throws:

java.io.IOException - if I/O error

flush

public void flush()
           throws java.io.IOException

Flush anything written to disk.

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

close the file.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

abort

public void abort()
           throws java.io.IOException

Abort writing to this file. The file is closed.

Throws:

java.io.IOException