ucar.nc2.grib

Class GribCollection

java.lang.Object

ucar.nc2.grib.GribCollection

All Implemented Interfaces:

FileCacheable

Direct Known Subclasses:

Grib1Collection, Grib2Collection, TimePartition

@ThreadSafe
public abstract class GribCollection
extends Object
implements FileCacheable

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 .ncx files

Since:

4/6/11

Author:

caron

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	GribCollection.GcNetcdfFile
class	GribCollection.GroupHcs
static class	GribCollection.Record
class	GribCollection.VariableIndex

Field Summary

Fields

Modifier and Type	Field and Description
int	backProcessId
int	center
protected File	directory
int	genProcessId
int	genProcessType
protected FeatureCollectionConfig.GribConfig	gribConfig
List<GribCollection.GroupHcs>	groups
protected RandomAccessFile	indexRaf
protected boolean	isGrib1
int	local
int	master
static long	MISSING_RECORD
protected String	name
static String	NCX_IDX
protected FileCache	objCache
List<Parameter>	params
int	subcenter
int	version

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GribCollection(String name, File directory, FeatureCollectionConfig.GribConfig dcm, boolean isGrib1)

Method Summary

Methods

Modifier and Type	Method and Description
static int	calcIndex(int timeIdx, int ensIdx, int vertIdx, int flag, EnsCoord ec, VertCoord vc, EnsCoord ecp, VertCoord vcp) Find index in partition dataset when vert and/or ens coordinates dont match with proto
static int	calcIndex(int timeIdx, int ensIdx, int vertIdx, int nens, int nverts)
void	close()
static GribCollection	createFromIndex(boolean isGrib1, String name, File directory, RandomAccessFile raf, FeatureCollectionConfig.GribConfig config, org.slf4j.Logger logger)
static void	disableDataRafCache()
static GribCollection	factory(boolean isGrib1, CollectionManager dcm, CollectionManager.Force force, org.slf4j.Logger logger) Create a GribCollection from a collection of grib files
GribCollection.GroupHcs	findGroupById(String id)
int	findGroupIdxById(String id)
MFile	findMFileByName(String filename)
int	getBackProcessId()
int	getCenter()
RandomAccessFile	getDataRaf(int fileno)
static FileCache	getDataRafCache()
File	getDirectory()
static DiskCache2	getDiskCache2()
List<String>	getFilenames()
List<MFile>	getFiles()
int	getGenProcessId()
int	getGenProcessType()
abstract GridDataset	getGridDataset(String groupName, String filename, FeatureCollectionConfig.GribConfig gribConfig, org.slf4j.Logger logger)
GribCollection.GroupHcs	getGroup(int index)
List<GribCollection.GroupHcs>	getGroups()
File	getIndexFile() get index file; may not exist
static File	getIndexFile(CollectionManager dcm)
static File	getIndexFile(String path)
long	getLastModified()
int	getLocal()
String	getLocation()
int	getMaster()
String	getName()
abstract NetcdfDataset	getNetcdfDataset(String groupName, String filename, FeatureCollectionConfig.GribConfig gribConfig, org.slf4j.Logger logger)
List<Parameter>	getParams()
int	getSubcenter()
static void	initDataRafCache(int minElementsInMemory, int maxElementsInMemory, int period)
boolean	isGrib1()
GribCollection.GroupHcs	makeGroup()
File	makeNewIndexFile(org.slf4j.Logger logger)
GribCollection.VariableIndex	makeVariableIndex(GribCollection.GroupHcs g, int tableVersion, int discipline, int category, int parameter, int levelType, boolean isLayer, int intvType, String intvName, int ensDerivedType, int probType, String probabilityName, int genProcessType, int cdmHash, int timeIdx, int vertIdx, int ensIdx, long recordsPos, int recordsLen)
static void	setDiskCache2(DiskCache2 dc)
void	setFileCache(FileCache fileCache)
void	setFiles(List<MFile> files)
void	setIndexRaf(RandomAccessFile indexRaf) public by accident, do not use
void	showIndex(Formatter f)
String	toString()
static boolean	update(boolean isGrib1, CollectionManager dcm, org.slf4j.Logger logger)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

NCX_IDX

public static final String NCX_IDX

See Also:

Constant Field Values

MISSING_RECORD

public static final long MISSING_RECORD

See Also:

Constant Field Values

name

protected final String name

directory

protected final File directory

gribConfig

protected final FeatureCollectionConfig.GribConfig gribConfig

isGrib1

protected final boolean isGrib1

objCache

protected FileCache objCache

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

groups

public List<GribCollection.GroupHcs> groups

params

public List<Parameter> params

indexRaf

protected RandomAccessFile indexRaf

