ucar.nc2.dt
Interface TypedDataset

All Known Subinterfaces:
GridDataset, PointObsDataset, RadialDatasetSweep, StationObsDataset, StationRadialDataset, TrajectoryObsDataset
All Known Implementing Classes:
TypedDatasetImpl

public interface TypedDataset

Superclass for "scientific type" datasets. This interface defines general "discovery metadata". Its subtypes define type-specific information. Implementations may or may not have a NetcdfFile underneath.

Author:
caron

Method Summary
 void close()
          Close all resources associated with this dataset.
 Attribute findGlobalAttributeIgnoreCase(java.lang.String name)
           
 LatLonRect getBoundingBox()
           
 VariableSimpleIF getDataVariable(java.lang.String shortName)
          Get the named data Variable.
 java.util.List<VariableSimpleIF> getDataVariables()
          The data Variables available in this dataset.
 java.lang.String getDescription()
           
 java.lang.String getDetailInfo()
           
 java.util.Date getEndDate()
           
 java.util.List<Attribute> getGlobalAttributes()
          List of global attributes.
 java.lang.String getLocationURI()
           
 NetcdfFile getNetcdfFile()
           
 java.util.Date getStartDate()
           
 java.lang.String getTitle()
           
 

Method Detail

getTitle

java.lang.String getTitle()
Returns:
Title of the dataset.

getDescription

java.lang.String getDescription()
Returns:
Text information about this dataset.

getLocationURI

java.lang.String getLocationURI()
Returns:
The URI location of the dataset

getStartDate

java.util.Date getStartDate()
Returns:
Start date for the entire dataset.

getEndDate

java.util.Date getEndDate()
Returns:
End date for the entire dataset.

getBoundingBox

LatLonRect getBoundingBox()
Returns:
the boundingBox for the entire dataset.

getGlobalAttributes

java.util.List<Attribute> getGlobalAttributes()
List of global attributes.

Returns:
List of type ucar.nc2.Attribute

findGlobalAttributeIgnoreCase

Attribute findGlobalAttributeIgnoreCase(java.lang.String name)
Parameters:
name - attribute name
Returns:
the global attribute with the given name, ingnoring case.

getDataVariables

java.util.List<VariableSimpleIF> getDataVariables()
The data Variables available in this dataset. Should just be data variable others might be searching for, not metadata or coordinate system variables, etc. The shape of this VariableSimpleIF does not necessarily match the

Returns:
List of type VariableSimpleIF

getDataVariable

VariableSimpleIF getDataVariable(java.lang.String shortName)
Get the named data Variable.

Parameters:
shortName - of data Variable.
Returns:
VariableSimpleIF or null.

getNetcdfFile

NetcdfFile getNetcdfFile()
Returns:
underlying NetcdfFile, or null if none.

close

void close()
           throws java.io.IOException
Close all resources associated with this dataset.

Throws:
java.io.IOException - on I/O error

getDetailInfo

java.lang.String getDetailInfo()
Returns:
debug / underlying implementation details