src/DAL/Field.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 Field.h
  24  * @brief This file contains the Field class.
  25  *
  26  * @see Field
  27  */
  28
  29 #include "Types.h"
  30
  31 /**
  32  * This class represents a field in a database table.
  33  *
  34  * @deprecated This super class might be removed since it is not used.
  35  */
  36 class Field
  37 {
  38 public:
  39         /** Creates a new field with the specified name and 'textness'. */
  40         Field(cstring name, bool text = false);
  41
  42         /** Destructor, a noop. */
  43         virtual ~Field();
  44
  45         /** Returns the name of the field. */
  46         const std::string& getName() const { return m_name; }
  47
  48         /** Returns whether this field is a text field. */
  49         bool isText() const { return m_text; }
  50
  51         /** Returns wether this field is a key. */
  52         virtual bool isKey() const { return false; }
  53
  54 protected:
  55         std::string m_name; /**< The name of this field. */
  56         bool m_text; /**< Whether this field is a text field. */
  57 };