GribCollection (GRIB IOSP and Feature Collection 4.5.5 API)

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

All Implemented Interfaces:

AutoCloseable, FileCacheable

Direct Known Subclasses:

Grib1Collection, Grib2Collection, PartitionCollection
```
public abstract class GribCollection
extends Object
implements FileCacheable, AutoCloseable
```
A collection of grib files as a single logical dataset. Concrete classes are for Grib1 and Grib2. Note that there is no dependence on GRIB tables here. Handles .ncx2 files. Data files are opened and managed externally.

Since:

12/1/13

Author:

John

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`GribCollection.Dataset`
`class`	`GribCollection.GroupGC`
`class`	`GribCollection.HorizCoordSys`
`static class`	`GribCollection.Record`
`static class`	`GribCollection.Type`
`class`	`GribCollection.VariableIndex`

Field Summary

Fields
Modifier and Type	Field and Description
`int`	`backProcessId`
`int`	`center`
`protected FeatureCollectionConfig`	`config`
`static int`	`countGC`
`protected GribTables`	`cust`
`protected List<GribCollection.Dataset>`	`datasets`
`protected File`	`directory`
`protected Map<Integer,MFile>`	`fileMap`
`int`	`genProcessId`
`int`	`genProcessType`
`protected List<GribCollection.HorizCoordSys>`	`horizCS`
`protected String`	`indexFilename`
`protected RandomAccessFile`	`indexRaf`
`protected boolean`	`isGrib1`
`int`	`local`
`int`	`master`
`protected CoordinateRuntime`	`masterRuntime`
`static long`	`MISSING_RECORD`
`protected String`	`name`
`protected FileCacheIF`	`objCache`
`List<Parameter>`	`params`
`int`	`subcenter`
`int`	`version`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`GribCollection(String name, File directory, FeatureCollectionConfig config, boolean isGrib1)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addHorizCoordSystem(GdsHorizCoordSys hcs, byte[] rawGds, int gdsHash, String nameOverride, int predefinedGridDefinition)`
`void`	`close()`
`protected void`	`copyInfo(GribCollection from)`
`static void`	`disableDataRafCache()`
`GribCollection.Dataset`	`findDataset(String name)`
`int`	`findHorizCS(GribCollection.HorizCoordSys hcs)`
`MFile`	`findMFileByName(String filename)`
`int`	`getBackProcessId()`
`int`	`getCenter()`
`FeatureCollectionConfig`	`getConfig()`
`String`	`getDataFilename(int fileno)`
`RandomAccessFile`	`getDataRaf(int fileno)`
`static FileCacheIF`	`getDataRafCache()`
`GribCollection.Dataset`	`getDatasetCanonical()`
`List<GribCollection.Dataset>`	`getDatasets()`
`File`	`getDirectory()`
`static DiskCache2`	`getDiskCache2()`
`static File`	`getExistingFileOrCache(String path)`
`static File`	`getFileInCache(File f)`
`static File`	`getFileInCache(String path)` Get index file, may be in cache directory, may not exist
`String`	`getFilename(int fileno)`
`List<String>`	`getFilenames()` The files that comprise the colelction.
`Collection<MFile>`	`getFiles()`
`int`	`getGenProcessId()`
`int`	`getGenProcessType()`
`abstract GridDataset`	`getGridDataset(GribCollection.Dataset ds, GribCollection.GroupGC group, String filename, FeatureCollectionConfig gribConfig, Formatter errlog, org.slf4j.Logger logger)`
`GribCollection.HorizCoordSys`	`getHorizCS(int index)`
`String`	`getIndexFilepathInCache()` get index filename
`File`	`getIndexParentFile()`
`long`	`getLastModified()`
`int`	`getLocal()`
`String`	`getLocation()`
`int`	`getMaster()`
`CoordinateRuntime`	`getMasterRuntime()`
`String`	`getName()`
`abstract NetcdfDataset`	`getNetcdfDataset(GribCollection.Dataset ds, GribCollection.GroupGC group, String filename, FeatureCollectionConfig gribConfig, Formatter errlog, org.slf4j.Logger logger)`
`List<Parameter>`	`getParams()`
`int`	`getSubcenter()`
`static void`	`initDataRafCache(int minElementsInMemory, int maxElementsInMemory, int period)`
`boolean`	`isGrib1()`
`GribCollection.Dataset`	`makeDataset(GribCollection.Type type)`
`GribCollection.GroupGC`	`makeGroup()`
`protected void`	`makeHorizCS()`
`static String`	`makeName(String collectionName, CalendarDate runtime)`
`static String`	`makeNameFromIndexFilename(String idxPathname)`
`static File`	`makeTopIndexFileFromConfig(FeatureCollectionConfig config)` This is only used for the top level GribCollection.
`GribCollection.VariableIndex`	`makeVariableIndex(GribCollection.GroupGC g, GribCollection.VariableIndex other)`
`GribCollection.VariableIndex`	`makeVariableIndex(GribCollection.GroupGC g, int cdmHash, int discipline, GribTables customizer, byte[] rawPds, List<Integer> index, long recordsPos, int recordsLen)`
`abstract String`	`makeVariableName(GribCollection.VariableIndex vindex)`
`void`	`setDirectory(File directory)`
`static void`	`setDiskCache2(DiskCache2 dc)`
`void`	`setFileCache(FileCacheIF fileCache)`
`void`	`setFileMap(Map<Integer,MFile> fileMap)`
`void`	`showIndex(Formatter f)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

MISSING_RECORD
```
public static final long MISSING_RECORD
```
See Also:
Constant Field Values

name
```
protected final String name
```

directory
```
protected File directory
```

config

protected final FeatureCollectionConfig config

isGrib1
```
protected final boolean isGrib1
```

version
```
public int version
```

center
```
public int center
```

subcenter
```
public int subcenter
```

master
```
public int master
```

local
```
public int local
```

genProcessType
```
public int genProcessType
```

genProcessId
```
public int genProcessId
```

backProcessId
```
public int backProcessId
```

params
```
public List<Parameter> params
```

fileMap
```
protected Map<Integer,MFile> fileMap
```

datasets

protected List<GribCollection.Dataset> datasets

horizCS

protected List<GribCollection.HorizCoordSys> horizCS

masterRuntime

protected CoordinateRuntime masterRuntime

cust
```
protected GribTables cust
```

indexRaf
```
protected RandomAccessFile indexRaf
```

objCache
```
protected FileCacheIF objCache
```

indexFilename
```
protected String indexFilename
```

countGC
```
public static int countGC
```

Constructor Detail

GribCollection

protected GribCollection(String name,
              File directory,
              FeatureCollectionConfig config,
              boolean isGrib1)

Method Detail

initDataRafCache

public static void initDataRafCache(int minElementsInMemory,
                    int maxElementsInMemory,
                    int period)

getDataRafCache

public static FileCacheIF getDataRafCache()

disableDataRafCache

public static void disableDataRafCache()

setDiskCache2

public static void setDiskCache2(DiskCache2 dc)

getDiskCache2

public static DiskCache2 getDiskCache2()

makeTopIndexFileFromConfig
```
public static File makeTopIndexFileFromConfig(FeatureCollectionConfig config)
```
This is only used for the top level GribCollection.

Parameters:
config - use this FeatureCollectionConfig

Returns:
index File

makeName

public static String makeName(String collectionName,
              CalendarDate runtime)

makeNameFromIndexFilename

public static String makeNameFromIndexFilename(String idxPathname)

getFileInCache
```
public static File getFileInCache(String path)
```
Get index file, may be in cache directory, may not exist

Parameters:
path - full path of index file

Returns:
File, possibly in cache

getFileInCache

public static File getFileInCache(File f)

getExistingFileOrCache

public static File getExistingFileOrCache(String path)

copyInfo

protected void copyInfo(GribCollection from)

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

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

getConfig

public FeatureCollectionConfig getConfig()

getFilenames
```
public List<String> getFilenames()
```
The files that comprise the colelction. Actual paths, including the grib cache if used.

Returns:
list of filename.

getIndexParentFile
```
public File getIndexParentFile()
```

getFilename

public String getFilename(int fileno)

getDatasets

public List<GribCollection.Dataset> getDatasets()

findDataset

public GribCollection.Dataset findDataset(String name)

makeDataset

public GribCollection.Dataset makeDataset(GribCollection.Type type)

getDatasetCanonical

public GribCollection.Dataset getDatasetCanonical()

getHorizCS

public GribCollection.HorizCoordSys getHorizCS(int index)

getMasterRuntime

public CoordinateRuntime getMasterRuntime()

makeHorizCS
```
protected void makeHorizCS()
```

findHorizCS

public int findHorizCS(GribCollection.HorizCoordSys hcs)

addHorizCoordSystem

public void addHorizCoordSystem(GdsHorizCoordSys hcs,
                       byte[] rawGds,
                       int gdsHash,
                       String nameOverride,
                       int predefinedGridDefinition)

findMFileByName

public MFile findMFileByName(String filename)

setFileMap

public void setFileMap(Map<Integer,MFile> fileMap)

getIndexFilepathInCache
```
public String getIndexFilepathInCache()
```
get index filename

Returns:
index filename; may not exist; may be in disk cache

getParams
```
public List<Parameter> getParams()
```

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()
```

