src/DAL/FieldValues.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 FieldValues.h
  24  * @brief This file contains the FieldValues bucket class.
  25  *
  26  * @see FieldValues
  27  * @see FieldValue
  28  */
  29
  30 #include "Types.h"
  31
  32 /**
  33  * This class is a bucket for Value objects.
  34  *
  35  * It will hold any Value objects for the table it was constructed for.
  36  * Value objects cann be added through the <code>addValue</code> function.
  37  * Also, any  tables added with <code>addJoinedTable</code> are allowed.
  38  *
  39  * @see FieldValue
  40  * @see addJoinedTable
  41  * @see addValue
  42  */
  43 class FieldValues
  44 {
  45 public:
  46         /** Constuct a new Values bucket for fields of this specific table. */
  47         FieldValues(TableImplPtr table);
  48
  49         /** Destructor, a noop */
  50         ~FieldValues();
  51
  52         /** Returns the table this Values bucket is for. */
  53         TableImplPtr getTable() const;
  54
  55         /** Add a Value, this value is run-time asserted to be of the proper table. */
  56         void addValue(ValuePtr key);
  57
  58         /** Add a table from which Value's may be added. */
  59         void addJoinedTable(TableImplPtr joinedTable);
  60
  61
  62         /** Returns the number of added fields. */
  63         size_t size() const;
  64
  65         /** Returns the first stored Value. */
  66         ValuePtr first() const;
  67
  68         /** Returns an iterator to the first stored value. */
  69         ValueMap::const_iterator begin() const;
  70
  71         /** Returns an iterator to the 'end' iterator. */
  72         ValueMap::const_iterator end() const;
  73
  74         /** Returns an iterator to the result of 'find' with this specific field as argument. */
  75         ValueMap::const_iterator find(FieldImplPtr field) const;
  76
  77         /** Returns a Value for this field, asserted not to be the 'end' iterator. */
  78         ValuePtr getField(FieldImplPtr field) const;
  79
  80 private:
  81         TableImplPtr m_table; /**< A member containing the table this Values bucket is for. */
  82         ValueMap m_fields; /**< A member containing the Value's that have been added. */
  83         TableImplVector m_joinedTables; /**< A member containing the joined tables. */
  84 };