gov/nasa/worldwind/PlaceNameService.java

   1 /*
   2 Copyright (C) 2001, 2006 United States Government as represented by
   3 the Administrator of the National Aeronautics and Space Administration.
   4 All Rights Reserved.
   5 */
   6 package gov.nasa.worldwind;
   7
   8 import gov.nasa.worldwind.geom.*;
   9
  10 /**
  11  * @author Paul Collins
  12  * @version $Id: PlaceNameService.java 1759 2007-05-07 19:27:49Z dcollins $
  13  */
  14 public class PlaceNameService
  15 {
  16     // Data retrieval and caching attributes.
  17     private final String service;
  18     private final String dataset;
  19     private final String fileCachePath;
  20     private static final String FORMAT_SUFFIX = ".xml.gz";
  21     // Geospatial attributes.
  22     private final Sector sector;
  23     private final LatLon tileDelta;
  24     private Extent extent = null;
  25     private double extentVerticalExaggeration = Double.MIN_VALUE;
  26     // Display attributes.
  27     private final java.awt.Font font;
  28     private boolean enabled;
  29     private java.awt.Color color;
  30     private double minDisplayDistance;
  31     private double maxDisplayDistance;
  32     private int numColumns;
  33
  34     private static final int MAX_ABSENT_TILE_TRIES = 2;
  35     private static final int MIN_ABSENT_TILE_CHECK_INTERVAL = 10000;
  36     private final AbsentResourceList absentTiles = new AbsentResourceList(MAX_ABSENT_TILE_TRIES,
  37         MIN_ABSENT_TILE_CHECK_INTERVAL);
  38
  39     /**
  40      * @param service
  41      * @param dataset
  42      * @param fileCachePath
  43      * @param sector
  44      * @param tileDelta
  45      * @param font
  46      * @throws IllegalArgumentException if any parameter is null
  47      */
  48     public PlaceNameService(String service, String dataset, String fileCachePath, Sector sector, LatLon tileDelta,
  49         java.awt.Font font)
  50     {
  51         // Data retrieval and caching attributes.
  52         this.service = service;
  53         this.dataset = dataset;
  54         this.fileCachePath = fileCachePath;
  55         // Geospatial attributes.
  56         this.sector = sector;
  57         this.tileDelta = tileDelta;
  58         // Display attributes.
  59         this.font = font;
  60         this.enabled = true;
  61         this.color = java.awt.Color.white;
  62         this.minDisplayDistance = Double.MIN_VALUE;
  63         this.maxDisplayDistance = Double.MAX_VALUE;
  64
  65         String message = this.validate();
  66         if (message != null)
  67         {
  68             WorldWind.logger().log(java.util.logging.Level.FINE, message);
  69             throw new IllegalArgumentException(message);
  70         }
  71
  72         this.numColumns = this.numColumnsInLevel();
  73     }
  74
  75     /**
  76      * @param row
  77      * @param column
  78      * @return
  79      * @throws IllegalArgumentException if either <code>row</code> or <code>column</code> is less than zero
  80      */
  81     public String createFileCachePathFromTile(int row, int column)
  82     {
  83         if (row < 0 || column < 0)
  84         {
  85             String message = WorldWind.retrieveErrMsg("PlaceNameService.RowOrColumnOutOfRange");
  86             WorldWind.logger().log(java.util.logging.Level.FINE, message);
  87             throw new IllegalArgumentException(message);
  88         }
  89
  90         StringBuilder sb = new StringBuilder(this.fileCachePath);
  91         sb.append(java.io.File.separator).append(this.dataset);
  92         sb.append(java.io.File.separator).append(row);
  93         sb.append(java.io.File.separator).append(row).append('_').append(column);
  94
  95         if (FORMAT_SUFFIX.charAt(0) != '.')
  96             sb.append('.');
  97         sb.append(FORMAT_SUFFIX);
  98
  99         String path = sb.toString();
 100         return path.replaceAll("[:*?<>|]", "");
 101     }
 102
 103     private int numColumnsInLevel()
 104     {
 105         int firstCol = Tile.computeColumn(this.tileDelta.getLongitude(), sector.getMinLongitude());
 106         int lastCol = Tile.computeColumn(this.tileDelta.getLongitude(),
 107             sector.getMaxLongitude().subtract(this.tileDelta.getLongitude()));
 108
 109         return lastCol - firstCol + 1;
 110     }
 111
 112     public long getTileNumber(int row, int column)
 113     {
 114         return row * this.numColumns + column;
 115     }
 116
 117     /**
 118      * @param sector
 119      * @return
 120      * @throws java.net.MalformedURLException
 121      * @throws IllegalArgumentException       if <code>sector</code> is null
 122      */
 123     public java.net.URL createServiceURLFromSector(Sector sector) throws java.net.MalformedURLException
 124     {
 125         if (sector == null)
 126         {
 127             String msg = WorldWind.retrieveErrMsg("nullValue.SectorIsNull");
 128             WorldWind.logger().log(java.util.logging.Level.FINE, msg);
 129             throw new IllegalArgumentException(msg);
 130         }
 131
 132         StringBuilder sb = new StringBuilder(this.service);
 133         if (sb.charAt(sb.length() - 1) != '?')
 134             sb.append('?');
 135         sb.append("TypeName=").append(dataset);
 136         sb.append("&Request=GetFeature");
 137         sb.append("&Service=WFS");
 138         sb.append("&OUTPUTFORMAT=GML2-GZIP");
 139         sb.append("&BBOX=");
 140         sb.append(sector.getMinLongitude().getDegrees()).append(',');
 141         sb.append(sector.getMinLatitude().getDegrees()).append(',');
 142         sb.append(sector.getMaxLongitude().getDegrees()).append(',');
 143         sb.append(sector.getMaxLatitude().getDegrees());
 144         return new java.net.URL(sb.toString());
 145     }
 146
 147     public synchronized final PlaceNameService deepCopy()
 148     {
 149         PlaceNameService copy = new PlaceNameService(this.service, this.dataset, this.fileCachePath, this.sector,
 150             this.tileDelta,
 151             this.font);
 152         copy.enabled = this.enabled;
 153         copy.color = this.color;
 154         copy.minDisplayDistance = this.minDisplayDistance;
 155         copy.maxDisplayDistance = this.maxDisplayDistance;
 156         return copy;
 157     }
 158
 159     @Override
 160     public boolean equals(Object o)
 161     {
 162         if (this == o)
 163             return true;
 164         if (o == null || this.getClass() != o.getClass())
 165             return false;
 166
 167         final PlaceNameService other = (PlaceNameService) o;
 168
 169         if (this.service != null ? !this.service.equals(other.service) : other.service != null)
 170             return false;
 171         if (this.dataset != null ? !this.dataset.equals(other.dataset) : other.dataset != null)
 172             return false;
 173         if (this.fileCachePath != null ? !this.fileCachePath.equals(other.fileCachePath) : other.fileCachePath != null)
 174             return false;
 175         if (this.sector != null ? !this.sector.equals(other.sector) : other.sector != null)
 176             return false;
 177         if (this.tileDelta != null ? !this.tileDelta.equals(other.tileDelta) : other.tileDelta != null)
 178             return false;
 179         if (this.font != null ? !this.font.equals(other.font) : other.font != null)
 180             return false;
 181         if (this.color != null ? !this.color.equals(other.color) : other.color != null)
 182             return false;
 183         if (this.minDisplayDistance != other.minDisplayDistance)
 184             return false;
 185         //noinspection RedundantIfStatement
 186         if (this.maxDisplayDistance != other.maxDisplayDistance)
 187             return false;
 188
 189         return true;
 190     }
 191
 192     public synchronized final java.awt.Color getColor()
 193     {
 194         return this.color;
 195     }
 196
 197     public final String getDataset()
 198     {
 199         return this.dataset;
 200     }
 201
 202     /**
 203      * @param dc
 204      * @return
 205      * @throws IllegalArgumentException if <code>dc</code> is null
 206      */
 207     public final Extent getExtent(DrawContext dc)
 208     {
 209         if (dc == null)
 210         {
 211             String message = WorldWind.retrieveErrMsg("nullValue.DrawContextIsNull");
 212             WorldWind.logger().log(java.util.logging.Level.FINE, message);
 213             throw new IllegalArgumentException(message);
 214         }
 215
 216         if (this.extent == null || this.extentVerticalExaggeration != dc.getVerticalExaggeration())
 217         {
 218             this.extentVerticalExaggeration = dc.getVerticalExaggeration();
 219             this.extent = Sector.computeBoundingCylinder(dc.getGlobe(), this.extentVerticalExaggeration, this.sector);
 220         }
 221
 222         return extent;
 223     }
 224
 225     public final String getFileCachePath()
 226     {
 227         return this.fileCachePath;
 228     }
 229
 230     public final java.awt.Font getFont()
 231     {
 232         return this.font;
 233     }
 234
 235     public synchronized final double getMaxDisplayDistance()
 236     {
 237         return this.maxDisplayDistance;
 238     }
 239
 240     public synchronized final double getMinDisplayDistance()
 241     {
 242         return this.minDisplayDistance;
 243     }
 244
 245     public final LatLon getTileDelta()
 246     {
 247         return tileDelta;
 248     }
 249
 250     public final Sector getSector()
 251     {
 252         return this.sector;
 253     }
 254
 255     public final String getService()
 256     {
 257         return this.service;
 258     }
 259
 260     @Override
 261     public int hashCode()
 262     {
 263         int result;
 264         result = (service != null ? service.hashCode() : 0);
 265         result = 29 * result + (this.dataset != null ? this.dataset.hashCode() : 0);
 266         result = 29 * result + (this.fileCachePath != null ? this.fileCachePath.hashCode() : 0);
 267         result = 29 * result + (this.sector != null ? this.sector.hashCode() : 0);
 268         result = 29 * result + (this.tileDelta != null ? this.tileDelta.hashCode() : 0);
 269         result = 29 * result + (this.font != null ? this.font.hashCode() : 0);
 270         result = 29 * result + (this.color != null ? this.color.hashCode() : 0);
 271         result = 29 * result + ((Double) minDisplayDistance).hashCode();
 272         result = 29 * result + ((Double) maxDisplayDistance).hashCode();
 273         return result;
 274     }
 275
 276     public synchronized final boolean isEnabled()
 277     {
 278         return this.enabled;
 279     }
 280
 281     /**
 282      * @param color
 283      * @throws IllegalArgumentException if <code>color</code> is null
 284      */
 285     public synchronized final void setColor(java.awt.Color color)
 286     {
 287         if (color == null)
 288         {
 289             String message = WorldWind.retrieveErrMsg("nullValue.ColorIsNull");
 290             WorldWind.logger().log(java.util.logging.Level.FINE, message);
 291             throw new IllegalArgumentException(message);
 292         }
 293
 294         this.color = color;
 295     }
 296
 297     public synchronized final void setEnabled(boolean enabled)
 298     {
 299         this.enabled = enabled;
 300     }
 301
 302     /**
 303      * @param maxDisplayDistance
 304      * @throws IllegalArgumentException if <code>maxDisplayDistance</code> is less than the current minimum display
 305      *                                  distance
 306      */
 307     public synchronized final void setMaxDisplayDistance(double maxDisplayDistance)
 308     {
 309         if (maxDisplayDistance < this.minDisplayDistance)
 310         {
 311             String message = WorldWind.retrieveErrMsg("PlaceNameService.MaxDisplayDistanceLessThanMinDisplayDistance");
 312             WorldWind.logger().log(java.util.logging.Level.FINE, message);
 313             throw new IllegalArgumentException(message);
 314         }
 315
 316         this.maxDisplayDistance = maxDisplayDistance;
 317     }
 318
 319     /**
 320      * @param minDisplayDistance
 321      * @throws IllegalArgumentException if <code>minDisplayDistance</code> is less than the current maximum display
 322      *                                  distance
 323      */
 324     public synchronized final void setMinDisplayDistance(double minDisplayDistance)
 325     {
 326         if (minDisplayDistance > this.maxDisplayDistance)
 327         {
 328             String message = WorldWind.retrieveErrMsg("PlaceNameService.MinDisplayDistanceGrtrThanMaxDisplayDistance");
 329             WorldWind.logger().log(java.util.logging.Level.FINE, message);
 330             throw new IllegalArgumentException(message);
 331         }
 332
 333         this.minDisplayDistance = minDisplayDistance;
 334     }
 335
 336     public synchronized final void markResourceAbsent(long tileNumber)
 337     {
 338         this.absentTiles.markResourceAbsent(tileNumber);
 339     }
 340
 341     public synchronized final boolean isResourceAbsent(long resourceNumber)
 342     {
 343         return this.absentTiles.isResourceAbsent(resourceNumber);
 344     }
 345
 346     public synchronized final void unmarkResourceAbsent(long tileNumber)
 347     {
 348         this.absentTiles.unmarkResourceAbsent(tileNumber);
 349     }
 350
 351     /**
 352      * Determines if this <code>PlaceNameService'</code> constructor arguments are valid.
 353      *
 354      * @return null if valid, otherwise a <code>String</code> containing a description of why it is invalid.
 355      */
 356     public final String validate()
 357     {
 358         String msg = "";
 359         if (this.service == null)
 360         {
 361             msg += WorldWind.retrieveErrMsg("nullValue.ServiceIsNull") + ", ";
 362         }
 363         if (this.dataset == null)
 364         {
 365             msg += WorldWind.retrieveErrMsg("nullValue.DataSetIsNull") + ", ";
 366         }
 367         if (this.fileCachePath == null)
 368         {
 369             msg += WorldWind.retrieveErrMsg("nullValue.FileCachePathIsNull") + ", ";
 370         }
 371         if (this.sector == null)
 372         {
 373             msg += WorldWind.retrieveErrMsg("nullValue.SectorIsNull") + ", ";
 374         }
 375         if (this.tileDelta == null)
 376         {
 377             msg += WorldWind.retrieveErrMsg("nullValue.TileDeltaIsNull") + ", ";
 378         }
 379         if (this.font == null)
 380         {
 381             msg += WorldWind.retrieveErrMsg("nullValue.FontIsNull") + ", ";
 382         }
 383
 384         if (msg.length() == 0)
 385         {
 386             return null;
 387         }
 388
 389         return msg;
 390     }
 391 }