LcsRowScanExecStream.h

Go to the documentation of this file.

/*
// $Id: //open/dev/fennel/lucidera/colstore/LcsRowScanExecStream.h#21 $
// 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_LcsRowScanExecStream_Included
#define Fennel_LcsRowScanExecStream_Included

#include <boost/scoped_array.hpp>
#include <boost/scoped_ptr.hpp>
#include "fennel/tuple/TupleDataWithBuffer.h"
#include "fennel/lucidera/colstore/LcsRowScanBaseExecStream.h"
#include "fennel/lucidera/bitmap/LbmRidReader.h"
#include "fennel/lucidera/colstore/LcsResidualColumnFilters.h"
#include "fennel/common/BernoulliRng.h"
#include "fennel/common/FemEnums.h"

FENNEL_BEGIN_NAMESPACE

struct FENNEL_LCS_EXPORT LcsRowScanExecStreamParams
    : public LcsRowScanBaseExecStreamParams
{
    static int32_t defaultSystemSamplingClumps;

    bool isFullScan;

    bool hasExtraFilter;

    TupleProjection residualFilterCols;

    TableSamplingMode samplingMode;

    float samplingRate;

    bool samplingIsRepeatable;

    int32_t samplingRepeatableSeed;

    int32_t samplingClumps;

    int64_t samplingRowCount;
};

class FENNEL_LCS_EXPORT LcsRowScanExecStream
    : public LcsRowScanBaseExecStream
{
    TupleDataWithBuffer outputTupleData;

    uint iFilterToInitialize;

    /*
     * Real output tuple.
     */
    TupleData projOutputTupleData;

    /*
     * projection for the output row.
     */
    TupleProjection outputProj;

    TupleData ridTupleData;

    LbmRidReader ridReader;

    RecordNum nRidsRead;

    LcsRid inputRid;

    LcsRid nextRid;

    bool readDeletedRid;

    bool deletedRidEos;

    LcsRid deletedRid;

    bool tupleFound;

    bool isFullScan;

    bool hasExtraFilter;

    bool producePending;

    boost::scoped_array<LcsResidualColumnFilters *> filters;

    int32_t nFilters;

    TableSamplingMode samplingMode;

    float samplingRate;

    bool isSamplingRepeatable;

    int32_t repeatableSeed;

    int32_t samplingClumps;

    uint64_t clumpSize;

    uint64_t clumpDistance;

    uint64_t clumpPos;

    uint64_t clumpSkipPos;

    uint numClumps;

    uint numClumpsBuilt;

    boost::scoped_ptr<BernoulliRng> samplingRng;

    int64_t rowCount;

    bool ridRunsBuilt;

    LcsRidRun currRidRun;

    CircularBufferIter<LcsRidRun> ridRunIter;

    virtual void buildOutputProj(
        TupleProjection &outputProj,
        LcsRowScanBaseExecStreamParams const &params);

    bool initializeFiltersIfNeeded();

    void prepareResidualFilters(LcsRowScanExecStreamParams const &params);

    void initializeSystemSampling();

    ExecStreamResult fillRidRunBuffer();

public:
    LcsRowScanExecStream();
    virtual void prepare(LcsRowScanExecStreamParams 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 LcsRowScanExecStream.h

---