gov/nasa/worldwind/Level.java

   1 /*
   2 Copyright (C) 2001, 2006 United States Government
   3 as represented by the Administrator of the
   4 National Aeronautics and Space Administration.
   5 All Rights Reserved.
   6 */
   7 package gov.nasa.worldwind;
   8
   9 import gov.nasa.worldwind.geom.*;
  10
  11 import java.net.*;
  12
  13 /**
  14  * @author tag
  15  * @version $Id: Level.java 2146 2007-06-26 07:24:14Z tgaskins $
  16  */
  17 public class Level implements Comparable<Level>
  18 {
  19     private final AVList params;
  20     private final int levelNumber;
  21     private final String levelName; // null or empty level name signifies no data resources associated with this level
  22     private final LatLon tileDelta;
  23     private final int tileWidth;
  24     private final int tileHeight;
  25     private final String cacheName;
  26     private final String service;
  27     private final String dataset;
  28     private final String formatSuffix;
  29     private final double averageTexelSize;
  30     private final String path;
  31     private final TileUrlBuilder urlBuilder;
  32     private long expiryTime = 0;
  33
  34     // Absent tiles: A tile is deemed absent if a specified maximum number of attempts have been made to retrieve it.
  35     // Retrieval attempts are governed by a minimum time interval between successive attempts. If an attempt is made
  36     // within this interval, the tile is still deemed to be absent until the interval expires.
  37     private final AbsentResourceList absentTiles;
  38     int DEFAULT_MAX_ABSENT_TILE_ATTEMPTS = 2;
  39     int DEFAULT_MIN_ABSENT_TILE_CHECK_INTERVAL = 10000; // milliseconds
  40
  41     public Level(AVList params)
  42     {
  43         if (params == null)
  44         {
  45             String message = WorldWind.retrieveErrMsg("nullValue.LayerParams");
  46             WorldWind.logger().log(java.util.logging.Level.FINE, message);
  47             throw new IllegalArgumentException(message);
  48         }
  49
  50         this.params = params.copy(); // Private copy to insulate from subsequent changes by the app
  51         String message = this.validate(params);
  52         if (message != null)
  53         {
  54             WorldWind.logger().log(java.util.logging.Level.FINE, message);
  55             throw new IllegalArgumentException(message);
  56         }
  57
  58         String ln = this.params.getStringValue(AVKey.LEVEL_NAME);
  59         this.levelName = ln != null ? ln : "";
  60
  61         this.levelNumber = (Integer) this.params.getValue(AVKey.LEVEL_NUMBER);
  62         this.tileDelta = (LatLon) this.params.getValue(AVKey.TILE_DELTA);
  63         this.tileWidth = (Integer) this.params.getValue(AVKey.TILE_WIDTH);
  64         this.tileHeight = (Integer) this.params.getValue(AVKey.TILE_HEIGHT);
  65         this.cacheName = this.params.getStringValue(AVKey.CACHE_NAME);
  66         this.service = this.params.getStringValue(AVKey.SERVICE);
  67         this.dataset = this.params.getStringValue(AVKey.DATASET_NAME);
  68         this.formatSuffix = this.params.getStringValue(AVKey.FORMAT_SUFFIX);
  69         this.urlBuilder = (TileUrlBuilder) this.params.getValue(AVKey.TILE_URL_BUILDER);
  70         this.expiryTime = AVListImpl.getLongValue(params, AVKey.EXPIRY_TIME, 0L);
  71
  72         double averageTileSize = 0.5 * (this.tileWidth + this.tileHeight);
  73         double averageTileDelta =
  74             0.5 * (this.tileDelta.getLatitude().getRadians() + this.tileDelta.getLongitude().getRadians());
  75         this.averageTexelSize = averageTileDelta / averageTileSize;
  76
  77         this.path = this.cacheName + "/" + this.levelName;
  78
  79         Integer maxAbsentTileAttempts = (Integer) this.params.getValue(AVKey.MAX_ABSENT_TILE_ATTEMPTS);
  80         if (maxAbsentTileAttempts == null)
  81             maxAbsentTileAttempts = DEFAULT_MAX_ABSENT_TILE_ATTEMPTS;
  82
  83         Integer minAbsentTileCheckInterval = (Integer) this.params.getValue(AVKey.MIN_ABSENT_TILE_CHECK_INTERVAL);
  84         if (minAbsentTileCheckInterval == null)
  85             minAbsentTileCheckInterval = DEFAULT_MIN_ABSENT_TILE_CHECK_INTERVAL;
  86
  87         this.absentTiles = new AbsentResourceList(maxAbsentTileAttempts, minAbsentTileCheckInterval);
  88     }
  89
  90     /**
  91      * Determines whether the constructor arguments are valid.
  92      * @param params the list of parameters to validate.
  93      * @return null if valid, otherwise a <code>String</code> containing a description of why it's invalid.
  94      */
  95     protected String validate(AVList params)
  96     {
  97         StringBuffer sb = new StringBuffer();
  98
  99         Object o = params.getValue(AVKey.LEVEL_NUMBER);
 100         if (o == null || !(o instanceof Integer) || ((Integer) o) < 0)
 101             sb.append(WorldWind.retrieveErrMsg("term.levelNumber"));
 102
 103         o = params.getValue(AVKey.LEVEL_NAME);
 104         if (o == null || !(o instanceof String))
 105             sb.append(WorldWind.retrieveErrMsg("term.levelName"));
 106
 107         o = params.getValue(AVKey.TILE_WIDTH);
 108         if (o == null || !(o instanceof Integer) || ((Integer) o) < 0)
 109             sb.append(WorldWind.retrieveErrMsg("term.tileWidth"));
 110
 111         o = params.getValue(AVKey.TILE_HEIGHT);
 112         if (o == null || !(o instanceof Integer) || ((Integer) o) < 0)
 113             sb.append(WorldWind.retrieveErrMsg("term.tileHeight"));
 114
 115         o = params.getValue(AVKey.TILE_DELTA);
 116         if (o == null || !(o instanceof LatLon))
 117             sb.append(WorldWind.retrieveErrMsg("term.tileDelta"));
 118
 119         o = params.getValue(AVKey.CACHE_NAME);
 120         if (o == null || !(o instanceof String) || ((String) o).length() < 1)
 121             sb.append(WorldWind.retrieveErrMsg("term.cacheFolder"));
 122
 123         o = params.getValue(AVKey.TILE_URL_BUILDER);
 124         if (o == null || !(o instanceof TileUrlBuilder))
 125             sb.append(WorldWind.retrieveErrMsg("term.tileURLBuilder"));
 126
 127         o = params.getValue(AVKey.EXPIRY_TIME);
 128         if (o != null && (!(o instanceof Long) || ((Long) o) < 1))
 129             sb.append(WorldWind.retrieveErrMsg("term.expiryTime"));
 130
 131         if (params.getStringValue(AVKey.LEVEL_NAME).length() > 0)
 132         {
 133             o = params.getValue(AVKey.SERVICE);
 134             if (o == null || !(o instanceof String) || ((String) o).length() < 1)
 135                 sb.append(WorldWind.retrieveErrMsg("term.service"));
 136
 137             o = params.getValue(AVKey.DATASET_NAME);
 138             if (o == null || !(o instanceof String) || ((String) o).length() < 1)
 139                 sb.append(WorldWind.retrieveErrMsg("term.datasetName"));
 140
 141             o = params.getValue(AVKey.FORMAT_SUFFIX);
 142             if (o == null || !(o instanceof String) || ((String) o).length() < 1)
 143                 sb.append(WorldWind.retrieveErrMsg("term.formatSuffix"));
 144         }
 145
 146         if (sb.length() == 0)
 147             return null;
 148
 149         return sb.insert(0, WorldWind.retrieveErrMsg("layers.LevelSet.InvalidLevelDescriptorFields")).toString();
 150     }
 151
 152     public final AVList getParams()
 153     {
 154         return params;
 155     }
 156
 157     public String getPath()
 158     {
 159         return this.path;
 160     }
 161
 162     public final int getLevelNumber()
 163     {
 164         return this.levelNumber;
 165     }
 166
 167     public String getLevelName()
 168     {
 169         return this.levelName;
 170     }
 171
 172     public LatLon getTileDelta()
 173     {
 174         return this.tileDelta;
 175     }
 176
 177     public final int getTileWidth()
 178     {
 179         return this.tileWidth;
 180     }
 181
 182     public final int getTileHeight()
 183     {
 184         return this.tileHeight;
 185     }
 186
 187     public final String getFormatSuffix()
 188     {
 189         return this.formatSuffix;
 190     }
 191
 192     public final String getService()
 193     {
 194         return this.service;
 195     }
 196
 197     public final String getDataset()
 198     {
 199         return this.dataset;
 200     }
 201
 202     public final String getCacheName()
 203     {
 204         return this.cacheName;
 205     }
 206
 207     public final double getTexelSize(double radius)
 208     {
 209         return radius * this.averageTexelSize;
 210     }
 211
 212     public final boolean isEmpty()
 213     {
 214         return this.levelName == null || this.levelName.equals("");
 215     }
 216
 217     public final void markResourceAbsent(long tileNumber)
 218     {
 219         this.absentTiles.markResourceAbsent(tileNumber);
 220     }
 221
 222     public final boolean isResourceAbsent(long tileNumber)
 223     {
 224         return this.absentTiles.isResourceAbsent(tileNumber);
 225     }
 226
 227     public final void unmarkResourceAbsent(long tileNumber)
 228     {
 229         this.absentTiles.unmarkResourceAbsent(tileNumber);
 230     }
 231
 232     public final long getExpiryTime()
 233     {
 234         return expiryTime;
 235     }
 236
 237     public void setExpiryTime(long expiryTime) // TODO: remove
 238     {
 239         this.expiryTime = expiryTime;
 240     }
 241
 242 //    public interface TileURLBuilder
 243 //    {
 244 //        public URL getURL(Tile tile) throws java.net.MalformedURLException;
 245 //    }
 246
 247     /**
 248      * Returns the URL necessary to retrieve the specified tile.
 249      * @param tile the tile who's resources will be retrieved.
 250      * @return the resource URL.
 251      * @throws java.net.MalformedURLException if the URL cannot be formed from the tile's parameters.
 252      * @throws IllegalArgumentException if <code>tile</code> is null.
 253      */
 254     public java.net.URL getTileResourceURL(Tile tile) throws java.net.MalformedURLException
 255     {
 256         if (tile == null)
 257         {
 258             String msg = WorldWind.retrieveErrMsg("nullValue.TileIsNull");
 259             WorldWind.logger().log(java.util.logging.Level.FINE, msg);
 260             throw new IllegalArgumentException(msg);
 261         }
 262
 263         return this.urlBuilder.getURL(tile);
 264     }
 265
 266     public int compareTo(Level that)
 267     {
 268         if (that == null)
 269         {
 270             String msg = WorldWind.retrieveErrMsg("nullValue.LevelIsNull");
 271             WorldWind.logger().log(java.util.logging.Level.FINE, msg);
 272             throw new IllegalArgumentException(msg);
 273         }
 274         return this.levelNumber < that.levelNumber ? -1 : this.levelNumber == that.levelNumber ? 0 : 1;
 275     }
 276
 277     public boolean equals(Object o)
 278     {
 279         if (this == o)
 280             return true;
 281         if (o == null || getClass() != o.getClass())
 282             return false;
 283
 284         final gov.nasa.worldwind.Level level = (gov.nasa.worldwind.Level) o;
 285
 286         if (levelNumber != level.levelNumber)
 287             return false;
 288         if (tileHeight != level.tileHeight)
 289             return false;
 290         if (tileWidth != level.tileWidth)
 291             return false;
 292         if (cacheName != null ? !cacheName.equals(level.cacheName) : level.cacheName != null)
 293             return false;
 294         if (dataset != null ? !dataset.equals(level.dataset) : level.dataset != null)
 295             return false;
 296         if (formatSuffix != null ? !formatSuffix.equals(level.formatSuffix) : level.formatSuffix != null)
 297             return false;
 298         if (levelName != null ? !levelName.equals(level.levelName) : level.levelName != null)
 299             return false;
 300         if (service != null ? !service.equals(level.service) : level.service != null)
 301             return false;
 302         //noinspection RedundantIfStatement
 303         if (tileDelta != null ? !tileDelta.equals(level.tileDelta) : level.tileDelta != null)
 304             return false;
 305
 306         return true;
 307     }
 308
 309     public int hashCode()
 310     {
 311         int result;
 312         result = levelNumber;
 313         result = 29 * result + (levelName != null ? levelName.hashCode() : 0);
 314         result = 29 * result + (tileDelta != null ? tileDelta.hashCode() : 0);
 315         result = 29 * result + tileWidth;
 316         result = 29 * result + tileHeight;
 317         result = 29 * result + (formatSuffix != null ? formatSuffix.hashCode() : 0);
 318         result = 29 * result + (service != null ? service.hashCode() : 0);
 319         result = 29 * result + (dataset != null ? dataset.hashCode() : 0);
 320         result = 29 * result + (cacheName != null ? cacheName.hashCode() : 0);
 321         return result;
 322     }
 323
 324     @Override
 325     public String toString()
 326     {
 327         return this.path;
 328     }
 329 }