LbmRidReader.h

Go to the documentation of this file.

/*
// $Id: //open/dev/fennel/lucidera/bitmap/LbmRidReader.h#10 $
// Fennel is a library of data storage and processing components.
// Copyright (C) 2006-2009 LucidEra, Inc.
// Copyright (C) 2006-2009 The Eigenbase Project
//
// 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_LbmRidReader_Included
#define Fennel_LbmRidReader_Included

#include "fennel/btree/BTreeReader.h"
#include "fennel/exec/ExecStreamDefs.h"
#include "fennel/lucidera/bitmap/LbmEntry.h"
#include "fennel/lucidera/bitmap/LbmSegmentReader.h"
#include "fennel/lucidera/bitmap/LbmTupleReader.h"

FENNEL_BEGIN_NAMESPACE

class LbmSingleTupleReader;

class LbmRidReaderBase : public LbmSegment
{
protected:
    LbmSegmentReader segmentReader;

    bool firstReadDone;

    uint curByte;

    LcsRid curRid;

    bool moveNext;

    LcsRid nextRid;

    void resetState();

    ExecStreamResult searchForNextRid();

    void initCommon();

public:
    ExecStreamResult advanceToRid(LcsRid rid);

    ExecStreamResult readRidAndAdvance(LcsRid &rid);
};

class LbmRidReader : public LbmRidReaderBase
{
public:
    void init(
        SharedExecStreamBufAccessor &pInAccessorInit,
        TupleData &bitmapSegTuple);
};

class FENNEL_LBM_EXPORT LbmIterableRidReader
    : protected LbmRidReaderBase
{
protected:
    bool buffered;

    LcsRid bufferedRid;

    void initCommon();

    inline bool searchForNextRid();

public:
    inline bool hasNext();

    inline LcsRid peek();

    inline void advance();

    inline LcsRid getNext();
};

class FENNEL_LBM_EXPORT LbmTupleRidReader
    : public LbmIterableRidReader
{
    LbmSingleTupleReader *pReader;

    SharedLbmTupleReader pSharedReader;

public:
    void init(TupleData &bitmapSegTuple);
};

class FENNEL_LBM_EXPORT LbmDeletionIndexReader
{
    SharedBTreeReader btreeReader;

    TupleData *pBitmapSegTuple;

    TupleData searchEntry;

    bool currTuple;

    LbmTupleRidReader ridReader;

    LcsRid btreeRid;

    bool emptyIndex;

    bool emptyIndexUnknown;

    void initRidReader();

public:
    ~LbmDeletionIndexReader();

    void init(
        SharedBTreeReader &btreeReader,
        TupleData &bitmapSegTuple);

    void endSearch();

    bool isEmpty();

    bool searchForRid(LcsRid rid);
};

/**************************************************************
  Definitions of inline methods for class LbmIterableRidReader
***************************************************************/

inline bool LbmIterableRidReader::searchForNextRid()
{
    ExecStreamResult rc = readRidAndAdvance(bufferedRid);
    switch (rc) {
    case EXECRC_YIELD:
        buffered = true;
        break;
    case EXECRC_EOS:
        buffered = false;
        break;
    default:
        permAssert(false);
    }
    return buffered;
}

inline bool LbmIterableRidReader::hasNext()
{
    if (buffered) {
        return true;
    }
    return searchForNextRid();
}

inline LcsRid LbmIterableRidReader::peek()
{
    bool valid = hasNext();
    assert(valid);
    return bufferedRid;
}

inline void LbmIterableRidReader::advance()
{
    bool valid = hasNext();
    assert(valid);
    buffered = false;
}

inline LcsRid LbmIterableRidReader::getNext()
{
    LcsRid next = peek();
    advance();
    return next;
}

FENNEL_END_NAMESPACE

#endif

// End LbmRidReader.h

---