ucar.nc2.grib.collection

Class GribCollectionImmutable

java.lang.Object

ucar.nc2.grib.collection.GribCollectionImmutable

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, ucar.nc2.util.cache.FileCacheable

Direct Known Subclasses:

Grib1Collection, Grib2Collection, PartitionCollectionImmutable

@Immutable
public abstract class GribCollectionImmutable
extends java.lang.Object
implements java.io.Closeable, ucar.nc2.util.cache.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).

possible we 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.Info
static class	GribCollectionImmutable.Record
static class	GribCollectionImmutable.Type
class	GribCollectionImmutable.VariableIndex

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
abstract void	addGlobalAttributes(ucar.nc2.AttributeContainer result)
abstract void	addVariableAttributes(ucar.nc2.AttributeContainer v, GribCollectionImmutable.VariableIndex vindex)
void	close()
thredds.inventory.MFile	findMFileByName(java.lang.String filename)
int	getBackProcessId()
int	getCenter()
ucar.unidata.io.RandomAccessFile	getDataRaf(int fileno)
java.lang.String	getDataRafFilename(int fileno)
GribCollectionImmutable.Dataset	getDataset(int idx)
GribCollectionImmutable.Dataset	getDatasetCanonical()
java.util.List<GribCollectionImmutable.Dataset>	getDatasets()
java.io.File	getDirectory()
thredds.inventory.MFile	getFile(int fileno)
java.lang.String	getFilename(int fileno)
java.util.Collection<thredds.inventory.MFile>	getFiles()
java.lang.String	getFirstFilename()
int	getGenProcessId()
int	getGenProcessType()
ucar.nc2.AttributeContainerHelper	getGlobalAttributes()
abstract ucar.nc2.ft2.coverage.CoverageCollection	getGridCoverage(GribCollectionImmutable.Dataset ds, GribCollectionImmutable.GroupGC group, java.lang.String filename, thredds.featurecollection.FeatureCollectionConfig gribConfig, java.util.Formatter errlog, org.slf4j.Logger logger)
abstract ucar.nc2.dt.grid.GridDataset	getGridDataset(GribCollectionImmutable.Dataset ds, GribCollectionImmutable.GroupGC group, java.lang.String filename, thredds.featurecollection.FeatureCollectionConfig gribConfig, java.util.Formatter errlog, org.slf4j.Logger logger)
long	getIndexFileSize()
long	getLastModified()
int	getLocal()
java.lang.String	getLocation()
int	getMaster()
ucar.nc2.time.CalendarDate	getMasterFirstDate()
CoordinateRuntime	getMasterRuntime()
java.lang.String	getName()
abstract ucar.nc2.dataset.NetcdfDataset	getNetcdfDataset(GribCollectionImmutable.Dataset ds, GribCollectionImmutable.GroupGC group, java.lang.String filename, thredds.featurecollection.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()
void	release()
void	setFileCache(ucar.nc2.util.cache.FileCacheIF fileCache)
void	showIndex(java.util.Formatter f)
void	showIndexFile(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 thredds.featurecollection.FeatureCollectionConfig config

isGrib1

public final boolean isGrib1

info

protected final GribCollectionImmutable.Info info

datasets

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

masterRuntime

protected final CoordinateRuntime masterRuntime

dateRange

protected final ucar.nc2.time.CalendarDateRange dateRange

fileMap

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

cust

protected final GribTables cust

indexFilename

protected final java.lang.String indexFilename

objCache

protected ucar.nc2.util.cache.FileCacheIF objCache

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 ucar.nc2.time.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 ucar.nc2.AttributeContainerHelper getGlobalAttributes()

addGlobalAttributes

public abstract void addGlobalAttributes(ucar.nc2.AttributeContainer result)

addVariableAttributes

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

makeVariableId

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

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface ucar.nc2.util.cache.FileCacheable

Throws:

java.io.IOException

release

public void release()
             throws java.io.IOException

Specified by:

release in interface ucar.nc2.util.cache.FileCacheable

Throws:

java.io.IOException

reacquire

public void reacquire()
               throws java.io.IOException

Specified by:

reacquire in interface ucar.nc2.util.cache.FileCacheable

Throws:

java.io.IOException

getLocation

public java.lang.String getLocation()

Specified by:

getLocation in interface ucar.nc2.util.cache.FileCacheable

getLastModified

public long getLastModified()

Specified by:

getLastModified in interface ucar.nc2.util.cache.FileCacheable

setFileCache

public void setFileCache(ucar.nc2.util.cache.FileCacheIF fileCache)

Specified by:

setFileCache in interface ucar.nc2.util.cache.FileCacheable

showStatus

public void showStatus(java.util.Formatter f)

showStatusSummary

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

showIndexFile

public void showIndexFile(java.util.Formatter f)

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 thredds.inventory.MFile getFile(int fileno)

getFilename

public java.lang.String getFilename(int fileno)

getFirstFilename

public java.lang.String getFirstFilename()

getFiles

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

findMFileByName

public thredds.inventory.MFile findMFileByName(java.lang.String filename)

getDataRaf

public ucar.unidata.io.RandomAccessFile getDataRaf(int fileno)
                                            throws java.io.IOException

Throws:

java.io.IOException

getDataRafFilename

public java.lang.String getDataRafFilename(int fileno)
                                    throws java.io.IOException

Throws:

java.io.IOException

getNetcdfDataset

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

Throws:

java.io.IOException

getGridDataset

public abstract ucar.nc2.dt.grid.GridDataset getGridDataset(GribCollectionImmutable.Dataset ds,
                                                            GribCollectionImmutable.GroupGC group,
                                                            java.lang.String filename,
                                                            thredds.featurecollection.FeatureCollectionConfig gribConfig,
                                                            java.util.Formatter errlog,
                                                            org.slf4j.Logger logger)
                                                     throws java.io.IOException

Throws:

java.io.IOException

getGridCoverage

public abstract ucar.nc2.ft2.coverage.CoverageCollection getGridCoverage(GribCollectionImmutable.Dataset ds,
                                                                         GribCollectionImmutable.GroupGC group,
                                                                         java.lang.String filename,
                                                                         thredds.featurecollection.FeatureCollectionConfig gribConfig,
                                                                         java.util.Formatter errlog,
                                                                         org.slf4j.Logger logger)
                                                                  throws java.io.IOException

Throws:

java.io.IOException