Drizzled Public API Documentation

indexes.h
00001 /* - mode: c; c-basic-offset: 2; indent-tabs-mode: nil; -*-
00002  *  vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
00003  *
00004  *  Copyright (C) 2010 Sun Microsystems, Inc.
00005  *
00006  *  This program is free software; you can redistribute it and/or modify
00007  *  it under the terms of the GNU General Public License as published by
00008  *  the Free Software Foundation; either version 2 of the License, or
00009  *  (at your option) any later version.
00010  *
00011  *  This program is distributed in the hope that it will be useful,
00012  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
00013  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00014  *  GNU General Public License for more details.
00015  *
00016  *  You should have received a copy of the GNU General Public License
00017  *  along with this program; if not, write to the Free Software
00018  *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
00019  */
00020 
00021 #pragma once
00022 
00023 class IndexesTool : public TablesTool
00024 {
00025 public:
00026   IndexesTool();
00027 
00028   IndexesTool(const char *schema_arg, const char *table_arg) :
00029     TablesTool(schema_arg, table_arg)
00030   { }
00031 
00032   IndexesTool(const char *table_arg) :
00033     TablesTool(table_arg)
00034   { }
00035 
00036   class Generator : public TablesTool::Generator 
00037   {
00038     int32_t index_iterator;
00039     bool is_index_primed;
00040     drizzled::message::Table::Index index;
00041 
00042     bool nextIndexCore();
00043     virtual void fill();
00044 
00045   public:
00046     Generator(drizzled::Field **arg);
00047 
00048     const drizzled::message::Table::Index& getIndex()
00049     {
00050       return index;
00051     }
00052 
00053     bool isIndexesPrimed()
00054     {
00055       return is_index_primed;
00056     }
00057 
00058     bool nextIndex();
00059 
00060     bool populate();
00061   };
00062 
00063   Generator *generator(drizzled::Field **arg)
00064   {
00065     return new Generator(arg);
00066   }
00067 };
00068