ucar.grib.grib2
Class Grib2GridTableLookup

java.lang.Object
  extended by ucar.grib.grib2.Grib2GridTableLookup
All Implemented Interfaces:
GridTableLookup

public final class Grib2GridTableLookup
extends java.lang.Object
implements GridTableLookup


Field Summary
 
Fields inherited from interface ucar.grid.GridTableLookup
AlbersEqualArea, Curvilinear, GaussianLatLon, LambertAzimuthEqualArea, LambertConformal, Mercator, Orthographic, PolarStereographic, RotatedLatLon, UTM
 
Constructor Summary
Grib2GridTableLookup(Grib2Record firstRecord)
          Constructor.
 
Method Summary
 java.lang.String getCategoryName(GridRecord gr)
          gets the CategoryName.
 java.lang.String getComment()
          comment for CF conventions.
 java.lang.String getDisciplineName(GridRecord gr)
          gets the DisciplineName.
 java.util.Date getFirstBaseTime()
          Get the first base time
 java.lang.String getFirstCenterName()
          gets the CenterName.
 float getFirstMissingValue()
          gets the MissingValue.
 java.lang.String getFirstProductStatusName()
          gets the ProductStatusName.
 java.lang.String getFirstProductTypeName()
          gets the ProductTypeName.
 java.lang.String getFirstSignificanceOfRTName()
          gets the SignificanceOfRTName.
 int getFirstSubcenterId()
          gets the SubcenterId.
 java.lang.String getFirstSubcenterName()
          gets the Subcenter Name, dependant on center.
 java.lang.String getFirstTimeRangeUnitName()
          gets the TimeRangeUnitName.
 java.lang.String getGridName(GridDefRecord gds)
          gets the grid type.
 java.lang.String getGridType()
          gets the grid type.
 java.lang.String getInstitution()
          Institution for CF conventions
 java.lang.String getLevelDescription(GridRecord gr)
          gets the LevelDescription.
 java.lang.String getLevelName(GridRecord gr)
          gets the LevelName.
 java.lang.String getLevelUnit(GridRecord gr)
          gets the LevelUnit.
 int getNB()
          gets the Number of Bands in the radar PDS.
 GridParameter getParameter(GridRecord gr)
          Get the grid parameter that corresponds to this record
 int[] getParameterId(GridRecord gr)
           
 int getProductDefinition(GridRecord gr)
          gets the ProductDefinition.
 java.lang.String getProductDefinitionName(GridRecord gr)
          gets the ProductDefinitionName.
 int getProjectionType(GridDefRecord gds)
          gets the ProjectionType.
 int[] getSatellite()
          gets the Satellite in the radar PDS.
 int[] getSatelliteInstrument()
          gets the Satellite Instrument in the radar PDS.
 int[] getSatelliteSeries()
          gets the Satellite Series in the radar PDS.
 float[] getSatelliteWave()
          gets the Satellite Wave in the radar PDS.
 java.lang.String getShapeName(GridDefRecord gds)
          gets the ShapeName.
 java.lang.String getSource()
          gets the Source, Generating Process or Model.
 java.lang.String getTitle()
          gets the CF title.
 int getTypeGenProcess(GridRecord gr)
          gets the Type of Gen Process.
 java.lang.String getTypeGenProcessName()
           
 java.lang.String getTypeGenProcessName(GridRecord gr)
          gets the Type of Gen Process Name.
 boolean isEnsemble(GridRecord gr)
          Ensemble type variable.
 boolean isInterval(GridRecord gr)
          is this GridRecord an Interval
 boolean isLatLon(GridDefRecord gds)
          is this a LatLon grid.
 boolean isLayer(GridRecord gr)
          Check to see if this grid is a layer variable
 boolean isPositiveUp(GridRecord gr)
          is this a PositiveUp VerticalCoordinate.
 boolean isProbability(GridRecord gr)
          gets the isProbability type var.
 boolean isVerticalCoordinate(GridRecord gr)
          is this a VerticalCoordinate.
 java.lang.String makeEnsembleName(GridRecord gr, GridTableLookup lookup)
          Make the ensemble name
 java.lang.String makeProbabilityName(GridRecord gr, GridTableLookup lookup)
          Make the probability name
 java.lang.String makeSuffix(GridRecord gr)
          Makes a Ensemble, Derived, Probability or error Suffix
 java.lang.String NumberOfForecastsInEnsemble(GridRecord gr)
          gets the number of forecast in Ensemble, Derived, or Probability.
 java.lang.String NumberOfForecastsInProbability(GridRecord gr)
          gets the number of forecasts in Probability.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Grib2GridTableLookup

