GribCollectionImmutable (grib 5.3.1 API)

java.lang.Object
- ucar.nc2.grib.collection.GribCollectionImmutable

All Implemented Interfaces:

Closeable, AutoCloseable, ucar.nc2.util.cache.FileCacheable

Direct Known Subclasses:

Grib1Collection, Grib2Collection, PartitionCollectionImmutable
```
@Immutable
public abstract class GribCollectionImmutable
extends Object
implements 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).
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 thredds.featurecollection.FeatureCollectionConfig`	`config`
`static int`	`countGC`
`protected GribTables`	`cust`
`protected List<GribCollectionImmutable.Dataset>`	`datasets`
`protected ucar.nc2.time.CalendarDateRange`	`dateRange`
`protected File`	`directory`
`protected Map<Integer,thredds.inventory.MFile>`	`fileMap`
`protected String`	`indexFilename`
`protected ucar.nc2.grib.collection.GribCollectionImmutable.Info`	`info`
`boolean`	`isGrib1`
`protected CoordinateRuntime`	`masterRuntime`
`protected String`	`name`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
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(String filename)`
`int`	`getBackProcessId()`
`int`	`getCenter()`
`GribCollectionImmutable.Dataset`	`getDataset(int idx)`
`GribCollectionImmutable.Dataset`	`getDatasetCanonical()`
`List<GribCollectionImmutable.Dataset>`	`getDatasets()`
`File`	`getDirectory()`
`thredds.inventory.MFile`	`getFile(int fileno)`
`String`	`getFilename(int fileno)`
`Collection<thredds.inventory.MFile>`	`getFiles()`
`int`	`getGenProcessId()`
`int`	`getGenProcessType()`
`ucar.nc2.AttributeContainer`	`getGlobalAttributes()`
`abstract ucar.nc2.ft2.coverage.CoverageCollection`	`getGridCoverage(GribCollectionImmutable.Dataset ds, GribCollectionImmutable.GroupGC group, String filename, thredds.featurecollection.FeatureCollectionConfig gribConfig, Formatter errlog, org.slf4j.Logger logger)`
`abstract ucar.nc2.dt.grid.GridDataset`	`getGridDataset(GribCollectionImmutable.Dataset ds, GribCollectionImmutable.GroupGC group, String filename, thredds.featurecollection.FeatureCollectionConfig gribConfig, Formatter errlog, org.slf4j.Logger logger)`
`long`	`getIndexFileSize()`
`long`	`getLastModified()`
`int`	`getLocal()`
`String`	`getLocation()`
`int`	`getMaster()`
`ucar.nc2.time.CalendarDate`	`getMasterFirstDate()`
`CoordinateRuntime`	`getMasterRuntime()`
`String`	`getName()`
`abstract ucar.nc2.dataset.NetcdfDataset`	`getNetcdfDataset(GribCollectionImmutable.Dataset ds, GribCollectionImmutable.GroupGC group, String filename, thredds.featurecollection.FeatureCollectionConfig gribConfig, Formatter errlog, org.slf4j.Logger logger)`
`int`	`getSubcenter()`
`int`	`getVersion()`
`protected abstract 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(Formatter f)`
`void`	`showStatus(Formatter f)`
`void`	`showStatusSummary(Formatter f, String type)`
`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 String name
```

directory
```
protected final File directory
```

config

protected final thredds.featurecollection.FeatureCollectionConfig config

isGrib1
```
public final boolean isGrib1
```

info

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

datasets

protected final List<GribCollectionImmutable.Dataset> datasets

masterRuntime

protected final CoordinateRuntime masterRuntime

dateRange

protected final ucar.nc2.time.CalendarDateRange dateRange

fileMap

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

cust
```
protected final GribTables cust
```

indexFilename
```
protected final String indexFilename
```

Method Detail

makeVariableIndex

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

getDatasets

public List<GribCollectionImmutable.Dataset> getDatasets()

getDataset

public GribCollectionImmutable.Dataset getDataset(int idx)

getDatasetCanonical

public GribCollectionImmutable.Dataset getDatasetCanonical()

getName
```
public String getName()
```

getDirectory
```
public 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.AttributeContainer 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 String makeVariableId(GribCollectionImmutable.VariableIndex v)

close
```
public void close()
           throws IOException
```
Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

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

Throws:

IOException

release
```
public void release()
```
Specified by:

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

reacquire
```
public void reacquire()
```
Specified by:

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

getLocation
```
public 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(Formatter f)
```

showStatusSummary

public void showStatusSummary(Formatter f,
                              String type)

showIndex
```
public void showIndex(Formatter f)
```

toString
```
public String toString()
```
Overrides:

toString in class Object

getIndexFileSize
```
public long getIndexFileSize()
```

getFile

public thredds.inventory.MFile getFile(int fileno)

getFilename

public String getFilename(int fileno)

getFiles

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

findMFileByName

@Nullable
public thredds.inventory.MFile findMFileByName(String filename)

getNetcdfDataset

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

Throws:: IOException

getGridDataset

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

Throws:: IOException

getGridCoverage

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

Throws:: IOException

Class GribCollectionImmutable

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

countGC

name

directory

config

isGrib1

info

datasets

masterRuntime

dateRange

fileMap

cust

indexFilename

Method Detail

makeVariableIndex

getDatasets

getDataset

getDatasetCanonical

getName

getDirectory

getMasterRuntime

getMasterFirstDate

getVersion

getCenter

getSubcenter

getMaster

getLocal

getGenProcessType

getGenProcessId

getBackProcessId

getGlobalAttributes

addGlobalAttributes

addVariableAttributes

makeVariableId

close

release

reacquire

getLocation

getLastModified

setFileCache

showStatus

showStatusSummary

showIndex

toString

getIndexFileSize

getFile

getFilename

getFiles

findMFileByName

getNetcdfDataset

getGridDataset

getGridCoverage