DataClass.h

/***************************************************************************
 *   Copyright (C) 2006 by Graeme Foster                                   *
 *   email    foster.graeme@gmail.com                                      *
 *                                                                         *
 *   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.             *
 ***************************************************************************/

#ifndef __DataClass_H
#define __DataClass_H

#include <iostream>

#include <QString>
#include "sql.h"

class DataClass;
typedef bool (*CompareDC)(const DataClass*, const DataClass*);

// Generic container class for data from a database
class DataClass // Abstract
{
public: // Data Types
        // When adding a new class also modify the getClassName() method in DataClass.cpp
        enum ClassName {DATA_CLASS
                                          ,INSTITUTE_CLASS
                                          ,PROGRAMME_CLASS
                                          ,MODULE_CLASS
                                          ,FACULTY_CLASS
                                          ,DEPARTMENT_CLASS
                                          ,STAFF_CLASS
                                          ,ROOM_CLASS
                                          ,MOD_LEC_ALLOC_CLASS
                                          ,MOD_LEC_ENROL_CLASS
                                          ,TIMESLOT_CLASS
                                          };
protected: // Properties
        int id;
        QString errorMsg;
        ClassName p_rtti;
        DataClass * parent;
public: // Constants
        static const int NOT_ON_DB;
        static const int NO_PARENT;

public: // Methods
        // Constructor
        DataClass(int pID=NO_PARENT);

        virtual ~DataClass(){};

        
        // Get & Set Methods
        inline int getID()                   {return id;}
        virtual QString getDescription() const =0;
        inline DataClass * getParent()       {return parent;}
        inline int getParentID();
        // Utility methods
        QString getClassName();
        inline ClassName rtti()              {return p_rtti;}
        inline bool isParent(DataClass *);
        virtual QString getSortValue()const;

        // Simple diagnostic methods
        inline QString Dump()                {return getClassName() + ": " + getDescription();}
        
        // General database methods
        static bool unique(int uniqueSQL);
        // A general uniqueness test method that will always return true.
        static bool uniqueTrue(QString, int){return true;}
        int save(int insertSQL, int updateSQL, int errorSQL);

        // Compare Methods used for qSort calls and the like
        static bool dcCompareCI(const DataClass *p1, const DataClass * p2);
        static bool dcCompareCS(const DataClass *p1, const DataClass * p2);

protected: // Methods
        // Specific database modification methods
        virtual int bindPKey(int preparedSQL){sql::Instance()->bind(0,id,preparedSQL); return 1;}
        virtual void bindValues(int preparedSQL, int start)=0;
        int insert  (int insertSQL, int errorSQL);
        int update  (int updateSQL, int errorSQL);
        virtual int remove  (int deleteSQL, int errorSQL);
//      int exec    (int execSQL, int errorSQL);
//      void dbError(int errorSQL, int errorID);
};

inline bool DataClass::isParent(DataClass * p)
{
        if (p == 0)
                return false;
        if (p == parent)
                return true;
        return parent->isParent(p);
}

inline int DataClass::getParentID()
{
        if (parent == 0)
                return NO_PARENT;
        else
                return parent->getID();
}
#endif

---