CorrelationJoinExecStream.h

Go to the documentation of this file.

/*
// $Id: //open/dev/fennel/exec/CorrelationJoinExecStream.h#3 $
// Fennel is a library of data storage and processing components.
// Copyright (C) 2005-2009 The Eigenbase Project
// Copyright (C) 2004-2009 SQLstream, Inc.
// Copyright (C) 2009-2009 LucidEra, Inc.
// Portions Copyright (C) 1999-2009 John V. Sichi
//
// 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_CorrelationJoinExecStream_Included
#define Fennel_CorrelationJoinExecStream_Included

#include "fennel/exec/ConfluenceExecStream.h"
#include "fennel/tuple/TupleAccessor.h"
#include "fennel/tuple/TupleData.h"

FENNEL_BEGIN_NAMESPACE


struct FENNEL_EXEC_EXPORT Correlation
{
    DynamicParamId dynamicParamId;
    uint leftAttributeOrdinal;

    Correlation(DynamicParamId id, uint offset) :
        dynamicParamId(id),
        leftAttributeOrdinal(offset)
    {
        //empty
    }
};

struct FENNEL_EXEC_EXPORT CorrelationJoinExecStreamParams
    : public ConfluenceExecStreamParams
{
    std::vector<Correlation> correlations;
};

class FENNEL_EXEC_EXPORT CorrelationJoinExecStream
    : public ConfluenceExecStream
{
    TupleData outputData;
    SharedExecStreamBufAccessor pLeftBufAccessor;
    SharedExecStreamBufAccessor pRightBufAccessor;
    uint nLeftAttributes;
    std::vector<Correlation> correlations;

    uint leftRowCount;

public:
    // implement ExecStream
    virtual void prepare(CorrelationJoinExecStreamParams const &params);
    virtual ExecStreamResult execute(ExecStreamQuantum const &quantum);
    void open(bool restart);
    virtual void close();
};

FENNEL_END_NAMESPACE

#endif

// End CorrelationJoinExecStream.h

---