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

java.lang.Object
- ucar.nc2.ft.cover.impl.CoverageDatasetImpl

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, CoverageDataset, FeatureDataset, FileCacheable
```
public class CoverageDatasetImpl
extends java.lang.Object
implements CoverageDataset
```
CoverageDataset Implementation

Since:

12/25/12

Nested Class Summary
- Nested classes/interfaces inherited from interface ucar.nc2.ft.cover.CoverageDataset
  CoverageDataset.CoverageSet

Constructor Summary

Constructors
Constructor and Description

CoverageDatasetImpl(NetcdfDataset ds, java.util.Formatter parseInfo)

Constructors
Constructor and Description
`CoverageDatasetImpl(NetcdfDataset ds, java.util.Formatter parseInfo)`

Method Summary

All Methods Instance Methods Concrete 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.
`Coverage`	`findCoverage(java.lang.String name)` find the named Coverage.
`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.
`java.util.List<Coverage>`	`getCoverages()` get the list of Coverage objects contained in this dataset.
`java.util.List<CoverageDataset.CoverageSet>`	`getCoverageSets()` Return Coverage objects grouped by CoverageSet.
`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()` 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<Attribute>`	`getGlobalAttributes()` List of global attributes.
`java.lang.String`	`getImplementationName()` Show who is implementing
`long`	`getLastModified()` Returns the time that the underlying file(s) were last modified.
`java.lang.String`	`getLocation()` 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.
`CoverageCS.Type`	`getType()`
`void`	`reacquire()`
`void`	`release()`
`void`	`setFileCache(FileCacheIF fileCache)` If the FileCache is not null, FileCacheable.close() must call FileCache.release()

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CoverageDatasetImpl
```
public CoverageDatasetImpl(NetcdfDataset ds,
                           java.util.Formatter parseInfo)
```
- Method Detail
  - getCoverages
```
public java.util.List<Coverage> getCoverages()
```
    Description copied from interface: CoverageDataset
    
    get the list of Coverage objects contained in this dataset.
    
    Specified by:
    
    getCoverages in interface CoverageDataset
    
    Returns:
    
    list of Coverage
  - findCoverage
```
public Coverage findCoverage(java.lang.String name)
```
    Description copied from interface: CoverageDataset
    
    find the named Coverage.
    
    Specified by:
    
    findCoverage in interface CoverageDataset
    
    Parameters:
    
    name - full unescaped name
    
    Returns:
    
    the named Coverage, or null if not found
  - getType
```
public CoverageCS.Type getType()
```
  - getCoverageSets
```
public java.util.List<CoverageDataset.CoverageSet> getCoverageSets()
```
    Description copied from interface: CoverageDataset
    
    Return Coverage objects grouped by CoverageSet. All Coverage in a CoverageSet have the same CoverageCS.
    
    Specified by:
    
    getCoverageSets in interface CoverageDataset
    
    Returns:
    
    List of type GridDataset.Gridset
  - getFeatureType
```
public FeatureType getFeatureType()
```
    Description copied from interface: FeatureDataset
    
    Contains collections of this FeatureType.
    
    Specified by:
    
    getFeatureType in interface FeatureDataset
    
    Returns:
    
    FeatureType of data
  - getTitle
```
public java.lang.String getTitle()
```
    Description copied from interface: FeatureDataset
    
    Title of the dataset.
    
    Specified by:
    
    getTitle in interface FeatureDataset
    
    Returns:
    
    the title of the dataset, or null
  - getDescription
```
public java.lang.String getDescription()
```
    Description copied from interface: FeatureDataset
    
    Text information about this dataset.
    
    Specified by:
    
    getDescription in interface FeatureDataset
    
    Returns:
    
    any text information about this dataset, or null.
  - getLocation
```
public java.lang.String getLocation()
```
    Description copied from interface: FeatureDataset
    
    The URI location of the dataset
    
    Specified by:
    
    getLocation in interface FeatureDataset
    
    Specified by:
    
    getLocation in interface FileCacheable
    
    Returns:
    
    the URI location of the dataset, or null
  - getCalendarDateRange
```
public CalendarDateRange getCalendarDateRange()
```
    Description copied from interface: FeatureDataset
    
    Calendar Date range for the entire dataset.
    
    Specified by:
    
    getCalendarDateRange in interface FeatureDataset
    
    Returns:
    
    the date range for the entire dataset, or null if unknown
  - getCalendarDateStart
```
public CalendarDate getCalendarDateStart()
```
    Description copied from interface: FeatureDataset
    
    Starting Calendar date for the entire dataset.
    
    Specified by:
    
    getCalendarDateStart in interface FeatureDataset
    
    Returns:
    
    the starting date for the entire dataset, or null if unknown
  - getCalendarDateEnd
```
public CalendarDate getCalendarDateEnd()
```
    Description copied from interface: FeatureDataset
    
    Ending Calendar date for the entire dataset.
    
    Specified by:
    
    getCalendarDateEnd in interface FeatureDataset
    
    Returns:
    
    the ending date for the entire dataset, or null if unknown
  - getBoundingBox
```
public LatLonRect getBoundingBox()
```
    Description copied from interface: FeatureDataset
    
    The boundingBox for the entire dataset.
    
    Specified by:
    
    getBoundingBox in interface FeatureDataset
    
    Returns:
    
    the lat/lon boundingBox for the entire dataset, or null if unknown.
  - calcBounds
```
public void calcBounds()
                throws java.io.IOException
```
    Description copied from interface: FeatureDataset
    
    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.
    
    Specified by:
    
    calcBounds in interface FeatureDataset
    
    Throws:
    
    java.io.IOException - or read error.
  - getGlobalAttributes
