Drizzled Public API Documentation

engine.h

00001 /* - mode: c; c-basic-offset: 2; indent-tabs-mode: nil; -*-
00002  *  vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
00003  *
00004  *  Copyright (C) 2010 Brian Aker
00005  *
00006  *  This program is free software; you can redistribute it and/or modify
00007  *  it under the terms of the GNU General Public License as published by
00008  *  the Free Software Foundation; either version 2 of the License, or
00009  *  (at your option) any later version.
00010  *
00011  *  This program is distributed in the hope that it will be useful,
00012  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
00013  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00014  *  GNU General Public License for more details.
00015  *
00016  *  You should have received a copy of the GNU General Public License
00017  *  along with this program; if not, write to the Free Software
00018  *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
00019  */
00020 
00021 #pragma once
00022 
00023 #include <boost/make_shared.hpp>
00024 #include <drizzled/catalog/engine.h>
00025 
00026 namespace plugin {
00027 namespace catalog {
00028 
00029 class Engine : public drizzled::catalog::Engine
00030 {
00031 
00032 public:
00033   Engine() :
00034     drizzled::catalog::Engine()
00035   {}
00036 
00037   bool create(const drizzled::identifier::Catalog &identifier, drizzled::message::catalog::shared_ptr &);
00038   bool drop(const drizzled::identifier::Catalog &identifier);
00039 
00040   bool exist(const drizzled::identifier::Catalog &identifier)
00041   {
00042     if (drizzled::catalog::local_identifier() == identifier)
00043       return true;
00044 
00045     return false;
00046   }
00047 
00048   void getIdentifiers(drizzled::identifier::Catalog::vector &identifiers)
00049   {
00050     identifiers.push_back(drizzled::catalog::local_identifier());
00051   }
00052 
00053   drizzled::message::catalog::shared_ptr getMessage(drizzled::identifier::Catalog::const_reference identifier);
00054 
00055   void getMessages(drizzled::message::catalog::vector &messages);
00056 
00057 private:
00058   drizzled::message::catalog::shared_ptr readFile(drizzled::identifier::Catalog::const_reference identifier);
00059   bool writeFile(const drizzled::identifier::Catalog &identifier, drizzled::message::catalog::shared_ptr &message);
00060   void prime(drizzled::message::catalog::vector &messages);
00061 
00062 };
00063 
00064 } /* namespace catalog */
00065 } /* namespace plugin */
00066