Package ucar.nc2.ft
Class FeatureDatasetImpl
- java.lang.Object
-
- ucar.nc2.ft.FeatureDatasetImpl
-
- All Implemented Interfaces:
Closeable,AutoCloseable,FeatureDataset,FileCacheable
- Direct Known Subclasses:
PointDatasetImpl
public abstract class FeatureDatasetImpl extends Object implements FeatureDataset
Abstract superclass for implementations of FeatureDataset. Subclass must implement getFeatureClass(), and add specific functionality. Also set dataVariables- Since:
- Sep 7, 2007
-
-
Field Summary
Fields Modifier and Type Field Description protected LatLonRectboundingBoxprotected List<VariableSimpleIF>dataVariablesprotected CalendarDateRangedateRangeprotected Stringdescprotected FileCacheIFfileCacheprotected Stringlocationprotected NetcdfDatasetnetcdfDatasetprotected FormatterparseInfoprotected Stringtitle
-
Constructor Summary
Constructors Modifier Constructor Description FeatureDatasetImpl()No-arg constuctorFeatureDatasetImpl(String title, String description, String location)Constructor when theres no NetcdfFile underneath.FeatureDatasetImpl(NetcdfDataset netcdfDataset)Constructor when theres a NetcdfFile underneathprotectedFeatureDatasetImpl(FeatureDatasetImpl from)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description AttributeContainerattributes()Get the global attributes.voidclose()Close all resources associated with this dataset.AttributefindGlobalAttributeIgnoreCase(String name)Deprecated.use attributes()LatLonRectgetBoundingBox()The lat/lon boundingBox for the entire dataset.CalendarDategetCalendarDateEnd()Ending Calendar date for the entire dataset.CalendarDateRangegetCalendarDateRange()Calendar Date range for the entire dataset.CalendarDategetCalendarDateStart()Starting Calendar date for the entire dataset.VariableSimpleIFgetDataVariable(String shortName)Get the named data Variable.List<VariableSimpleIF>getDataVariables()The data Variables available in this dataset.StringgetDescription()Text information about this dataset.voidgetDetailInfo(Formatter sf)Show debug / underlying implementation detailsList<Attribute>getGlobalAttributes()Deprecated.use attributes()StringgetImplementationName()Show who is implementinglonggetLastModified()Returns the time that the underlying file(s) were last modified.StringgetLocation()The URI location of the datasetNetcdfFilegetNetcdfFile()Return underlying NetcdfFile, or null if none.StringgetTitle()Title of the dataset.voidreacquire()Deprecated.do not usevoidrelease()Deprecated.do not usevoidsetBoundingBox(LatLonRect boundingBox)voidsetDateRange(CalendarDateRange dateRange)protected voidsetDescription(String desc)voidsetFileCache(FileCacheIF fileCache)Deprecated.do not useprotected voidsetLocationURI(String location)protected voidsetTitle(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.ft.FeatureDataset
getFeatureType
-
-
-
-
Field Detail
-
netcdfDataset
protected NetcdfDataset netcdfDataset
-
title
protected String title
-
desc
protected String desc
-
location
protected String location
-
dataVariables
protected List<VariableSimpleIF> dataVariables
-
parseInfo
protected Formatter parseInfo
-
dateRange
protected CalendarDateRange dateRange
-
boundingBox
protected LatLonRect boundingBox
-
fileCache
protected FileCacheIF fileCache
-
-
Constructor Detail
-
FeatureDatasetImpl
protected FeatureDatasetImpl(FeatureDatasetImpl from)
-
FeatureDatasetImpl
public FeatureDatasetImpl()
No-arg constuctor
-
FeatureDatasetImpl
public FeatureDatasetImpl(String title, String description, String location)
Constructor when theres no NetcdfFile underneath.- Parameters:
title- title of the dataset.description- description of the dataset.location- URI of the dataset
-
FeatureDatasetImpl
public FeatureDatasetImpl(NetcdfDataset netcdfDataset)
Constructor when theres a NetcdfFile underneath- Parameters:
netcdfDataset- adapt this NetcdfDataset
-
-
Method Detail
-
setTitle
protected void setTitle(String title)
-
setDescription
protected void setDescription(String desc)
-
setLocationURI
protected void setLocationURI(String location)
-
setDateRange
public void setDateRange(CalendarDateRange dateRange)
-
setBoundingBox
public void setBoundingBox(LatLonRect boundingBox)
-
getNetcdfFile
public NetcdfFile getNetcdfFile()
Description copied from interface:FeatureDatasetReturn underlying NetcdfFile, or null if none.- Specified by:
getNetcdfFilein interfaceFeatureDataset- Returns:
- the underlying NetcdfFile, or null if none.
-
getTitle
public String getTitle()
Description copied from interface:FeatureDatasetTitle of the dataset.- Specified by:
getTitlein interfaceFeatureDataset- Returns:
- the title of the dataset, or null
-
getDescription
public String getDescription()
Description copied from interface:FeatureDatasetText information about this dataset.- Specified by:
getDescriptionin interfaceFeatureDataset- Returns:
- any text information about this dataset, or null.
-
getLocation
public String getLocation()
Description copied from interface:FeatureDatasetThe URI location of the dataset- Specified by:
getLocationin interfaceFeatureDataset- Specified by:
getLocationin interfaceFileCacheable- Returns:
- the URI location of the dataset, or null
-
attributes
public AttributeContainer attributes()
Description copied from interface:FeatureDatasetGet the global attributes.- Specified by:
attributesin interfaceFeatureDataset
-
getGlobalAttributes
@Deprecated public List<Attribute> getGlobalAttributes()
Deprecated.use attributes()Description copied from interface:FeatureDatasetList of global attributes.- Specified by:
getGlobalAttributesin interfaceFeatureDataset- Returns:
- List of type ucar.nc2.Attribute, may be empty but not null
-
findGlobalAttributeIgnoreCase
@Deprecated public Attribute findGlobalAttributeIgnoreCase(String name)
Deprecated.use attributes()Description copied from interface:FeatureDatasetReturn the global attribute with the given name, ignoring case.- Specified by:
findGlobalAttributeIgnoreCasein interfaceFeatureDataset- Parameters:
name- attribute name- Returns:
- the global attribute, or null
-
getDetailInfo
public void getDetailInfo(Formatter sf)
Description copied from interface:FeatureDatasetShow debug / underlying implementation details- Specified by:
getDetailInfoin interfaceFeatureDataset- Parameters:
sf- append info here
-
getCalendarDateRange
public CalendarDateRange getCalendarDateRange()
Description copied from interface:FeatureDatasetCalendar Date range for the entire dataset.- Specified by:
getCalendarDateRangein interfaceFeatureDataset- Returns:
- the date range for the entire dataset, or null if unknown
-
getCalendarDateStart
public CalendarDate getCalendarDateStart()
Description copied from interface:FeatureDatasetStarting Calendar date for the entire dataset.- Specified by:
getCalendarDateStartin interfaceFeatureDataset- Returns:
- the starting date for the entire dataset, or null if unknown
-
getCalendarDateEnd
public CalendarDate getCalendarDateEnd()
Description copied from interface:FeatureDatasetEnding Calendar date for the entire dataset.- Specified by:
getCalendarDateEndin interfaceFeatureDataset- Returns:
- the ending date for the entire dataset, or null if unknown
-
getBoundingBox
public LatLonRect getBoundingBox()
Description copied from interface:FeatureDatasetThe lat/lon boundingBox for the entire dataset.- Specified by:
getBoundingBoxin interfaceFeatureDataset- Returns:
- the lat/lon boundingBox for the entire dataset, or null if unknown.
-
getDataVariables
public List<VariableSimpleIF> getDataVariables()
Description copied from interface:FeatureDatasetThe 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:
getDataVariablesin interfaceFeatureDataset- Returns:
- List of subclass of VariableSimpleIF, may be empty but not null
-
getDataVariable
public VariableSimpleIF getDataVariable(String shortName)
Description copied from interface:FeatureDatasetGet the named data Variable.- Specified by:
getDataVariablein interfaceFeatureDataset- Parameters:
shortName- of data Variable.- Returns:
- VariableSimpleIF or null if not found
-
getImplementationName
public String getImplementationName()
Description copied from interface:FeatureDatasetShow who is implementing- Specified by:
getImplementationNamein interfaceFeatureDataset- Returns:
- name of implementor
-
close
public void close() throws IOExceptionDescription copied from interface:FeatureDatasetClose all resources associated with this dataset.- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable- Specified by:
closein interfaceFeatureDataset- Specified by:
closein interfaceFileCacheable- Throws:
IOException- on i/o error
-
release
@Deprecated public void release() throws IOException
Deprecated.do not useDescription copied from interface:FileCacheableRelease 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:
releasein interfaceFileCacheable- Throws:
IOException
-
reacquire
@Deprecated public void reacquire() throws IOException
Deprecated.do not useDescription copied from interface:FileCacheableReacquire any resources like file handles Used when reactivating in cache.- Specified by:
reacquirein interfaceFileCacheable- Throws:
IOException
-
getLastModified
public long getLastModified()
Description copied from interface:FileCacheableReturns 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 withFileFactory.- Specified by:
getLastModifiedin interfaceFileCacheable- Returns:
- a
longvalue representing the time the file(s) were last modified or0Lif the last-modified time couldn't be determined for any reason.
-
setFileCache
@Deprecated public void setFileCache(FileCacheIF fileCache)
Deprecated.do not useDescription copied from interface:FileCacheableIf 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:
setFileCachein interfaceFileCacheable- Parameters:
fileCache- must store this, use it on close as above.
-
-