text: /**
  *    Copyright (C) 2013 10gen Inc.
  *
  *    This program is free software: you can redistribute it and/or  modify
  *    it under the terms of the GNU Affero General Public License, version 3,
  *    as published by the Free Software Foundation.
  *
  *    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 Affero General Public License for more details.
  *
  *    You should have received a copy of the GNU Affero General Public License
  *    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  *
  *    As a special exception, the copyright holders give permission to link the
  *    code of portions of this program with the OpenSSL library under certain
  *    conditions as described in each individual source file and distribute
  *    linked combinations including the program with the OpenSSL library. You
  *    must comply with the GNU Affero General Public License in all respects for
  *    all of the code used other than as permitted herein. If you modify file(s)
  *    with this exception, you may extend this exception to your version of the
  *    file(s), but you are not obligated to do so. If you do not wish to do so,
  *    delete this exception statement from your version. If you delete this
  *    exception statement from all source files in the program, then also delete
  *    it in the license file.
  */
  
  #pragma once
  
  #include "mongo/base/status.h"
  #include "mongo/db/geo/s2common.h"
  #include "mongo/db/index/btree_based_access_method.h"
  #include "mongo/db/index/index_descriptor.h"
  #include "mongo/db/jsobj.h"
  
  namespace mongo {
  
      class IndexCursor;
      struct S2IndexingParams;
  
      class S2AccessMethod : public BtreeBasedAccessMethod {
      public:
          using BtreeBasedAccessMethod::_descriptor;
  
          S2AccessMethod(IndexCatalogEntry* btreeState, BtreeInterface* btree);
          virtual ~S2AccessMethod() { }
  
          /**
           * Takes an index spec object for this index and returns a copy tweaked to conform to the
           * expected format.  When an index build is initiated, this function is called on the spec
           * object the user provides, and the return value of this function is the final spec object
           * that gets saved in the index catalog.  Throws a UserException if 'specObj' is invalid.
           */
          static BSONObj fixSpec(const BSONObj& specObj);
  
      private:
          virtual void getKeys(const BSONObj& obj, BSONObjSet* keys);
  
          S2IndexingParams _params;
      };
  
  }  // namespace mongo
  