MapsFeature.java

// Copyright 2009 Google Inc. All Rights Reserved.
package com.google.android.apps.mytracks.io.gdata.maps;

import android.location.Location;

import java.util.Random;
import java.util.Vector;

/**
 * MapsFeature contains all of the data associated with a feature in Google
 * Maps, where a feature is a marker, line, or shape. Some of the data is stored
 * in a {@link MapsFeatureMetadata} object so that it can be more efficiently
 * transmitted to other activities.
 */
public class MapsFeature {

  /** A marker feature displays an icon at a single point on the map. */
  public static final int MARKER = 0;

  /**
   * A line feature displays a line connecting a set of points on the map.
   */
  public static final int LINE = 1;

  /**
   * A shape feature displays a border defined by connecting a set of points,
   * including connecting the last to the first, and displays the area
   * confined by this border.
   */
  public static final int SHAPE = 2;

  /** The local feature id for this feature, if needed. */
  private String androidId;

  // Points of this feature in order.
  private final Vector<Location> points = new Vector<Location>();
  
  /** The metadata of this feature in a format efficient for transmission. */
  private MapsFeatureMetadata featureInfo = new MapsFeatureMetadata();

  private final Random random = new Random();

  /**
   * Initializes a valid but empty feature. It will default to a
   * {@link #MARKER} with a blue placemark with a dot as an icon at the
   * location (0, 0).
   */
  public MapsFeature() {
  }

  /**
   * Adds a new point to the end of this feature.
   *
   * @param location the new point to add
   */
  public void addPoint(Location location) {
    points.add(location);
  }

  /**
   * Generates a new local id for this feature based on the current time and
   * a random number.
   */
  public void generateAndroidId() {
    long time = System.currentTimeMillis();
    int rand = random.nextInt(10000);
    androidId = time + "." + rand;
  }

  /**
   * Retrieves the current local id for this feature if one is available.
   *
   * @return The local id for this feature
   */
  public String getAndroidId() {
    return androidId;
  }

  /**
   * Retrieves the current (html) description of this feature. The description
   * is stored in the feature metadata.
   *
   * @return The description of this feature
   */
  public String getDescription() {
    return featureInfo.getDescription();
  }

  /**
   * Sets the description of this feature. That description is stored in the
   * feature metadata.
   *
   * @param description The new description of this feature
   */
  public void setDescription(String description) {
    featureInfo.setDescription(description);
  }

  /**
   * Gets the point at a given index.
   *
   * @param index the index
   */
  public Location getPoint(int index) {
    if (index >= points.size()) {
      return null;
    }
    return points.get(index);
  }
 
  /**
   * Gets the number of points.
   */
  public int getPointCount() {
    return points.size();
  }

  /**
   * Retrieves the title of this feature. That title is stored in the feature
   * metadata.
   *
   * @return the current title of this feature
   */
  public String getTitle() {
    return featureInfo.getTitle();
  }

  /**
   * Retrieves the type of this feature. That type is stored in the feature
   * metadata.
   *
   * @return One of {@link #MARKER}, {@link #LINE}, or {@link #SHAPE}
   *         identifying the type of this feature
   */
  public int getType() {
    return featureInfo.getType();
  }

  /**
   * Retrieves the current color of this feature as an ARGB color integer.
   * That color is stored in the feature metadata.
   *
   * @return The ARGB color of this feature
   */
  public int getColor() {
    return featureInfo.getColor();
  }

  /**
   * Retrieves the current line width of this feature. That line width is
   * stored in the feature metadata.
   *
   * @return The line width of this feature
   */
  public int getLineWidth() {
    return featureInfo.getLineWidth();
  }

  /**
   * Retrieves the current fill color of this feature as an ARGB color
   * integer. That color is stored in the feature metadata.
   *
   * @return The ARGB fill color of this feature
   */
  public int getFillColor() {
    return featureInfo.getFillColor();
  }

  /**
   * Retrieves the current icon url of this feature. That icon url is stored
   * in the feature metadata.
   *
   * @return The icon url for this feature
   */
  public String getIconUrl() {
    return featureInfo.getIconUrl();
  }

  /**
   * Sets the title of this feature. That title is stored in the feature
   * metadata.
   *
   * @param title The new title of this feature
   */
  public void setTitle(String title) {
    featureInfo.setTitle(title);
  }

  /**
   * Sets the type of this feature. That type is stored in the feature
   * metadata.
   *
   * @param type The new type of the feature. That type must be one of
   *        {@link #MARKER}, {@link #LINE}, or {@link #SHAPE}
   */
  public void setType(int type) {
    featureInfo.setType(type);
  }

  /**
   * Sets the ARGB color of this feature. That color is stored in the feature
   * metadata.
   *
   * @param color The new ARGB color of this feature
   */
  public void setColor(int color) {
    featureInfo.setColor(color);
  }

  /**
   * Sets the icon url of this feature. That icon url is stored in the feature
   * metadata.
   *
   * @param url The new icon url of the feature
   */
  public void setIconUrl(String url) {
    featureInfo.setIconUrl(url);
  }
}