package org.devaki.nextobjects.workspace.models;
   /*
   
   nextobjects Copyright (C) 2001-2005 Emmanuel Florent
   
   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by the
   Free Software Foundation; either version 2 of the License, or (at your
   option) any later version.
  
  This program is distributed in the hope that it will
  be useful, but WITHOUT ANY WARRANTY; without even the implied warranty
  of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  PURPOSE. See the GNU General Public License for more details.
  
  You should have received a copy of the GNU General Public License along
  with this program; if not, write to the Free Software Foundation, Inc., 59
  Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  
  */
  import java.io.Serializable;
  import java.util.Vector;
  import org.devaki.nextobjects.workspace.models.graphics.ConceptualView;
  import org.devaki.nextobjects.workspace.models.graphics.BaseModelView;
  import org.devaki.nextobjects.workspace.models.graphics.LineView;
  import org.devaki.nextobjects.workspace.models.objects.Association;
  import org.devaki.nextobjects.workspace.models.objects.AssociationLink;
  import org.devaki.nextobjects.workspace.models.objects.BaseObject;
  import org.devaki.nextobjects.workspace.models.objects.Entity;
  /***
   * The Conceptual Data Model
   * @author <a href="mailto:eflorent@devaki.org">Emmanuel Florent</a>
   */
  public class ConceptualModel extends BaseModel implements Serializable
  {
      /***
       * The entities
       */
      private Vector entities = new Vector();
      /***
       * The associations
       */
      private Vector associations = new Vector();
      /***
       * The association links
       */
      private Vector associationLinks = new Vector();
      /***
       * cards
       */
      public static final int ASSO_01 = 0;
      /***
       * cards
       */
      public static final int ASSO_11 = 1;
      /***
       * cards
       */
      public static final int ASSO_0N = 2;
      /***
       * cards
       */
      public static final int ASSO_1N = 3;
      /***
       * cards (for a model only)
       */
      public static final int ASSO_NM = 4; //
      /***
       * Graphical View
       */
      private ConceptualView myConceptualView;
      /***
       * Construct a new 'ConceptualModel' object
       * @param pName Name of the model
       */
      public ConceptualModel(final String pName)
      {
          super(pName);
          myConceptualView = new ConceptualView(this);
      }
      /***
       * Return the best possible filename for save
       * @return the best filename
       */
      public final String getBestFilename()
      {
          if (this.getFileForSave() == null)
          {
              return (new StringBuffer().append(this.getId()).append(".cdm"))
                  .toString();
          }
          else
          {
              return this.getFileForSave();
          }
      }
      /***
      * Conveniency method wich return all the links to draw
      * in this models.
     * @return the line views
     */
     public final LineView[] getModelLinks()
     {
         LineView[] links =
             new LineView[associationLinks.size()
                 + getInheritanceLinks().size()];
         for (int i = 0; i < associationLinks.size(); i++)
         {
             links[i] = (LineView) getAssociationLinkAt(i).getObjectView();
         }
         for (int j = associationLinks.size();
             j < getInheritanceLinks().size() + associationLinks.size();
             j++)
         {
             links[j] =
                 (LineView) getInheritanceLinkAt(j - associationLinks.size())
                     .getObjectView();
         }
         return links;
     }
     /***
     * Conveniency method wich return all the objects in the models
     * in this models.
     * @return the base objects
     * */
     public final BaseObject[] getModelObjects()
     {
         BaseObject[] baseObjects =
             new BaseObject[associationLinks.size()
                 + getInheritanceLinks().size()
                 + entities.size()
                 + associations.size()];
         int offset = 0;
         for (int i = 0; i < associationLinks.size(); i++)
         {
             baseObjects[offset] = getAssociationLinkAt(i);
             offset++;
         }
         for (int i = 0; i < getInheritanceLinks().size(); i++)
         {
             baseObjects[offset] = getInheritanceLinkAt(i);
             offset++;
         }
         for (int i = 0; i < associations.size(); i++)
         {
             baseObjects[offset] = getAssociationAt(i);
             offset++;
         }
         for (int i = 0; i < entities.size(); i++)
         {
             baseObjects[offset] = getEntityAt(i);
             offset++;
         }
         return baseObjects;
     }
     /***
      * Return the graphics view of the model
      * @return the graphic view
      */
     public final BaseModelView getModelView()
     {
         return this.myConceptualView;
     }
     /***
      * Return the associations of the model
      * @return the associations
      */
     public final Vector getAssociations()
     {
         return this.associations;
     }
     /***
      * Return the entities of the model
      * @return the entities
      */
     public final Vector getEntities()
     {
         return this.entities;
     }
     /***
      * Return the association links of the model
      * @return the associations links
      */
     public final Vector getAssociationLinks()
     {
         return this.associationLinks;
     }
     /***
      * Return the association identified by the parameter in the list
      * of associations.
      * @param at index
      * @return the association
      */
     public final Association getAssociationAt(final int at)
     {
         return (Association) this.associations.elementAt(at);
     }
     /***
      * Return the entity identified by the parameter in the list
      * of entities.
      * @param at the index
      * @return entity
      */
     public final Entity getEntityAt(final int at)
     {
         return (Entity) this.entities.elementAt(at);
     }
     /***
      * Return a entity for code
      * @param pString the string
      * @return the entity
      */
     public final Entity getEntity(final String pString)
     {
         Entity tmp = null;
         for (int i = 0; i < entities.size(); i++)
         {
             if (((Entity) this.entities.elementAt(i))
                 .getCode()
                 .equals(pString))
             {
                 tmp = (Entity) this.entities.elementAt(i);
             }
         }
         return tmp;
     }
     /***
      * Return the association link identified by the parameter in the list
      * of entities.
      * @param at index
      * @return the association link
      */
     public final AssociationLink getAssociationLinkAt(final int at)
     {
         return (AssociationLink) this.associationLinks.elementAt(at);
     }
     /***
      * Set the conceptual view of the model
      * @param pConceptualView the graphics view
      */
     public final void setConceptualView(final ConceptualView pConceptualView)
     {
         this.myConceptualView = pConceptualView;
     }
     /***
      * Return the number of entities in the model
      * @return the count
      */
     public final int countEntities()
     {
         return this.entities.size();
     }
     /***
      * Return the number of associations in the model
      * @return the count
      */
     public final int countAssociation()
     {
         return this.associations.size();
     }
     /***
      * Return the number of association links in the model
      * @return the count
      */
     public final int countAssociationLinks()
     {
         return this.associationLinks.size();
     }
 }