```
public java.util.List<Attribute> getGlobalAttributes()
```
    Description copied from interface: FeatureDataset
    
    List of global attributes.
    
    Specified by:
    
    getGlobalAttributes in interface FeatureDataset
    
    Returns:
    
    List of type ucar.nc2.Attribute, may be empty but not null
  - findGlobalAttributeIgnoreCase
```
public Attribute findGlobalAttributeIgnoreCase(java.lang.String name)
```
    Description copied from interface: FeatureDataset
    
    Return the global attribute with the given name, ignoring case.
    
    Specified by:
    
    findGlobalAttributeIgnoreCase in interface FeatureDataset
    
    Parameters:
    
    name - attribute name
    
    Returns:
    
    the global attribute, or null
  - getDataVariables
```
public java.util.List<VariableSimpleIF> getDataVariables()
```
    Description copied from interface: FeatureDataset
    
    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.
    
    Specified by:
    
    getDataVariables in interface FeatureDataset
    
    Returns:
    
    List of subclass of VariableSimpleIF, may be empty but not null
  - getDataVariable
```
public VariableSimpleIF getDataVariable(java.lang.String shortName)
```
    Description copied from interface: FeatureDataset
    
    Get the named data Variable.
    
    Specified by:
    
    getDataVariable in interface FeatureDataset
    
    Parameters:
    
    shortName - of data Variable.
    
    Returns:
    
    VariableSimpleIF or null if not found
  - getNetcdfFile
```
public NetcdfFile getNetcdfFile()
```
    Description copied from interface: FeatureDataset
    
    Return underlying NetcdfFile, or null if none.
    
    Specified by:
    
    getNetcdfFile in interface FeatureDataset
    
    Returns:
    
    the underlying NetcdfFile, or null if none.
  - close
```
public void close()
           throws java.io.IOException
```
    Description copied from interface: FeatureDataset
    
    Close all resources associated with this dataset.
    
    Specified by:
    
    close in interface java.io.Closeable
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Specified by:
    
    close in interface FeatureDataset
    
    Specified by:
    
    close in interface FileCacheable
    
    Throws:
    
    java.io.IOException - on io error
  - release
```
public void release()
             throws java.io.IOException
```
    Specified by:
    
    release in interface FileCacheable
    
    Throws:
    
    java.io.IOException
  - reacquire
```
public void reacquire()
               throws java.io.IOException
```
    Specified by:
    
    reacquire in interface FileCacheable
    
    Throws:
    
    java.io.IOException
  - getLastModified
```
public long getLastModified()
```
    Description copied from interface: FileCacheable
    
    Returns the time that the underlying file(s) were last modified. If they've changed since they were stored in the cache, they will be closed and reopened with FileFactory.
    
    Specified by:
    
    getLastModified in interface FileCacheable
    
    Returns:
    
    a long value representing the time the file(s) were last modified or 0L if the last-modified time couldn't be determined for any reason.
  - setFileCache
```
public void setFileCache(FileCacheIF fileCache)
```
    Description copied from interface: FileCacheable
    If the FileCache is not null, FileCacheable.close() must call FileCache.release()
```
  public synchronized void close() throws java.io.IOException {
    if (cache != null) {
      if (cache.release(this)) return;
    }

    reallyClose();
  } 
```
    Specified by:
    
    setFileCache in interface FileCacheable
    
    Parameters:
    
    fileCache - must store this, use it on close as above.
  - getDetailInfo
```
public void getDetailInfo(java.util.Formatter sf)
```
    Description copied from interface: FeatureDataset
    
    Show debug / underlying implementation details
    
    Specified by:
    
    getDetailInfo in interface FeatureDataset
    
    Parameters:
    
    sf - append info here
  - getImplementationName
```
public java.lang.String getImplementationName()
```
    Description copied from interface: FeatureDataset
    
    Show who is implementing
    
    Specified by:
    
    getImplementationName in interface FeatureDataset
    
    Returns:
    
    name of implementor
  - getDateRange
```
public DateRange getDateRange()
```
    Description copied from interface: FeatureDataset
    
    Date range for the entire dataset.
    
    Specified by:
    
    getDateRange in interface FeatureDataset
    
    Returns:
    
    the date range for the entire dataset, or null if unknown
  - getStartDate
```
public java.util.Date getStartDate()
```
    Description copied from interface: FeatureDataset
    
    Starting date for the entire dataset.
    
    Specified by:
    
    getStartDate in interface FeatureDataset
    
    Returns:
    
    the starting date for the entire dataset, or null if unknown
  - getEndDate
```
public java.util.Date getEndDate()
```
    Description copied from interface: FeatureDataset
    
    Ending date for the entire dataset.
    
    Specified by:
    
    getEndDate in interface FeatureDataset
    
    Returns:
    
    the ending date for the entire dataset, or null if unknown

Class CoverageDatasetImpl

Nested Class Summary

Nested classes/interfaces inherited from interface ucar.nc2.ft.cover.CoverageDataset

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CoverageDatasetImpl

Method Detail

getCoverages

findCoverage

getType

getCoverageSets

getFeatureType

getTitle

getDescription

getLocation

getCalendarDateRange

getCalendarDateStart

getCalendarDateEnd

getBoundingBox

calcBounds

getGlobalAttributes

findGlobalAttributeIgnoreCase

getDataVariables

getDataVariable

getNetcdfFile

close

release

reacquire

getLastModified

setFileCache

getDetailInfo

getImplementationName

getDateRange

getStartDate

getEndDate