LbmChopperExecStream.h

Go to the documentation of this file.

/*
// $Id: //open/dev/fennel/lucidera/bitmap/LbmChopperExecStream.h#6 $
// Fennel is a library of data storage and processing components.
// Copyright (C) 2005-2009 LucidEra, Inc.
// Copyright (C) 2005-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_LbmChopperExecStream_Included
#define Fennel_LbmChopperExecStream_Included

#include "fennel/tuple/TupleData.h"
#include "fennel/exec/ConfluenceExecStream.h"
#include "fennel/exec/DynamicParam.h"
#include "fennel/lucidera/bitmap/LbmByteSegment.h"
#include "fennel/lucidera/bitmap/LbmSeqSegmentReader.h"
#include "fennel/lucidera/bitmap/LbmSegmentWriter.h"

FENNEL_BEGIN_NAMESPACE

struct LbmChopperExecStreamParams : public ConfluenceExecStreamParams
{
    DynamicParamId ridLimitParamId;
};

class FENNEL_LBM_EXPORT LbmChopperExecStream
    : public ConfluenceExecStream
{
    enum LbmChopperState {
        LBM_STATE_NONE = 0,
        LBM_STATE_READ,
        LBM_STATE_WRITE,
        LBM_STATE_PRODUCE,
        LBM_STATE_DONE
    };

    DynamicParamId ridLimitParamId;

    RecordNum ridLimit;

    LbmSeqSegmentReader segmentReader;

    TupleData inputTuple;

    LbmByteSegment inputSegment;

    LbmSegmentWriter segmentWriter;

    SegPageLock writerPageLock;

    uint pageSize;

    LbmChopperState state;

    bool writePending;

    bool producePending;

    LcsRid currentSrid;

    LcsRid currentEndRid;

    ExecStreamResult readSegment();

    bool writeSegment();

    bool produceTuple();

public:
    explicit LbmChopperExecStream();
    virtual void prepare(LbmChopperExecStreamParams const &params);
    virtual void open(bool restart);
    virtual ExecStreamResult execute(ExecStreamQuantum const &quantum);
    virtual void getResourceRequirements(
        ExecStreamResourceQuantity &minQuantity,
        ExecStreamResourceQuantity &optQuantity);
    virtual void closeImpl();
};

FENNEL_END_NAMESPACE

#endif

// End LbmChopperExecStream.h

---