ucar.nc2.ft
Interface FeatureDataset

All Known Subinterfaces:

FeatureDatasetPoint, StationRadialDataset

All Known Implementing Classes:

FeatureDatasetImpl, PointDatasetImpl

public interface FeatureDataset

Superclass for "scientific feature type" datasets. These are collections of features of the same feature type.

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) Return the global attribute with the given name, ignoring case.
LatLonRect	getBoundingBox() The boundingBox for the entire dataset.
VariableSimpleIF	getDataVariable(java.lang.String shortName) Get the named data Variable.
java.util.List<? extends VariableSimpleIF>	getDataVariables() The data Variables available in this dataset.
DateRange	getDateRange() Date range for the entire dataset.
java.lang.String	getDescription() Text information about this dataset.
void	getDetailInfo(java.util.Formatter sf) Show debug / underlying implementation details
java.util.Date	getEndDate() Ending date for the entire dataset.
FeatureType	getFeatureType() Contains collections of this FeatureType.
java.util.List	getGlobalAttributes() List of global attributes.
java.lang.String	getLocationURI() The URI location of the dataset
NetcdfFile	getNetcdfFile() Return underlying NetcdfFile, or null if none.
java.util.Date	getStartDate() Starting date for the entire dataset.
java.lang.String	getTitle() Title of the dataset.

Method Detail

getFeatureType

FeatureType getFeatureType()

Contains collections of this FeatureType.

Returns:

FeatureType of data

getTitle

java.lang.String getTitle()

Title of the dataset.

Returns:

the title of the dataset, or null

getDescription

java.lang.String getDescription()

Text information about this dataset.

Returns:

any text information about this dataset, or null.

getLocationURI

java.lang.String getLocationURI()

The URI location of the dataset

Returns:

the URI location of the dataset, or null

getDateRange

DateRange getDateRange()

Date range for the entire dataset.

Returns:

the date range for the entire dataset, or null if unknown

getStartDate

java.util.Date getStartDate()

Starting date for the entire dataset.

Returns:

the starting date for the entire dataset, or null if unknown

getEndDate

java.util.Date getEndDate()

Ending date for the entire dataset.

Returns:

the ending date for the entire dataset, or null if unknown

getBoundingBox

LatLonRect getBoundingBox()

The boundingBox for the entire dataset.

Returns:

the lat/lon boundingBox for the entire dataset, or null if unknown.

getGlobalAttributes

java.util.List getGlobalAttributes()

List of global attributes.

Returns:

List of type ucar.nc2.Attribute, may be empty but not null

findGlobalAttributeIgnoreCase

Attribute findGlobalAttributeIgnoreCase(java.lang.String name)

Return the global attribute with the given name, ignoring case.

Parameters:

name - attribute name

Returns:

the global attribute, or null

getDataVariables

java.util.List<? extends VariableSimpleIF> getDataVariables()

The data Variables available in this dataset. Should just be data variables others might be searching for, not metadata or coordinate system variables, etc. The shape of this VariableSimpleIF does not necessarily match the StuctureData member.

Returns:

List of subclass of VariableSimpleIF, may be empty but not null

getDataVariable

VariableSimpleIF getDataVariable(java.lang.String shortName)

Get the named data Variable.

Parameters:

shortName - of data Variable.

Returns:

VariableSimpleIF or null if not found

getNetcdfFile

NetcdfFile getNetcdfFile()

Return underlying NetcdfFile, or null if none.

Returns:

the 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

void getDetailInfo(java.util.Formatter sf)

Show debug / underlying implementation details

Parameters:

sf - append info here