public Grib2GridTableLookup(Grib2Record firstRecord)
Constructor.

Parameters:
firstRecord - in the Grib file
Method Detail

getGridName

public final java.lang.String getGridName(GridDefRecord gds)
gets the grid type.

Specified by:
getGridName in interface GridTableLookup
Parameters:
gds - Grib2GridDefinitionSection
Returns:
GridName

getShapeName

public final java.lang.String getShapeName(GridDefRecord gds)
gets the ShapeName.

Specified by:
getShapeName in interface GridTableLookup
Parameters:
gds - Grib2GridDefinitionSection
Returns:
ShapeName

getDisciplineName

public final java.lang.String getDisciplineName(GridRecord gr)
gets the DisciplineName.

Specified by:
getDisciplineName in interface GridTableLookup
Parameters:
gr - GridRecord
Returns:
DisciplineName

getCategoryName

public final java.lang.String getCategoryName(GridRecord gr)
gets the CategoryName.

Specified by:
getCategoryName in interface GridTableLookup
Parameters:
gr - GridRecord
Returns:
CategoryName

getParameter

public GridParameter getParameter(GridRecord gr)
Get the grid parameter that corresponds to this record

Specified by:
getParameter in interface GridTableLookup
Parameters:
gr - record to check
Returns:
Parameter.

getParameterId

public int[] getParameterId(GridRecord gr)
Parameters:
gr - GridRecord
Returns:
int[] representing the parameter discipline, category, and parmeter number

getProductDefinitionName

public final java.lang.String getProductDefinitionName(GridRecord gr)
gets the ProductDefinitionName.

Parameters:
gr - GridRecord
Returns:
ProductDefinitionName

getProductDefinition

public final int getProductDefinition(GridRecord gr)
gets the ProductDefinition.

Parameters:
gr - GridRecord
Returns:
ProductDefinition

getSource

public final java.lang.String getSource()
gets the Source, Generating Process or Model.

Specified by:
getSource in interface GridTableLookup
Returns:
source

getTypeGenProcessName

public final java.lang.String getTypeGenProcessName(GridRecord gr)
gets the Type of Gen Process Name.

Parameters:
gr - GridRecord
Returns:
typeGenProcessName

getTypeGenProcessName

public final java.lang.String getTypeGenProcessName()

getTypeGenProcess

public final int getTypeGenProcess(GridRecord gr)
gets the Type of Gen Process.

Parameters:
gr - GridRecord
Returns:
typeGenProcessName

isEnsemble

public final boolean isEnsemble(GridRecord gr)
Ensemble type variable.

Parameters:
gr - GridRecord
Returns:
boolean

NumberOfForecastsInEnsemble

public final java.lang.String NumberOfForecastsInEnsemble(GridRecord gr)
gets the number of forecast in Ensemble, Derived, or Probability.

Parameters:
gr - GridRecord
Returns:
String number of forecasts as a String

makeEnsembleName

public final java.lang.String makeEnsembleName(GridRecord gr,
                                               GridTableLookup lookup)
Make the ensemble name

Parameters:
gr - grid record
lookup - lookup table
Returns:
name for the level

isProbability

public final boolean isProbability(GridRecord gr)
gets the isProbability type var.

Parameters:
gr - GridRecord
Returns:
boolean

NumberOfForecastsInProbability

public final java.lang.String NumberOfForecastsInProbability(GridRecord gr)
gets the number of forecasts in Probability.

Parameters:
gr - GridRecord
Returns:
String number of forecasts as a String

makeProbabilityName

public final java.lang.String makeProbabilityName(GridRecord gr,
                                                  GridTableLookup lookup)
Make the probability name

Parameters:
gr - grid record
lookup - lookup table
Returns:
name for the level

makeSuffix

public java.lang.String makeSuffix(GridRecord gr)
Makes a Ensemble, Derived, Probability or error Suffix

Parameters:
gr - GridRecord
Returns:
suffix

getLevelName

public final java.lang.String getLevelName(GridRecord gr)
gets the LevelName.

Specified by:
getLevelName in interface GridTableLookup
Parameters:
gr - GridRecord
Returns:
LevelName

getLevelDescription

public final java.lang.String getLevelDescription(GridRecord gr)
gets the LevelDescription.

