gov.nasa.gsfc.spdf.cdfj

Class GenericWriter

java.lang.Object

gov.nasa.gsfc.spdf.cdfj.GenericWriter

Direct Known Subclasses:

CDFWriter

public class GenericWriter
extends java.lang.Object

Base class for creating a version 3.6 CDF. Derived class CDFWriter provides methods for creating a CDF which includes user selected data from existing CDFs.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	rowMajority

Constructor Summary

Constructors

Constructor and Description
GenericWriter() Constructs a column major GenericWriter
GenericWriter(boolean rowMajority) Constructs a GenericWriter of specified row majority

Method Summary

Modifier and Type	Method and Description
void	addData(java.lang.String name, java.lang.Object data) Adds data to a variable.
void	addData(java.lang.String name, java.lang.Object data, boolean relax) Adds data to a variable.
void	addData(java.lang.String name, java.lang.Object data, int[] recordRange) Adds data for a specified record range to a variable.
void	addData(java.lang.String name, java.lang.Object data, int[] recordRange, boolean relax) Adds data for a specified record range to a variable.
void	addGlobalAttributeEntry(java.lang.String name, CDFDataType dataType, java.lang.Object value) Adds a global attribute entry of specified type..
void	addGlobalAttributeEntry(java.lang.String name, java.lang.Object value) Adds a global attribute entry.
void	addNRVString(java.lang.String name, java.lang.String value) Adds an NRV record of string type.
void	addNRVVariable(java.lang.String name, CDFDataType dataType, int[] dim, int size, java.lang.Object value) Adds a NRV record of the given type and dimensions.
void	addNRVVariable(java.lang.String name, CDFDataType dataType, int[] dim, java.lang.Object value) Adds a NRV record of the given numeric type and dimension.
void	addNRVVariable(java.lang.String name, CDFDataType dataType, java.lang.Object value) Adds a scalar NRV record of the given numeric type.
void	addOneD(java.lang.String name, java.lang.Object data) Adds data (represented as a one dimensional array) to a variable.
void	addOneD(java.lang.String name, java.lang.Object data, boolean relax) Adds data (represented as a one dimensional array) to a variable.
void	addOneD(java.lang.String name, java.lang.Object data, int[] recordRange) Adds data (represented as a one dimensional array) for a specified record range to a variable.
void	addOneD(java.lang.String name, java.lang.Object data, int[] recordRange, boolean relax) Adds data (represented as a one dimensional array) for a specified record range to a variable.
void	addVariableAttributeEntry(java.lang.String vname, java.lang.String aname, CDFDataType dataType, java.lang.Object value) Sets the value of a given attribute for a variable.
void	addVariableAttributeEntry(java.lang.String vname, java.lang.String aname, java.lang.Object value) Sets the value of a given attribute for a variable.
void	defineCompressedStringVariable(java.lang.String name, int[] dim, int size) Defines a compressed variable of string type with given dimensions.
void	defineCompressedTimeSeries(java.lang.String name, CDFDataType dataType, int[] dim, java.lang.String tname, CDFTimeType timeType) Defines a time series of the named variable of specified data type and the time variable of specified name and type.
void	defineCompressedVariable(java.lang.String name, CDFDataType dataType, int[] dim) Defines a compressed variable of specified numeric data type and dimensions.
void	defineCompressedVariable(java.lang.String name, CDFDataType dataType, int[] dim, int size) Defines a compressed variable of string type with given dimensions.
void	defineNRVVariable(java.lang.String name, CDFDataType dataType, int[] dim, int size) Defines a NRV record of the given type and dimensions.
void	defineStringVariable(java.lang.String name, int[] dim, boolean[] varys, boolean recordVariance, boolean compressed, java.lang.Object pad, int size) Defines a variable of string type using default sparse record option.
void	defineStringVariable(java.lang.String name, int[] dim, boolean[] varys, boolean recordVariance, boolean compressed, java.lang.Object pad, int size, SparseRecordOption option) Defines a variable of string type using given sparse record option.
void	defineStringVariable(java.lang.String name, int[] dim, int size) Defines a named variable of string data type
void	defineTimeSeries(java.lang.String name, CDFDataType dataType, int[] dim) Defines a time series for a new variable of specified data type.
void	defineTimeSeries(java.lang.String name, CDFDataType dataType, int[] dim, java.lang.String tname) Defines a time series of the named variable of specified data type and the time variable of specified name.
void	defineTimeSeries(java.lang.String name, CDFDataType dataType, int[] dim, java.lang.String tname, CDFTimeType timeType, boolean compressed) Defines a time series of a new named variable of specified data type and the time variable of specified name and type.
void	defineTimeVariable(java.lang.String name, CDFTimeType timeType) Defines a time variable of the specified time type.
void	defineVariable(java.lang.String name, CDFDataType dataType, int[] dim) Defines a named variable of specified numeric data type
void	defineVariable(java.lang.String name, CDFDataType dataType, int[] dim, boolean[] varys, boolean recordVariance, boolean compressed, java.lang.Object pad) Defines a variable of specified numeric data type using default sparse record option.
void	defineVariable(java.lang.String name, CDFDataType dataType, int[] dim, boolean[] varys, boolean recordVariance, boolean compressed, java.lang.Object pad, int size) Defines a variable of string type using given sparse record option.
void	defineVariable(java.lang.String name, CDFDataType dataType, int[] dim, boolean[] varys, boolean recordVariance, boolean compressed, java.lang.Object pad, int size, SparseRecordOption option) Defines a new variable
void	defineVariable(java.lang.String name, CDFDataType dataType, int[] dim, boolean[] varys, boolean recordVariance, boolean compressed, java.lang.Object pad, SparseRecordOption option) Defines a variable of specified numeric data type using given sparse record option.
void	defineVariable(java.lang.String name, CDFDataType dataType, int[] dim, int size) Defines a named variable of specified numeric data type and dimensions.
boolean	hasTimeVariable(java.lang.String name) Returns whether the time variable has been defined for a variable.
void	setLastLeapSecondId(int n) Sets the last Leap Second Id.
void	setMD5Needed(boolean need) Prescribes whether an MD5 digest is to be included in the output file.
void	setVariableAttributeEntry(java.lang.String vname, java.lang.String aname, CDFDataType dataType, java.lang.Object value) Sets the value of a given attribute for a variable.
void	setVariableAttributeEntry(java.lang.String vname, java.lang.String aname, java.lang.Object value) Sets the value of a given attribute for a variable.
void	write(java.lang.String fname) Writes CDF to a file.
boolean	write(java.lang.String fname, boolean overwrite)

