gov.nasa.gsfc.spdf.cdfj

Class CDFWriter

java.lang.Object

gov.nasa.gsfc.spdf.cdfj.GenericWriter

gov.nasa.gsfc.spdf.cdfj.CDFWriter

public class CDFWriter
extends GenericWriter

Extends GenericWriter with methods to include user selected data from CDFs

Field Summary

Fields inherited from class gov.nasa.gsfc.spdf.cdfj.GenericWriter

rowMajority

Constructor Summary

Constructors

Constructor and Description
CDFWriter(boolean targetMajority) Constructs a CDFWriter of given row majority.
CDFWriter(GenericReader cdf) Constructs a CDFWriter populated with data from the given GenericReader.
CDFWriter(java.lang.String fname) Constructs a column major CDFWriter populated with data from the given CDF file.
CDFWriter(java.lang.String[] files) Constructs a column major CDFWriter populated with data from the given files.
CDFWriter(java.lang.String[] files, boolean targetMajority) Constructs a CDFWriter of specified row majority, populated with data from the given files.
CDFWriter(java.lang.String[] files, boolean targetMajority, SelectedVariableCollection col) Constructs a CDFWriter of specified row majority, populated with selected variables, and variables they depend on, from the given files.
CDFWriter(java.lang.String[] files, SelectedVariableCollection col) Constructs a column major CDFWriter populated with selected variables, and variables they depend on, from the given files.
CDFWriter(java.lang.String fname, boolean targetMajority) Constructs a CDFWriter of specified row majority, populated with data from the given file.
CDFWriter(java.lang.String fname, boolean targetMajority, SelectedVariableCollection col) Constructs a CDFWriter of specified row majority, populated with selected variables, and variables they depend on, from the given file.
CDFWriter(java.lang.String fname, SelectedVariableCollection col) Constructs a column major CDFWriter populated with selected variables, and variables they depend on, from the given file.
CDFWriter(java.net.URL url) Constructs a column major CDFWriter populated with data from the given URL.
CDFWriter(java.net.URL[] urls) Constructs a column major CDFWriter populated with data from the given array of URLs.
CDFWriter(java.net.URL[] urls, boolean targetMajority) Constructs a CDFWriter of specified row majority, populated with data from the given array of URLs.
CDFWriter(java.net.URL[] urls, boolean targetMajority, SelectedVariableCollection col) Constructs a CDFWriter of specified row majority, populated with selected variables, and variables they depend on, from the given array of URLs.
CDFWriter(java.net.URL[] urls, SelectedVariableCollection col) Constructs a column major CDFWriter populated with selected variables, and variables they depend on, from the given array of URLs.
CDFWriter(java.net.URL url, boolean targetMajority) Constructs a CDFWriter of specified row majority, populated with data from the given URL.
CDFWriter(java.net.URL url, boolean targetMajority, SelectedVariableCollection col) Constructs a CDFWriter of specified row majority, populated with selected variables, and variables they depend on, from the given URL.
CDFWriter(java.net.URL url, SelectedVariableCollection col) Constructs a column major CDFWriter populated with selected variables, and variables they depend on, from the given URL.

Method Summary

Modifier and Type	Method and Description
void	addCDF(GenericReader cdf) Adds previously selected variables, and variables they depend on, from the given GenericReader..
void	addCDF(java.lang.String fname) Adds previously selected variables, and variables they depend on, from the given file.
void	addCDF(java.net.URL url) Adds previously selected variables, and variables they depend on, from the given URL.
static void	addToDoNotCheckList(java.lang.String aname) Adds an attribute to the list of 'not to be monitored' global attributes.
java.lang.String[]	attributesInDoNotCheckList() Returns names of 'not to be monitored' global attributes.
static void	removeFromDoNotCheckList(java.lang.String aname) Removes an attribute from the list 'not to be monitored' global attributes.
static SelectedVariableCollection	selectorInstance() Returns a new instance of the SelectedVariableCollection.
void	setLogger(java.util.logging.Logger _logger) sets a Logger for this class
static void	setLoggerLevel(java.util.logging.Level newLevel) Sets Level for the default anonymous Logger for this class.

