src/DAL/KeyImpl.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 KeyImpl.h
  24  * @brief This file contains the KeyImpl class.
  25  *
  26  * @see KeyImpl
  27  */
  28
  29 #include "Types.h"
  30 #include "FieldImpl.h"
  31
  32 /**
  33  * This class represents a generated (concrete version of a) KeyDef.
  34  *
  35  * This class should not be instantiated manually.
  36  * Instead, the generated ones contained in TableImpls should be used.
  37  *
  38  * @see KeyDef
  39  * @see TableImpls
  40  * @see FieldImpl
  41  */
  42 class KeyImpl : public FieldImpl
  43 {
  44 public:
  45         /** Construct a foreign key belonging to the specified native table to the specified foreign table with the specified name. */
  46         KeyImpl(TableImplPtr nativeTable, TableImplPtr foreignTable, cstring name, bool primary, bool lookup = false);
  47
  48         /** Destructor, a noop. */
  49         ~KeyImpl() { }
  50
  51
  52         /** Returns a new FieldValue for this field. */
  53         FieldValuePtr newValue();
  54
  55
  56         /** Returns the foreign table this key points to, is equal to the native table in the case of a native key. */
  57         TableImplPtr getForeignTable() const ;
  58
  59         /** Returns that this is a key field. */
  60         bool isKey() const { return true; }
  61
  62         bool isPrimaryKey() const { return m_primary; }
  63
  64         /** Returns whether this is a foreign key. */
  65         bool isForeignKey() const ;
  66
  67 private:
  68         TableImplPtr m_foreignTable; /**< The table this key belongs to. */
  69         bool m_primary; /**< Whether this field is a primary key. */
  70 };