BulkLoader.h

Go to the documentation of this file.

/******************************************************************************
 * Project:  libspatialindex - A C++ library for spatial indexing
 * Author:   Marios Hadjieleftheriou, [email protected]
 ******************************************************************************
 * Copyright (c) 2002, Marios Hadjieleftheriou
 *
 * All rights reserved.
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included
 * in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
******************************************************************************/
 
#pragma once
 
namespace SpatialIndex
{
        namespace RTree
        {
                class ExternalSorter
                {
                public:
                        class Record
                        {
                        public:
                                Record();
                                Record(const Region& r, id_type id, uint32_t len, byte* pData, uint32_t s);
                                ~Record();
                                
                                bool operator<(const Record& r) const;
 
                                void storeToFile(Tools::TemporaryFile& f);
                                void loadFromFile(Tools::TemporaryFile& f);
 
                                struct SortAscending : public std::binary_function<Record* const, Record* const, bool>
                                {
                                        bool operator()(Record* const r1, Record* const r2)
                                        {
                                                if (*r1 < *r2) return true;
                                                else return false;
                                        }
                                };
 
                        public:
                                Region m_r;
                                id_type m_id;
                                uint32_t m_len;
                                byte* m_pData;
                                uint32_t m_s;
                        };
 
                public:
                        ExternalSorter(uint32_t u32PageSize, uint32_t u32BufferPages);
                        virtual ~ExternalSorter();
 
                        void insert(Record* r);
                        void sort();
                        Record* getNextRecord();
                        uint64_t getTotalEntries() const;
 
                private:
                        class PQEntry
                        {
                        public:
                                PQEntry(Record* r, uint32_t u32Index) : m_r(r), m_u32Index(u32Index) {}
 
                                struct SortAscending : public std::binary_function<const PQEntry&, const PQEntry&, bool>
                                {
                                        bool operator()(const PQEntry& e1, const PQEntry& e2)
                                        {
                                                if (*(e1.m_r) < *(e2.m_r)) return true;
                                                else return false;
                                        }
                                };
 
                                Record* m_r;
                                uint32_t m_u32Index;
                        };
 
                private:
                        bool m_bInsertionPhase;
                        uint32_t m_u32PageSize;
                        uint32_t m_u32BufferPages;
                        Tools::SmartPointer<Tools::TemporaryFile> m_sortedFile;
                        std::list<Tools::SmartPointer<Tools::TemporaryFile> > m_runs;
                        std::vector<Record*> m_buffer;
                        uint64_t m_u64TotalEntries;
                        uint32_t m_stI;
                };
 
                class BulkLoader
                {
                public:
                        void bulkLoadUsingSTR(
                                RTree* pTree,
                                IDataStream& stream,
                                uint32_t bindex,
                                uint32_t bleaf,
                                uint32_t pageSize, // The number of node entries per page.
                                uint32_t numberOfPages // The total number of pages to use.
                        );
 
                protected:
                        void createLevel(
                                RTree* pTree,
                                Tools::SmartPointer<ExternalSorter> es,
                                uint32_t dimension,
                                uint32_t indexSize,
                                uint32_t leafSize,
                                uint32_t level,
                                Tools::SmartPointer<ExternalSorter> es2,
                                uint32_t pageSize,
                                uint32_t numberOfPages
                        );
 
                        Node* createNode(
                                RTree* pTree,
                                std::vector<ExternalSorter::Record*>& e,
                                uint32_t level
                        );
                };
        }
}