BTreeAccessBase.h

Go to the documentation of this file.

/*
// $Id: //open/dev/fennel/btree/BTreeAccessBase.h#11 $
// 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_BTreeAccessBase_Included
#define Fennel_BTreeAccessBase_Included

#include "fennel/btree/BTreeDescriptor.h"
#include "fennel/tuple/TupleProjectionAccessor.h"
#include "fennel/tuple/AttributeAccessor.h"

#include <boost/utility.hpp>
#include <boost/scoped_ptr.hpp>

FENNEL_BEGIN_NAMESPACE

class AttributeAccessor;
class BTreeNode;
class BTreeNodeAccessor;

class FENNEL_BTREE_EXPORT BTreeAccessBase
    : public boost::noncopyable
{
protected:
    BTreeDescriptor treeDescriptor;

    TupleDescriptor keyDescriptor;

    AttributeAccessor const *pChildAccessor;

    TupleProjectionAccessor leafKeyAccessor;

    boost::scoped_ptr<BTreeNodeAccessor> pNonLeafNodeAccessor;

    boost::scoped_ptr<BTreeNodeAccessor> pLeafNodeAccessor;

    uint cbTupleMax;

    // ----------------------------------------------------------------------
    // protected inlines below are defined in BTreeAccessBaseImpl.h
    // ----------------------------------------------------------------------

    inline BTreeNodeAccessor &getLeafNodeAccessor(BTreeNode const &node);

    inline BTreeNodeAccessor &getNonLeafNodeAccessor(BTreeNode const &node);

    inline BTreeNodeAccessor &getNodeAccessor(BTreeNode const &node);

    inline PageId getChildForCurrent();

    inline PageId getChild(BTreeNode const &node,uint iChild);

    inline PageId getRightSibling(PageId pageId);

    inline void setRightSibling(
        BTreeNode &leftNode,PageId leftPageId,PageId rightPageId);

    PageId getFirstChild(PageId pageId);

    explicit BTreeAccessBase(BTreeDescriptor const &descriptor);
    virtual ~BTreeAccessBase();

public:

    inline SharedSegment getSegment() const;

    inline SharedCacheAccessor getCacheAccessor() const;

    inline PageId getRootPageId() const;

    void setRootPageId(PageId rootPageId);

    inline SegmentId getSegmentId() const;

    inline PageOwnerId getPageOwnerId() const;

    inline TupleDescriptor const &getTupleDescriptor() const;

    inline TupleDescriptor const &getKeyDescriptor() const;

    inline TupleProjection const &getKeyProjection() const;

    void validateTupleSize(
        TupleAccessor const &tupleAccessor);
};

inline SharedSegment BTreeAccessBase::getSegment() const
{
    return treeDescriptor.segmentAccessor.pSegment;
}

inline SharedCacheAccessor BTreeAccessBase::getCacheAccessor() const
{
    return treeDescriptor.segmentAccessor.pCacheAccessor;
}

inline PageId BTreeAccessBase::getRootPageId() const
{
    return treeDescriptor.rootPageId;
}

inline SegmentId BTreeAccessBase::getSegmentId() const
{
    return treeDescriptor.segmentId;
}

inline PageOwnerId BTreeAccessBase::getPageOwnerId() const
{
    return treeDescriptor.pageOwnerId;
}

inline TupleDescriptor const &BTreeAccessBase::getTupleDescriptor() const
{
    return treeDescriptor.tupleDescriptor;
}

inline TupleDescriptor const &BTreeAccessBase::getKeyDescriptor() const
{
    return keyDescriptor;
}

inline TupleProjection const &BTreeAccessBase::getKeyProjection() const
{
    return treeDescriptor.keyProjection;
}

FENNEL_END_NAMESPACE

#endif

// End BTreeAccessBase.h

---