Specified by:
getLevelDescription in interface GridTableLookup
Parameters:
gr - GridRecord
Returns:
LevelDescription

getLevelUnit

public final java.lang.String getLevelUnit(GridRecord gr)
gets the LevelUnit.

Specified by:
getLevelUnit in interface GridTableLookup
Parameters:
gr - GridRecord
Returns:
LevelUnit

getFirstBaseTime

public final java.util.Date getFirstBaseTime()
Get the first base time

Specified by:
getFirstBaseTime in interface GridTableLookup
Returns:
FirstBaseTime.

getFirstTimeRangeUnitName

public final java.lang.String getFirstTimeRangeUnitName()
gets the TimeRangeUnitName.

Specified by:
getFirstTimeRangeUnitName in interface GridTableLookup
Returns:
TimeRangeUnitName

getFirstCenterName

public final java.lang.String getFirstCenterName()
gets the CenterName.

Returns:
CenterName

getFirstSubcenterId

public final int getFirstSubcenterId()
gets the SubcenterId.

Returns:
SubcenterId

getFirstSubcenterName

public final java.lang.String getFirstSubcenterName()
gets the Subcenter Name, dependant on center.

Returns:
Subcenter Name

getInstitution

public java.lang.String getInstitution()
Institution for CF conventions

Specified by:
getInstitution in interface GridTableLookup
Returns:
Institution

getFirstProductStatusName

public final java.lang.String getFirstProductStatusName()
gets the ProductStatusName.

Returns:
ProductStatusName

getComment

public final java.lang.String getComment()
comment for CF conventions.

Specified by:
getComment in interface GridTableLookup
Returns:
comment

getFirstProductTypeName

public final java.lang.String getFirstProductTypeName()
gets the ProductTypeName.

Returns:
ProductTypeName

getTitle

public final java.lang.String getTitle()
gets the CF title.

Specified by:
getTitle in interface GridTableLookup
Returns:
title

getFirstSignificanceOfRTName

public final java.lang.String getFirstSignificanceOfRTName()
gets the SignificanceOfRTName.

Returns:
SignificanceOfRTName

isLatLon

public final boolean isLatLon(GridDefRecord gds)
is this a LatLon grid.

Specified by:
isLatLon in interface GridTableLookup
Parameters:
gds - GridDefRecord
Returns:
isLatLon

getProjectionType

public final int getProjectionType(GridDefRecord gds)
gets the ProjectionType.

Specified by:
getProjectionType in interface GridTableLookup
Parameters:
gds - GridDefRecord
Returns:
ProjectionType

isVerticalCoordinate

public final boolean isVerticalCoordinate(GridRecord gr)
is this a VerticalCoordinate.

Specified by:
isVerticalCoordinate in interface GridTableLookup
Parameters:
gr - GridRecord
Returns:
isVerticalCoordinate

isPositiveUp

public final boolean isPositiveUp(GridRecord gr)
is this a PositiveUp VerticalCoordinate.

Specified by:
isPositiveUp in interface GridTableLookup
Parameters:
gr - GridRecord
Returns:
isPositiveUp

getFirstMissingValue

public final float getFirstMissingValue()
gets the MissingValue. Grib Package is written to use Float.NaN.

Specified by:
getFirstMissingValue in interface GridTableLookup
Returns:
MissingValue

isLayer

public final boolean isLayer(GridRecord gr)
Check to see if this grid is a layer variable

Specified by:
isLayer in interface GridTableLookup
Parameters:
gr - record to check
Returns:
true if a layer

isInterval

public final boolean isInterval(GridRecord gr)
is this GridRecord an Interval

Parameters:
gr - GridRecord
Returns:
isInterval

getNB

public final int getNB()
gets the Number of Bands in the radar PDS.

Returns:
NB int

getSatelliteSeries

public final int[] getSatelliteSeries()
gets the Satellite Series in the radar PDS.

Returns:
series1 int[]

getSatellite

public final int[] getSatellite()
gets the Satellite in the radar PDS.

Returns:
satellite int[]

getSatelliteInstrument

public final int[] getSatelliteInstrument()
gets the Satellite Instrument in the radar PDS.

Returns:
Instrument int[]

getSatelliteWave

public final float[] getSatelliteWave()
gets the Satellite Wave in the radar PDS.

Returns:
series2 int[]

getGridType

public final java.lang.String getGridType()
gets the grid type.

Specified by:
getGridType in interface GridTableLookup
Returns:
GridType