granicus.if.org Git - icinga2/blob - lib/livestatus/table.hpp

   1 /******************************************************************************
   2  * Icinga 2                                                                   *
   3  * Copyright (C) 2012-2014 Icinga Development Team (http://www.icinga.org)    *
   4  *                                                                            *
   5  * This program is free software; you can redistribute it and/or              *
   6  * modify it under the terms of the GNU General Public License                *
   7  * as published by the Free Software Foundation; either version 2             *
   8  * of the License, or (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 Free Software Foundation     *
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.             *
  18  ******************************************************************************/
  19
  20 #ifndef TABLE_H
  21 #define TABLE_H
  22
  23 #include "livestatus/column.hpp"
  24 #include "base/object.hpp"
  25 #include "base/dictionary.hpp"
  26 #include <vector>
  27
  28 namespace icinga
  29 {
  30
  31 typedef boost::function<void (const Value&)> AddRowFunction;
  32
  33 class Filter;
  34
  35 /**
  36  * @ingroup livestatus
  37  */
  38 class Table : public Object
  39 {
  40 public:
  41         DECLARE_PTR_TYPEDEFS(Table);
  42
  43         static Table::Ptr GetByName(const String& name, const String& compat_log_path = "", const unsigned long& from = 0, const unsigned long& until = 0);
  44
  45         virtual String GetName(void) const = 0;
  46         virtual String GetPrefix(void) const = 0;
  47
  48         std::vector<Value> FilterRows(const shared_ptr<Filter>& filter);
  49
  50         void AddColumn(const String& name, const Column& column);
  51         Column GetColumn(const String& name) const;
  52         std::vector<String> GetColumnNames(void) const;
  53
  54 protected:
  55         Table(void);
  56
  57         virtual void FetchRows(const AddRowFunction& addRowFn) = 0;
  58
  59         static Value ZeroAccessor(const Value&);
  60         static Value OneAccessor(const Value&);
  61         static Value EmptyStringAccessor(const Value&);
  62         static Value EmptyArrayAccessor(const Value&);
  63         static Value EmptyDictionaryAccessor(const Value&);
  64
  65 private:
  66         std::map<String, Column> m_Columns;
  67
  68         void FilteredAddRow(std::vector<Value>& rs, const shared_ptr<Filter>& filter, const Value& row);
  69 };
  70
  71 }
  72
  73 #endif /* TABLE_H */