ucar.nc2.ft.grid.impl

Class CoverageDatasetImpl

java.lang.Object

ucar.nc2.ft.grid.impl.CoverageDatasetImpl

All Implemented Interfaces:

FeatureDataset, CoverageDataset, FileCacheable

public class CoverageDatasetImpl
extends Object
implements CoverageDataset

Description

Since:

12/25/12

Author:

John

Nested Class Summary

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

CoverageDataset.CoverageSet

Constructor Summary

Constructors

Constructor and Description
CoverageDatasetImpl(NetcdfDataset ds, Formatter parseInfo)

Method Summary

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(String name) find the named GridDatatype.
Attribute	findGlobalAttributeIgnoreCase(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.
List<Coverage>	getCoverages() get the list of GridDatatype objects contained in this dataset.
List<CoverageDataset.CoverageSet>	getCoverageSets() Return GridDatatype objects grouped by GridCoordSystem.
VariableSimpleIF	getDataVariable(String shortName) Get the named data Variable.
List<VariableSimpleIF>	getDataVariables() The data Variables available in this dataset.
DateRange	getDateRange() Date range for the entire dataset.
String	getDescription() Text information about this dataset.
void	getDetailInfo(Formatter sf) Show debug / underlying implementation details
Date	getEndDate() Ending date for the entire dataset.
FeatureType	getFeatureType() Contains collections of this FeatureType.
List<Attribute>	getGlobalAttributes() List of global attributes.
String	getImplementationName() Show who is implementing
long	getLastModified() Get last modified date of underlying file.
String	getLocation() The URI location of the dataset
NetcdfFile	getNetcdfFile() Return underlying NetcdfFile, or null if none.
Date	getStartDate() Starting date for the entire dataset.
String	getTitle() Title of the dataset.
void	setFileCache(FileCache fileCache) If the FileCache is set, the FileCacheable object must store it and call FileCache.release() on FileCacheable.close():

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,
                   Formatter parseInfo)

Method Detail

getCoverages

public List<Coverage> getCoverages()

Description copied from interface: CoverageDataset

get the list of GridDatatype objects contained in this dataset.

Specified by:

getCoverages in interface CoverageDataset

Returns:

list of GridDatatype

findCoverage

public Coverage findCoverage(String name)

Description copied from interface: CoverageDataset

find the named GridDatatype.

Specified by:

findCoverage in interface CoverageDataset

Parameters:

name - full unescaped name

Returns:

the named GridDatatype, or null if not found

getCoverageSets

public List<CoverageDataset.CoverageSet> getCoverageSets()

Description copied from interface: CoverageDataset

Return GridDatatype objects grouped by GridCoordSystem. All GridDatatype in a Gridset have the same GridCoordSystem.

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 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 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 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 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:

IOException - or read error.

getGlobalAttributes

public 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(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 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(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 IOException

Description copied from interface: FeatureDataset

Close all resources associated with this dataset.

Specified by:

close in interface FeatureDataset

Specified by:

close in interface FileCacheable

Throws:

IOException - on io error

getLastModified

public long getLastModified()

Description copied from interface: FileCacheable

Get last modified date of underlying file. If changes, will be discarded.

Specified by:

getLastModified in interface FileCacheable

Returns:

a sequence number (typically file date), 0 if cannot change

setFileCache

public void setFileCache(FileCache fileCache)

Description copied from interface: FileCacheable

If the FileCache is set, the FileCacheable object must store it and call FileCache.release() on FileCacheable.close():

  public synchronized void close() throws java.io.IOException {
    if (cache != null) {
      cache.release(this);
    } else {
      reallyClose();
    }
   

Specified by:

setFileCache in interface FileCacheable

Parameters:

fileCache - must store this, use it on close as above.

getDetailInfo

public void getDetailInfo(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 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 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 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