BTreeSearchExecStream.h

Go to the documentation of this file.

/*
// $Id: //open/dev/fennel/ftrs/BTreeSearchExecStream.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_BTreeSearchExecStream_Included
#define Fennel_BTreeSearchExecStream_Included

#include "fennel/ftrs/BTreeReadExecStream.h"
#include "fennel/exec/ConduitExecStream.h"
#include "fennel/exec/DynamicParam.h"
#include "fennel/common/SearchEndpoint.h"

FENNEL_BEGIN_NAMESPACE

struct FENNEL_FTRS_EXPORT BTreeSearchKeyParameter
{
    DynamicParamId dynamicParamId;

    uint keyOffset;

    BTreeSearchKeyParameter(
        DynamicParamId id,
        uint offset) :
        dynamicParamId(id),
        keyOffset(offset)
    {
    }
};

struct FENNEL_FTRS_EXPORT BTreeSearchExecStreamParams
    : public BTreeReadExecStreamParams, public ConduitExecStreamParams
{
    bool outerJoin;

    TupleProjection inputKeyProj;

    TupleProjection inputJoinProj;

    TupleProjection inputDirectiveProj;

    std::vector<BTreeSearchKeyParameter> searchKeyParams;
};

class FENNEL_FTRS_EXPORT BTreeSearchExecStream
    : public BTreeReadExecStream, public ConduitExecStream
{
    enum DirectiveOrdinal {
        LOWER_BOUND_DIRECTIVE = 0,
        UPPER_BOUND_DIRECTIVE = 1
    };

protected:
    TupleProjectionAccessor inputKeyAccessor;
    TupleProjectionAccessor inputJoinAccessor;
    TupleProjectionAccessor readerKeyAccessor;
    TupleProjectionAccessor directiveAccessor;
    TupleProjectionAccessor upperBoundAccessor;
    TupleDescriptor inputKeyDesc, upperBoundDesc;
    TupleData inputKeyData,upperBoundData,readerKeyData,directiveData,
        *pSearchKey;
    bool outerJoin;
    bool preFilterNulls;
    uint nJoinAttributes;
    SearchEndpoint lowerBoundDirective;
    SearchEndpoint upperBoundDirective;
    bool leastUpper;
    std::vector<BTreeSearchKeyParameter> searchKeyParams;
    boost::scoped_array<FixedBuffer> searchKeyBuffer;
    bool dynamicKeysRead;
    TupleProjection searchKeyProj, upperBoundKeyProj;

    bool innerSearchLoop();
    ExecStreamResult innerFetchLoop(
        ExecStreamQuantum const &quantum,
        uint &nTuples);
    void readDirectives();
    bool testInterval();

    void readSearchKey();

    void readUpperBoundKey();

    bool checkNextKey();

    virtual bool reachedTupleLimit(uint nTuples);

    bool searchForKey();

public:
    // implement ExecStream
    void prepare(BTreeSearchExecStreamParams const &params);
    virtual void open(bool restart);
    virtual ExecStreamResult execute(ExecStreamQuantum const &quantum);
    virtual void closeImpl();
};

FENNEL_END_NAMESPACE

#endif

// End BTreeSearchExecStream.h

---