Drizzled Public API Documentation

analysis_table.h

00001 /* 
00002  * Copyright (C) 2009, Padraig O'Sullivan
00003  * All rights reserved.
00004  *
00005  * Redistribution and use in source and binary forms, with or without
00006  * modification, are permitted provided that the following conditions are met:
00007  *
00008  *   * Redistributions of source code must retain the above copyright notice,
00009  *     this list of conditions and the following disclaimer.
00010  *   * Redistributions in binary form must reproduce the above copyright notice,
00011  *     this list of conditions and the following disclaimer in the documentation
00012  *     and/or other materials provided with the distribution.
00013  *   * Neither the name of Padraig O'Sullivan nor the names of its contributors
00014  *     may be used to endorse or promote products derived from this software
00015  *     without specific prior written permission.
00016  *
00017  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00018  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00019  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00020  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
00021  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
00022  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
00023  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
00024  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
00025  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
00026  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
00027  * THE POSSIBILITY OF SUCH DAMAGE.
00028  */
00029 
00030 #pragma once
00031 
00032 #include <drizzled/plugin/table_function.h>
00033 #include <drizzled/field.h>
00034 
00035 namespace drizzle_plugin
00036 {
00037 
00038 class AnalysisTableTool : public drizzled::plugin::TableFunction
00039 {
00040 public:
00041 
00042   AnalysisTableTool();
00043 
00044   class Generator : public drizzled::plugin::TableFunction::Generator
00045   {
00046   public:
00047     Generator(drizzled::Field **arg);
00048 
00049     bool populate();
00050   private:
00051     bool is_done;
00052   };
00053 
00054   Generator *generator(drizzled::Field **arg)
00055   {
00056     return new Generator(arg);
00057   }
00058 };
00059 
00060 } /* namespace drizzle_plugin */
00061