|

BufferedTable.hpp

Go to the documentation of this file.

#ifndef IONFLUX_TOOLS_BUFFEREDTABLE
#define IONFLUX_TOOLS_BUFFEREDTABLE
/* ==========================================================================
 * Ionflux Tools
 * Copyright (c) 2005 Joern P. Meier
 * mail@ionflux.org
 * --------------------------------------------------------------------------
 * BufferedTable.hpp                 Buffered database table.
 * ==========================================================================
 * 
 * This file is part of Ionflux Tools.
 * 
 * Ionflux Tools is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the 
 * Free Software Foundation; either version 2 of the License, or (at your 
 * option) any later version.
 * 
 * Ionflux Tools is distributed in the hope that it will be useful, but 
 * WITHOUT ANY WARRANTY; without even the implied warranty of 
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU 
 * General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License along 
 * with Ionflux Tools; if not, write to the Free Software Foundation, Inc.,
 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 * 
 * ========================================================================== */

#include <string>
#include <iostream>
#include <sstream>
#include <vector>
#include "ionflux/Reporter.hpp"
#include "ionflux/MySQLDatabase.hpp"
#include "ionflux/Node.hpp"
#include "ionflux/Template.hpp"
#include "ionflux/ObjectPool.hpp"

namespace Ionflux
{

namespace Tools
{

class BufferedTable
: public Ionflux::Tools::ManagedObject
{
    private:
        
    protected:
        Ionflux::Tools::Reporter log;
        Ionflux::Tools::ObjectPool pool;
        Ionflux::Tools::Database* database;
        Ionflux::Tools::Node* prevBlock;
        Ionflux::Tools::Node* currentBlock;
        Ionflux::Tools::Node* nextBlock;
        int currentOffset;
        std::map<std::string, unsigned int> offsetIndex;
        std::vector<std::string> keyIndex;
        unsigned int blockSize;
        std::string origin;
        std::string table;
        std::string keyField;
        std::vector<std::string> fields;
        int currentIndex;
        std::string createTemplate;
        std::string createTemplateFile;
        Ionflux::Tools::Node config;
        
        virtual void cycleForward();
        
        virtual void cycleBackward();
        
        virtual void updateIndices();
        
        virtual void initBlock(Ionflux::Tools::Node* target, 
            const std::string& fromKey, bool invert = false);
        
        virtual int getBlockStartOffset(const std::string& key);
        
    public:
        static const unsigned int DEFAULT_BLOCK_SIZE;
        
        BufferedTable();
        
        BufferedTable(unsigned int initBlockSize);
        
        BufferedTable(Ionflux::Tools::Database* initDatabase);
        
        BufferedTable(Ionflux::Tools::Database* initDatabase, unsigned int 
        initBlockSize);
        
        BufferedTable(Ionflux::Tools::Database* initDatabase, unsigned int 
        initBlockSize, const std::string& initTable, const std::string& 
        initKeyField, const std::vector<std::string>& initFields);
        
        BufferedTable(Ionflux::Tools::Database* initDatabase, unsigned int 
        initBlockSize, const std::string& initTable, const std::string& 
        initKeyField, const std::vector<std::string>& initFields, const 
        std::string& initOrigin);
        
        virtual ~BufferedTable();
        
        virtual void setConfig(Ionflux::Tools::Node& newConfig);
        
        virtual void setDatabase(Ionflux::Tools::Database* newDatabase);
        
        virtual Ionflux::Tools::Database* getDatabase();
        
        virtual bool validateTable();
        
        virtual Ionflux::Tools::Node* getRecord(int recIndex);
        
        virtual Ionflux::Tools::Node* operator[](int recIndex);
        
        virtual Ionflux::Tools::Node* getCurrentRecord();
        
        virtual Ionflux::Tools::Node* getNextRecord();
        
        virtual Ionflux::Tools::Node* getPrevRecord();
        
        virtual int getTableOffset(const std::string& key);
        
        virtual std::string getKey(const std::string& key, int recOffset);
        
        virtual std::string getKey(int recIndex);
        
        virtual std::string fetchKey(unsigned int offset);
        
        virtual unsigned int getNumRecs();
        
        virtual unsigned int getFieldIndex(const std::string& fieldName);
        
        virtual void refresh();
        
        virtual void clearBlocks();
        
        virtual void clear();
        
        virtual Ionflux::Tools::Reporter& getLog();
        
        virtual void setOrigin(unsigned int offset);
        
        virtual void setCurrentRecord(const std::string& newKey);
        
        virtual void setBlockSize(unsigned int newBlockSize);
        
        virtual void setOrigin(const std::string& newOrigin);
        
        virtual void setTable(const std::string& newTable);
        
        virtual void setKeyField(const std::string& newKeyField);
        
        virtual void setFields(const std::vector<std::string>& newFields);
        
        virtual void setCurrentIndex(int newCurrentIndex);
        
        virtual void setCreateTemplate(const std::string& newCreateTemplate);
        
        virtual void setCreateTemplateFile(const std::string& 
        newCreateTemplateFile);
        
        virtual unsigned int getBlockSize() const;
        
        virtual std::string getOrigin() const;
        
        virtual std::string getTable() const;
        
        virtual std::string getKeyField() const;
        
        virtual std::vector<std::string> getFields() const;
        
        virtual int getCurrentIndex() const;
        
        virtual std::string getCreateTemplate() const;
        
        virtual std::string getCreateTemplateFile() const;
        
};

}

}

#endif

---