| gvSIG desktop 1

package org.gvsig.remoteClient.descriptor;

import java.util.TreeMap;

/**

 * class for storing all the metadata asociated to a map composition (LayerList)

 * @author Laura Diaz

*/

public class MapComposition

{

  protected int     m_ID; 

  private TreeMap layers = new TreeMap();

  /**

   * Instance creation. Creates a nameless map composition.

   */ 

  public MapComposition()

  {

  }

  /**

   * returns the unique identifier from this mapComposition

   */

  public int getID()

  {

    return m_ID;

  }

  /**

   * Sets the unique identifier from this mapComposition

   */

  public void setID(int id)

  {

    m_ID = id;

  }

  /**

   * Adds a Layer object to the vector of layers of this mapComposition

   */

  public void addLayer(Layer layer)

  {

    String layerName = layer.getName();

    if (layerName == null)

    {

      throw new RuntimeException("Error: attempt to add a nameless layer");

    }

    // We use the lower case version of the name as a key for the hash map.

    layerName = layerName.toLowerCase();    

    layers.put(layerName, layer);

  }

  /**

   * removes the vector of layers of this mapComposition

   */

  public void removeAllLayers()

  {

    layers.clear();    

  }

  /**

   * checks if there are layers in this mapComposition

   * @return true if there are layers in the mapComposition

   */

  public boolean hasLayers()

  {

    return ( layers.size() > 0 );

  }

  /**

   * returns the number of layers the mapComposition

   */

  public int numberOfLayers()

  {

    return layers.size();

  }

 /**

  * returns the layer with this layerName in the mapComposition

  * @param String layerName the name of the required layer

  * @return Layer. the "first" Layer in this mapComposition with this layerName

  */

  public Layer getLayer(String layerName)

  {

          Layer layer;

          if (layers.get(layerName) != null)

          {

      layers.get(layerName);

          }

    return null;

  }

  public String[] getLayerNames()

  {

         String[] names;

         names = (String[])layers.values().toArray();

         //TODO: Watch out!!!!! this will not work as long as the values

         // are the layer objects and not the names.

         // Iterate through the Collection and extract the names.?????

         return names;

  }

  /**

   * checks if there is a layer in the mapComposition with this name

   * @param layerName, name of the layer to be searched

   * @return true if a layer with this name exists in the mapComposition

   */

  public boolean containsLayer(String layerName)

  {

    return (getLayer(layerName) != null);

  }

}