mirror of https://gitee.com/bigwinds/arangodb
148 lines
5.5 KiB
C++
148 lines
5.5 KiB
C++
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief EnumerateListBlock
|
|
///
|
|
/// @file
|
|
///
|
|
/// DISCLAIMER
|
|
///
|
|
/// Copyright 2010-2014 triagens GmbH, Cologne, Germany
|
|
///
|
|
/// Licensed under the Apache License, Version 2.0 (the "License");
|
|
/// you may not use this file except in compliance with the License.
|
|
/// You may obtain a copy of the License at
|
|
///
|
|
/// http://www.apache.org/licenses/LICENSE-2.0
|
|
///
|
|
/// Unless required by applicable law or agreed to in writing, software
|
|
/// distributed under the License is distributed on an "AS IS" BASIS,
|
|
/// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
/// See the License for the specific language governing permissions and
|
|
/// limitations under the License.
|
|
///
|
|
/// Copyright holder is triAGENS GmbH, Cologne, Germany
|
|
///
|
|
/// @author Max Neunhoeffer
|
|
/// @author Copyright 2014, triagens GmbH, Cologne, Germany
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifndef ARANGODB_AQL_ENUMERATE_LIST_BLOCK_H
|
|
#define ARANGODB_AQL_ENUMERATE_LIST_BLOCK_H 1
|
|
|
|
#include "ExecutionBlock.h"
|
|
#include "Aql/ExecutionNode.h"
|
|
#include "Utils/AqlTransaction.h"
|
|
|
|
namespace triagens {
|
|
namespace aql {
|
|
|
|
class AqlItemBlock;
|
|
|
|
class ExecutionEngine;
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- EnumerateListBlock
|
|
// -----------------------------------------------------------------------------
|
|
|
|
class EnumerateListBlock : public ExecutionBlock {
|
|
|
|
public:
|
|
|
|
EnumerateListBlock (ExecutionEngine*,
|
|
EnumerateListNode const*);
|
|
|
|
~EnumerateListBlock ();
|
|
|
|
int initialize () override;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief initializeCursor, here we release our docs from this collection
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
int initializeCursor (AqlItemBlock* items, size_t pos) override;
|
|
|
|
AqlItemBlock* getSome (size_t atLeast, size_t atMost) override final;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
// skip between atLeast and atMost returns the number actually skipped . . .
|
|
// will only return less than atLeast if there aren't atLeast many
|
|
// things to skip overall.
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
size_t skipSome (size_t atLeast, size_t atMost) override final;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief create an AqlValue from the inVariable using the current _index
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- private functions
|
|
// -----------------------------------------------------------------------------
|
|
|
|
private:
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief create an AqlValue from the inVariable using the current _index
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
AqlValue getAqlValue (AqlValue const&);
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief throws an "array expected" exception
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
void throwArrayExpectedException ();
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- private variables
|
|
// -----------------------------------------------------------------------------
|
|
|
|
private:
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief current position in the _inVariable
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
size_t _index;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief current block in DOCVEC
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
size_t _thisblock;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief number of elements in DOCVEC before the current block
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
size_t _seen;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief total number of elements in DOCVEC
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
size_t _DOCVECsize;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief document collection from DOCVEC
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
TRI_document_collection_t const* _collection;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief the register index containing the inVariable of the EnumerateListNode
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
RegisterId _inVarRegId;
|
|
|
|
};
|
|
|
|
} // namespace triagens::aql
|
|
} // namespace triagens
|
|
|
|
#endif
|
|
|
|
// Local Variables:
|
|
// mode: outline-minor
|
|
// outline-regexp: "^\\(/// @brief\\|/// {@inheritDoc}\\|/// @addtogroup\\|// --SECTION--\\|/// @\\}\\)"
|
|
// End:
|