ucar.nc2.grib.collection

Class GribCollectionImmutable

java.lang.Object

ucar.nc2.grib.collection.GribCollectionImmutable

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, FileCacheable

Direct Known Subclasses:

Grib1Collection, Grib2Collection, PartitionCollectionImmutable

@Immutable
public abstract class GribCollectionImmutable
extends java.lang.Object
implements java.io.Closeable, FileCacheable

An Immutable GribCollection, corresponds to one index (ncx) file. The index file has already been read; it is opened and the closed when a variable is first accessed to read in the record array (sa).

Could use the Proto equivalents, and eliminate GribCollectionMutable ?

Since:

11/10/2014

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	GribCollectionImmutable.Dataset
class	GribCollectionImmutable.GroupGC
static class	GribCollectionImmutable.Record
static class	GribCollectionImmutable.Type
class	GribCollectionImmutable.VariableIndex

Field Summary

Fields

Modifier and Type	Field and Description
protected FeatureCollectionConfig	config
static int	countGC
protected GribTables	cust
protected java.util.List<GribCollectionImmutable.Dataset>	datasets
protected CalendarDateRange	dateRange
protected java.io.File	directory
protected java.util.Map<java.lang.Integer,MFile>	fileMap
protected java.lang.String	indexFilename
protected ucar.nc2.grib.collection.GribCollectionImmutable.Info	info
boolean	isGrib1
protected CoordinateRuntime	masterRuntime
protected java.lang.String	name

Method Summary

Modifier and Type	Method and Description
abstract void	addGlobalAttributes(AttributeContainer result)
abstract void	addVariableAttributes(AttributeContainer v, GribCollectionImmutable.VariableIndex vindex)
void	close() Close the FileCacheable, release all resources.
MFile	findMFileByName(java.lang.String filename)
int	getBackProcessId()
int	getCenter()
GribCollectionImmutable.Dataset	getDataset(int idx)
GribCollectionImmutable.Dataset	getDatasetCanonical()
java.util.List<GribCollectionImmutable.Dataset>	getDatasets()
java.io.File	getDirectory()
MFile	getFile(int fileno)
java.lang.String	getFilename(int fileno)
java.util.Collection<MFile>	getFiles()
int	getGenProcessId()
int	getGenProcessType()
AttributeContainer	getGlobalAttributes()
abstract CoverageCollection	getGridCoverage(GribCollectionImmutable.Dataset ds, GribCollectionImmutable.GroupGC group, java.lang.String filename, FeatureCollectionConfig gribConfig, java.util.Formatter errlog, org.slf4j.Logger logger)
abstract GridDataset	getGridDataset(GribCollectionImmutable.Dataset ds, GribCollectionImmutable.GroupGC group, java.lang.String filename, FeatureCollectionConfig gribConfig, java.util.Formatter errlog, org.slf4j.Logger logger)
long	getIndexFileSize()
long	getLastModified() Returns the time that the underlying file(s) were last modified.
int	getLocal()
java.lang.String	getLocation() The location of the FileCacheable.
int	getMaster()
CalendarDate	getMasterFirstDate()
CoordinateRuntime	getMasterRuntime()
java.lang.String	getName()
abstract NetcdfDataset	getNetcdfDataset(GribCollectionImmutable.Dataset ds, GribCollectionImmutable.GroupGC group, java.lang.String filename, FeatureCollectionConfig gribConfig, java.util.Formatter errlog, org.slf4j.Logger logger)
int	getSubcenter()
int	getVersion()
protected abstract java.lang.String	makeVariableId(GribCollectionImmutable.VariableIndex v)
protected GribCollectionImmutable.VariableIndex	makeVariableIndex(GribCollectionImmutable.GroupGC group, GribCollectionMutable.VariableIndex mutableVar)
void	reacquire() Deprecated. do not use.
void	release() Deprecated. do not use.
void	setFileCache(FileCacheIF fileCache) Deprecated. do not use
void	showIndex(java.util.Formatter f)
void	showStatus(java.util.Formatter f)
void	showStatusSummary(java.util.Formatter f, java.lang.String type)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

countGC

public static int countGC

name

protected final java.lang.String name

directory

protected final java.io.File directory

config

protected final FeatureCollectionConfig config

isGrib1

public final boolean isGrib1

info

protected final ucar.nc2.grib.collection.GribCollectionImmutable.Info info

datasets

