ucar.nc2.iosp

Interface IOServiceProviderWriter

All Superinterfaces:

IOServiceProvider

All Known Implementing Classes:

N3iosp, N3raf, Nc4Iosp

public interface IOServiceProviderWriter
extends IOServiceProvider

This is really just an interface to Netcdf-3 and Netcdf-4 file writing. For now, other parties are discouraged from using this.

Method Summary

Modifier and Type	Method and Description
int	appendStructureData(Structure s, StructureData sdata) Append a structureData along the unlimited dimension
void	create(java.lang.String filename, NetcdfFile ncfile, int extra, long preallocateSize, boolean largeFile) Create new file, populate it from the objects in ncfile.
void	flush() Flush all data buffers to disk.
void	openForWriting(RandomAccessFile raf, NetcdfFile ncfile, CancelTask cancelTask) Open existing file and allow writing.
boolean	rewriteHeader(boolean largeFile) if theres room before data, rewrite header without moving the data.
void	setFill(boolean fill) Set the fill flag.
void	updateAttribute(Variable v2, Attribute att) Update the value of an existing attribute.
void	writeData(Variable v2, Section section, Array values) Write data into a variable.

Methods inherited from interface ucar.nc2.iosp.IOServiceProvider

close, getDetailInfo, getFileTypeDescription, getFileTypeId, getFileTypeVersion, getStructureIterator, isValidFile, open, reacquire, readData, readSection, readToByteChannel, readToOutputStream, release, sendIospMessage, streamToByteChannel, syncExtend, toStringDebug

Method Detail

create

void create(java.lang.String filename,
            NetcdfFile ncfile,
            int extra,
            long preallocateSize,
            boolean largeFile)
     throws java.io.IOException

Create new file, populate it from the objects in ncfile.

Parameters:

filename - name of file to create.

ncfile - get everything but data from here

extra - if > 0, pad header with extra bytes

preallocateSize - if > 0, set length of file to this upon creation - this (usually) pre-allocates contiguous storage.

largeFile - if want large file format

Throws:

java.io.IOException - if I/O error

openForWriting

void openForWriting(RandomAccessFile raf,
                    NetcdfFile ncfile,
                    CancelTask cancelTask)
             throws java.io.IOException

Open existing file and allow writing.

Parameters:

raf - the file to work on.

ncfile - add objects to this empty NetcdfFile

cancelTask - used to monitor user cancellation; may be null.

Throws:

java.io.IOException - if I/O error

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 java.io.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:

java.io.IOException - if I/O error

InvalidRangeException - if invalid section

appendStructureData

int appendStructureData(Structure s,
                        StructureData sdata)
                 throws java.io.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:

java.io.IOException

InvalidRangeException

rewriteHeader

boolean rewriteHeader(boolean largeFile)
               throws java.io.IOException

if theres room before data, rewrite header without moving the data. netcdf3 only

Returns:

true if it worked

Throws:

java.io.IOException

updateAttribute

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.

Parameters:

v2 - variable, or null for global attribute

att - replace with this value

Throws:

java.io.IOException - if I/O error

flush

void flush()
    throws java.io.IOException

Flush all data buffers to disk.

Throws:

java.io.IOException - if I/O error