Methods inherited from class gov.nasa.gsfc.spdf.cdfj.GenericWriter

addData, addData, addData, addData, addGlobalAttributeEntry, addGlobalAttributeEntry, addNRVString, addNRVVariable, addNRVVariable, addNRVVariable, addOneD, addOneD, addOneD, addOneD, addVariableAttributeEntry, addVariableAttributeEntry, defineCompressedStringVariable, defineCompressedTimeSeries, defineCompressedVariable, defineCompressedVariable, defineNRVVariable, defineStringVariable, defineStringVariable, defineStringVariable, defineTimeSeries, defineTimeSeries, defineTimeSeries, defineTimeVariable, defineVariable, defineVariable, defineVariable, defineVariable, defineVariable, defineVariable, hasTimeVariable, setLastLeapSecondId, setMD5Needed, setVariableAttributeEntry, setVariableAttributeEntry, write, write

Methods inherited from class java.lang.Object

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

Constructor Detail

CDFWriter

public CDFWriter(boolean targetMajority)

Constructs a CDFWriter of given row majority.

Parameters:

targetMajority - A flag indicating whether the target CDF is row major

CDFWriter

public CDFWriter(GenericReader cdf)
          throws CDFException.WriterError,
                 CDFException.ReaderError

Constructs a CDFWriter populated with data from the given GenericReader.

Parameters:

cdf - A GenericReader object

Throws:

CDFException.WriterError - if an error is encountered while writing the CDF

CDFException.ReaderError - if an error is encountered while reading the CDF

CDFWriter

public CDFWriter(java.lang.String fname)
          throws CDFException.WriterError,
                 CDFException.ReaderError

Constructs a column major CDFWriter populated with data from the given CDF file.

Parameters:

fname - The output CDF file name

Throws:

CDFException.WriterError - if an error is encountered while writing the CDF

CDFException.ReaderError - if an error is encountered while reading the CDF

CDFWriter

public CDFWriter(java.lang.String[] files)
          throws CDFException.WriterError,
                 CDFException.ReaderError

Constructs a column major CDFWriter populated with data from the given files.

Parameters:

files - An array of CDF file names

Throws:

CDFException.WriterError - if an error is encountered while writing the CDF

CDFException.ReaderError - if an error is encountered while reading the CDF

CDFWriter

public CDFWriter(java.net.URL url)
          throws CDFException.WriterError,
                 CDFException.ReaderError

Constructs a column major CDFWriter populated with data from the given URL.

Parameters:

url - An URL

Throws:

CDFException.WriterError - if an error is encountered while writing the CDF

CDFException.ReaderError - if an error is encountered while reading the CDF

CDFWriter

public CDFWriter(java.net.URL[] urls)
          throws CDFException.WriterError,
                 CDFException.ReaderError

Constructs a column major CDFWriter populated with data from the given array of URLs.

Parameters:

urls - An array of URL

Throws:

CDFException.WriterError - if an error is encountered while writing the CDF

CDFException.ReaderError - if an error is encountered while reading the CDF

CDFWriter

public CDFWriter(java.lang.String fname,
                 SelectedVariableCollection col)
          throws CDFException.WriterError,
                 CDFException.ReaderError

Constructs a column major CDFWriter populated with selected variables, and variables they depend on, from the given file.

Parameters:

fname - the output file name

col - SelectedVariableCollection that defines variables to be selected and their properties

Throws:

CDFException.WriterError - if an error is encountered while writing the CDF

CDFException.ReaderError - if an error is encountered while reading the CDF

CDFWriter

public CDFWriter(java.lang.String[] files,
                 SelectedVariableCollection col)
          throws CDFException.WriterError,
                 CDFException.ReaderError

Constructs a column major CDFWriter populated with selected variables, and variables they depend on, from the given files.