protected final java.util.List<GribCollectionImmutable.Dataset> datasets

masterRuntime

protected final CoordinateRuntime masterRuntime

dateRange

protected final CalendarDateRange dateRange

fileMap

protected final java.util.Map<java.lang.Integer,MFile> fileMap

cust

protected final GribTables cust

indexFilename

protected final java.lang.String indexFilename

Method Detail

makeVariableIndex

protected GribCollectionImmutable.VariableIndex makeVariableIndex(GribCollectionImmutable.GroupGC group,
                                                                  GribCollectionMutable.VariableIndex mutableVar)

getDatasets

public java.util.List<GribCollectionImmutable.Dataset> getDatasets()

getDataset

public GribCollectionImmutable.Dataset getDataset(int idx)

getDatasetCanonical

public GribCollectionImmutable.Dataset getDatasetCanonical()

getName

public java.lang.String getName()

getDirectory

public java.io.File getDirectory()

getMasterRuntime

public CoordinateRuntime getMasterRuntime()

getMasterFirstDate

public CalendarDate getMasterFirstDate()

getVersion

public int getVersion()

getCenter

public int getCenter()

getSubcenter

public int getSubcenter()

getMaster

public int getMaster()

getLocal

public int getLocal()

getGenProcessType

public int getGenProcessType()

getGenProcessId

public int getGenProcessId()

getBackProcessId

public int getBackProcessId()

getGlobalAttributes

public AttributeContainer getGlobalAttributes()

addGlobalAttributes

public abstract void addGlobalAttributes(AttributeContainer result)

addVariableAttributes

public abstract void addVariableAttributes(AttributeContainer v,
                                           GribCollectionImmutable.VariableIndex vindex)

makeVariableId

protected abstract java.lang.String makeVariableId(GribCollectionImmutable.VariableIndex v)

close

public void close()
           throws java.io.IOException

Description copied from interface: FileCacheable

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

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface FileCacheable

Throws:

java.io.IOException - on io error

release

@Deprecated
public void release()

Deprecated. do not use.

release any resources like file handles.

Specified by:

release in interface FileCacheable

reacquire

@Deprecated
public void reacquire()

Deprecated. do not use.

reacquire any resources like file handles.

Specified by:

reacquire in interface FileCacheable

getLocation

public java.lang.String getLocation()

Description copied from interface: FileCacheable

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

Specified by:

getLocation in interface FileCacheable

Returns:

location

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.

setFileCache

@Deprecated
public void setFileCache(FileCacheIF fileCache)

Deprecated. do not use

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.

showStatus

public void showStatus(java.util.Formatter f)

showStatusSummary

public void showStatusSummary(java.util.Formatter f,
                              java.lang.String type)

showIndex

public void showIndex(java.util.Formatter f)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getIndexFileSize

public long getIndexFileSize()

getFile

public MFile getFile(int fileno)

getFilename

public java.lang.String getFilename(int fileno)

getFiles

public java.util.Collection<MFile> getFiles()

findMFileByName

@Nullable
public MFile findMFileByName(java.lang.String filename)

getNetcdfDataset

@Nullable
public abstract NetcdfDataset getNetcdfDataset(GribCollectionImmutable.Dataset ds,
                                                         GribCollectionImmutable.GroupGC group,
                                                         java.lang.String filename,
                                                         FeatureCollectionConfig gribConfig,
                                                         java.util.Formatter errlog,
                                                         org.slf4j.Logger logger)
                                                  throws java.io.IOException

Throws:

java.io.IOException

getGridDataset

@Nullable
public abstract GridDataset getGridDataset(GribCollectionImmutable.Dataset ds,
                                                     GribCollectionImmutable.GroupGC group,
                                                     java.lang.String filename,
                                                     FeatureCollectionConfig gribConfig,
                                                     java.util.Formatter errlog,
                                                     org.slf4j.Logger logger)
                                              throws java.io.IOException

Throws:

java.io.IOException

getGridCoverage

@Nullable
public abstract CoverageCollection getGridCoverage(GribCollectionImmutable.Dataset ds,
                                                             GribCollectionImmutable.GroupGC group,
                                                             java.lang.String filename,
                                                             FeatureCollectionConfig gribConfig,
                                                             java.util.Formatter errlog,
                                                             org.slf4j.Logger logger)
                                                      throws java.io.IOException

Throws:

java.io.IOException