ucar.nc2.dt.trajectory

Class MultiTrajectoryObsDataset

java.lang.Object

ucar.nc2.dt.TypedDatasetImpl

ucar.nc2.dt.trajectory.MultiTrajectoryObsDataset

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, TrajectoryObsDataset, TypedDataset

Direct Known Subclasses:

Float10TrajectoryObsDataset

Deprecated.

use ucar.nc2.ft.*

public class MultiTrajectoryObsDataset
extends TypedDatasetImpl
implements TrajectoryObsDataset

Superclass for for implementations of TrajectoryObsDataset using a NetcdfFile underneath that contains multiple trajectories. The file must have two coordinate variables one over time and one over the multiple trajectories, the time dimension may be UNLIMITED (if time is not UNLIMITED, there must be no UNLIMITED dimension). The file must also have a latitude variable, a longitude variable, and an elevation variable each over the time and trajectory dimension. All other trajectory variables must be on the time and trajectory dimension with other dimensions as needed. For instance:

 traj( traj)        - convertable to -> String
 time( time)        - convertable to -> double
 lat( time, traj)   - convertable to -> double
 lon( time, traj)   - convertable to -> double
 elev( time, traj)  - convertable to -> double
 var1( time, traj[, dim#]*)
 ...
 varM( time, traj[, dim#]*)
 

Since:

13 May 2005 16:12 -0600

Field Summary

Fields

Modifier and Type	Field and Description
protected ucar.nc2.Variable	elevVar Deprecated.
protected double	elevVarUnitsConversionFactor Deprecated.
protected ucar.nc2.Variable	latVar Deprecated.
protected ucar.nc2.Variable	lonVar Deprecated.
protected ucar.nc2.Structure	recordVar Deprecated.
protected ucar.nc2.Dimension	timeDim Deprecated.
protected ucar.nc2.Variable	timeVar Deprecated.
protected java.lang.String	timeVarUnitsString Deprecated.
protected ucar.nc2.Dimension	trajDim Deprecated.
protected java.util.List	trajectories Deprecated.
protected java.util.HashMap	trajectoriesMap Deprecated.
protected java.util.List	trajectoryIds Deprecated.
protected int	trajectoryNumPoint Deprecated.
protected java.util.HashMap	trajectoryVarsMap Deprecated.
protected ucar.nc2.Variable	trajVar Deprecated.

Fields inherited from class ucar.nc2.dt.TypedDatasetImpl

boundingBox, dataVariables, desc, endDate, location, netcdfDataset, parseInfo, startDate, title

Constructor Summary

Constructors

Constructor and Description
MultiTrajectoryObsDataset() Deprecated.
MultiTrajectoryObsDataset(ucar.nc2.dataset.NetcdfDataset ncfile) Deprecated.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDetailInfo() Deprecated.
protected static double	getMetersConversionFactor(java.lang.String unitsString) Deprecated.
java.util.List	getTrajectories() Deprecated. Get trajectories contained in this dataset.
TrajectoryObsDatatype	getTrajectory(java.lang.String trajectoryId) Deprecated. Get the named trajectory
java.util.List	getTrajectoryIds() Deprecated. Get a list of String IDs for the available trajectories.
protected void	setBoundingBox() Deprecated.
protected void	setEndDate() Deprecated.
protected void	setStartDate() Deprecated.
void	setTrajectoryInfo(ucar.nc2.Dimension trajDim, ucar.nc2.Variable trajVar, ucar.nc2.Dimension timeDim, ucar.nc2.Variable timeVar, ucar.nc2.Variable latVar, ucar.nc2.Variable lonVar, ucar.nc2.Variable elevVar) Deprecated. Setup needed for all MultiTrajectoryObsDatatypes.
boolean	syncExtend() Deprecated. Syncronize with the underlying dataset if it has been extended in a way that is compatible with the existing structural metadata (for instance, if the unlimited dimension has grown).

Methods inherited from class ucar.nc2.dt.TypedDatasetImpl

close, findGlobalAttributeIgnoreCase, getBoundingBox, getDataVariable, getDataVariables, getDescription, getEndDate, getGlobalAttributes, getLocation, getLocationURI, getNetcdfFile, getStartDate, getTitle, removeDataVariable, setDescription, setLocationURI, setTitle

Methods inherited from class java.lang.Object

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

Methods inherited from interface ucar.nc2.dt.TypedDataset

close, findGlobalAttributeIgnoreCase, getBoundingBox, getDataVariable, getDataVariables, getDescription, getEndDate, getGlobalAttributes, getLocationURI, getNetcdfFile, getStartDate, getTitle

Field Detail

trajDim

protected ucar.nc2.Dimension trajDim

Deprecated.

trajVar

protected ucar.nc2.Variable trajVar

Deprecated.

timeDim

protected ucar.nc2.Dimension timeDim

Deprecated.

timeVar

protected ucar.nc2.Variable timeVar

Deprecated.

recordVar

protected ucar.nc2.Structure recordVar

Deprecated.

latVar

protected ucar.nc2.Variable latVar

Deprecated.

lonVar

protected ucar.nc2.Variable lonVar

Deprecated.

elevVar

protected ucar.nc2.Variable elevVar

Deprecated.

timeVarUnitsString

protected java.lang.String timeVarUnitsString

Deprecated.

elevVarUnitsConversionFactor

protected double elevVarUnitsConversionFactor

Deprecated.

trajectoryIds

protected java.util.List trajectoryIds

Deprecated.

trajectories

protected java.util.List trajectories

Deprecated.

trajectoriesMap

protected java.util.HashMap trajectoriesMap

Deprecated.

trajectoryNumPoint

protected int trajectoryNumPoint

Deprecated.

trajectoryVarsMap

protected java.util.HashMap trajectoryVarsMap

Deprecated.

Constructor Detail

MultiTrajectoryObsDataset

public MultiTrajectoryObsDataset()

Deprecated.

MultiTrajectoryObsDataset

public MultiTrajectoryObsDataset(ucar.nc2.dataset.NetcdfDataset ncfile)

Deprecated.

Method Detail

setTrajectoryInfo

public void setTrajectoryInfo(ucar.nc2.Dimension trajDim,
                              ucar.nc2.Variable trajVar,
                              ucar.nc2.Dimension timeDim,
                              ucar.nc2.Variable timeVar,
                              ucar.nc2.Variable latVar,
                              ucar.nc2.Variable lonVar,
                              ucar.nc2.Variable elevVar)
                       throws java.io.IOException

Deprecated.

Setup needed for all MultiTrajectoryObsDatatypes. Units of time varible must be udunits time units. Units of latitude variable must be convertible to "degrees_north" by udunits. Units of longitude variable must be convertible to "degrees_east" by udunits. Units of altitude variable must be convertible to "meters" by udunits.

Throws:

java.lang.IllegalArgumentException - if units of time, latitude, longitude, or altitude variables are not as required.

java.io.IOException

getMetersConversionFactor

protected static double getMetersConversionFactor(java.lang.String unitsString)
                                           throws java.lang.Exception

Deprecated.

Throws:

java.lang.Exception

syncExtend

public boolean syncExtend()

Deprecated.

Description copied from interface: TrajectoryObsDataset

Syncronize with the underlying dataset if it has been extended in a way that is compatible with the existing structural metadata (for instance, if the unlimited dimension has grown). Return true if syncronization was needed and sucessful. Otherwise, return false. NOTE: For now, assuming growth of the unlimited dimension only allowed change. To get range for new extent only, use getRange( oldNumPoints + 1, newNumPoints, 1)

Specified by:

syncExtend in interface TrajectoryObsDataset

Returns:

true if syncronization was needed and sucessful, otherwise false.

setStartDate

protected void setStartDate()

Deprecated.

Specified by:

setStartDate in class TypedDatasetImpl

setEndDate

protected void setEndDate()

Deprecated.

Specified by:

setEndDate in class TypedDatasetImpl

setBoundingBox

protected void setBoundingBox()

Deprecated.

Specified by:

setBoundingBox in class TypedDatasetImpl

getTrajectoryIds

public java.util.List getTrajectoryIds()

Deprecated.

Description copied from interface: TrajectoryObsDataset

Get a list of String IDs for the available trajectories.

Specified by:

getTrajectoryIds in interface TrajectoryObsDataset

Returns:

list of ids for this dataset

getTrajectories

public java.util.List getTrajectories()

Deprecated.

Description copied from interface: TrajectoryObsDataset

Get trajectories contained in this dataset.

Specified by:

getTrajectories in interface TrajectoryObsDataset

Returns:

List of type TrajectoryObsDatatype.

getTrajectory

public TrajectoryObsDatatype getTrajectory(java.lang.String trajectoryId)

Deprecated.

Description copied from interface: TrajectoryObsDataset

Get the named trajectory

Specified by:

getTrajectory in interface TrajectoryObsDataset

Parameters:

trajectoryId - id of trajectory

Returns:

the named trajectory

getDetailInfo

public java.lang.String getDetailInfo()

Deprecated.

Specified by:

getDetailInfo in interface TypedDataset

Overrides:

getDetailInfo in class TypedDatasetImpl

Returns:

debug / underlying implementation details