BTreeBuildLevel.h

Go to the documentation of this file.

/*
// $Id: //open/dev/fennel/btree/BTreeBuildLevel.h#9 $
// Fennel is a library of data storage and processing components.
// Copyright (C) 2005-2009 The Eigenbase Project
// Copyright (C) 2005-2009 SQLstream, Inc.
// Copyright (C) 2005-2009 LucidEra, Inc.
// Portions Copyright (C) 1999-2009 John V. Sichi
//
// This program 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 approved by The Eigenbase Project.
//
// This program 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 this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/

#ifndef Fennel_BTreeBuildLevel_Included
#define Fennel_BTreeBuildLevel_Included

#include "fennel/btree/BTreeBuilder.h"
#include "fennel/btree/BTreeNode.h"

#include <boost/scoped_array.hpp>

FENNEL_BEGIN_NAMESPACE

// TODO:  doc internals

class FENNEL_BTREE_EXPORT BTreeBuildLevel
{
    friend class BTreeBuilder;

protected:
    BTreeBuilder &builder;

    BTreeNodeAccessor &nodeAccessor;

    uint iLevel;

    RecordNum iNode;

    RecordNum nEntriesTotal;

    BTreePageLock pageLock;

    PageId pageId;

    uint nEntriesPerNode;

    RecordNum nEntriesProcessed;

    uint cbReserved;

    bool isFinished() const;

    void processInput(ByteInputStream &sortedInputStream);

    void unmarshalLastKey();

    BTreeNode *allocateAndLinkNewNode();

    BTreeNode &allocatePage();

    explicit BTreeBuildLevel(
        BTreeBuilder &builderInit,
        BTreeNodeAccessor &nodeAccessorInit);

    virtual bool isNodeFull(BTreeNode const &node,uint cbTuple);

    virtual void indexLastKey(bool finalize) = 0;

public:
    virtual ~BTreeBuildLevel();

    void indexLastChild();
};

class FENNEL_BTREE_EXPORT FixedBuildLevel
    : public BTreeBuildLevel
{
    friend class BTreeBuilder;

    explicit FixedBuildLevel(
        BTreeBuilder &builderInit,
        BTreeNodeAccessor &nodeAccessorInit);

    // implement the BTreeBuildLevel interface
    virtual void indexLastKey(bool finalize);
    virtual bool isNodeFull(BTreeNode const &node,uint cbTuple);
};

class FENNEL_BTREE_EXPORT VariableBuildLevel
    : public BTreeBuildLevel
{
    friend class BTreeBuilder;

    SharedSegOutputStream pParentKeyStream;

    explicit VariableBuildLevel(
        BTreeBuilder &builderInit,
        BTreeNodeAccessor &nodeAccessorInit);

    SharedSegInputStream getParentKeyStream();

    // implement the BTreeBuildLevel interface
    virtual void indexLastKey(bool finalize);

public:
    virtual ~VariableBuildLevel();
};

class FENNEL_BTREE_EXPORT DynamicBuildLevel
    : public BTreeBuildLevel
{
    friend class BTreeBuilder;

    explicit DynamicBuildLevel(
        BTreeBuilder &builderInit,
        BTreeNodeAccessor &nodeAccessorInit);

    // implement the BTreeBuildLevel interface
    virtual void indexLastKey(bool finalize);
};

FENNEL_END_NAMESPACE

#endif

// End BTreeBuildLevel.h

---