ucar.nc2.dt.radial

Class AbstractRadialAdapter

java.lang.Object

ucar.nc2.dt.radial.AbstractRadialAdapter

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, RadialDatasetSweep, FeatureDataset, FeatureDatasetFactory, FileCacheable

Direct Known Subclasses:

CFRadialAdapter, Dorade2RadialAdapter, Nexrad2RadialAdapter, NidsRadialAdapter, NsslRadialAdapter, UF2RadialAdapter

public abstract class AbstractRadialAdapter
extends java.lang.Object
implements RadialDatasetSweep, FeatureDatasetFactory

Make a NetcdfDataset into a RadialDatasetSweep.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AbstractRadialAdapter.MyRadialVariableAdapter

Nested classes/interfaces inherited from interface ucar.nc2.dt.RadialDatasetSweep

RadialDatasetSweep.RadialVariable, RadialDatasetSweep.Sweep, RadialDatasetSweep.Type

Field Summary

Fields

Modifier and Type	Field and Description
protected LatLonRect	boundingBox
protected CalendarDateUnit	calDateUnits
protected java.util.HashMap	csHash
protected java.util.List<VariableSimpleIF>	dataVariables
protected DateUnit	dateUnits
protected java.lang.String	desc
protected java.util.Date	endDate
protected FileCacheIF	fileCache
protected java.lang.String	location
protected NetcdfDataset	netcdfDataset
protected EarthLocation	origin
protected java.lang.StringBuffer	parseInfo
protected java.util.Date	startDate
protected java.lang.String	title

Constructor Summary

Constructors

Constructor and Description
AbstractRadialAdapter()
AbstractRadialAdapter(NetcdfDataset ds)

Method Summary

Modifier and Type	Method and Description
protected abstract void	addRadialVariable(NetcdfDataset ds, Variable var)
void	calcBounds()
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 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.
CalendarDateUnit	getCalendarDateUnit()
RadialDatasetSweep.Type	getCommonType() If all the sweeps are the same type, return it here, else NONE
VariableSimpleIF	getDataVariable(java.lang.String shortName) Get the named data Variable.
java.util.List<VariableSimpleIF>	getDataVariables() The radial data variables available in the dataset.
DateRange	getDateRange()
java.lang.String	getDescription() Text information about this dataset.
java.lang.String	getDetailInfo()
void	getDetailInfo(java.util.Formatter sf) Show debug / underlying implementation details
EarthLocation	getEarthLocation()
java.util.Date	getEndDate()
FeatureType	getFeatureType() Contains collections of this FeatureType.
FeatureType[]	getFeatureTypes() This Factory can open these types of Feature datasets.
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
java.lang.String	getLocationURI()
NetcdfFile	getNetcdfFile() Return underlying NetcdfFile, or null if none.
java.util.Date	getStartDate()
DateUnit	getTimeUnits() Get the units of Calendar time.
java.lang.String	getTitle() Title of the dataset.
protected abstract RadialDatasetSweep.RadialVariable	makeRadialVariable(NetcdfDataset nds, VariableSimpleIF v, Variable v0)
void	reacquire() Reacquire any resources like file handles Used when reactivating in cache.
void	release() Release any system resources like file handles.
protected void	removeDataVariable(java.lang.String varName)
protected void	setBoundingBox()
void	setDescription(java.lang.String desc)
protected abstract void	setEarthLocation()
protected abstract void	setEndDate()
void	setFileCache(FileCacheIF fileCache) If the FileCache is not null, FileCacheable.close() must call FileCache.release()
void	setLocationURI(java.lang.String location)
protected abstract void	setStartDate()
protected abstract void	setTimeUnits()
void	setTitle(java.lang.String title)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ucar.nc2.dt.RadialDatasetSweep

clearDatasetMemory, getCommonOrigin, getDataFormat, getRadarID, getRadarName, isStationary, isVolume

Methods inherited from interface ucar.nc2.ft.FeatureDatasetFactory

isMine, open

Field Detail

netcdfDataset

protected NetcdfDataset netcdfDataset

title

protected java.lang.String title

desc

protected java.lang.String desc

location

protected java.lang.String location

startDate

protected java.util.Date startDate

endDate

