FeatureDataset (All javadoc for netcdf-java version 4.6.22-SNAPSHOT)

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, FileCacheable

All Known Subinterfaces:

CoverageDataset, FeatureDatasetPoint, RadialDatasetSweep, StationRadialDataset, StationRadialDataset

All Known Implementing Classes:

CFnetCDF2Dataset, CoverageDatasetImpl, Dorade2Dataset, FeatureDatasetImpl, GridDataset, LevelII2Dataset, Netcdf2Dataset, Nids2Dataset, PointDatasetImpl, PointDatasetRemote, RadialDatasetSweepAdapter, UF2Dataset
```
public interface FeatureDataset
extends FileCacheable, java.io.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

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`calcBounds()` Caclulate date range and bounding box, even if the data has to be scanned.
`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.
`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(java.lang.String shortName)` Get the named data Variable.
`java.util.List<VariableSimpleIF>`	`getDataVariables()` The data Variables available in this dataset.
`DateRange`	`getDateRange()` Deprecated. use getCalendarDateRange
`java.lang.String`	`getDescription()` Text information about this dataset.
`void`	`getDetailInfo(java.util.Formatter sf)` Show debug / underlying implementation details
`java.util.Date`	`getEndDate()` Deprecated. use getCalendarDateEnd
`FeatureType`	`getFeatureType()` Contains collections of this FeatureType.
`java.util.List<Attribute>`	`getGlobalAttributes()` List of global attributes.
`java.lang.String`	`getImplementationName()` Show who is implementing
`java.lang.String`	`getLocation()` The URI location of the dataset
`NetcdfFile`	`getNetcdfFile()` Return underlying NetcdfFile, or null if none.
`java.util.Date`	`getStartDate()` Deprecated. use getCalendarDateStart
`java.lang.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
```
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.
  - getLocation
```
java.lang.String getLocation()
```
    The URI location of the dataset
    
    Specified by:
    
    getLocation in interface 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 boundingBox for the entire dataset.
    
    Returns:
    
    the lat/lon boundingBox for the entire dataset, or null if unknown.
  - calcBounds
```
void calcBounds()
         throws java.io.IOException
```
    Caclulate date range and bounding box, even if the data has to be scanned. This ensures that getDateRange() and getBoundingBox() return non-null. If the collection already knows its date range and bounding box, then this has no effect.
    
    Throws:
    
    java.io.IOException - or read error.
  - getGlobalAttributes
```
java.util.List<Attribute> 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<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(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.
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Specified by:
    
    close in interface java.io.Closeable
    
    Specified by:
    
    close in interface FileCacheable
    
    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
  - getImplementationName
```
java.lang.String getImplementationName()
```
    Show who is implementing
    
    Returns:
    
    name of implementor
  - getDateRange
```
DateRange getDateRange()
```
    Deprecated. use getCalendarDateRange
    
    Date range for the entire dataset.
    
    Returns:
    
    the date range for the entire dataset, or null if unknown
  - getStartDate
```
java.util.Date getStartDate()
```
    Deprecated. use getCalendarDateStart
    
    Starting date for the entire dataset.
    
    Returns:
    
    the starting date for the entire dataset, or null if unknown
  - getEndDate
```
java.util.Date getEndDate()
```
    Deprecated. use getCalendarDateEnd
    
    Ending date for the entire dataset.
    
    Returns:
    
    the ending date for the entire dataset, or null if unknown

Interface FeatureDataset

Method Summary

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

Method Detail

getFeatureType

getTitle

getDescription

getLocation

getCalendarDateRange

getCalendarDateStart

getCalendarDateEnd

getBoundingBox

calcBounds

getGlobalAttributes

findGlobalAttributeIgnoreCase

getDataVariables

getDataVariable

getNetcdfFile

close

getDetailInfo

getImplementationName

getDateRange

getStartDate

getEndDate