Methods inherited from class java.lang.Object

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

Field Detail

rowMajority

public final boolean rowMajority

Constructor Detail

GenericWriter

public GenericWriter()

Constructs a column major GenericWriter

GenericWriter

public GenericWriter(boolean rowMajority)

Constructs a GenericWriter of specified row majority

Method Detail

addGlobalAttributeEntry

public void addGlobalAttributeEntry(java.lang.String name,
                                    java.lang.Object value)
                             throws CDFException.WriterError

Adds a global attribute entry.

Parameters:

name - name of the attribute

value - array or wrapped scalar value to assign to attribute

Throws:

CDFException.WriterError

addGlobalAttributeEntry

public void addGlobalAttributeEntry(java.lang.String name,
                                    CDFDataType dataType,
                                    java.lang.Object value)
                             throws CDFException.WriterError

Adds a global attribute entry of specified type..

Parameters:

name - name of the attribute

dataType - CDFDataType desired

value - array or wrapped scalar value to assign to attribute

Throws:

CDFException.WriterError

setVariableAttributeEntry

public void setVariableAttributeEntry(java.lang.String vname,
                                      java.lang.String aname,
                                      java.lang.Object value)
                               throws CDFException.WriterError

Sets the value of a given attribute for a variable.

Parameters:

vname - name of the variable