Constructor Detail

GribCollection

protected GribCollection(String name,
              File directory,
              FeatureCollectionConfig.GribConfig dcm,
              boolean isGrib1)

Method Detail

initDataRafCache

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

getDataRafCache

public static FileCache getDataRafCache()

disableDataRafCache

public static void disableDataRafCache()

getIndexFile

public static File getIndexFile(String path)

getIndexFile

public static File getIndexFile(CollectionManager dcm)

setDiskCache2

public static void setDiskCache2(DiskCache2 dc)

getDiskCache2

public static DiskCache2 getDiskCache2()

calcIndex

public static int calcIndex(int timeIdx,
            int ensIdx,
            int vertIdx,
            int nens,
            int nverts)

calcIndex

public static int calcIndex(int timeIdx,
            int ensIdx,
            int vertIdx,
            int flag,
            EnsCoord ec,
            VertCoord vc,
            EnsCoord ecp,
            VertCoord vcp)

Find index in partition dataset when vert and/or ens coordinates dont match with proto

Parameters:

timeIdx - time index in this partition

ensIdx - ensemble index in proto dataset

vertIdx - vert index in proto dataset

flag - TimePartition.VERT_COORDS_DIFFER and/or TimePartition.ENS_COORDS_DIFFER

ec - ensemble coord in partition dataset

vc - vert coord in partition dataset

ecp - ensemble coord in proto dataset

vcp - vert coord in proto dataset

Returns:

index in partition dataset

factory

public static GribCollection factory(boolean isGrib1,
                     CollectionManager dcm,
                     CollectionManager.Force force,
                     org.slf4j.Logger logger)
                              throws IOException

Create a GribCollection from a collection of grib files

Parameters:

isGrib1 - true if files are grib1, else grib2

dcm - the file collection : assume its been scanned

force - should index file be used or remade?

Returns:

GribCollection

Throws:

IOException - on io error

createFromIndex

public static GribCollection createFromIndex(boolean isGrib1,
                             String name,
                             File directory,
                             RandomAccessFile raf,
                             FeatureCollectionConfig.GribConfig config,
                             org.slf4j.Logger logger)
                                      throws IOException

Throws:

IOException

update

public static boolean update(boolean isGrib1,
             CollectionManager dcm,
             org.slf4j.Logger logger)
                      throws IOException

Throws:

IOException

getName

public String getName()

getFiles

public List<MFile> getFiles()

getFilenames

public List<String> getFilenames()

findMFileByName

public MFile findMFileByName(String filename)

setFiles

public void setFiles(List<MFile> files)

setIndexRaf

public void setIndexRaf(RandomAccessFile indexRaf)

public by accident, do not use

Parameters:

indexRaf - the open raf of the index file

getIndexFile

public File getIndexFile()

get index file; may not exist

Returns:

File, but may not exist

makeNewIndexFile

public File makeNewIndexFile(org.slf4j.Logger logger)

getGroups

public List<GribCollection.GroupHcs> getGroups()

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

getNetcdfDataset

public abstract NetcdfDataset getNetcdfDataset(String groupName,
                             String filename,
                             FeatureCollectionConfig.GribConfig gribConfig,
                             org.slf4j.Logger logger)
                                        throws IOException

Throws:

IOException

getGridDataset

public abstract GridDataset getGridDataset(String groupName,
                         String filename,
                         FeatureCollectionConfig.GribConfig gribConfig,
                         org.slf4j.Logger logger)
                                    throws IOException

Throws:

IOException

getGroup

public GribCollection.GroupHcs getGroup(int index)

findGroupById

public GribCollection.GroupHcs findGroupById(String id)

findGroupIdxById

public int findGroupIdxById(String id)

getDataRaf

public RandomAccessFile getDataRaf(int fileno)
                            throws IOException

Throws:

IOException

close

public void close()
           throws IOException

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(FileCache fileCache)

Specified by:

setFileCache in interface FileCacheable

makeVariableIndex

public GribCollection.VariableIndex makeVariableIndex(GribCollection.GroupHcs g,
                                             int tableVersion,
                                             int discipline,
                                             int category,
                                             int parameter,
                                             int levelType,
                                             boolean isLayer,
                                             int intvType,
                                             String intvName,
                                             int ensDerivedType,
                                             int probType,
                                             String probabilityName,
                                             int genProcessType,
                                             int cdmHash,
                                             int timeIdx,
                                             int vertIdx,
                                             int ensIdx,
                                             long recordsPos,
                                             int recordsLen)

showIndex

public void showIndex(Formatter f)

toString

public String toString()

Overrides:

toString in class Object

makeGroup

public GribCollection.GroupHcs makeGroup()