src/tim/prune/gui/map/MapSourceLibrary.java

   1 package tim.prune.gui.map;
   2
   3 import java.util.ArrayList;
   4
   5 import tim.prune.config.Config;
   6
   7 /**
   8  * Class to hold a library for all the map sources
   9  * and provide access to each one
  10  */
  11 public abstract class MapSourceLibrary
  12 {
  13         /** list of map sources */
  14         private static ArrayList<MapSource> _sourceList = null;
  15         /** Number of fixed sources */
  16         private static int _numFixedSources = 0;
  17
  18         // Static block to initialise source list
  19         static
  20         {
  21                 _sourceList = new ArrayList<MapSource>();
  22                 addFixedSources();
  23                 _numFixedSources = _sourceList.size();
  24                 addConfigSources();
  25         }
  26
  27         /** Private constructor to block instantiation */
  28         private MapSourceLibrary() {}
  29
  30
  31         /** @return number of fixed sources which shouldn't be deleted */
  32         public static int getNumFixedSources() {
  33                 return _numFixedSources;
  34         }
  35
  36         /**
  37          * Initialise source list by adding bare minimum
  38          */
  39         private static void addFixedSources()
  40         {
  41                 _sourceList.add(new OsmMapSource("Mapnik", "https://[abc].tile.openstreetmap.org/"));
  42                 _sourceList.add(new OsmMapSource("Cycling Trails", "https://[abc].tile.openstreetmap.org/", "png",
  43                         "https://tile.waymarkedtrails.org/cycling/", "png", 18));
  44                 _sourceList.add(new OsmMapSource("Reitkarte", "http://topo[234].wanderreitkarte.de/topo/"));
  45                 _sourceList.add(new MffMapSource("Mapsforfree", "https://maps-for-free.com/layer/relief/", "jpg",
  46                         "https://maps-for-free.com/layer/water/", "gif", 11));
  47                 _sourceList.add(new OsmMapSource("Hikebikemap", "https://tiles.wmflabs.org/hikebike/",
  48                         "https://tiles.wmflabs.org/hillshading/", 18));
  49                 _sourceList.add(new OsmMapSource("OpenSeaMap", "http://tile.openstreetmap.org/",
  50                         "http://tiles.openseamap.org/seamark/", 18));
  51         }
  52
  53         /**
  54          * Add custom sources from Config to the library
  55          */
  56         private static void addConfigSources()
  57         {
  58                 String configString = Config.getConfigString(Config.KEY_MAPSOURCE_LIST);
  59                 if (configString != null && configString.length() > 10)
  60                 {
  61                         // Loop over sources in string, separated by vertical bars
  62                         int splitPos = configString.indexOf('|');
  63                         while (splitPos > 0)
  64                         {
  65                                 String sourceString = configString.substring(0, splitPos);
  66                                 MapSource source = OsmMapSource.fromConfig(sourceString);
  67                                 if (source != null) {
  68                                         _sourceList.add(source);
  69                                 }
  70                                 configString = configString.substring(splitPos+1);
  71                                 splitPos = configString.indexOf('|');
  72                         }
  73                 }
  74         }
  75
  76         /**
  77          * @return current number of sources
  78          */
  79         public static int getNumSources() {
  80                 return _sourceList.size();
  81         }
  82
  83         /**
  84          * Add the given MapSource to the list (at the end)
  85          * @param inSource MapSource object
  86          */
  87         public static void addSource(MapSource inSource) {
  88                 // Check whether source is already there?  Check whether valid?
  89                 _sourceList.add(inSource);
  90         }
  91
  92         /**
  93          * Edit the given MapSource object by replacing with a new one
  94          * @param inOriginal existing MapSource object
  95          * @param inNewSource new MapSource object
  96          */
  97         public static void editSource(MapSource inOriginal, MapSource inNewSource)
  98         {
  99                 // Check whether original source is still there
 100                 int origPos = _sourceList.indexOf(inOriginal);
 101                 if (origPos < 0) {
 102                         addSource(inNewSource);
 103                 }
 104                 else {
 105                         _sourceList.set(origPos, inNewSource);
 106                 }
 107         }
 108
 109         /**
 110          * @param inIndex source index number
 111          * @return corresponding map source object
 112          */
 113         public static MapSource getSource(int inIndex)
 114         {
 115                 // Check whether within range
 116                 if (inIndex < 0 || inIndex >= _sourceList.size()) {return null;}
 117                 return _sourceList.get(inIndex);
 118         }
 119
 120         /**
 121          * Delete the specified source
 122          * @param inIndex index of source to delete
 123          */
 124         public static void deleteSource(int inIndex)
 125         {
 126                 if (inIndex >= _numFixedSources) {
 127                         _sourceList.remove(inIndex);
 128                 }
 129         }
 130
 131         /**
 132          * Check whether the given name already exists in the library (case-insensitive)
 133          * @param inName name to check
 134          * @return true if already exists, false otherwise
 135          */
 136         public static boolean hasSourceName(String inName)
 137         {
 138                 if (inName == null) {return false;}
 139                 String checkName = inName.toLowerCase().trim();
 140                 for (int i=0; i<getNumSources(); i++)
 141                 {
 142                         String name = getSource(i).getName().toLowerCase();
 143                         if (name.equals(checkName)) {return true;}
 144                 }
 145                 return false;
 146         }
 147
 148         /**
 149          * @return String containing all custom-added sources as a |-separated list
 150          */
 151         public static String getConfigString()
 152         {
 153                 StringBuilder builder = new StringBuilder();
 154                 for (int i=getNumFixedSources(); i<getNumSources(); i++) {
 155                         builder.append(getSource(i).getConfigString()).append('|');
 156                 }
 157                 return builder.toString();
 158         }
 159 }