aname - name of the attribute

value - array of primitives, or String value to assign to attribute

Throws:

CDFException.WriterError

setVariableAttributeEntry

public void setVariableAttributeEntry(java.lang.String vname,
                                      java.lang.String aname,
                                      CDFDataType dataType,
                                      java.lang.Object value)
                               throws CDFException.WriterError

Sets the value of a given attribute for a variable.

Parameters:

vname - name of the variable

aname - name of the attribute

dataType - CDFDataType desired

value - array of primitives, or String value to assign to attribute Overwrites previous value, if any

Throws:

CDFException.WriterError

addVariableAttributeEntry

public void addVariableAttributeEntry(java.lang.String vname,
                                      java.lang.String aname,
                                      java.lang.Object value)
                               throws CDFException.WriterError

Sets the value of a given attribute for a variable. This method creates a new value for the given attribute. If an entry exists, new value is added to the existing entry if both are of String type.

Parameters:

vname - name of the variable

aname - name of the attribute

value - array of primitives, or String value to assign to attribute

Throws:

CDFException.WriterError

addVariableAttributeEntry

public void addVariableAttributeEntry(java.lang.String vname,
                                      java.lang.String aname,
                                      CDFDataType dataType,
                                      java.lang.Object value)
                               throws CDFException.WriterError

Sets the value of a given attribute for a variable. This method creates a new value for the given attribute. If an entry exists, new value is added to the existing entry if both are of String type.

Parameters:

vname - name of the variable

aname - name of the attribute

dataType - CDFDataType desired

value - array of primitives, or String value to assign to attribute

Throws:

CDFException.WriterError

hasTimeVariable

public boolean hasTimeVariable(java.lang.String name)
                        throws CDFException.WriterError

Returns whether the time variable has been defined for a variable.

Throws:

CDFException.WriterError

defineTimeVariable

public void defineTimeVariable(java.lang.String name,
                               CDFTimeType timeType)
                        throws CDFException.WriterError

Defines a time variable of the specified time type.

Throws:

CDFException.WriterError

defineTimeSeries

public void defineTimeSeries(java.lang.String name,
                             CDFDataType dataType,
                             int[] dim)
                      throws CDFException.WriterError

Defines a time series for a new variable of specified data type. Variable's times are contained in a time variable named Epoch which must have been created before this method is called.

Throws:

CDFException.WriterError

defineTimeSeries

public void defineTimeSeries(java.lang.String name,
                             CDFDataType dataType,
                             int[] dim,
                             java.lang.String tname)
                      throws CDFException.WriterError

Defines a time series of the named variable of specified data type and the time variable of specified name. The named time variable must have been defined before this method is called. Name of the time variable is assigned to the DEPEND_0 attribute.

Throws:

CDFException.WriterError

defineCompressedTimeSeries

public void defineCompressedTimeSeries(java.lang.String name,
                                       CDFDataType dataType,
                                       int[] dim,
                                       java.lang.String tname,
                                       CDFTimeType timeType)
                                throws CDFException.WriterError

Defines a time series of the named variable of specified data type and the time variable of specified name and type. Variable's data is compressed before it is stored

Throws:

CDFException.WriterError

defineTimeSeries

public void defineTimeSeries(java.lang.String name,
                             CDFDataType dataType,
                             int[] dim,
                             java.lang.String tname,
                             CDFTimeType timeType,
                             boolean compressed)
                      throws CDFException.WriterError

Defines a time series of a new named variable of specified data type and the time variable of specified name and type.

Throws:

CDFException.WriterError

defineVariable

public void defineVariable(java.lang.String name,
                           CDFDataType dataType,
                           int[] dim)
                    throws CDFException.WriterError

Defines a named variable of specified numeric data type

Throws:

CDFException.WriterError

defineStringVariable

public void defineStringVariable(java.lang.String name,
                                 int[] dim,
                                 int size)
                          throws CDFException.WriterError

Defines a named variable of string data type

Throws:

