LcsColumnReader.h

Go to the documentation of this file.

/*
// $Id: //open/dev/fennel/lucidera/colstore/LcsColumnReader.h#17 $
// 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_LcsColumnReader_Included
#define Fennel_LcsColumnReader_Included

#include "fennel/lucidera/colstore/LcsClusterNode.h"
#include "fennel/lucidera/colstore/LcsBitOps.h"
#include "fennel/lucidera/colstore/LcsResidualColumnFilters.h"


FENNEL_BEGIN_NAMESPACE

class FENNEL_LCS_EXPORT LcsColumnReader
    : public boost::noncopyable
{
    LcsClusterReader *pScan;

    uint colOrd;

    PLcsBatchDir pBatch;

    PBuffer pValues;

    PBuffer pBase;

    PtrVec origin;

    WidthVec width;

    /* Number of entries per vector
     */
    uint iV;

    PBitVecFuncPtr pFuncReadBitVec;

    const PBuffer (LcsColumnReader:: *pGetCurrentValueFunc) ();

    LcsResidualColumnFilters filters;

    TupleProjection allProj;

    const PBuffer getCompressedValue();

    const PBuffer getFixedValue();

    const PBuffer getVariableValue();

    uint findVal(
        uint filterPos,
        bool highBound,
        bool bStrict,
        TupleDataWithBuffer &readerKeyData);

    void findBounds(
        uint filterPos,
        uint &nLoVal,
        uint &nHiVal,
        TupleDataWithBuffer &readerKeyData);

    void buildContainsMap();

public:
    void init(LcsClusterReader *pScanInit, uint colOrdInit)
    {
        pScan = pScanInit;
        colOrd = colOrdInit;
        filters.hasResidualFilters = false;
        filters.filterDataInitialized = false;
        allProj.push_back(0);
    }

    void sync();

    bool batchIsCompressed() const
    {
        return pBatch->mode == LCS_COMPRESSED;
    }

    bool batchIsFixed() const
    {
        return pBatch->mode == LCS_FIXED;
    }

    const PBuffer getCurrentValue()
    {
        return (this->*pGetCurrentValueFunc)();
    }

    uint16_t getCurrentValueCode() const;

    // The following functions access the distinct values in a compressed
    // batch.  The offsets table contains one offset for each distinct value.
    // GetBatchValue() finds the address of i-th distinct value by adding the
    // base pointer of the batch to the i-th entry in the offset table.
    uint getBatchValCount() const
    {
        return pBatch->nVal;
    }

    const PBuffer getBatchBase() const
    {
        return pBase;
    }

    const uint16_t *getBatchOffsets() const
    {
        return (const uint16_t *) pValues;
    }

    const PBuffer getBatchValue(uint iValCode) const
    {
        return (const PBuffer) (getBatchBase() + getBatchOffsets()[iValCode]);
    }

    void readCompressedBatch(uint count, uint16_t *pValCodes, uint *pActCount);

    struct LcsResidualColumnFilters& getFilters()
    {
        return filters;
    }

    bool applyFilters(
        TupleDescriptor &projDescriptor,
        TupleData &outputTupleData);
};

FENNEL_END_NAMESPACE

#endif

// End LcsColumnReader.h

---