Wolframe, 0.0.3

statement.hpp
Go to the documentation of this file.
1 /************************************************************************
2 
3  Copyright (C) 2011 - 2014 Project Wolframe.
4  All rights reserved.
5 
6  This file is part of Project Wolframe.
7 
8  Commercial Usage
9  Licensees holding valid Project Wolframe Commercial licenses may
10  use this file in accordance with the Project Wolframe
11  Commercial License Agreement provided with the Software or,
12  alternatively, in accordance with the terms contained
13  in a written agreement between the licensee and Project Wolframe.
14 
15  GNU General Public License Usage
16  Alternatively, you can redistribute this file and/or modify it
17  under the terms of the GNU General Public License as published by
18  the Free Software Foundation, either version 3 of the License, or
19  (at your option) any later version.
20 
21  Wolframe is distributed in the hope that it will be useful,
22  but WITHOUT ANY WARRANTY; without even the implied warranty of
23  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24  GNU General Public License for more details.
25 
26  You should have received a copy of the GNU General Public License
27  along with Wolframe. If not, see <http://www.gnu.org/licenses/>.
28 
29  If you have questions regarding the use of this file, please contact
30  Project Wolframe.
31 
32 ************************************************************************/
33 
36 
37 #ifndef _DATABASE_STATEMENET_HPP_INCLUDED
38 #define _DATABASE_STATEMENET_HPP_INCLUDED
39 
40 #include <string>
41 #include "types/variant.hpp"
42 
43 namespace _Wolframe {
44 namespace db {
45 
48 class Statement
49 {
50  public:
51  virtual ~Statement( ) { }
52 
55  virtual void bind( const unsigned int idx, const types::Variant &arg ) = 0;
56 
59  virtual const std::string originalSQL( ) const = 0;
60 
64  virtual const std::string nativeSQL( ) const = 0;
65 
67  virtual void init( const std::string &stmtStr ) = 0;
68 
70  virtual void clear( ) = 0;
71 
77  virtual void substitute( bool checkForMissingPlaceholders = true ) = 0;
78 
82  virtual const std::string replace( const unsigned int idx ) const = 0;
83 };
84 
85 }}//namespace
86 #endif
87 
virtual const std::string nativeSQL() const =0
Returns the SQL statement with the native database placeholders or the data filled in (this is up to ...
The interface of a statement SQL parameter substutution class.
Definition: statement.hpp:48
virtual void init(const std::string &stmtStr)=0
Set new SQL statement.
Forward declaration.
Definition: variant.hpp:65
Variant value type.
virtual ~Statement()
Definition: statement.hpp:51
virtual const std::string originalSQL() const =0
Returns the SQL statement as passed down to the database layer.
virtual void bind(const unsigned int idx, const types::Variant &arg)=0
Binds parameter at position idx with variant data in the format with Wolframe placeholders.
virtual void substitute(bool checkForMissingPlaceholders=true)=0
Trigger substitution (nativeSQL is valid after this call and not before!)
virtual void clear()=0
Clear current statement.
virtual const std::string replace(const unsigned int idx) const =0
Funtion called when the placeholder should be put into the final string (this is either for subsituti...