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

All Implemented Interfaces:

Closeable, AutoCloseable, FileCacheable

Direct Known Subclasses:

Grib1Collection, Grib2Collection, PartitionCollectionImmutable
```
@Immutable
public abstract class GribCollectionImmutable
extends Object
implements 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	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	Description
`protected FeatureCollectionConfig`	`config`
`static int`	`countGC`
`protected GribTables`	`cust`
`protected List<GribCollectionImmutable.Dataset>`	`datasets`
`protected CalendarDateRange`	`dateRange`
`protected File`	`directory`
`protected Map<Integer,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 Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`abstract void`	`addGlobalAttributes(AttributeContainer result)`
`abstract void`	`addVariableAttributes(AttributeContainer v, GribCollectionImmutable.VariableIndex vindex)`
`protected static NetcdfDataset`	`buildNetcdfDataset(AbstractIOServiceProvider iosp, String location)`
`void`	`close()`	Close the FileCacheable, release all resources.
`MFile`	`findMFileByName(String filename)`
`int`	`getBackProcessId()`
`int`	`getCenter()`
`GribCollectionImmutable.Dataset`	`getDataset(int idx)`
`GribCollectionImmutable.Dataset`	`getDatasetCanonical()`
`List<GribCollectionImmutable.Dataset>`	`getDatasets()`
`File`	`getDirectory()`
`MFile`	`getFile(int fileno)`
`String`	`getFilename(int fileno)`
`Collection<MFile>`	`getFiles()`
`int`	`getGenProcessId()`
`int`	`getGenProcessType()`
`AttributeContainer`	`getGlobalAttributes()`
`abstract CoverageCollection`	`getGridCoverage(GribCollectionImmutable.Dataset ds, GribCollectionImmutable.GroupGC group, String filename, FeatureCollectionConfig gribConfig, Formatter errlog, org.slf4j.Logger logger)`
`abstract GridDataset`	`getGridDataset(GribCollectionImmutable.Dataset ds, GribCollectionImmutable.GroupGC group, String filename, FeatureCollectionConfig gribConfig, Formatter errlog, org.slf4j.Logger logger)`
`long`	`getIndexFileSize()`
`long`	`getLastModified()`	Returns the time that the underlying file(s) were last modified.
`int`	`getLocal()`
`String`	`getLocation()`	The location of the FileCacheable.
`int`	`getMaster()`
`CalendarDate`	`getMasterFirstDate()`
`CoordinateRuntime`	`getMasterRuntime()`
`String`	`getName()`
`abstract NetcdfDataset`	`getNetcdfDataset(GribCollectionImmutable.Dataset ds, GribCollectionImmutable.GroupGC group, String filename, 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()`	Deprecated. do not use.
`void`	`release()`	Deprecated. do not use.
`void`	`setFileCache(FileCacheIF fileCache)`	Deprecated. do not use
`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 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 CalendarDateRange dateRange

fileMap

protected final Map<Integer,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 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 String makeVariableId(GribCollectionImmutable.VariableIndex v)

close
```
public void close()
           throws 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 AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface FileCacheable

Throws:

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 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(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 MFile getFile(int fileno)
```

getFilename

public String getFilename(int fileno)

getFiles
```
public Collection<MFile> getFiles()
```

findMFileByName

@Nullable
public MFile findMFileByName(String filename)

buildNetcdfDataset

protected static NetcdfDataset buildNetcdfDataset(AbstractIOServiceProvider iosp,
                                                  String location)
                                           throws IOException

Throws:: IOException

getNetcdfDataset

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

Throws:: IOException

getGridDataset

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

Throws:: IOException

getGridCoverage

@Nullable
public abstract CoverageCollection getGridCoverage(GribCollectionImmutable.Dataset ds,
                                                   GribCollectionImmutable.GroupGC group,
                                                   String filename,
                                                   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

buildNetcdfDataset

getNetcdfDataset

getGridDataset

getGridCoverage