ucar.nc2.write

Class NetcdfFormatWriter.Builder<T extends NetcdfFormatWriter.Builder<T>>

java.lang.Object

ucar.nc2.write.NetcdfFormatWriter.Builder<T>

Enclosing class:

NetcdfFormatWriter

public abstract static class NetcdfFormatWriter.Builder<T extends NetcdfFormatWriter.Builder<T>>
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
T	addAttribute(Attribute att) Add a global attribute
Dimension	addDimension(Dimension dim) Add a dimension to the root group.
Dimension	addDimension(String dimName, int length) Add a dimension to the root group.
Structure.Builder<?>	addStructure(String shortName, String dimString) Add a Structure to the root group.
Dimension	addUnlimitedDimension(String dimName) Add an unlimited dimension to the root group.
Variable.Builder<?>	addVariable(String shortName, ArrayType dataType, List<Dimension> dims) Add a Variable to the root group.
Variable.Builder<?>	addVariable(String shortName, ArrayType dataType, String dimString) Add a Variable to the root group.
Variable.Builder<?>	addVariable(String shortName, DataType dataType, List<Dimension> dims) Deprecated. use addVariable(String shortName, ArrayType dataType, List dims)
Variable.Builder<?>	addVariable(String shortName, DataType dataType, String dimString) Deprecated. use addVariable(String shortName, ArrayType dataType, String dimString)
NetcdfFormatWriter	build() Once this is called, do not use the Builder again.
Group.Builder	getRootGroup() Get the root group
protected abstract T	self()
T	setChunker(Nc4Chunking chunker) Nc4Chunking, used only for netcdf4
T	setExtraHeader(int extraHeaderBytes) Set extra bytes to reserve in the header.
T	setFill(boolean fill) Set the fill flag.
T	setFormat(NetcdfFileFormat format) Set the format version.
NetcdfFormatWriter.Builder<?>	setIosp(IOServiceProvider iosp)
T	setIsExisting()
T	setLocation(String location) The file locatipn
T	setPreallocateSize(long preallocateSize) Preallocate the file size, for efficiency.
T	setRootGroup(Group.Builder rootGroup) Set the root group.
T	setUseJna(boolean useJna) Set if you want to use JNA / netcdf c library to do the writing.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

self

protected abstract T self()

setIosp

public NetcdfFormatWriter.Builder<?> setIosp(IOServiceProvider iosp)

setLocation

public T setLocation(String location)

The file locatipn

setIsExisting

public T setIsExisting()

setFill

public T setFill(boolean fill)

Set the fill flag. Only used by netcdf-3. If true, the data is first written with fill values. Default is fill = true, to follow the C library. Set false if you expect to write all data values, which makes writing faster. Set true if you want to be sure that unwritten data values are set to the fill value.

setFormat

public T setFormat(NetcdfFileFormat format)

Set the format version. Only needed when its a new file. Default is NetcdfFileFormat.NETCDF3

setExtraHeader

public T setExtraHeader(int extraHeaderBytes)

Set extra bytes to reserve in the header. Only used by netcdf-3. This can prevent rewriting the entire file on redefine.

Parameters:

extraHeaderBytes - # bytes extra for the header

setPreallocateSize

public T setPreallocateSize(long preallocateSize)

Preallocate the file size, for efficiency. Only used by netcdf-3.

setChunker

public T setChunker(Nc4Chunking chunker)

Nc4Chunking, used only for netcdf4

setUseJna

public T setUseJna(boolean useJna)

Set if you want to use JNA / netcdf c library to do the writing. Default is false. JNA must be used for Netcdf-4. This is used to write to Netcdf-3 format with jna.

addAttribute

public T addAttribute(Attribute att)

Add a global attribute

addDimension

public Dimension addDimension(String dimName,
                              int length)

Add a dimension to the root group.

addDimension

public Dimension addDimension(Dimension dim)

Add a dimension to the root group.

addUnlimitedDimension

public Dimension addUnlimitedDimension(String dimName)

Add an unlimited dimension to the root group.

getRootGroup

public Group.Builder getRootGroup()

Get the root group

setRootGroup

public T setRootGroup(Group.Builder rootGroup)

Set the root group. This allows metadata to be modified externally.

addVariable

@Deprecated
public Variable.Builder<?> addVariable(String shortName,
                                                    DataType dataType,
                                                    String dimString)

Deprecated. use addVariable(String shortName, ArrayType dataType, String dimString)

addVariable

public Variable.Builder<?> addVariable(String shortName,
                                       ArrayType dataType,
                                       String dimString)

Add a Variable to the root group.

addVariable

@Deprecated
public Variable.Builder<?> addVariable(String shortName,
                                                    DataType dataType,
                                                    List<Dimension> dims)

Deprecated. use addVariable(String shortName, ArrayType dataType, List dims)

addVariable

public Variable.Builder<?> addVariable(String shortName,
                                       ArrayType dataType,
                                       List<Dimension> dims)

Add a Variable to the root group.

addStructure

public Structure.Builder<?> addStructure(String shortName,
                                         String dimString)

Add a Structure to the root group.

build

public NetcdfFormatWriter build()
                         throws IOException

Once this is called, do not use the Builder again.

Throws:

IOException