src/DAL/FieldDef.h

   1 /***************************************************************************
   2  *   Copyright (C) 2008 by Sverre Rabbelier                                *
   3  *   sverre@rabbelier.nl                                                   *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 3 of the License, or     *
   8  *   (at your option) any later version.                                   *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  19  ***************************************************************************/
  20 #pragma once
  21
  22 /**
  23  * @file FieldDef.h
  24  * @brief This file contains the FieldDef class.
  25  *
  26  * @see FieldDef
  27  */
  28
  29 #include "Types.h"
  30 #include "Global.h"
  31
  32 /**
  33  * This class represents the definition of a field in a table.
  34  *
  35  * Based on this class FieldImpl's will be generated.
  36 */
  37 class FieldDef
  38 {
  39 public:
  40         /** Construct a FieldDef with the specified name, defaultvalue and 'textness'. */
  41         FieldDef(const std::string& name, bool text, const std::string& defaultvalue = Global::Get()->EmptyString);
  42
  43         /** Construct a FieldDef with the specified name, lookup and 'textness'. */
  44         FieldDef(const std::string& name, bool text, bool lookup);
  45
  46         /** Destructor, a noop. */
  47         virtual ~FieldDef();
  48
  49
  50         /** Returns the SQL string to generate this field. */
  51         std::string creationString() const;
  52
  53         /** Returns the name of the field. */
  54         const std::string& getName() const { return m_name; }
  55
  56         /** Returns whether this field is a text field. */
  57         bool isText() const { return m_text; }
  58
  59         /** Returns the default value for this field. */
  60         const std::string& getDefaultValue() const { return m_defaultvalue; };
  61
  62         /** Whether this is a lookup field. */
  63         bool isLookup() const { return m_lookup; }
  64
  65         /** Whether this field is a key. */
  66         virtual bool isKey() const { return false; }
  67
  68         /** Whether this field is a primary key. */
  69         virtual bool isPrimaryKey() const { return false; }
  70
  71 private:
  72         std::string m_name; /**< The name of this field. */
  73         bool m_text; /**< Whether this field is a text field. */
  74         std::string m_defaultvalue; /**< The default value for this field. */
  75         bool m_lookup; /**< Should this field be unique. */
  76 };