ucar.nc2.dt.point

Class RecordDatasetHelper

java.lang.Object

ucar.nc2.dt.point.RecordDatasetHelper

Deprecated.

use ucar.nc2.ft.*

public class RecordDatasetHelper
extends Object

Helper class for using the netcdf-3 record dimension. Can be used for PointObs or StationObs.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	RecordDatasetHelper.RecordPointObs Deprecated.
class	RecordDatasetHelper.RecordStationObs Deprecated.

Field Summary

Fields

Modifier and Type	Field and Description
protected double	altScaleFactor Deprecated.
protected String	altVName Deprecated.
protected ucar.unidata.geoloc.LatLonRect	boundingBox Deprecated.
protected StringBuffer	errs Deprecated.
protected String	latVName Deprecated.
protected String	lonVName Deprecated.
protected double	maxDate Deprecated.
protected double	minDate Deprecated.
protected ucar.nc2.dataset.NetcdfDataset	ncfile Deprecated.
protected String	nomTimeVName Deprecated.
protected ucar.nc2.Dimension	obsDim Deprecated.
protected String	obsTimeVName Deprecated.
protected ucar.nc2.dataset.StructureDS	recordVar Deprecated.
protected boolean	showErrors Deprecated.
protected ucar.ma2.DataType	stationIdType Deprecated.
protected String	stnDescVName Deprecated.
protected Map<Object,ucar.unidata.geoloc.Station>	stnHash Deprecated.
protected String	stnIdVName Deprecated.
protected String	stnNameVName Deprecated.
protected ucar.nc2.units.DateUnit	timeUnit Deprecated.

Constructor Summary

Constructors

Constructor and Description
RecordDatasetHelper(ucar.nc2.dataset.NetcdfDataset ncfile, String obsTimeVName, String nomTimeVName, List typedDataVariables) Deprecated. Constructor.
RecordDatasetHelper(ucar.nc2.dataset.NetcdfDataset ncfile, String obsTimeVName, String nomTimeVName, List typedDataVariables, StringBuffer errBuffer) Deprecated.
RecordDatasetHelper(ucar.nc2.dataset.NetcdfDataset ncfile, String obsTimeVName, String nomTimeVName, List typedDataVariables, String recDimName, StringBuffer errBuffer) Deprecated. Constructor.

Method Summary

Modifier and Type	Method and Description
List	getData(ArrayList records, ucar.unidata.geoloc.LatLonRect boundingBox, ucar.nc2.util.CancelTask cancel) Deprecated.
List	getData(ArrayList records, ucar.unidata.geoloc.LatLonRect boundingBox, double startTime, double endTime, ucar.nc2.util.CancelTask cancel) Deprecated.
int	getRecordCount() Deprecated.
ucar.nc2.Structure	getRecordVar() Deprecated.
ucar.nc2.units.DateUnit	getTimeUnit() Deprecated.
ArrayList	readAllCreateObs(ucar.nc2.util.CancelTask cancel) Deprecated. This reads through all the records in the dataset, and constructs a list of RecordPointObs or RecordStationObs.
void	setLocationInfo(String latVName, String lonVName, String altVName) Deprecated.
void	setShortNames(String latVName, String lonVName, String altVName, String obsTimeVName, String nomTimeVName) Deprecated.
void	setStationInfo(String stnIdVName, String stnDescVName) Deprecated. Set extra information used by station obs datasets.
void	setTimeUnit(ucar.nc2.units.DateUnit timeUnit) Deprecated.

Methods inherited from class java.lang.Object

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

Field Detail

ncfile

protected ucar.nc2.dataset.NetcdfDataset ncfile

Deprecated.

obsTimeVName

protected String obsTimeVName

Deprecated.

nomTimeVName

protected String nomTimeVName

Deprecated.

stnIdVName

protected String stnIdVName

Deprecated.

stnNameVName

protected String stnNameVName

Deprecated.

stnDescVName

protected String stnDescVName

Deprecated.

latVName

protected String latVName

Deprecated.

lonVName

protected String lonVName

Deprecated.

altVName

protected String altVName

Deprecated.

stationIdType

protected ucar.ma2.DataType stationIdType

Deprecated.

stnHash

