db_reader.h

Go to the documentation of this file.
00001 /*
00002 **  ClanLib SDK
00003 **  Copyright (c) 1997-2011 The ClanLib Team
00004 **
00005 **  This software is provided 'as-is', without any express or implied
00006 **  warranty.  In no event will the authors be held liable for any damages
00007 **  arising from the use of this software.
00008 **
00009 **  Permission is granted to anyone to use this software for any purpose,
00010 **  including commercial applications, and to alter it and redistribute it
00011 **  freely, subject to the following restrictions:
00012 **
00013 **  1. The origin of this software must not be misrepresented; you must not
00014 **     claim that you wrote the original software. If you use this software
00015 **     in a product, an acknowledgment in the product documentation would be
00016 **     appreciated but is not required.
00017 **  2. Altered source versions must be plainly marked as such, and must not be
00018 **     misrepresented as being the original software.
00019 **  3. This notice may not be removed or altered from any source distribution.
00020 **
00021 **  Note: Some of the libraries ClanLib may link to may have additional
00022 **  requirements or restrictions.
00023 **
00024 **  File Author(s):
00025 **
00026 **    Magnus Norddahl
00027 */
00028 
00031 
00032 #pragma once
00033 
00034 #include "api_database.h"
00035 
00036 class CL_DBValue;
00037 class CL_DateTime;
00038 class CL_DataBuffer;
00039 class CL_DBConnection;
00040 class CL_DBReaderProvider;
00041 class CL_DBReader_Impl;
00042 
00046 class CL_API_DATABASE CL_DBReader
00047 {
00050 public:
00052         CL_DBReader();
00053 
00057         CL_DBReader(const CL_SharedPtr<CL_DBReader_Impl> &impl);
00058 
00059         ~CL_DBReader();
00061 
00064 public:
00066         int get_column_count() const;
00067         
00069         CL_String get_column_name(int index) const;
00070         
00072         int get_name_index(const CL_StringRef &name) const;
00073 
00075         CL_DBValue get_column_value(int index) const;
00076 
00078         CL_DBValue get_column_value(const CL_StringRef &name) const;
00079 
00081         CL_String get_column_string(int index) const;
00082         
00084         bool get_column_bool(int index) const;
00085         
00087         int get_column_int(int index) const;
00088         
00090         double get_column_double(int index) const;
00091         
00093         CL_DateTime get_column_datetime(int index) const;
00094         
00096         CL_DataBuffer get_column_binary(int index) const;
00097 
00099         CL_String get_column_string(const CL_StringRef &column_name) const;
00100 
00102         bool get_column_bool(const CL_StringRef &column_name) const;
00103 
00105         int get_column_int(const CL_StringRef &column_name) const;
00106 
00108         double get_column_double(const CL_StringRef &column_name) const;
00109 
00111         CL_DateTime get_column_datetime(const CL_StringRef &column_name) const;
00112 
00114         CL_DataBuffer get_column_binary(const CL_StringRef &column_name) const;
00115 
00117         CL_DBReaderProvider *get_provider();
00119 
00122 public:
00125         bool retrieve_row();
00126         
00128         void close();
00130 
00133 private:
00134         CL_SharedPtr<CL_DBReader_Impl> impl;
00135 
00137 };
00138