Issue #189 update readme with more install notes, remove common subgrid package that was moved to edex, mark several classes deprecated.

Former-commit-id: a6ef4957d6 [formerly a6ef4957d6 [formerly 99df0ed1cf531a6b60035b79bd5a2cbdf262328d]]
Former-commit-id: c1c55fa7aa
Former-commit-id: e4b81a6829

deltaScripts/unified_grid/README.txt

@@ -16,6 +16,17 @@ convert_grib_data.py can take a significant amount of time, as much as 2 hours.
 If you don't need your data and you want to upgrade faster you can purge all grib data.
 If there is no grib data to convert there is no need to run convert_grib_data.py.
 
+After convert_grib_data.py has run, it may not convert all models(perhaps skipping
+alaskan, hawaiin, or other models.) If this is the case there will be data left over
+in /awips2/edex/data/hdf5/grib. This data can be used if you need to convert additional
+models or if a rollback is necessary. The system is not set up to purge this data, so
+after a successful upgrade when new data is arriving this directory will need to be deleted.
+
+The format of the data in /awips2/edex/data/hdf5/topo/modelStaticTopo.h5 has changed. When the
+ingestGrib edex is started it will attempt to regenerate this file. This is a very time and
+memory intensive process. To save time when upgrading an operational system it is recommended
+that you copy a modelStaticTopo.h5 file from a testbed or other system that has already generated it.
+
 The update_saved_display.sh script can be used if there are any saved displays that are
 saved outside of localization.
 

edexOsgi/com.raytheon.edex.plugin.grib/src/com/raytheon/edex/plugin/grib/dao/GribDao.java

@@ -68,7 +68,7 @@ import com.raytheon.uf.edex.database.plugin.PluginDao;
 import com.raytheon.uf.edex.database.query.DatabaseQuery;
 
 /**
- * Data access object for accessing Grib records from the database
+ * Deprecated, use grid
  * 
  * <pre>
  * 
@@ -85,6 +85,7 @@ import com.raytheon.uf.edex.database.query.DatabaseQuery;
  * @author bphillip
  * @version 1
  */
