ucar.nc2.internal.iosp.netcdf3

Class N3iospWriter

java.lang.Object

ucar.nc2.iosp.AbstractIOServiceProvider

ucar.nc2.internal.iosp.netcdf3.N3iosp

ucar.nc2.internal.iosp.netcdf3.N3iospWriter

All Implemented Interfaces:

Closeable, AutoCloseable, IospFileWriter, IOServiceProvider

public class N3iospWriter
extends N3iosp
implements IospFileWriter

IOServiceProviderWriter for Netcdf3 files.

Field Summary

Fields inherited from class ucar.nc2.internal.iosp.netcdf3.N3iosp

header, lastModified, log

Fields inherited from class ucar.nc2.iosp.AbstractIOServiceProvider

location, ncfile, raf, rafOrder

Constructor Summary

Constructors

Constructor and Description
N3iospWriter()
N3iospWriter(IOServiceProvider iosp)

Method Summary

Modifier and Type	Method and Description
int	appendStructureData(Structure s, StructureData sdata) Append a structureData along the unlimited dimension
void	close() Close the file.
NetcdfFile	create(String filename, Group.Builder rootGroup, int extra, long preallocateSize, boolean largeFile) Create new file, populate it from the objects in rootGroup.
void	flush()
NetcdfFile	getOutputFile()
void	openForWriting(String location, Group.Builder rootGroup, CancelTask cancelTask) Open existing file, populate rootGroup.
boolean	rewriteHeader(boolean largeFile)
void	setFill(boolean fill) Set the fill flag.
void	updateAttribute(Group g, Attribute att)
void	updateAttribute(Variable v2, Attribute att) Update the value of an existing attribute on disk, not in memory.
void	writeData(Variable v2, Section section, Array values) Write data into a variable.

Methods inherited from class ucar.nc2.internal.iosp.netcdf3.N3iosp

build, getDetailInfo, getFileTypeDescription, getFileTypeId, getFileTypeVersion, isValidFile, reacquire, readArrayData, readData, sendIospMessage, toStringDebug

Methods inherited from class ucar.nc2.iosp.AbstractIOServiceProvider

buildFinish, getLastModified, getStructureDataArrayIterator, getStructureIterator, open, readSection, readToOutputStream, release, setNetcdfFile

Methods inherited from class java.lang.Object

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

Methods inherited from interface ucar.nc2.iosp.IOServiceProvider

buildFinish, getLastModified, getStructureDataArrayIterator, getStructureIterator, readSection, readToOutputStream, release

Constructor Detail

N3iospWriter

public N3iospWriter()

N3iospWriter

public N3iospWriter(IOServiceProvider iosp)

Method Detail

create

public NetcdfFile create(String filename,
                         Group.Builder rootGroup,
                         int extra,
                         long preallocateSize,
                         boolean largeFile)
                  throws IOException

Description copied from interface: IospFileWriter

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

Specified by:

create in interface IospFileWriter

Parameters:

filename - name of file to create.

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

extra - if > 0, pad header with extra bytes (netcdf3 only).

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

largeFile - if want large file format (netcdf3 only).

Returns:

the NetcdfFile being written to

Throws:

IOException

openForWriting

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

Description copied from interface: IospFileWriter

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.

Specified by:

openForWriting in interface IospFileWriter

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

public NetcdfFile getOutputFile()

Specified by:

getOutputFile in interface IospFileWriter

setFill

public void setFill(boolean fill)

Description copied from interface: IospFileWriter

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.

Specified by:

setFill in interface IospFileWriter

Parameters:

fill - set fill mode true or false

rewriteHeader

public boolean rewriteHeader(boolean largeFile)
                      throws IOException

Throws:

IOException

writeData

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

Description copied from interface: IospFileWriter

Write data into a variable.

Specified by:

writeData in interface IospFileWriter

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

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

Description copied from interface: IospFileWriter

Append a structureData along the unlimited dimension

Specified by:

appendStructureData in interface IospFileWriter

Parameters:

s - belongs to this structure

sdata - the stuctureData to append

Returns:

the recnum where it was written

Throws:

IOException

InvalidRangeException

updateAttribute

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

Update the value of an existing attribute on disk, not in memory. 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.

Specified by:

updateAttribute in interface IospFileWriter

Parameters:

v2 - variable, or null for global attribute

att - replace with this value

Throws:

IOException

updateAttribute

public void updateAttribute(Group g,
                            Attribute att)
                     throws IOException

Specified by:

updateAttribute in interface IospFileWriter

Throws:

IOException

flush

public void flush()
           throws IOException

Throws:

IOException

close

public void close()
           throws IOException

Description copied from interface: IOServiceProvider

Close the file. It is the IOServiceProvider's job to close the file (even though it didnt open it), and to free any other resources it has used.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface IOServiceProvider

Overrides:

close in class N3iosp

Throws:

IOException - if read error