Parameters:

files - An array of file names

col - SelectedVariableCollection that defines variables to be selected and their properties

Throws:

CDFException.WriterError - if an error is encountered while writing the CDF

CDFException.ReaderError - if an error is encountered while reading the CDF

CDFWriter

public CDFWriter(java.net.URL url,
                 SelectedVariableCollection col)
          throws CDFException.WriterError,
                 CDFException.ReaderError

Constructs a column major CDFWriter populated with selected variables, and variables they depend on, from the given URL.

Parameters:

url - a URL object

col - SelectedVariableCollection that defines variables to be selected and their properties

Throws:

CDFException.WriterError - if an error is encountered while writing the CDF

CDFException.ReaderError - if an error is encountered while reading the CDF

CDFWriter

public CDFWriter(java.net.URL[] urls,
                 SelectedVariableCollection col)
          throws CDFException.WriterError,
                 CDFException.ReaderError

Constructs a column major CDFWriter populated with selected variables, and variables they depend on, from the given array of URLs.

Parameters:

urls - an array of URLs

col - SelectedVariableCollection that defines variables to be selected and their properties

Throws:

CDFException.WriterError - if an error is encountered while writing the CDF

CDFException.ReaderError - if an error is encountered while reading the CDF

CDFWriter

public CDFWriter(java.lang.String fname,
                 boolean targetMajority)
          throws CDFException.WriterError,
                 CDFException.ReaderError

Constructs a CDFWriter of specified row majority, populated with data from the given file.

Parameters:

fname - the CDF file name

targetMajority - A flag indicating whether the target CDF is row major

Throws:

CDFException.WriterError - if an error is encountered while writing the CDF

CDFException.ReaderError - if an error is encountered while reading the CDF

CDFWriter

public CDFWriter(java.lang.String[] files,
                 boolean targetMajority)
          throws CDFException.WriterError,
                 CDFException.ReaderError

Constructs a CDFWriter of specified row majority, populated with data from the given files.

Parameters:

files - An array of file names

targetMajority - A flag indicating whether the target CDF is row major

Throws:

CDFException.WriterError - if an error is encountered while writing the CDF

CDFException.ReaderError - if an error is encountered while reading the CDF

CDFWriter

public CDFWriter(java.net.URL url,
                 boolean targetMajority)
          throws CDFException.WriterError,
                 CDFException.ReaderError

Constructs a CDFWriter of specified row majority, populated with data from the given URL.

Parameters:

url - A URL object

targetMajority - A flag indicating whether the target CDF is row major

Throws:

CDFException.WriterError - if an error is encountered while writing the CDF

CDFException.ReaderError - if an error is encountered while reading the CDF

CDFWriter

public CDFWriter(java.net.URL[] urls,
                 boolean targetMajority)
          throws CDFException.WriterError,
                 CDFException.ReaderError

Constructs a CDFWriter of specified row majority, populated with data from the given array of URLs.

Parameters:

urls - An array of URLs

targetMajority - A flag indicating whether the target CDF is row major

Throws:

CDFException.WriterError - if an error is encountered while writing the CDF

CDFException.ReaderError - if an error is encountered while reading the CDF

CDFWriter

public CDFWriter(java.lang.String fname,
                 boolean targetMajority,
                 SelectedVariableCollection col)
          throws CDFException.WriterError,
                 CDFException.ReaderError

Constructs a CDFWriter of specified row majority, populated with selected variables, and variables they depend on, from the given file.

Parameters:

fname - the CDF file name

targetMajority - A flag indicating whether the target CDF is row major

col - SelectedVariableCollection that defines variables to be selected and their properties

Throws:

CDFException.WriterError - if an error is encountered while writing the CDF

CDFException.ReaderError - if an error is encountered while reading the CDF

CDFWriter

public CDFWriter(java.lang.String[] files,
                 boolean targetMajority,
                 SelectedVariableCollection col)
          throws CDFException.WriterError,
                 CDFException.ReaderError