CDFException.WriterError

defineVariable

public void defineVariable(java.lang.String name,
                           CDFDataType dataType,
                           int[] dim,
                           int size)
                    throws CDFException.WriterError

Defines a named variable of specified numeric data type and dimensions.

Throws:

CDFException.WriterError

defineCompressedVariable

public void defineCompressedVariable(java.lang.String name,
                                     CDFDataType dataType,
                                     int[] dim)
                              throws CDFException.WriterError

Defines a compressed variable of specified numeric data type and dimensions.

Throws:

CDFException.WriterError

defineCompressedStringVariable

public void defineCompressedStringVariable(java.lang.String name,
                                           int[] dim,
                                           int size)
                                    throws CDFException.WriterError

Defines a compressed variable of string type with given dimensions.

Throws:

CDFException.WriterError

defineCompressedVariable

public void defineCompressedVariable(java.lang.String name,
                                     CDFDataType dataType,
                                     int[] dim,
                                     int size)
                              throws CDFException.WriterError

Defines a compressed variable of string type with given dimensions.

Throws:

CDFException.WriterError

addNRVString

public void addNRVString(java.lang.String name,
                         java.lang.String value)
                  throws CDFException.WriterError

Adds an NRV record of string type.

Throws:

CDFException.WriterError

addNRVVariable

public void addNRVVariable(java.lang.String name,
                           CDFDataType dataType,
                           java.lang.Object value)
                    throws CDFException.WriterError

Adds a scalar NRV record of the given numeric type.

Throws:

CDFException.WriterError

addNRVVariable

public void addNRVVariable(java.lang.String name,
                           CDFDataType dataType,
                           int[] dim,
                           java.lang.Object value)
                    throws CDFException.WriterError

Adds a NRV record of the given numeric type and dimension.

Throws:

CDFException.WriterError

addNRVVariable

public void addNRVVariable(java.lang.String name,
                           CDFDataType dataType,
                           int[] dim,
                           int size,
                           java.lang.Object value)
                    throws CDFException.WriterError

Adds a NRV record of the given type and dimensions.

Throws:

CDFException.WriterError

defineNRVVariable

public void defineNRVVariable(java.lang.String name,
                              CDFDataType dataType,
                              int[] dim,
                              int size)
                       throws CDFException.WriterError

Defines a NRV record of the given type and dimensions. Parameter size is ignored for variables of numeric types.

Throws:

CDFException.WriterError

defineVariable

public void defineVariable(java.lang.String name,
                           CDFDataType dataType,
                           int[] dim,
                           boolean[] varys,
                           boolean recordVariance,
                           boolean compressed,
                           java.lang.Object pad)
                    throws CDFException.WriterError

Defines a variable of specified numeric data type using default sparse record option.

Parameters:

name -

dataType - data tpe

dim - dimensions

varys - dimension variance

recordVariance -

compressed - whether the values will be saved in compressed form

pad - array or wrapped scalar value to assign to use as pad

Throws:

CDFException.WriterError

defineVariable

public void defineVariable(java.lang.String name,
                           CDFDataType dataType,
                           int[] dim,
                           boolean[] varys,
                           boolean recordVariance,
                           boolean compressed,
                           java.lang.Object pad,
                           SparseRecordOption option)
                    throws CDFException.WriterError

Defines a variable of specified numeric data type using given sparse record option.

Parameters:

name -

dataType - data tpe

dim - dimensions

varys - dimension variance

recordVariance -

compressed - whether the values will be saved in compressed form

pad - array or wrapped scalar value to assign to use as pad

option - sparse record option

Throws:

CDFException.WriterError

defineStringVariable

public void defineStringVariable(java.lang.String name,
                                 int[] dim,
                                 boolean[] varys,
                                 boolean recordVariance,
                                 boolean compressed,
                                 java.lang.Object pad,
                                 int size)
                          throws CDFException.WriterError

