ucar.nc2.dt.point

Class RecordDatasetHelper

java.lang.Object

ucar.nc2.dt.point.RecordDatasetHelper

Deprecated.

use ucar.nc2.ft.*

public class RecordDatasetHelper
extends java.lang.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 java.lang.String	altVName Deprecated.
protected LatLonRect	boundingBox Deprecated.
protected java.lang.StringBuffer	errs Deprecated.
protected java.lang.String	latVName Deprecated.
protected java.lang.String	lonVName Deprecated.
protected double	maxDate Deprecated.
protected double	minDate Deprecated.
protected NetcdfDataset	ncfile Deprecated.
protected java.lang.String	nomTimeVName Deprecated.
protected Dimension	obsDim Deprecated.
protected java.lang.String	obsTimeVName Deprecated.
protected StructureDS	recordVar Deprecated.
protected boolean	showErrors Deprecated.
protected DataType	stationIdType Deprecated.
protected java.lang.String	stnDescVName Deprecated.
protected java.util.Map<java.lang.Object,Station>	stnHash Deprecated.
protected java.lang.String	stnIdVName Deprecated.
protected java.lang.String	stnNameVName Deprecated.
protected DateUnit	timeUnit Deprecated.

Constructor Summary

Constructors

Constructor and Description
RecordDatasetHelper(NetcdfDataset ncfile, java.lang.String obsTimeVName, java.lang.String nomTimeVName, java.util.List typedDataVariables) Deprecated. Constructor.
RecordDatasetHelper(NetcdfDataset ncfile, java.lang.String obsTimeVName, java.lang.String nomTimeVName, java.util.List typedDataVariables, java.lang.StringBuffer errBuffer) Deprecated.
RecordDatasetHelper(NetcdfDataset ncfile, java.lang.String obsTimeVName, java.lang.String nomTimeVName, java.util.List typedDataVariables, java.lang.String recDimName, java.lang.StringBuffer errBuffer) Deprecated. Constructor.

Method Summary

Modifier and Type	Method and Description
java.util.List	getData(java.util.ArrayList records, LatLonRect boundingBox, CancelTask cancel) Deprecated.
java.util.List	getData(java.util.ArrayList records, LatLonRect boundingBox, double startTime, double endTime, CancelTask cancel) Deprecated.
int	getRecordCount() Deprecated.
Structure	getRecordVar() Deprecated.
DateUnit	getTimeUnit() Deprecated.
java.util.ArrayList	readAllCreateObs(CancelTask cancel) Deprecated. This reads through all the records in the dataset, and constructs a list of RecordPointObs or RecordStationObs.
void	setLocationInfo(java.lang.String latVName, java.lang.String lonVName, java.lang.String altVName) Deprecated.
void	setShortNames(java.lang.String latVName, java.lang.String lonVName, java.lang.String altVName, java.lang.String obsTimeVName, java.lang.String nomTimeVName) Deprecated.
void	setStationInfo(java.lang.String stnIdVName, java.lang.String stnDescVName) Deprecated. Set extra information used by station obs datasets.
void	setTimeUnit(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 NetcdfDataset ncfile

Deprecated.

obsTimeVName

protected java.lang.String obsTimeVName

Deprecated.

nomTimeVName

protected java.lang.String nomTimeVName

Deprecated.

stnIdVName

protected java.lang.String stnIdVName

Deprecated.

stnNameVName

protected java.lang.String stnNameVName

Deprecated.

stnDescVName

protected java.lang.String stnDescVName

Deprecated.

latVName

protected java.lang.String latVName

Deprecated.

lonVName

protected java.lang.String lonVName

Deprecated.

altVName

protected java.lang.String altVName

Deprecated.

stationIdType

protected DataType stationIdType

Deprecated.

stnHash

protected java.util.Map<java.lang.Object,Station> stnHash

Deprecated.

recordVar

protected StructureDS recordVar

Deprecated.

obsDim

protected Dimension obsDim

Deprecated.

boundingBox

protected LatLonRect boundingBox

Deprecated.

minDate

protected double minDate

Deprecated.

maxDate

protected double maxDate

Deprecated.

timeUnit

protected DateUnit timeUnit

Deprecated.

altScaleFactor

protected double altScaleFactor

Deprecated.

errs

protected java.lang.StringBuffer errs

Deprecated.

showErrors

protected boolean showErrors

Deprecated.

Constructor Detail

RecordDatasetHelper

public RecordDatasetHelper(NetcdfDataset ncfile,
                           java.lang.String obsTimeVName,
                           java.lang.String nomTimeVName,
                           java.util.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:

java.lang.IllegalArgumentException - if ncfile has no unlimited dimension.

RecordDatasetHelper

public RecordDatasetHelper(NetcdfDataset ncfile,
                           java.lang.String obsTimeVName,
                           java.lang.String nomTimeVName,
                           java.util.List typedDataVariables,
                           java.lang.StringBuffer errBuffer)

Deprecated.

RecordDatasetHelper

public RecordDatasetHelper(NetcdfDataset ncfile,
                           java.lang.String obsTimeVName,
                           java.lang.String nomTimeVName,
                           java.util.List typedDataVariables,
                           java.lang.String recDimName,
                           java.lang.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:

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

Method Detail

setStationInfo

public void setStationInfo(java.lang.String stnIdVName,
                           java.lang.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(java.lang.String latVName,
                            java.lang.String lonVName,
                            java.lang.String altVName)

Deprecated.

getRecordVar

public Structure getRecordVar()

Deprecated.

getRecordCount

public int getRecordCount()

Deprecated.

setTimeUnit

public void setTimeUnit(DateUnit timeUnit)

Deprecated.

getTimeUnit

public DateUnit getTimeUnit()

Deprecated.

readAllCreateObs

public java.util.ArrayList readAllCreateObs(CancelTask cancel)
                                     throws java.io.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:

java.io.IOException

setShortNames

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

Deprecated.

getData

public java.util.List getData(java.util.ArrayList records,
                              LatLonRect boundingBox,
                              CancelTask cancel)
                       throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

getData

public java.util.List getData(java.util.ArrayList records,
                              LatLonRect boundingBox,
                              double startTime,
                              double endTime,
                              CancelTask cancel)
                       throws java.io.IOException

Deprecated.

Throws:

java.io.IOException