protected java.util.Date endDate

boundingBox

protected LatLonRect boundingBox

dataVariables

protected java.util.List<VariableSimpleIF> dataVariables

parseInfo

protected java.lang.StringBuffer parseInfo

origin

protected EarthLocation origin

csHash

protected java.util.HashMap csHash

dateUnits

protected DateUnit dateUnits

calDateUnits

protected CalendarDateUnit calDateUnits

fileCache

protected FileCacheIF fileCache

Constructor Detail

AbstractRadialAdapter

public AbstractRadialAdapter()

AbstractRadialAdapter

public AbstractRadialAdapter(NetcdfDataset ds)

Method Detail

addRadialVariable

protected abstract void addRadialVariable(NetcdfDataset ds,
                                          Variable var)

makeRadialVariable

protected abstract RadialDatasetSweep.RadialVariable makeRadialVariable(NetcdfDataset nds,
                                                                        VariableSimpleIF v,
                                                                        Variable v0)

setTimeUnits

protected abstract void setTimeUnits()
                              throws java.lang.Exception

Throws:

java.lang.Exception

setEarthLocation

protected abstract void setEarthLocation()

setStartDate

protected abstract void setStartDate()

setEndDate

protected abstract void setEndDate()

setTitle

public void setTitle(java.lang.String title)

setDescription

public void setDescription(java.lang.String desc)

setLocationURI

public void setLocationURI(java.lang.String location)

removeDataVariable

protected void removeDataVariable(java.lang.String varName)

setBoundingBox

protected void setBoundingBox()

calcBounds

public void calcBounds()
                throws java.io.IOException

Throws:

java.io.IOException

getStartDate

public java.util.Date getStartDate()

getEndDate

public java.util.Date getEndDate()

getBoundingBox

public LatLonRect getBoundingBox()

Description copied from interface: FeatureDataset

The lat/lon boundingBox for the entire dataset.

Specified by:

getBoundingBox in interface FeatureDataset

Returns:

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

getDataVariables

public java.util.List<VariableSimpleIF> getDataVariables()

Description copied from interface: RadialDatasetSweep

The radial data variables available in the dataset.

Specified by:

getDataVariables in interface RadialDatasetSweep

Specified by:

getDataVariables in interface FeatureDataset

Returns:

List of type RadialDatasetSweep.RadialVariable

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

getCommonType

public RadialDatasetSweep.Type getCommonType()

Description copied from interface: RadialDatasetSweep

If all the sweeps are the same type, return it here, else NONE

Specified by:

getCommonType in interface RadialDatasetSweep

Returns:

type of sweep, or NONE

getTimeUnits

public DateUnit getTimeUnits()

Description copied from interface: RadialDatasetSweep

Get the units of Calendar time. To get a Date, from a time value, call DateUnit.getStandardDate(double value). To get units as a String, call DateUnit.getUnitsString().

Specified by:

getTimeUnits in interface RadialDatasetSweep

Returns:

units of Calendar time

getCalendarDateUnit

public CalendarDateUnit getCalendarDateUnit()

getEarthLocation

public EarthLocation getEarthLocation()

getFeatureTypes

public FeatureType[] getFeatureTypes()

Description copied from interface: FeatureDatasetFactory

This Factory can open these types of Feature datasets.

Specified by:

getFeatureTypes in interface FeatureDatasetFactory

Returns:

array of FeatureType

getFeatureType

public FeatureType getFeatureType()

Description copied from interface: FeatureDataset

Contains collections of this FeatureType.

Specified by:

getFeatureType in interface FeatureDataset

Returns:

FeatureType of data

getDateRange

public DateRange getDateRange()

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

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

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.

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

Description copied from interface: FileCacheable

Release any system resources like file handles. Optional, implement only if you are able to reacquire. Used when object is made inactive in cache.

Specified by:

release in interface FileCacheable

Throws:

java.io.IOException

reacquire

public void reacquire()
               throws java.io.IOException

Description copied from interface: FileCacheable

Reacquire any resources like file handles Used when reactivating in cache.

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.

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.

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.

getLocationURI

public java.lang.String getLocationURI()

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

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

getDetailInfo

public java.lang.String getDetailInfo()