LcsRowScanBaseExecStream.h

Go to the documentation of this file.

/*
// $Id: //open/dev/fennel/lucidera/colstore/LcsRowScanBaseExecStream.h#12 $
// 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_LcsRowScanBaseExecStream_Included
#define Fennel_LcsRowScanBaseExecStream_Included

#include "fennel/exec/ConfluenceExecStream.h"
#include "fennel/ftrs/BTreeExecStream.h"
#include "fennel/tuple/TupleDescriptor.h"
#include "fennel/tuple/TupleDataWithBuffer.h"
#include "fennel/tuple/UnalignedAttributeAccessor.h"
#include "fennel/common/CircularBuffer.h"
#include "fennel/lucidera/colstore/LcsClusterReader.h"

FENNEL_BEGIN_NAMESPACE

struct LcsClusterScanDef : public BTreeExecStreamParams
{
    TupleDescriptor clusterTupleDesc;
};

typedef std::vector<LcsClusterScanDef> LcsClusterScanDefList;

struct LcsRowScanBaseExecStreamParams : public ConfluenceExecStreamParams
{
    LcsClusterScanDefList lcsClusterScanDefs;

    TupleProjection outputProj;
};


class FENNEL_LCS_EXPORT LcsRowScanBaseExecStream
    : public ConfluenceExecStream
{
protected:
    VectorOfUint projMap;

    uint nClusters;

    boost::scoped_array<SharedLcsClusterReader> pClusters;

    TupleDescriptor projDescriptor;

    std::vector<int> nonClusterCols;

    bool allSpecial;

    CircularBuffer<LcsRidRun> ridRuns;

    void syncColumns(SharedLcsClusterReader &pScan);

    std::vector<UnalignedAttributeAccessor> attrAccessors;

    bool readColVals(
        SharedLcsClusterReader &pScan,
        TupleDataWithBuffer &tupleData,
        uint colStart);

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

public:
    explicit LcsRowScanBaseExecStream();
    virtual void prepare(LcsRowScanBaseExecStreamParams const &params);
    virtual void open(bool restart);
    virtual void getResourceRequirements(
        ExecStreamResourceQuantity &minQuantity,
        ExecStreamResourceQuantity &optQuantity);
    virtual void closeImpl();
};

enum LcsSpecialColumnId {
    LCS_RID_COLUMN_ID = 0x7FFFFF00
};

FENNEL_END_NAMESPACE

#endif

// End LcsRowScanBaseExecStream.h

---