ucar.nc2.util.cache

Interface FileCacheable

All Known Subinterfaces:

CoverageDataset, FeatureDataset, FeatureDatasetPoint, RadialDatasetSweep, StationRadialDataset, StationRadialDataset

All Known Implementing Classes:

CdmRemote, CFnetCDF2Dataset, CoverageDatasetImpl, Dorade2Dataset, FeatureDatasetImpl, GridDataset, HTTPRandomAccessFile, InMemoryRandomAccessFile, LevelII2Dataset, MMapRandomAccessFile, Netcdf2Dataset, NetcdfDataset, NetcdfFile, NetcdfFileSubclass, NetcdfFileWriteable, Nids2Dataset, PointDatasetImpl, PointDatasetRemote, RadialDatasetSweepAdapter, RandomAccessFile, UF2Dataset

public interface FileCacheable

Interface for files that can be stored in FileCache. Requirements: 1. hashCode() must return Object.hashCode() 2. close() must call cache.release(this) if cache is not null. 3. must be able to detect changes in underlying object, and indicate whether it has changed.

Since:

Jun 2, 2008

Author:

caron

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close the FileCacheable, release all resources.
long	getLastModified() Get last modified date of underlying file(s).
String	getLocation() The location of the FileCacheable.
void	setFileCache(FileCacheIF fileCache) If the FileCache is not null, FileCacheable.close() must call FileCache.release()

Method Detail

getLocation

String getLocation()

The location of the FileCacheable. This must be sufficient for FileFactory.factory() to create the FileCacheable object

Returns:

location

close

void close()
           throws IOException

Close the FileCacheable, release all resources. Must call cache.release(this) if cache is not null.

Throws:

IOException - on io error

getLastModified

long getLastModified()

Get last modified date of underlying file(s). If changed since it was stored in the cache, it will be closed and recreated with FileFactory

Returns:

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

setFileCache

void setFileCache(FileCacheIF fileCache)

If the FileCache is not null, FileCacheable.close() must call FileCache.release()

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

Parameters:

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