Drizzled Public API Documentation

result_set_meta_data.h
1 /* - mode: c; c-basic-offset: 2; indent-tabs-mode: nil; -*-
2  * vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
3  *
4  * Copyright (C) 2011, Brian Aker
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions are met:
9  *
10  * * Redistributions of source code must retain the above copyright notice,
11  * this list of conditions and the following disclaimer.
12  * * Redistributions in binary form must reproduce the above copyright notice,
13  * this list of conditions and the following disclaimer in the documentation
14  * and/or other materials provided with the distribution.
15  * * Neither the name of Patrick Galbraith nor the names of its contributors
16  * may be used to endorse or promote products derived from this software
17  * without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
23  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
29  * THE POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 #pragma once
33 
34 #include <cassert>
35 #include <queue>
36 #include <vector>
37 #include <drizzled/field.h>
38 
39 namespace drizzled {
40 namespace sql {
41 
42 
44 {
45 public:
46  inline size_t getColumnCount() const
47  {
48  return _columns;
49  }
50 
51 protected:
52  friend class ResultSet;
53 
54  ResultSetMetaData(size_t columns) :
55  _columns(columns)
56  {
57  _columnInfo.resize(columns);
58  }
59 
60  void setColumnCount(size_t columns)
61  {
62  _columns= columns;
63  _columnInfo.resize(columns);
64  }
65 
66  void setColumnInfo(size_t column_number, const SendField& field)
67  {
68  _columnInfo.at(column_number) = field;
69  }
70 
71  SendField getColumnInfo(size_t column_number)
72  {
73  return _columnInfo.at(column_number);
74  }
75 
76 private: // Member methods
77 
78 private: // Member variables
79  size_t _columns;
80  typedef std::vector<SendField> ColumnInfoVector;
81  ColumnInfoVector _columnInfo;
82 };
83 
84 std::ostream& operator<<(std::ostream& output, const ResultSetMetaData &result_set);
85 
86 } // namespace sql
87 } // namespace drizzled
88 
TODO: Rename this file - func.h is stupid.