protected Map<Object,ucar.unidata.geoloc.Station> stnHash

Deprecated.

recordVar

protected ucar.nc2.dataset.StructureDS recordVar

Deprecated.

obsDim

protected ucar.nc2.Dimension obsDim

Deprecated.

boundingBox

protected ucar.unidata.geoloc.LatLonRect boundingBox

Deprecated.

minDate

protected double minDate

Deprecated.

maxDate

protected double maxDate

Deprecated.

timeUnit

protected ucar.nc2.units.DateUnit timeUnit

Deprecated.

altScaleFactor

protected double altScaleFactor

Deprecated.

errs

protected StringBuffer errs

Deprecated.

showErrors

protected boolean showErrors

Deprecated.

Constructor Detail

RecordDatasetHelper

public RecordDatasetHelper(ucar.nc2.dataset.NetcdfDataset ncfile,
                           String obsTimeVName,
                           String nomTimeVName,
                           List typedDataVariables)

Deprecated.

Constructor.

Parameters:

ncfile - the netccdf file

typedDataVariables - list of data variables; all record variables will be added to this list, except . You can remove extra

obsTimeVName - observation time variable name (required)

nomTimeVName - nominal time variable name (may be null)

Throws:

IllegalArgumentException - if ncfile has no unlimited dimension.

RecordDatasetHelper

public RecordDatasetHelper(ucar.nc2.dataset.NetcdfDataset ncfile,
                           String obsTimeVName,
                           String nomTimeVName,
                           List typedDataVariables,
                           StringBuffer errBuffer)

Deprecated.

RecordDatasetHelper

public RecordDatasetHelper(ucar.nc2.dataset.NetcdfDataset ncfile,
                           String obsTimeVName,
                           String nomTimeVName,
                           List typedDataVariables,
                           String recDimName,
                           StringBuffer errBuffer)

Deprecated.

Constructor.

Parameters:

ncfile - the netccdf file

typedDataVariables - list of data variables; all record variables will be added to this list, except . You can remove extra

obsTimeVName - observation time variable name (required)

nomTimeVName - nominal time variable name (may be null)

Throws:

IllegalArgumentException - if ncfile has no unlimited dimension and recDimName is null.

Method Detail

setStationInfo

public void setStationInfo(String stnIdVName,
                           String stnDescVName)

Deprecated.

Set extra information used by station obs datasets.

Parameters:

stnIdVName - the obs variable that is used to find the station in the stnHash; may be type int or a String (char).

stnDescVName - optional station var containing station description

setLocationInfo

public void setLocationInfo(String latVName,
                            String lonVName,
                            String altVName)

Deprecated.

getRecordVar

public ucar.nc2.Structure getRecordVar()

Deprecated.

getRecordCount

public int getRecordCount()

Deprecated.

setTimeUnit

public void setTimeUnit(ucar.nc2.units.DateUnit timeUnit)

Deprecated.

getTimeUnit

public ucar.nc2.units.DateUnit getTimeUnit()

Deprecated.

readAllCreateObs

public ArrayList readAllCreateObs(ucar.nc2.util.CancelTask cancel)
                           throws IOException

Deprecated.

This reads through all the records in the dataset, and constructs a list of RecordPointObs or RecordStationObs. It does not cache the data.

If stnIdVName is not null, its a StationDataset, then construct a Station HashMap of StationImpl objects. Add the RecordStationObs into the list of obs for that station.

Parameters:

cancel - allow user to cancel

Returns:

List of RecordPointObs or RecordStationObs

Throws:

IOException

setShortNames

public void setShortNames(String latVName,
                          String lonVName,
                          String altVName,
                          String obsTimeVName,
                          String nomTimeVName)

Deprecated.

getData

public List getData(ArrayList records,
                    ucar.unidata.geoloc.LatLonRect boundingBox,
                    ucar.nc2.util.CancelTask cancel)
             throws IOException

Deprecated.

Throws:

IOException

getData

public List getData(ArrayList records,
                    ucar.unidata.geoloc.LatLonRect boundingBox,
                    double startTime,
                    double endTime,
                    ucar.nc2.util.CancelTask cancel)
             throws IOException

Deprecated.

Throws:

IOException