GribCollectionImmutable (GRIB IOSP and Feature Collection 4.6.0 API)

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).

Since:

11/10/2014

Author:

caron

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 FeatureCollectionConfig`	`config`
`static int`	`countGC`
`protected GribTables`	`cust`
`protected List<GribCollectionImmutable.Dataset>`	`datasets`
`protected File`	`directory`
`protected Map<Integer,MFile>`	`fileMap`
`protected List<GribHorizCoordSystem>`	`horizCS`
`protected String`	`indexFilename`
`protected GribCollectionImmutable.Info`	`info`
`boolean`	`isGrib1`
`protected CoordinateRuntime`	`masterRuntime`
`protected String`	`name`
`protected FileCacheIF`	`objCache`

Method Summary

Methods
Modifier and Type	Method and Description
`protected abstract void`	`addGlobalAttributes(List<Attribute> result)`
`void`	`close()`
`MFile`	`findMFileByName(String filename)`
`int`	`getBackProcessId()`
`int`	`getCenter()`
`RandomAccessFile`	`getDataRaf(int fileno)`
`GribCollectionImmutable.Dataset`	`getDataset(int idx)`
`GribCollectionImmutable.Dataset`	`getDatasetByTypeName(String name)`
`GribCollectionImmutable.Dataset`	`getDatasetCanonical()`
`List<GribCollectionImmutable.Dataset>`	`getDatasets()`
`File`	`getDirectory()`
`String`	`getFilename(int fileno)`
`Collection<MFile>`	`getFiles()`
`String`	`getFirstFilename()`
`int`	`getGenProcessId()`
`int`	`getGenProcessType()`
`List<Attribute>`	`getGlobalAttributes()`
`abstract GridDataset`	`getGridDataset(GribCollectionImmutable.Dataset ds, GribCollectionImmutable.GroupGC group, String filename, FeatureCollectionConfig gribConfig, Formatter errlog, org.slf4j.Logger logger)`
`long`	`getIndexFileSize()`
`long`	`getLastModified()`
`int`	`getLocal()`
`String`	`getLocation()`
`int`	`getMaster()`
`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 GribCollectionImmutable.VariableIndex`	`makeVariableIndex(GribCollectionImmutable.GroupGC group, GribCollectionMutable.VariableIndex mutableVar)`
`void`	`reacquire()`
`void`	`release()`
`void`	`setFileCache(FileCacheIF fileCache)`
`void`	`showIndex(Formatter f)`
`void`	`showIndexFile(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 GribCollectionImmutable.Info info

datasets

protected final List<GribCollectionImmutable.Dataset> datasets

horizCS

protected final List<GribHorizCoordSystem> horizCS

masterRuntime

protected final CoordinateRuntime masterRuntime

fileMap

protected final Map<Integer,MFile> fileMap

cust
```
protected final GribTables cust
```

indexFilename
```
protected final String indexFilename
```

objCache
```
protected FileCacheIF objCache
```

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)

getDatasetByTypeName

public GribCollectionImmutable.Dataset getDatasetByTypeName(String name)

getDatasetCanonical

public GribCollectionImmutable.Dataset getDatasetCanonical()

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

getDirectory
```
public File getDirectory()
```

getMasterRuntime

public CoordinateRuntime getMasterRuntime()

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 List<Attribute> getGlobalAttributes()

addGlobalAttributes

protected abstract void addGlobalAttributes(List<Attribute> result)

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

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface FileCacheable

Throws:

IOException

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

release in interface FileCacheable

Throws:

IOException

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

reacquire in interface FileCacheable

Throws:

IOException

getLocation
```
public String getLocation()
```
Specified by:

getLocation in interface FileCacheable

getLastModified
```
public long getLastModified()
```
Specified by:

getLastModified in interface FileCacheable

setFileCache
```
public void setFileCache(FileCacheIF fileCache)
```
Specified by:

setFileCache in interface FileCacheable

showStatus
```
public void showStatus(Formatter f)
```

showStatusSummary

public void showStatusSummary(Formatter f,
                     String type)

showIndexFile

public void showIndexFile(Formatter f)

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

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

toString in class Object

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

getFilename

public String getFilename(int fileno)

getFirstFilename
```
public String getFirstFilename()
```

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

findMFileByName

public MFile findMFileByName(String filename)

getDataRaf

public RandomAccessFile getDataRaf(int fileno)
                            throws IOException

Throws:: IOException

getNetcdfDataset

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

public abstract GridDataset getGridDataset(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

horizCS

masterRuntime

fileMap

cust

indexFilename

objCache

Method Detail

makeVariableIndex

getDatasets

getDataset

getDatasetByTypeName

getDatasetCanonical

getName

getDirectory

getMasterRuntime

getVersion

getCenter

getSubcenter

getMaster

getLocal

getGenProcessType

getGenProcessId

getBackProcessId

getGlobalAttributes

addGlobalAttributes

close

release

reacquire

getLocation

getLastModified

setFileCache

showStatus

showStatusSummary

showIndexFile

showIndex

toString

getIndexFileSize

getFilename

getFirstFilename

getFiles

findMFileByName

getDataRaf

getNetcdfDataset

getGridDataset