Merge pull request #16 from kw217/add-style-kw217

Expose new s= URL parameter in MWMPoint.

README.html

@@ -38,7 +38,7 @@ You don't need any additional permissions in your AndroidManifest.xml to use
 
 <ul>
 <li><a href="lib/src/com/mapswithme/maps/api/MapsWithMeApi.java" title="MapsWithMeApi.java">com.mapswithme.maps.api.MapsWithMeApi</a> - static class with methods such as <code>showPointOnMap(Activity, double, double, String)</code> etc.</li>
-<li><a href="lib/src/com/mapswithme/maps/api/MWMPoint.java" title="MWMPoint.java">com.mapswithme.maps.api.MWMPoint</a> - model of POI, includes lat, lon, name, and id data.</li>
+<li><a href="lib/src/com/mapswithme/maps/api/MWMPoint.java" title="MWMPoint.java">com.mapswithme.maps.api.MWMPoint</a> - model of POI, includes lat, lon, name, id, and style data.</li>
 <li><a href="lib/src/com/mapswithme/maps/api/MWMResponse.java" title="MWMResponse.java">com.mapswithme.maps.api.MWMResponse</a> - helps you to extract response from MapsWithMe by applying <code>MWMResponse.extractFromIntent(Intent)</code> to Intent. Contains MWMPoint data.</li>
 </ul>
 

README.md

@@ -33,7 +33,7 @@ You don't need any additional permissions in your AndroidManifest.xml to use API
 Core classes you will work with are:
 
 * [com.mapswithme.maps.api.MapsWithMeApi][linkApiClass] - static class with methods such as `showPointOnMap(Activity, double, double, String)` etc.
-* [com.mapswithme.maps.api.MWMPoint][linkPointClass] - model of POI, includes lat, lon, name, and id data.
+* [com.mapswithme.maps.api.MWMPoint][linkPointClass] - model of POI, includes lat, lon, name, id, and style data.
 * [com.mapswithme.maps.api.MWMResponse][linkRespClass] - helps you to extract response from MapsWithMe by applying `MWMResponse.extractFromIntent(Intent)` to Intent. Contains MWMPoint data.
 
 ### Show Points on the Map

lib/src/com/mapswithme/maps/api/MWMPoint.java

@@ -26,7 +26,7 @@ import java.io.Serializable;
 
 /**
  * POI wrapper object.
- * Has it's <code>equals()</code> and <code>hashCode()</code> methods overloaded
+ * Has its <code>equals()</code> and <code>hashCode()</code> methods overloaded
  * so could be used in Hash(Map/Set/etc) classes.
  */
 public final class MWMPoint implements Serializable
@@ -37,6 +37,7 @@ public final class MWMPoint implements Serializable
   final private double mLon;
   final private String mName;
   private String mId;
+  private Style mStyle;
 
   public MWMPoint(double lat, double lon, String name)
   {
@@ -51,10 +52,22 @@ public final class MWMPoint implements Serializable
     this.mId = id;
   }
 
+  public MWMPoint(double lat, double lon, String name, String id, Style style)
+  {
+    this.mLat = lat;
+    this.mLon = lon;
+    this.mName = name;
+    this.mId = id;
+    this.mStyle = style;
+  }
+
   public double getLat()       { return mLat;   }
   public double getLon()       { return mLon;   }
   public String getName()      { return mName;  }
   public String getId()        { return mId;    }
+  public Style  getStyle()     { return mStyle; }
+
+  public String getStyleForUrl() { return (mStyle == null) ? null : mStyle.getName(); }
 
   /**
    * Sets string ID for this point. Internally it is not used to distinguish point,
@@ -63,10 +76,24 @@ public final class MWMPoint implements Serializable
    */
   public void setId(String id) { mId = id; }
 
+  /**
+   * Sets the style (appearance) for this point.
+   *
+   * @param style Style to use, or null for default (violet circle).
+   */
+  public void setStyle(Style style)
+  {
+    this.mStyle = style;
+  }
+
   @Override
   public String toString()
   {
-    return "MWMPoint [lat=" + mLat + ", lon=" + mLon + ", name=" + mName + ", id=" + mId + "]";
+    return "MWMPoint [lat=" + mLat +
+            ", lon=" + mLon +
+            ", name=" + mName +
+            ", id=" + mId +
+            ", style=" + mStyle + "]";
   }
 
   @Override
@@ -104,4 +131,34 @@ public final class MWMPoint implements Serializable
 
     return mName == null ? other.mName == null : mName.equals(other.mName);
   }
+
+  /**
+   * Supported styles for MAPS.ME. Each appears as a small flag of the appropriate colour.
+   */
+  public enum Style
+  {
+    PlacemarkRed("placemark-red"),
+    PlacemarkBlue("placemark-blue"),
+    PlacemarkPurple("placemark-purple"),
+    PlacemarkYellow("placemark-yellow"),
+    PlacemarkPink("placemark-pink"),
+    PlacemarkBrown("placemark-brown"),
+    PlacemarkGreen("placemark-green"),
+    PlacemarkOrange("placemark-orange");
+
+    private String name;
+
+    private Style(String name)
+    {
+      this.name = name;
+    }
+
+    /**
+     * @return name as it should appear in the MAPS.ME URL.
+     */
+    private String getName()
+    {
+      return name;
+    }
+  }
 }

lib/src/com/mapswithme/maps/api/MwmRequest.java

@@ -137,6 +137,7 @@ public class MwmRequest
 
         appendIfNotNull(urlBuilder, "n", point.getName());
         appendIfNotNull(urlBuilder, "id", point.getId());
+        appendIfNotNull(urlBuilder, "s", point.getStyleForUrl());
       }
     }