Constructs a CDFWriter of specified row majority, populated with selected variables, and variables they depend on, from the given files.

Parameters:

files - An array of file names

targetMajority - A flag indicating whether the target CDF is row major

col - SelectedVariableCollection that defines variables to be selected and their properties

Throws:

CDFException.WriterError - if an error is encountered while writing the CDF

CDFException.ReaderError - if an error is encountered while reading the CDF

CDFWriter

public CDFWriter(java.net.URL url,
                 boolean targetMajority,
                 SelectedVariableCollection col)
          throws CDFException.WriterError,
                 CDFException.ReaderError

Constructs a CDFWriter of specified row majority, populated with selected variables, and variables they depend on, from the given URL.

Parameters:

url - A URL object

targetMajority - A flag indicating whether the target CDF is row major

col - SelectedVariableCollection that defines variables to be selected and their properties

Throws:

CDFException.WriterError - if an error is encountered while writing the CDF

CDFException.ReaderError - if an error is encountered while reading the CDF

CDFWriter

public CDFWriter(java.net.URL[] urls,
                 boolean targetMajority,
                 SelectedVariableCollection col)
          throws CDFException.WriterError,
                 CDFException.ReaderError

Constructs a CDFWriter of specified row majority, populated with selected variables, and variables they depend on, from the given array of URLs.

Parameters:

urls - An array of URLs

targetMajority - A flag indicating whether the target CDF is row major

col - SelectedVariableCollection that defines variables to be selected and their properties

Throws:

CDFException.WriterError - if an error is encountered while writing the CDF

CDFException.ReaderError - if an error is encountered while reading the CDF

Method Detail

addCDF

public void addCDF(java.lang.String fname)
            throws CDFException.WriterError,
                   CDFException.ReaderError

Adds previously selected variables, and variables they depend on, from the given file.

Parameters:

fname - The CDF file name

Throws:

CDFException.WriterError - if an error is encountered while writing the CDF

CDFException.ReaderError - if an error is encountered while reading the CDF

addCDF

public void addCDF(java.net.URL url)
            throws CDFException.WriterError,
                   CDFException.ReaderError

Adds previously selected variables, and variables they depend on, from the given URL.

Parameters:

url - The URL object

Throws:

CDFException.WriterError - if an error is encountered while writing the CDF

CDFException.ReaderError - if an error is encountered while reading the CDF

addCDF

public void addCDF(GenericReader cdf)
            throws CDFException.ReaderError,
                   CDFException.WriterError

Adds previously selected variables, and variables they depend on, from the given GenericReader..

Parameters:

cdf - The CDF GenericReader object

Throws:

CDFException.WriterError - if an error is encountered while writing the CDF

CDFException.ReaderError - if an error is encountered while reading the CDF

selectorInstance

public static SelectedVariableCollection selectorInstance()

Returns a new instance of the SelectedVariableCollection.

Returns:

a coolection of all selected variables

setLogger

public void setLogger(java.util.logging.Logger _logger)

sets a Logger for this class

Parameters:

_logger - the logger

setLoggerLevel

public static void setLoggerLevel(java.util.logging.Level newLevel)

Sets Level for the default anonymous Logger for this class. If a logger has been set via a call to setLogger(Logger logger), this method has no effect

Parameters:

newLevel - The level of logger

addToDoNotCheckList

public static void addToDoNotCheckList(java.lang.String aname)

Adds an attribute to the list of 'not to be monitored' global attributes.

Parameters:

aname - The name of a global attribute added to the not to be monitored list.

removeFromDoNotCheckList

public static void removeFromDoNotCheckList(java.lang.String aname)

Removes an attribute from the list 'not to be monitored' global attributes.

Parameters:

aname - The name of a global attribute removed to the not to be monitored list

attributesInDoNotCheckList

public java.lang.String[] attributesInDoNotCheckList()

Returns names of 'not to be monitored' global attributes.

Returns:

The names of global attributes in the not to be monitored list