isGrib1
```
public boolean isGrib1()
```

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

setDirectory

public void setDirectory(File directory)

makeVariableName

public abstract String makeVariableName(GribCollection.VariableIndex vindex)

getNetcdfDataset

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

Throws:: IOException

getGridDataset

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

Throws:: IOException

getDataRaf

public RandomAccessFile getDataRaf(int fileno)
                            throws IOException

Throws:: IOException

getDataFilename

public String getDataFilename(int fileno)
                       throws IOException

Throws:: IOException

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

close in interface AutoCloseable

Specified by:

close 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

makeVariableIndex

public GribCollection.VariableIndex makeVariableIndex(GribCollection.GroupGC g,
                                             int cdmHash,
                                             int discipline,
                                             GribTables customizer,
                                             byte[] rawPds,
                                             List<Integer> index,
                                             long recordsPos,
                                             int recordsLen)

makeVariableIndex

public GribCollection.VariableIndex makeVariableIndex(GribCollection.GroupGC g,
                                             GribCollection.VariableIndex other)

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

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

toString in class Object

makeGroup

public GribCollection.GroupGC makeGroup()

Class GribCollection

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MISSING_RECORD

name

directory

config

isGrib1

version

center

subcenter

master

local

genProcessType

genProcessId

backProcessId

params

fileMap

datasets

horizCS

masterRuntime

cust

indexRaf

objCache

indexFilename

countGC

Constructor Detail

GribCollection

Method Detail

initDataRafCache

getDataRafCache

disableDataRafCache

setDiskCache2

getDiskCache2

makeTopIndexFileFromConfig

makeName

makeNameFromIndexFilename

getFileInCache

getFileInCache

getExistingFileOrCache

copyInfo

getName

getFiles

getConfig

getFilenames

getIndexParentFile

getFilename

getDatasets

findDataset

makeDataset

getDatasetCanonical

getHorizCS

getMasterRuntime

makeHorizCS

findHorizCS

addHorizCoordSystem

findMFileByName

setFileMap

getIndexFilepathInCache

getParams

getCenter

getSubcenter

getMaster

getLocal

getGenProcessType

getGenProcessId

getBackProcessId

isGrib1

getDirectory

setDirectory

makeVariableName

getNetcdfDataset

getGridDataset

getDataRaf

getDataFilename

close