package org.devaki.nextobjects.workspace.models.objects;
   /*
   
   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.ui.components.CustomTreeNode;
  import org.devaki.nextobjects.workspace.models.BaseModel;
  import org.devaki.nextobjects.workspace.models.graphics.ObjectView;
  /***
   * Objects of the models.
   * @author <a href="mailto:eflorent@devaki.org">Emmanuel Florent</a>
   */
  public abstract class BaseObject implements Serializable
  {
      /***
      * The name
      */
      private String name = "";
      /***
      * The code
      */
      private String code = "";
      /***
      * The description
      */
      private String description = "";
      /***
      * Notes
      */
      private String notes = "";
      /***
      * Coumns associated
      */
      private Vector columns = new Vector(1);
      /***
        * Model associated
        */
      private BaseModel myModel;
      /***
      *Nodel associated
      */
      private transient CustomTreeNode customTreeNode;
      /***
      * Has the data of the object been modified
      */
      private boolean dataChanged = false;
      /***
       * Construct a standard nextGraphicsObject
       */
      public BaseObject()
      {
      }
      /***
       * Construct an object with a pre-defined model
       * @param pModel the context model
       */
      public BaseObject(final BaseModel pModel)
      {
          this.myModel = pModel;
      }
      /***
       * Construct a (next)Object by copying another nextGraphicsObject
       * @param pObject the object to clone
       */
      public BaseObject(final BaseObject pObject)
      {
          this.setName(pObject.getName());
          this.setCode(pObject.getCode());
          this.setDescription(pObject.getDescription());
          this.setNotes(pObject.getNotes());
      }
      /***
       * Get the object view
       * @return the objectview
       */
      public abstract ObjectView getObjectView();
      /***
       * Returns a String representation of the object
       * Really usefull in the treeview ow/ would avoid.
       * @return the name
       */
     public final String toString()
     {
         return this.name;
     }
     /***
      * Set notes for the object
      * @param pNotes the notes
      */
     public final void setNotes(final String pNotes)
     {
         this.notes = pNotes;
     }
     /***
      * Changes the name
      * @param pName the name
      */
     public final void setName(final String pName)
     {
         this.name = pName;
         if (this.myModel != null)
         {
             this.resetModelStatus();
         }
     }
     /***
      * Changes the code
      * @param pCode the code
      */
     public final void setCode(final String pCode)
     {
         this.code = pCode;
         if (this.myModel != null)
         {
             this.resetModelStatus();
         }
     }
     /***
      * Changes the description
      * @param pDescription the description
      */
     public final void setDescription(final String pDescription)
     {
         this.description = pDescription;
         if (this.myModel != null)
         {
             this.resetModelStatus();
         }
     }
     /***
      * Set if the data has changed or not
      * @param pDataChanged is the data changed
      */
     public final void setDataChanged(final boolean pDataChanged)
     {
         this.dataChanged = pDataChanged;
     }
     /***
      * Changes the model
      * @param pModel the context model
      */
     public final void setMyModel(final BaseModel pModel)
     {
         this.myModel = pModel;
         this.resetModelStatus();
     }
     /***
      * Defines the CustomTreeNode associated to the current object
      * @param pNode the node
      */
     public final void setDynamicTreeNode(final CustomTreeNode pNode)
     {
         this.customTreeNode = pNode;
     }
     /***
      * Get notes for the object
      * @return the notes
      */
     public final String getNotes()
     {
         return this.notes;
     }
     /***
      * Get the name
      * @return the name
      */
     public final String getName()
     {
         return this.name;
     }
     /***
      * Get the code
      * @return the code
      */
     public final String getCode()
     {
         return this.code;
     }
     /***
      * Get the description
      * @return the description
      */
     public final String getDescription()
     {
         return this.description;
     }
     /***
      * Return the list of fields
      * @return the columns
      */
     public final Vector getData()
     {
         return this.columns;
     }
     /***
      * Return if the data has changed or not
      * @return is data changed
      */
     public final boolean getDataChanged()
     {
         return this.dataChanged;
     }
     /***
      * Get the model
      * @return the model
      */
     public final BaseModel getMyModel()
     {
         return this.myModel;
     }
     /***
      * Get the CustomTreeNode object associated
      * @return the tree node
      */
     public final CustomTreeNode getDynamicTreeNode()
     {
         return this.customTreeNode;
     }
     /***
      * Reset the status of the model because it has been changed
      */
     public final void resetModelStatus()
     {
         this.myModel.setSaved(false);
         this.myModel.setVerified(false);
     }
     /***
      * Get the columns of the object
      * @return the columns
      */
     public final Vector getColumns()
     {
         return columns;
     }
 
     /***
      * Set the columns of the object
      * @param vector a set of columns
      */
     public final void setColumns(final Vector vector)
     {
         columns = vector;
     }
 
 } // End of class