src/DAL/FieldImpl.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 FieldImpl.h
  24  * @brief This file contains the FieldImpl class.
  25  *
  26  * @see FieldImpl
  27  */
  28
  29 #include "Types.h"
  30 #include "Field.h"
  31
  32 /**
  33  * This class represents a generated (concrete version of a) FieldDef.
  34  *
  35  * This class should not be instantiated manually.
  36  * Instead, the generated ones contained in TableImpls should be used.
  37  *
  38  * @see FieldDef
  39  * @see TableImpls
  40  * @see Field
  41  */
  42 class FieldImpl : public Field, public boost::enable_shared_from_this<FieldImpl>
  43 {
  44 public:
  45         /** Constructs a new field belonging to the specified table with the specified name, default value and 'textness'.*/
  46         FieldImpl(TableImplPtr table, cstring name, bool text, cstring defaultvalue);
  47
  48         /** Constructs a new field belonging to the specified table with the specified name 'textness' and lookup possibility.*/
  49         FieldImpl(TableImplPtr table, cstring name, bool text, bool lookup);
  50
  51         /** Destructor, a noop. */
  52         ~FieldImpl();
  53
  54
  55         /** Returns the table this field belongs to. */
  56         TableImplPtr getTable() const { return m_table; }
  57
  58         /** Returns the default value for this field. */
  59         const std::string& getDefaultValue() const { return m_defaultvalue; }
  60
  61         /** Whether this field is 'guaranteed' to be unique. */
  62         bool isLookup() const { return m_lookup; }
  63
  64
  65         /** Returns a new FieldValue for this field. */
  66         virtual FieldValuePtr newValue();
  67
  68
  69         /** Returns wether this field is a key. */
  70         virtual bool isKey() const { return false; }
  71
  72         /** Returns wether this field is a primary key. */
  73         virtual bool isPrimaryKey() const { return false; }
  74
  75 private:
  76         TableImplPtr m_table; /**< The table this field belongs to. */
  77         std::string m_defaultvalue; /**< The defaultvalue for this field. */
  78         bool m_lookup; /**< Whether this field is a lookup field. */
  79 };