/*
    * Copyright 1999-2006 Faculty of Mathematics, Physics and Informatics, Comenius
    * University, Bratislava. This file is protected by the Mozilla Public License
    * version 1.1 (the License); you may not use this file except in compliance
    * with the License. You may obtain a copy of the License at
    * http://euromath2.sourceforge.net/license.html Unless required by applicable
    * law or agreed to in writing, software distributed under the License is
    * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    * KIND, either express or implied. See the License for the specific language
   * governing permissions and limitations under the License.
   */
  package sk.uniba.euromath.editor.xmlEditor;
  
  import java.util.ArrayList;
  import java.util.HashMap;
  import java.util.HashSet;
  import java.util.List;
  import java.util.Map;
  import java.util.Set;
  
  import sk.uniba.euromath.editor.xmlEditor.editParts.XMLEditPart;
  import sk.uniba.euromath.editor.xmlEditor.lang.Messages;
  
  /***
   * Holds relation between node's ids from source XML document to EditParts which
   * visualize them. One id can be visualized by one EditPart, many or by none.
   * 
   * @author Tomáš Studva 4.11.2005
   */
  public class IdVisualInfo {
  
      /***
       * Ids currently in map - not only element's ids as elementIDs.
       */
      protected final Set<String> idSet;
  
      /***
       * Ids of elements currently in map.
       */
      private final Set<String> elementIDs;
  
      /***
       * Maps id to EditParts visually representing node with given id.
       */
      protected final Map<String, Set<XMLEditPart>> parts;
  
      /***
       * Conatructor.
       */
      public IdVisualInfo() {
          super();
          this.idSet = new HashSet<String>();
          this.parts = new HashMap<String, Set<XMLEditPart>>();
          this.elementIDs = new HashSet<String>();
      }
  
      /***
       * Adds vusualPart to set of visualizers of xml node with id <code>id</code>.
       * 
       * @param id
       *            Unique identifier of a node from XML data source, not null
       * @param visualPart
       *            An XMLEditPart visually representing node with given id, not
       *            null
       */
      public void add(String id, XMLEditPart visualPart) {
          if (id == null)
              throw new IllegalArgumentException(Messages.getString("IdVisualInfo.0")); //$NON-NLS-1$
          if (visualPart == null)
              throw new IllegalArgumentException(Messages.getString("IdVisualInfo.1")); //$NON-NLS-1$
  
          if (!getIdSet().contains(id)) {
              addNewID(id);
          }
  
          getParts().get(id).add(visualPart);
      }
  
      /***
       * Adds id to this info. Helper method.
       * 
       * @param id
       *            not null and not contained by info
       */
      private void addNewID(String id) {
          getIdSet().add(id);
          getParts().put(id, new HashSet<XMLEditPart>());
          if ((id.indexOf(';') == -1) && (id.indexOf('@') == -1))
              getElementIDs().add(id);
      }
  
      /***
       * Clears out holded info. Object state is same as after construction.
       */
      public void clear() {
          getIdSet().clear();
          getParts().clear();
          getElementIDs().clear();
      }
 
     /***
      * Returns true if holds some info about desired id.
      * 
      * @param id
      *            of node not null
      * @return true if contains the id
      */
     public boolean contains(String id) {
         if (id == null)
             throw new IllegalArgumentException(Messages.getString("IdVisualInfo.2")); //$NON-NLS-1$
         return getIdSet().contains(id);
     }
 
     /***
      * Returns how many EditParts represent id (this information is taken from
      * object's state). If id was not yet added, zero is returned.
      * 
      * @param id
      *            of node not null
      * @return how many EditParts represent id
      */
     public int count(String id) {
         if (id == null)
             throw new IllegalArgumentException(Messages.getString("IdVisualInfo.3")); //$NON-NLS-1$
         if (contains(id))
             return getVisualParts(id).size();
         return 0;
     }
 
     /***
      * Returns list of XMLEditParts which visualize node with id <code>id</code>.
      * 
      * @param id
      *            of xml node, not null
      * @return EditParts representing id in new instance of ArrayList
      */
     public List<XMLEditPart> getVisualParts(String id) {
         if (id == null)
             throw new IllegalArgumentException(Messages.getString("IdVisualInfo.4")); //$NON-NLS-1$
         // id is not in info so empty array list is returned
         if (!contains(id))
             return new ArrayList<XMLEditPart>();
         
         return new ArrayList<XMLEditPart>(getParts().get(id));
     }
 
     /***
      * Returns set containing all element ids holded by info.
      * 
      * @return elements ids set by copy
      */
     public Set<String> getElementIds() {
         return new HashSet<String>(this.elementIDs);
     }
 
     /***
      * Returns set containing all ids holded by info.
      * 
      * @return ids set by copy
      */
     public Set<String> getIds() {
         return new HashSet<String>(this.idSet);
     }
 
     /***
      * @return Returns the elementIDs.
      */
     protected Set<String> getElementIDs() {
         return this.elementIDs;
     }
 
     /***
      * @return Returns the idSet.
      */
     protected Set<String> getIdSet() {
         return this.idSet;
     }
 
     /***
      * @return Returns the parts.
      */
     protected Map<String, Set<XMLEditPart>> getParts() {
         return this.parts;
     }
 
  /*   public String getNextElementID(String id) {
         try {
             int _id = Integer.parseInt(id);
             Set ids = getElementIDs();
             while (_id < maxID) {
                 if (ids.contains(String.valueOf(++_id)))
                     return String.valueOf(_id);
             }
         } catch (NumberFormatException nfe) {
 
         }
         return null;
     }*/
 }