arangodb/arangod/Indexes/IndexIterator.cpp

////////////////////////////////////////////////////////////////////////////////
/// DISCLAIMER
///
/// Copyright 2014-2016 ArangoDB GmbH, Cologne, Germany
/// Copyright 2004-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 ArangoDB GmbH, Cologne, Germany
///
/// @author Michael Hackstein
////////////////////////////////////////////////////////////////////////////////

#include "IndexIterator.h"
#include "Indexes/Index.h"
#include "VocBase/LogicalCollection.h"

#include <velocypack/Slice.h>

using namespace arangodb;

IndexIterator::IndexIterator(LogicalCollection* collection, transaction::Methods* trx)
    : _collection(collection), _trx(trx) {
  // note: collection may be a nullptr here, if we are dealing with the EmptyIndexIterator
  TRI_ASSERT(_trx != nullptr);
}

/// @brief default implementation for rearm
/// specialized index iterators can implement this method with some
/// sensible behavior
bool IndexIterator::rearm(arangodb::aql::AstNode const*,
                          arangodb::aql::Variable const*,
                          IndexIteratorOptions const&) {
  TRI_ASSERT(canRearm());
  THROW_ARANGO_EXCEPTION_MESSAGE(TRI_ERROR_INTERNAL, "requested rearming of an index iterator that does not support it");
}

bool IndexIterator::nextDocument(DocumentCallback const& cb, size_t limit) {
  TRI_ASSERT(_collection != nullptr);
  return next(
      [this, &cb](LocalDocumentId const& token) {
        return _collection->readDocumentWithCallback(_trx, token, cb);
      },
      limit);
}
  
/// @brief default implementation for nextCovering
/// specialized index iterators can implement this method with some
/// sensible behavior
bool IndexIterator::nextCovering(DocumentCallback const&, size_t) {
  TRI_ASSERT(hasCovering());
  THROW_ARANGO_EXCEPTION_MESSAGE(TRI_ERROR_INTERNAL, "requested covering values from an index iterator that does not support it");
}

/// @brief default implementation for nextExtra
bool IndexIterator::nextExtra(ExtraCallback const&, size_t) {
  TRI_ASSERT(hasExtra());
  THROW_ARANGO_EXCEPTION_MESSAGE(TRI_ERROR_INTERNAL, "requested extra values from an index iterator that does not support it");
}

/// @brief default implementation for reset
void IndexIterator::reset() {}

/// @brief default implementation for skip
void IndexIterator::skip(uint64_t count, uint64_t& skipped) {
  // Skip the first count-many entries
  next([&skipped](LocalDocumentId const&) { 
    ++skipped; 
    return true; 
  }, count);
}

/// @brief Get the next elements
///        If one iterator is exhausted, the next one is used.
///        If callback is called less than limit many times
///        all iterators are exhausted
bool MultiIndexIterator::next(LocalDocumentIdCallback const& callback, size_t limit) {
  auto cb = [&limit, &callback](LocalDocumentId const& token) {
    if (callback(token)) {
      --limit;
      return true;
    }
    return false;
  };
  while (limit > 0) {
    if (_current == nullptr) {
      return false;
    }
    if (!_current->next(cb, limit)) {
      _currentIdx++;
      if (_currentIdx >= _iterators.size()) {
        _current = nullptr;
        return false;
      } else {
        _current = _iterators.at(_currentIdx).get();
      }
    }
  }
  return true;
}

/// @brief Get the next elements
///        If one iterator is exhausted, the next one is used.
///        If callback is called less than limit many times
///        all iterators are exhausted
bool MultiIndexIterator::nextDocument(DocumentCallback const& callback, size_t limit) {
  auto cb = [&limit, &callback](LocalDocumentId const& token, arangodb::velocypack::Slice slice) {
    if (callback(token, slice)) {
      --limit;
      return true;
    }
    return false;
  };
  while (limit > 0) {
    if (_current == nullptr) {
      return false;
    }
    if (!_current->nextDocument(cb, limit)) {
      _currentIdx++;
      if (_currentIdx >= _iterators.size()) {
        _current = nullptr;
        return false;
      } else {
        _current = _iterators.at(_currentIdx).get();
      }
    }
  }
  return true;
}

bool MultiIndexIterator::nextExtra(ExtraCallback const& callback, size_t limit) {
  THROW_ARANGO_EXCEPTION_MESSAGE(TRI_ERROR_INTERNAL, "requested extra values from an index iterator that does not support it");
}


/// @brief Get the next elements
///        If one iterator is exhausted, the next one is used.
///        If callback is called less than limit many times
///        all iterators are exhausted
bool MultiIndexIterator::nextCovering(DocumentCallback const& callback, size_t limit) {
  TRI_ASSERT(hasCovering());
  auto cb = [&limit, &callback](LocalDocumentId const& token,
                                arangodb::velocypack::Slice slice) {
    if (callback(token, slice)) {
      --limit;
      return true;
    }
    return false;
  };
  while (limit > 0) {
    if (_current == nullptr) {
      return false;
    }
    if (!_current->nextCovering(cb, limit)) {
      _currentIdx++;
      if (_currentIdx >= _iterators.size()) {
        _current = nullptr;
        return false;
      } else {
        _current = _iterators.at(_currentIdx).get();
      }
    }
  }
  return true;
}

/// @brief Reset the cursor
///        This will reset ALL internal iterators and start all over again
void MultiIndexIterator::reset() {
  _current = _iterators[0].get();
  _currentIdx = 0;
  for (auto& it : _iterators) {
    it->reset();
  }
}