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, Netcdf2Dataset, NetcdfDataset, NetcdfFile, NetcdfFileWriteable, Nids2Dataset, PointDatasetImpl, PointDatasetRemote, RadialDatasetSweepAdapter, RandomAccessFile, UF2Dataset

public interface FileCacheable

Interface for files that can be stored in FileCache.

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.
String	getLocation() The location of the FileCacheable.
void	setFileCache(FileCache fileCache) If the FileCache is set, the FileCacheable object must store it and call FileCache.release() on FileCacheable.close():

Method Detail

getLocation

String getLocation()

The location of the FileCacheable.

Returns:

location

close

void close()
           throws IOException

Close the FileCacheable, release all resources. Also must honor contract with setFileCache().

Throws:

IOException - on io error

getLastModified

long getLastModified()

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

Returns:

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

setFileCache

void setFileCache(FileCache fileCache)

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();
    }
   

Parameters:

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