ucar.nc2.ft

Interface FeatureDataset

All Superinterfaces:

AutoCloseable, Closeable, ucar.nc2.util.cache.FileCacheable

All Known Subinterfaces:

FeatureDatasetPoint, RadialDatasetSweep, StationRadialDataset

All Known Implementing Classes:

FeatureDatasetCoverage, FeatureDatasetImpl, PointDatasetImpl

public interface FeatureDataset
extends ucar.nc2.util.cache.FileCacheable, Closeable

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.

Method Summary

Modifier and Type	Method and Description
void	close() Close all resources associated with this dataset.
Attribute	findGlobalAttributeIgnoreCase(String name) Return the global attribute with the given name, ignoring case.
LatLonRect	getBoundingBox() The lat/lon boundingBox for the entire dataset.
CalendarDate	getCalendarDateEnd() Ending Calendar date for the entire dataset.
CalendarDateRange	getCalendarDateRange() Calendar Date range for the entire dataset.
CalendarDate	getCalendarDateStart() Starting Calendar date for the entire dataset.
VariableSimpleIF	getDataVariable(String shortName) Get the named data Variable.
List<VariableSimpleIF>	getDataVariables() The data Variables available in this dataset.
String	getDescription() Text information about this dataset.
void	getDetailInfo(Formatter sf) Show debug / underlying implementation details
FeatureType	getFeatureType() Contains collections of this FeatureType.
List<Attribute>	getGlobalAttributes() List of global attributes.
String	getImplementationName() Show who is implementing
String	getLocation() The URI location of the dataset
NetcdfFile	getNetcdfFile() Return underlying NetcdfFile, or null if none.
String	getTitle() Title of the dataset.

Methods inherited from interface ucar.nc2.util.cache.FileCacheable

getLastModified, reacquire, release, setFileCache

Method Detail

getFeatureType

FeatureType getFeatureType()

Contains collections of this FeatureType.

Returns:

FeatureType of data

getTitle

String getTitle()

Title of the dataset.

Returns:

the title of the dataset, or null

getDescription

String getDescription()

Text information about this dataset.

Returns:

any text information about this dataset, or null.

getLocation

String getLocation()

The URI location of the dataset

Specified by:

getLocation in interface ucar.nc2.util.cache.FileCacheable

Returns:

the URI location of the dataset, or null

getCalendarDateRange

CalendarDateRange getCalendarDateRange()

Calendar Date range for the entire dataset.

Returns:

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

getCalendarDateStart

CalendarDate getCalendarDateStart()

Starting Calendar date for the entire dataset.

Returns:

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

getCalendarDateEnd

CalendarDate getCalendarDateEnd()

Ending Calendar date for the entire dataset.

Returns:

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

getBoundingBox

LatLonRect getBoundingBox()

The lat/lon boundingBox for the entire dataset.

Returns:

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

getGlobalAttributes

List<Attribute> getGlobalAttributes()

List of global attributes.

Returns:

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

findGlobalAttributeIgnoreCase

Attribute findGlobalAttributeIgnoreCase(String name)

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

Parameters:

name - attribute name

Returns:

the global attribute, or null

getDataVariables

List<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 shapes of the VariableSimpleIF do not necessarily match the StructureData member.

Returns:

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

getDataVariable

VariableSimpleIF getDataVariable(String shortName)

Get the named data Variable.

Parameters:

shortName - of data Variable.

Returns:

VariableSimpleIF or null if not found

getNetcdfFile

@Nullable
NetcdfFile getNetcdfFile()

Return underlying NetcdfFile, or null if none.

Returns:

the underlying NetcdfFile, or null if none.

close

void close()
    throws IOException

Close all resources associated with this dataset.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface ucar.nc2.util.cache.FileCacheable

Throws:

IOException - on i/o error

getDetailInfo

void getDetailInfo(Formatter sf)

Show debug / underlying implementation details

Parameters:

sf - append info here

getImplementationName

String getImplementationName()

Show who is implementing

Returns:

name of implementor