Defines a variable of string type using default sparse record option. same as: defineStringVariable(String name, int[] dim, boolean[] varys, boolean recordVariance, boolean compressed, Object pad, int size, SparseRecordOption.NONE)

Throws:

CDFException.WriterError

See Also:

defineStringVariable(String name, int[] dim, boolean[] varys, boolean recordVariance, boolean compressed, Object pad, int size, SparseRecordOption option)

defineStringVariable

public void defineStringVariable(java.lang.String name,
                                 int[] dim,
                                 boolean[] varys,
                                 boolean recordVariance,
                                 boolean compressed,
                                 java.lang.Object pad,
                                 int size,
                                 SparseRecordOption option)
                          throws CDFException.WriterError

Defines a variable of string type using given sparse record option.

Parameters:

name -

dim - dimensions

varys - dimension variance

recordVariance -

compressed - whether the values will be saved in compressed form

pad - array or wrapped scalar value to assign to use as pad

size - length of character string

option - sparse record option

Throws:

CDFException.WriterError

defineVariable

public void defineVariable(java.lang.String name,
                           CDFDataType dataType,
                           int[] dim,
                           boolean[] varys,
                           boolean recordVariance,
                           boolean compressed,
                           java.lang.Object pad,
                           int size)
                    throws CDFException.WriterError

Defines a variable of string type using given sparse record option.

Parameters:

name -

dim - dimensions

varys - dimension variance

recordVariance -

compressed - whether the values will be saved in compressed form

pad - array or wrapped scalar value to assign to use as pad

size - length of character string

Throws:

CDFException.WriterError

defineVariable

public void defineVariable(java.lang.String name,
                           CDFDataType dataType,
                           int[] dim,
                           boolean[] varys,
                           boolean recordVariance,
                           boolean compressed,
                           java.lang.Object pad,
                           int size,
                           SparseRecordOption option)
                    throws CDFException.WriterError

Defines a new variable

Parameters:

name - Variable name

dataType - data type of the variable

dim - dimension

varys -

recordVariance -

compressed - whether the variable data appears in compressed form in the CDF

pad - Object to use as a pad value - a Number object for a numeric variable, a String for a character variable

size - length of charater string for character variable, Must be 1 for numeric type variable

option - sparse record option

Throws:

CDFException.WriterError

addOneD

public void addOneD(java.lang.String name,
                    java.lang.Object data)
             throws CDFException.WriterError

Adds data (represented as a one dimensional array) to a variable. same as addOneD(String name, Object data, null, false)

Throws:

CDFException.WriterError

See Also:

addOneD(String name, Object data, int[] recordRange, boolean relax)

addOneD

public void addOneD(java.lang.String name,
                    java.lang.Object data,
                    boolean relax)
             throws CDFException.WriterError

Adds data (represented as a one dimensional array) to a variable. same as addOneD(String name, Object data, null, boolean relax)

Throws:

CDFException.WriterError

See Also:

addOneD(String name, Object data, int[] recordRange, boolean relax)

addOneD

public void addOneD(java.lang.String name,
                    java.lang.Object data,
                    int[] recordRange)
             throws CDFException.WriterError

Adds data (represented as a one dimensional array) for a specified record range to a variable. same as addOneD(String name, Object data, int[] recordRange, false)

Throws:

CDFException.WriterError

See Also:

addOneD(String name, Object data, int[] recordRange, boolean relax)

addOneD

public void addOneD(java.lang.String name,
                    java.lang.Object data,
                    int[] recordRange,
                    boolean relax)
             throws CDFException.WriterError

Adds data (represented as a one dimensional array) for a specified record range to a variable.

Parameters:

name - name of the variable.

data - a one dimensional array of a type compatible with the type of variable.

recordRange - int[2] containing record range. May be null, in which case range is assumed to be follow last record added.

relax - relevant for unsigned data types, CDF_UINT1, CDF_UINT2 and CDF_UINT4 only,specifies that values in data array can be interpreted as unsigned.

