ucar.nc2.internal.iosp

Interface IospFileUpdater

All Superinterfaces:

AutoCloseable, Closeable

public interface IospFileUpdater
extends Closeable

This is an interface to Netcdf-3 and Netcdf-4 file updating.

Method Summary

Modifier and Type	Method and Description
int	appendStructureData(Structure s, StructureData sdata) Append a structureData along the unlimited dimension
NetcdfFile	getOutputFile() Get the output file being written to.
void	openForWriting(String location, Group.Builder rootGroup, CancelTask cancelTask) Open existing file populate rootGroup.
void	setFill(boolean fill) Set the fill flag.
void	updateAttribute(Group g, Attribute att)
void	updateAttribute(Variable v2, Attribute att) TODO review this Update the value of an existing attribute.
void	writeData(Variable v2, Section section, Array values) Write data into a variable.

Methods inherited from interface java.io.Closeable

close

Method Detail

openForWriting

void openForWriting(String location,
                    Group.Builder rootGroup,
                    CancelTask cancelTask)
             throws IOException

Open existing file populate rootGroup. Netcdf-3 writing is restricted to writing data into existing variables, including extending the record dimension. Netcdf-4 writing is general, can change and delete metadata etc.

Parameters:

location - the existing file

rootGroup - has the metadata of the file to be created. It is then modified, do not reuse.

Throws:

IOException - if I/O error

getOutputFile

NetcdfFile getOutputFile()

Get the output file being written to.

setFill

void setFill(boolean fill)

Set the fill flag. For new files, set in the create() method. This method is to set fill for existing files that you want to write. If true, the data is first written with fill values. Set to false if you expect to write all data values, set to true if you want to be sure that unwritten data values have the fill value in it.

Parameters:

fill - set fill mode true or false

writeData

void writeData(Variable v2,
               Section section,
               Array values)
        throws IOException,
               InvalidRangeException

Write data into a variable.

Parameters:

v2 - variable to write; must already exist.

section - the section of data to write. There must be a Range for each Dimension in the variable, in order. The shape must match the shape of values. The origin and stride indicate where the data is placed into the stored Variable array.

values - data to write. The shape must match section.getShape().

Throws:

IOException - if I/O error

InvalidRangeException - if invalid section

appendStructureData

int appendStructureData(Structure s,
                        StructureData sdata)
                 throws IOException,
                        InvalidRangeException

Append a structureData along the unlimited dimension

Parameters:

s - belongs to this structure

sdata - the stuctureData to append

Returns:

the recnum where it was written

Throws:

IOException

InvalidRangeException

updateAttribute

void updateAttribute(Variable v2,
                     Attribute att)
              throws IOException

TODO review this 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.

Parameters:

v2 - variable, or null for global attribute

att - replace with this value

Throws:

IOException

updateAttribute

void updateAttribute(Group g,
                     Attribute att)
              throws IOException

Throws:

IOException