gov/nasa/worldwind/LevelSet.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 import java.util.*;
  13
  14 /**
  15  * @author tag
  16  * @version $Id: LevelSet.java 1746 2007-05-06 17:21:30Z tgaskins $
  17  */
  18 public class LevelSet extends WWObjectImpl
  19 {
  20     private final Sector sector;
  21     private final LatLon levelZeroTileDelta;
  22     private final int numLevelZeroColumns;
  23     private final java.util.ArrayList<Level> levels = new java.util.ArrayList<Level>();
  24
  25     public LevelSet(AVList params)
  26     {
  27         StringBuffer sb = new StringBuffer();
  28
  29         Object o = params.getValue(Level.LEVEL_ZERO_TILE_DELTA);
  30         if (o == null || !(o instanceof LatLon))
  31             sb.append(WorldWind.retrieveErrMsg("term.tileDelta"));
  32
  33         o = params.getValue(AVKey.SECTOR);
  34         if (o == null || !(o instanceof Sector))
  35             sb.append(WorldWind.retrieveErrMsg("term.sector"));
  36
  37         int numLevels = 0;
  38         o = params.getValue(Level.NUM_LEVELS);
  39         if (o == null || !(o instanceof Integer) || (numLevels = (Integer) o) < 1)
  40             sb.append(WorldWind.retrieveErrMsg("term.numLevels"));
  41
  42         int numEmptyLevels = 0;
  43         o = params.getValue(Level.NUM_EMPTY_LEVELS);
  44         if (o == null || !(o instanceof Integer) || (numEmptyLevels = (Integer) o) < 0)
  45             sb.append(WorldWind.retrieveErrMsg("term.numEMptyLevels"));
  46
  47         if (sb.length() > 0)
  48         {
  49             String message = WorldWind.retrieveErrMsg("layers.LevelSet.InvalidLevelDescriptorFields")
  50                 + " " + sb.toString();
  51             WorldWind.logger().log(java.util.logging.Level.FINE, message);
  52             throw new IllegalArgumentException(message);
  53         }
  54
  55         this.levelZeroTileDelta = (LatLon) params.getValue(Level.LEVEL_ZERO_TILE_DELTA);
  56         this.sector = (Sector) params.getValue(AVKey.SECTOR);
  57
  58         params = params.copy(); // copy so as not to modify the user's params
  59
  60         Level.TileURLBuilder tub = (Level.TileURLBuilder) params.getValue(Level.TILE_URL_BUILDER);
  61         if (tub == null)
  62         {
  63             params.setValue(Level.TILE_URL_BUILDER, new Level.TileURLBuilder()
  64             {
  65                 public URL getURL(Tile tile) throws MalformedURLException
  66                 {
  67                     StringBuffer sb = new StringBuffer(tile.getLevel().getService());
  68                     if (sb.lastIndexOf("?") != sb.length() - 1)
  69                         sb.append("?");
  70                     sb.append("T=");
  71                     sb.append(tile.getLevel().getDataset());
  72                     sb.append("&L=");
  73                     sb.append(tile.getLevel().getLevelName());
  74                     sb.append("&X=");
  75                     sb.append(tile.getColumn());
  76                     sb.append("&Y=");
  77                     sb.append(tile.getRow());
  78
  79                     return new URL(sb.toString());
  80                 }
  81             });
  82         }
  83
  84         for (int i = 0; i < numLevels; i++)
  85         {
  86             params.setValue(Level.LEVEL_NAME, i < numEmptyLevels ? "" : Integer.toString(i - numEmptyLevels));
  87             params.setValue(Level.LEVEL_NUMBER, i);
  88
  89             Angle latDelta = this.levelZeroTileDelta.getLatitude().divide(Math.pow(2, i));
  90             Angle lonDelta = this.levelZeroTileDelta.getLongitude().divide(Math.pow(2, i));
  91             params.setValue(Level.TILE_DELTA, new LatLon(latDelta, lonDelta));
  92
  93             this.levels.add(new Level(params));
  94         }
  95
  96         this.numLevelZeroColumns =
  97             (int) Math.round(this.sector.getDeltaLon().divide(this.levelZeroTileDelta.getLongitude()));
  98     }
  99
 100     public LevelSet(LevelSet source)
 101     {
 102         if (source == null)
 103         {
 104             String msg = WorldWind.retrieveErrMsg("nullValue.LevelSetIsNull");
 105             WorldWind.logger().log(java.util.logging.Level.FINE, msg);
 106             throw new IllegalArgumentException(msg);
 107         }
 108
 109         this.levelZeroTileDelta = source.levelZeroTileDelta;
 110         this.sector = source.sector;
 111         this.numLevelZeroColumns = source.numLevelZeroColumns;
 112
 113         for (Level level : source.levels)
 114         {
 115             this.levels.add(level); // Levels are final, so it's safe to copy references.
 116         }
 117     }
 118
 119     public final Sector getSector()
 120     {
 121         return this.sector;
 122     }
 123
 124     public final LatLon getLevelZeroTileDelta()
 125     {
 126         return this.levelZeroTileDelta;
 127     }
 128
 129     public final ArrayList<Level> getLevels()
 130     {
 131         return this.levels;
 132     }
 133
 134     public final Level getLevel(int levelNumber)
 135     {
 136         return (levelNumber >= 0 && levelNumber < this.levels.size()) ? this.levels.get(levelNumber) : null;
 137     }
 138
 139     public final int getNumLevels()
 140     {
 141         return this.levels.size();
 142     }
 143
 144     public final Level getFirstLevel()
 145     {
 146         return this.getLevel(0);
 147     }
 148
 149     public final Level getLastLevel()
 150     {
 151         return this.getLevel(this.getNumLevels() - 1);
 152     }
 153
 154     public final boolean isFinalLevel(int levelNum)
 155     {
 156         return levelNum == this.getNumLevels() - 1;
 157     }
 158
 159     public final boolean isLevelEmpty(int levelNumber)
 160     {
 161         return this.levels.get(levelNumber).isEmpty();
 162     }
 163
 164     private int numColumnsInLevel(Level level)
 165     {
 166         int levelDelta = level.getLevelNumber() - this.getFirstLevel().getLevelNumber();
 167         double twoToTheN = Math.pow(2, levelDelta);
 168         return (int) (twoToTheN * this.numLevelZeroColumns);
 169     }
 170
 171     private long getTileNumber(Tile tile)
 172     {
 173         return tile.getRow() * this.numColumnsInLevel(tile.getLevel()) + tile.getColumn();
 174     }
 175
 176     /**
 177      * Instructs the level set that a tile is likely to be absent.
 178      *
 179      * @param tile The tile to mark as having an absent resource.
 180      * @throws IllegalArgumentException if <code>tile</code> is null
 181      */
 182     public final void markResourceAbsent(Tile tile)
 183     {
 184         if (tile == null)
 185         {
 186             String msg = WorldWind.retrieveErrMsg("nullValue.TileIsNull");
 187             WorldWind.logger().log(java.util.logging.Level.FINE, msg);
 188             throw new IllegalArgumentException(msg);
 189         }
 190
 191         tile.getLevel().markResourceAbsent(this.getTileNumber(tile));
 192     }
 193
 194     /**
 195      * Indicates whether a tile has been marked as absent.
 196      *
 197      * @param tile The tile in question.
 198      * @return <code>true</code> if the tile is marked absent, otherwise <code>false</code>.
 199      * @throws IllegalArgumentException if <code>tile</code> is null
 200      */
 201     public final boolean isResourceAbsent(Tile tile)
 202     {
 203         if (tile == null)
 204         {
 205             String msg = WorldWind.retrieveErrMsg("nullValue.TileIsNull");
 206             WorldWind.logger().log(java.util.logging.Level.FINE, msg);
 207             throw new IllegalArgumentException(msg);
 208         }
 209
 210         if (tile.getLevel().isEmpty())
 211             return true;
 212
 213         int tileNumber = tile.getRow() * this.numColumnsInLevel(tile.getLevel()) + tile.getColumn();
 214         return tile.getLevel().isResourceAbsent(tileNumber);
 215     }
 216
 217     /**
 218      * Removes the absent-tile mark associated with a tile, if one is associatied.
 219      *
 220      * @param tile The tile to unmark.
 221      * @throws IllegalArgumentException if <code>tile</code> is null
 222      */
 223     public final void unmarkResourceAbsent(Tile tile)
 224     {
 225         if (tile == null)
 226         {
 227             String msg = WorldWind.retrieveErrMsg("nullValue.TileIsNull");
 228             WorldWind.logger().log(java.util.logging.Level.FINE, msg);
 229             throw new IllegalArgumentException(msg);
 230         }
 231
 232         tile.getLevel().unmarkResourceAbsent(this.getTileNumber(tile));
 233     }
 234 }