ucar.grid
Class GridIndex

java.lang.Object
  extended by ucar.grid.GridIndex

public final class GridIndex
extends java.lang.Object

An "in memory" index for 2D grid files.


Field Summary
static java.lang.String current_index_version
          used to check versions of already created indexes.
 
Constructor Summary
GridIndex()
          Constructor for creating an Index from the Grid file.
 
Method Summary
 void addGlobalAttribute(java.lang.String name, java.lang.String value)
          adds a GlobalAttribute to the index.
 void addGridRecord(GridRecord gr)
          adds a GridRecord to the index.
 void addHorizCoordSys(GridDefRecord gds)
          adds a GridDefRecord to the index.
 void finish()
          compares GDS for duplicates
 java.util.Map<java.lang.String,java.lang.String> getGlobalAttributes()
          GlobalAttributes of index.
 int getGridCount()
          Get the grid count
 java.util.List<GridRecord> getGridRecords()
          Grib records of index, one for each parameter.
 java.util.List<GridDefRecord> getHorizCoordSys()
          GridDefs of the index.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

current_index_version

public static final java.lang.String current_index_version
used to check versions of already created indexes.

See Also:
Constant Field Values
Constructor Detail

GridIndex

public GridIndex()
Constructor for creating an Index from the Grid file. Use the addXXX() methods.

Method Detail

getGlobalAttributes

public final java.util.Map<java.lang.String,java.lang.String> getGlobalAttributes()
GlobalAttributes of index.

Returns:
HashMap of type GlobalAttributes.

getGridRecords

public final java.util.List<GridRecord> getGridRecords()
Grib records of index, one for each parameter.

Returns:
list of type GridRecord.

getHorizCoordSys

public final java.util.List<GridDefRecord> getHorizCoordSys()
GridDefs of the index.

Returns:
list of type GridDef.

addGridRecord

public final void addGridRecord(GridRecord gr)
adds a GridRecord to the index.

Parameters:
gr - GridRecord

addHorizCoordSys

public final void addHorizCoordSys(GridDefRecord gds)
adds a GridDefRecord to the index.

Parameters:
gds - GdsRecord

addGlobalAttribute

public final void addGlobalAttribute(java.lang.String name,
                                     java.lang.String value)
adds a GlobalAttribute to the index.

Parameters:
name - GlobalAttribute
value - String

getGridCount

public int getGridCount()
Get the grid count

Returns:
the count

finish

public void finish()
compares GDS for duplicates