secondo/Algebras/CRel/Operators/ItSpatialJoin.h

/*
----
This file is part of SECONDO.

Copyright (C) 2004-2009, University in Hagen, Faculty of Mathematics
and Computer Science, Database Systems for New Applications.

SECONDO 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.

SECONDO 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 SECONDO; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
----

*/

#pragma once

#include "AlgebraTypes.h"
#include <memory>
#include "MMRTree.h"
#include "NestedList.h"
#include "Operator.h"
#include "Shared.h"
#include "Stream.h"
#include "../TBlock.h"
#include "../TypeConstructors/TBlockTC.h"
#include <vector>

namespace CRelAlgebra
{
  namespace Operators
  {
    class ItSpatialJoin : public Operator
    {
    public:
      ItSpatialJoin();

    private:
      class IndexProjection
      {
      public:
        uint64_t index,
          projection;

        IndexProjection()
        {
        }

        IndexProjection(uint64_t index, uint64_t projection) :
          index(index),
          projection(projection)
        {
        }
      };

      template<int dimA, int dimB, bool project>
      class State
      {
      public:
        State(Supplier streamA, Supplier streamB, uint64_t joinIndexA,
              uint64_t joinIndexB, uint64_t columnCountA, uint64_t columnCountB,
              IndexProjection *projectionsA, IndexProjection *projectionsB,
              uint64_t nodeMin, uint64_t nodeMax, uint64_t memLimit,
              const TBlockTI &blockTypeInfo);

        ~State();

        TBlock *Request();

      private:
        static const int minDim = dimA > dimB ? dimB : dimA;

        class MapEntry : public TBlockEntry
        {
        public:
          MapEntry(int);

          MapEntry(const TBlockEntry &tuple);
        };

        class MapResultIterator
        {
        public:
          MapResultIterator();

          MapResultIterator(
            typename mmrtree::RtreeT<minDim, MapEntry>::iterator* iterator);

          ~MapResultIterator();

          bool IsValid() const;

          bool MoveToNext();

          const MapEntry &GetValue() const;

          MapResultIterator &operator=(
            typename mmrtree::RtreeT<minDim, MapEntry>::iterator* iterator);

        private:
          typename mmrtree::RtreeT<minDim, MapEntry>::iterator* m_iterator;

          const MapEntry *m_current;
        };

        const uint64_t m_joinIndexA,
          m_joinIndexB,
          m_columnCountA,
          m_columnCountB,
          m_memLimit,
          m_blockSize;

        mmrtree::RtreeT<minDim, MapEntry> m_map;

        MapResultIterator m_mapResult;

        TBlock *m_blockA;

        std::vector<TBlock*> m_blocksB;

        bool m_isBExhausted;

        TBlockIterator m_blockAIterator;

        Stream<TBlock> m_streamA,
          m_streamB;

        const PTBlockInfo m_blockInfo;

        AttrArrayEntry * const m_tuple;

        const IndexProjection * const m_projectionsA,
          * const m_projectionsB;

        uint64_t m_iterations;

        bool ProceedStreamB();
      };

      static const long defaultNodeMin;

      static const OperatorInfo info;

      static ValueMapping valueMappings[];

      static ListExpr TypeMapping(ListExpr args);

      static int SelectValueMapping(ListExpr args);

      template<int dimA, int dimB, bool project>
      static State<dimA, dimB, project> *CreateState(ArgVector args,
                                                     Supplier s);
    };
  }
}