BTreeExecStream.h

Go to the documentation of this file.

/*
// $Id: //open/dev/fennel/ftrs/BTreeExecStream.h#14 $
// 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) 2004-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_BTreeExecStream_Included
#define Fennel_BTreeExecStream_Included

#include "fennel/exec/SingleOutputExecStream.h"
#include "fennel/exec/DynamicParam.h"
#include "fennel/tuple/TupleDescriptor.h"
#include "fennel/btree/BTreeDescriptor.h"

FENNEL_BEGIN_NAMESPACE

class BTreeOwnerRootMap;

struct FENNEL_FTRS_EXPORT BTreeParams
{
    SharedSegment pSegment;

    PageId rootPageId;

    SegmentId segmentId;

    PageOwnerId pageOwnerId;

    TupleDescriptor tupleDesc;

    TupleProjection keyProj;

    BTreeOwnerRootMap *pRootMap;

    DynamicParamId rootPageIdParamId;
};

struct FENNEL_FTRS_EXPORT BTreeExecStreamParams
    : BTreeParams, virtual public SingleOutputExecStreamParams
{
    explicit BTreeExecStreamParams();
};

class FENNEL_FTRS_EXPORT BTreeOwnerRootMap
{
public:
    virtual ~BTreeOwnerRootMap();
    virtual PageId getRoot(PageOwnerId pageOwnerId) = 0;
};

class BTreeAccessBase;

class FENNEL_FTRS_EXPORT BTreeExecStream
    : virtual public SingleOutputExecStream
{
protected:
    BTreeDescriptor treeDescriptor;
    SegmentAccessor scratchAccessor;
    BTreeOwnerRootMap *pRootMap;
    SharedBTreeAccessBase pBTreeAccessBase;
    SharedBTreeReader pBTreeReader;
    DynamicParamId rootPageIdParamId;

    virtual SharedBTreeReader newReader();
    SharedBTreeWriter newWriter(bool monotonic = false);

    virtual void endSearch();
public:
    // implement ExecStream
    virtual void prepare(BTreeExecStreamParams const &params);
    virtual void open(bool restart);
    virtual void closeImpl();

    static void copyParamsToDescriptor(
        BTreeDescriptor &,
        BTreeParams const &,
        SharedCacheAccessor const &);
    static SharedBTreeWriter newWriter(BTreeExecStreamParams const &params);
};

FENNEL_END_NAMESPACE

#endif

// End BTreeExecStream.h

---