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.PhysicalView;
  import org.devaki.nextobjects.workspace.models.graphics.BaseModelView;
  import org.devaki.nextobjects.workspace.models.objects.BaseObject;
  import org.devaki.nextobjects.workspace.models.objects.Constraint;
  import org.devaki.nextobjects.workspace.models.objects.Table;
  /***
   * Physical model represent the database as it is
   *
   *@see  http://www.devaki.org/pdm.html
   * @author <a href="mailto:eflorent@devaki.org">Emmanuel Florent</a>
   */
  public class PhysicalModel extends BaseModel implements Serializable
  {
      /***
       * tables
       */
      private Vector tables = new Vector();
      /***
       * constraints
       */
      private Vector constraints = new Vector();
      /***
       *  the model view
       */
      private PhysicalView myPhysicalView;
      /***
       * If a SQL file has been generated for this model, this variable indicates
      * where to find it
      */
      private String sqlFile;
      /***
       * Construct a new 'PhysicalModel' object
       * @param pName Nae of the model
       */
      public PhysicalModel(final String pName)
      {
          super(pName);
          myPhysicalView = new PhysicalView(this);
      }
      /***
       * Return the best possible filename for save
       * @return filename
       */
      public final String getBestFilename()
      {
          if (this.getFileForSave() == null)
          {
              return (new StringBuffer().append(this.getId()).append(".pdm"))
                  .toString();
          }
          else
          {
              return this.getFileForSave();
          }
      }
      /***
       * Get the model view
       * @return model view
       */
      public final BaseModelView getModelView()
      {
          return this.myPhysicalView;
      }
      /***
       * Get the list of tables in the model
       * @return tables
       */
      public final Vector getTables()
      {
          return this.tables;
      }
      /***
       * Get the list of constraints in the model
       * @return constraints
       */
      public final Vector getConstraints()
      {
         return this.constraints;
     }
     /***
      * Get constraint(s) for the given table
      * @param t the context table
      * @return vctConstraints
      */
     public final Vector getConstraints(final Table t)
     {
         Vector cst = new Vector();
         for (int i = 0; i < this.countConstraint(); i++)
         {
             if (this.getConstraintAt(i).getParentClass().equals(t))
             {
                 cst.addElement(this.getConstraintAt(i));
             }
         }
         return cst;
     }
     /***
      * Get table for the given tableCode
      * @param pString the table code
      * @return table
      */
     public final Table getTableForId(final String pString)
     {
         Table tmp = null;
         for (int i = 0; i < getTables().size(); i++)
         {
             if (this.getTableAt(i).getCode().equals(pString))
             {
                 tmp = (Table) this.tables.elementAt(i);
             }
         }
         return tmp;
     }
     /***
      * Return the table identified by the parameter in the list of tables.
      * @param at index
      * @return table
      */
     public final Table getTableAt(final int at)
     {
         return (Table) this.tables.elementAt(at);
     }
     /***
      * Return the constraint identified by the parameter in the list
      * of constraints.
      * @param at index
      * @return constraint
      */
     public final Constraint getConstraintAt(final int at)
     {
         return (Constraint) constraints.elementAt(at);
     }
     /***
      * Return the number of tables in the model
      * @return count
      */
     public final int countTable()
     {
         return this.tables.size();
     }
     /***
      * Return the number of constraint in the model
      * @return count
      */
     public final int countConstraint()
     {
         return this.constraints.size();
     }
     /***
      * Get the path for the SQL file generated from this model
      * @return filename
      */
     public final String getSqlFile()
     {
         return this.sqlFile;
     }
     /***
      * Set the path for the SQL file generated from this model
      * @param pSqlFile filename
      */
     public final void setSqlFile(final String pSqlFile)
     {
         this.sqlFile = pSqlFile;
     }
     /***
      * Set the model view
      * @param pView the model view
      */
     public final void setPhysicalView(final PhysicalView pView)
     {
         this.myPhysicalView = pView;
     }
     /***
     * Conveniency method wich return all the objects in the models
     * @return array of base objects
     */
     public final BaseObject[] getModelObjects()
     {
         BaseObject[] baseObjects =
             new BaseObject[tables.size()
                 + getInheritanceLinks().size()
                 + constraints.size()];
         int offset = 0;
         for (int i = 0; i < tables.size(); i++)
         {
             baseObjects[offset] = getTableAt(i);
             offset++;
         }
         for (int i = 0; i < getInheritanceLinks().size(); i++)
         {
             baseObjects[offset] = getInheritanceLinkAt(i);
             offset++;
         }
         for (int i = 0; i < constraints.size(); i++)
         {
             baseObjects[offset] = getConstraintAt(i);
             offset++;
         }
         return baseObjects;
     }
 }