+@Deprecated
 public class GribDao extends PluginDao {
 
     private static final transient IUFStatusHandler statusHandler = UFStatus

edexOsgi/com.raytheon.edex.plugin.grib/src/com/raytheon/edex/plugin/grib/dao/GribModelDao.java

@@ -42,7 +42,7 @@ import com.raytheon.uf.edex.database.dao.CoreDao;
 import com.raytheon.uf.edex.database.dao.DaoConfig;
 
 /**
- * Data access object for retrieving GribModel objects from the database
+ * Deprecated, use grid
  * 
  * <pre>
  * 
@@ -57,6 +57,7 @@ import com.raytheon.uf.edex.database.dao.DaoConfig;
  * @author bphillip
  * @version 1
  */
+@Deprecated
 public class GribModelDao extends CoreDao {
 
     private static final IUFStatusHandler handler = UFStatus

edexOsgi/com.raytheon.uf.common.dataplugin.grib/META-INF/MANIFEST.MF

@@ -26,6 +26,5 @@ Import-Package: com.raytheon.uf.common.dataplugin.grid,
  com.raytheon.uf.common.gridcoverage.exception,
  com.raytheon.uf.common.parameter
 Export-Package: com.raytheon.uf.common.dataplugin.grib,
- com.raytheon.uf.common.dataplugin.grib.request,
+ com.raytheon.uf.common.dataplugin.grib.request
- com.raytheon.uf.common.dataplugin.grib.subgrid
 Bundle-RequiredExecutionEnvironment: JavaSE-1.6

edexOsgi/com.raytheon.uf.common.dataplugin.grib/src/com/raytheon/uf/common/dataplugin/grib/GribModel.java

@@ -49,8 +49,7 @@ import com.raytheon.uf.common.serialization.annotations.DynamicSerialize;
 import com.raytheon.uf.common.serialization.annotations.DynamicSerializeElement;
 
 /**
- * Class encapsulating parameter, level, and spatial information of the grib
+ * Deprecated, use grid
- * record.
  * 
  * <pre>
  * 
@@ -70,6 +69,7 @@ import com.raytheon.uf.common.serialization.annotations.DynamicSerializeElement;
 @XmlRootElement
 @XmlAccessorType(XmlAccessType.NONE)
 @DynamicSerialize
+@Deprecated
 public class GribModel extends PersistableDataObject {
 
     private static final long serialVersionUID = 4417959632479879335L;

edexOsgi/com.raytheon.uf.common.dataplugin.grib/src/com/raytheon/uf/common/dataplugin/grib/GribPathProvider.java

@@ -30,7 +30,7 @@ import com.raytheon.uf.common.dataplugin.persist.DefaultPathProvider;
 import com.raytheon.uf.common.dataplugin.persist.IPersistable;
 
 /**
- * Path provider for storing grib data to HDF5
+ * Deprecated, use grid
  * 
  * <pre>
  * 
@@ -45,6 +45,7 @@ import com.raytheon.uf.common.dataplugin.persist.IPersistable;
  * @author bphillip
  * @version 1
  */
+@Deprecated
 public class GribPathProvider extends DefaultPathProvider {
 
     private static final DecimalFormat forecastHourFormat = new DecimalFormat(

edexOsgi/com.raytheon.uf.common.dataplugin.grib/src/com/raytheon/uf/common/dataplugin/grib/GribRecord.java

@@ -51,7 +51,7 @@ import com.raytheon.uf.common.serialization.annotations.DynamicSerialize;
 import com.raytheon.uf.common.serialization.annotations.DynamicSerializeElement;
 
 /**
- * Record class for the grib plugin.
+ * Deprecated, use grid
  * 
  * <pre>
  * 
@@ -71,6 +71,7 @@ import com.raytheon.uf.common.serialization.annotations.DynamicSerializeElement;
 @XmlRootElement
 @XmlAccessorType(XmlAccessType.NONE)
 @DynamicSerialize
+@Deprecated
 public class GribRecord extends PersistablePluginDataObject implements
         IPersistable, ISpatialEnabled, IPrecomputedRange {
 

edexOsgi/com.raytheon.uf.common.dataplugin.grib/src/com/raytheon/uf/common/dataplugin/grib/request/GetCoveragesRequest.java

@@ -27,7 +27,7 @@ import com.raytheon.uf.common.serialization.comm.IServerRequest;
 
 /**
  * 
- * TODO Add Description
+ * Deprecated, use grid
  * 
  * <pre>
  * 
@@ -43,6 +43,7 @@ import com.raytheon.uf.common.serialization.comm.IServerRequest;
  * @version 1.0
  */
 @DynamicSerialize
+@Deprecated
 public class GetCoveragesRequest implements IServerRequest {
     @DynamicSerializeElement
     private List<String> modelNames;

edexOsgi/com.raytheon.uf.common.dataplugin.grib/src/com/raytheon/uf/common/dataplugin/grib/subgrid/SubGridDef.java

@@ -1,172 +0,0 @@
-/**
- * This software was developed and / or modified by Raytheon Company,
- * pursuant to Contract DG133W-05-CQ-1067 with the US Government.
- * 
- * U.S. EXPORT CONTROLLED TECHNICAL DATA
- * This software product contains export-restricted data whose
- * export/transfer/disclosure is restricted by U.S. law. Dissemination
- * to non-U.S. persons whether in the United States or abroad requires
- * an export license or other authorization.
- * 
- * Contractor Name:        Raytheon Company
- * Contractor Address:     6825 Pine Street, Suite 340
- *                         Mail Stop B8
- *                         Omaha, NE 68106
- *                         402.291.0100
- * 
- * See the AWIPS II Master Rights File ("Master Rights File.pdf") for
- * further licensing information.
- **/
-package com.raytheon.uf.common.dataplugin.grib.subgrid;
-
-import java.util.List;
-
-import javax.xml.bind.annotation.XmlAccessType;
-import javax.xml.bind.annotation.XmlAccessorType;
-import javax.xml.bind.annotation.XmlElement;
-import javax.xml.bind.annotation.XmlList;
-import javax.xml.bind.annotation.XmlRootElement;
-
-import com.raytheon.uf.common.geospatial.MapUtil;
-import com.raytheon.uf.common.serialization.ISerializableObject;
-
-/**
- * A sub grid definition
- * 
- * <pre>
- * 
- * SOFTWARE HISTORY
- * Date         Ticket#    Engineer    Description
- * ------------ ---------- ----------- --------------------------
- * Jun 25, 2010            rjpeter     Initial creation
- * Jul 25, 2012 977        rjpeter     Add optional centerLatitude/centerLongitude
- * </pre>
- * 
- * @author rjpeter
- * @version 1.0
- */
-@XmlRootElement
-@XmlAccessorType(XmlAccessType.NONE)
-public class SubGridDef implements ISerializableObject {
-    /** The model names this sub grid applies to */
-    @XmlElement(required = true)
-    @XmlList
-    private List<String> modelNames;
-
-    @XmlElement(required = true)
-    private String referenceModel;
-
-    @XmlElement(required = true)
-    private double nx;
-
-    @XmlElement(required = true)
-    private double ny;
-
-    // annotation on setter to enforce data constraints
-    private Double centerLatitude;
-
-    // annotation on setter to enforce data constraints
-    private Double centerLongitude;
-
-    /** the lower left latitude */
-    private double lowerLeftLat;
-
-    /** the lower left longitude */
-    private double lowerLeftLon;
-
-    /** the upper right latitude */
-    private double upperRightLat;
-
-    /** the upper right longitude */
-    private double upperRightLon;
-
-    public List<String> getModelNames() {
-        return modelNames;
-    }
-
-    public void setModelNames(final List<String> modelNames) {
-        this.modelNames = modelNames;
-    }
-
-    public double getLowerLeftLat() {
-        return lowerLeftLat;
-    }
-
-    public void setLowerLeftLat(final double lowerLeftLat) {
-        this.lowerLeftLat = lowerLeftLat;
-    }
-
-    public double getLowerLeftLon() {
-        return lowerLeftLon;
-    }
-
-    public void setLowerLeftLon(final double lowerLeftLon) {
-        this.lowerLeftLon = lowerLeftLon;
-    }
-
-    public double getUpperRightLat() {
-        return upperRightLat;
-    }
-
-    public void setUpperRightLat(final double upperRightLat) {
-        this.upperRightLat = upperRightLat;
-    }
-
-    public double getUpperRightLon() {
-        return upperRightLon;
-    }
-
-    public void setUpperRightLon(final double upperRightLon) {
-        this.upperRightLon = upperRightLon;
-    }
-
-    public double getNx() {
-        return nx;
-    }
-
-    public void setNx(final double nx) {
-        this.nx = nx;
-    }
-
-    public double getNy() {
-        return ny;
-    }
-
-    public void setNy(final double ny) {
-        this.ny = ny;
-    }
-
-    public String getReferenceModel() {
-        return referenceModel;
-    }
-
-    public void setReferenceModel(final String referenceModel) {
-        this.referenceModel = referenceModel;
-    }
-
-    public Double getCenterLatitude() {
-        return centerLatitude;
-    }
-
-    @XmlElement
-    public void setCenterLatitude(final Double centerLatitude) {
-        this.centerLatitude = centerLatitude;
-        if (this.centerLatitude != null) {
-            this.centerLatitude = new Double(MapUtil.correctLat(centerLatitude
-                    .doubleValue()));
-        }
-    }
-
-    public Double getCenterLongitude() {
-        return centerLongitude;
-    }
-
-    @XmlElement
-    public void setCenterLongitude(final Double centerLongitude) {
-        this.centerLongitude = centerLongitude;
-        if (this.centerLongitude != null) {
-            this.centerLongitude = new Double(
-                    MapUtil.correctLon(centerLongitude.doubleValue()));
-        }
-    }
-}