CDF Type of Variable	Type of Array
INT8, TT2000, UINT4	long
UINT4	int, if relax = true, long otherwise
DOUBLE, EPOCH, EPOCH16	double
FLOAT	float or double
INT4	int
UINT2	short, if relax = true, int otherwise
INT2	short
UINT1	byte, if relax = true, short otherwise
INT1	byte
CHAR	String

data must contain an integral number of points, and its contents must conform to the row majority of this GenericWriter.

Throws:

CDFException.WriterError

addData

public void addData(java.lang.String name,
                    java.lang.Object data)
             throws CDFException.WriterError

Adds data to a variable. same as addData(String name, Object data, false)

Throws:

CDFException.WriterError

See Also:

addData(String name, Object data, boolean relax)

addData

public void addData(java.lang.String name,
                    java.lang.Object data,
                    boolean relax)
             throws CDFException.WriterError

Adds data to a variable.

Parameters:

name - name of the variable.

data - an array of type compatible with the type of variable.

relax - relevant for unsigned data types, CDF_UINT1, CDF_UINT2 and CDF_UINT4 only,specifies that values in data array can be interpreted as unsigned.

Throws:

CDFException.WriterError

See Also:

for more details.

addData

public void addData(java.lang.String name,
                    java.lang.Object data,
                    int[] recordRange)
             throws CDFException.WriterError

Adds data for a specified record range to a variable.

Parameters:

name - name of the variable.

data - an array of type compatible with the type of variable, or a ByteOrder.LITTLE_ENDIAN ByteBuffer containing data to be added.

recordRange - int[2] containing record range. If data is an array, or variable is to be saved uncompressed, recordRange may be null, in which case range is assumed to be follow last record added.

Throws:

CDFException.WriterError

See Also:

addData(String name, Object data, int[] recordRange, boolean relax)

addData

public void addData(java.lang.String name,
                    java.lang.Object data,
                    int[] recordRange,
                    boolean relax)
             throws CDFException.WriterError

Adds data for a specified record range to a variable.

Parameters:

name - name of the variable.

data - an array of type compatible with the type of variable, or a ByteOrder.LITTLE_ENDIAN ByteBuffer containing data to be added.

recordRange - int[2] containing record range. If data is an array, or variable is to be saved uncompressed, recordRange may be null, in which case range is assumed to be follow last record added.

relax - relevant for unsigned data types, CDF_UINT1, CDF_UINT2 and CDF_UINT4 only,specifies that values in data array can be interpreted as unsigned.

CDF Type of Variable	Type of Array
INT8, TT2000, UINT4	long
UINT4	int, if relax = true, long otherwise
DOUBLE, EPOCH, EPOCH16	double
FLOAT	float or double
INT4	int
UINT2	short, if relax = true, int otherwise
INT2	short
UINT1	byte, if relax = true, short otherwise
INT1	byte
CHAR	String

data must contain an integral number of points. If data is an array, rank of the array must be 1 greater than the rank of the variable, and the dimensions after the first must match the variable dimensions in number and order. If data is a ByteBuffer, contents must conform to the row majority of this GenericWriter. If the variable is to be stored as compressed, then the buffer should contain compressed data, and record range must be specified.

Throws:

CDFException.WriterError

setMD5Needed

public void setMD5Needed(boolean need)

Prescribes whether an MD5 digest is to be included in the output file.

write

public void write(java.lang.String fname)
           throws java.io.IOException

Writes CDF to a file.

Throws:

java.io.IOException

write

public boolean write(java.lang.String fname,
                     boolean overwrite)
              throws java.io.IOException

Throws:

java.io.IOException

setLastLeapSecondId

public void setLastLeapSecondId(int n)

Sets the last Leap Second Id. This value is intended to allow applications that read the created CDF to validate TT2000 times in the CDF.

Parameters:

n - integer = year*10000 + month*100 + day, where year month and day refer to the day following the leap second. A 0 value for n asserts that applications accept the validity of TT2000 times. n = -1 implies lastLeapSecondId=20120701, which is the default for CDF versions prior to 3.6.