ucar.nc2.dt
Interface TrajectoryObsDataset

All Superinterfaces:

TypedDataset

All Known Implementing Classes:

ARMTrajectoryObsDataset, COSMICTrajectoryObsDataset, Float10TrajectoryObsDataset, MultiTrajectoryObsDataset, RafTrajectoryObsDataset, SimpleTrajectoryObsDataset, SingleTrajectoryObsDataset, TrajectoryObsDatasetImpl, UnidataTrajectoryObsDataset, UnidataTrajectoryObsDataset2, ZebraClassTrajectoryObsDataset

public interface TrajectoryObsDataset
extends TypedDataset

A collection of TrajectoryObsDatatype. To open a data file as a TrajectoryObsDataset and access the trajectories it contains use TrajectoryObsDatasetFactory.open() and TrajectoryObsDataset.getTrajectories(), for example:

    TrajectoryObsDataset trajDs = TrajectoryObsDatasetFactory.open (uriString);
    for ( Iterator it = trajDs.getTrajectories().iterator(); it.hasNext(); )
    {
      TrajectoryObsDatatype traj = (TrajectoryObsDatatype) it.next();
    }
   

Author:

caron

Method Summary

List	getTrajectories() Get trajectories contained in this dataset.
TrajectoryObsDatatype	getTrajectory(String trajectoryId) Get the named trajectory
List<String>	getTrajectoryIds() Get a list of String IDs for the available trajectories.
boolean	syncExtend() 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 interface ucar.nc2.dt.TypedDataset

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

Method Detail

getTrajectoryIds

List<String> getTrajectoryIds()

Get a list of String IDs for the available trajectories.

Returns:

list of ids for this dataset

getTrajectories

List getTrajectories()

Get trajectories contained in this dataset.

Returns:

List of type TrajectoryObsDatatype.

getTrajectory

TrajectoryObsDatatype getTrajectory(String trajectoryId)

Get the named trajectory

Parameters:

trajectoryId - id of trajectory

Returns:

the named trajectory

syncExtend

boolean syncExtend()

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)

Returns:

true if syncronization was needed and sucessful, otherwise false.