VTK
vtkSQLiteQuery.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkSQLiteQuery.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
15 /*-------------------------------------------------------------------------
16  Copyright 2008 Sandia Corporation.
17  Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
18  the U.S. Government retains certain rights in this software.
19 -------------------------------------------------------------------------*/
44 #ifndef vtkSQLiteQuery_h
45 #define vtkSQLiteQuery_h
46 
47 #include "vtkIOSQLModule.h" // For export macro
48 #include "vtkSQLQuery.h"
49 
50 class vtkSQLiteDatabase;
51 class vtkVariant;
52 class vtkVariantArray;
53 struct vtk_sqlite3_stmt;
54 
55 class VTKIOSQL_EXPORT vtkSQLiteQuery : public vtkSQLQuery
56 {
57 
58  friend class vtkSQLiteDatabase;
59 
60 public:
61  vtkTypeMacro(vtkSQLiteQuery, vtkSQLQuery);
62  void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;
63  static vtkSQLiteQuery *New();
64 
69  bool SetQuery(const char *query) VTK_OVERRIDE;
70 
76  bool Execute() VTK_OVERRIDE;
77 
81  int GetNumberOfFields() VTK_OVERRIDE;
82 
86  const char* GetFieldName(int i) VTK_OVERRIDE;
87 
91  int GetFieldType(int i) VTK_OVERRIDE;
92 
96  bool NextRow() VTK_OVERRIDE;
97 
101  bool HasError() VTK_OVERRIDE;
102 
104 
107  bool BeginTransaction() VTK_OVERRIDE;
108  bool RollbackTransaction() VTK_OVERRIDE;
109  bool CommitTransaction() VTK_OVERRIDE;
111 
115  vtkVariant DataValue(vtkIdType c) VTK_OVERRIDE;
116 
120  const char* GetLastErrorText() VTK_OVERRIDE;
121 
130  using vtkSQLQuery::BindParameter;
131  bool BindParameter(int index, unsigned char value) VTK_OVERRIDE;
132  bool BindParameter(int index, signed char value) VTK_OVERRIDE;
133  bool BindParameter(int index, unsigned short value) VTK_OVERRIDE;
134  bool BindParameter(int index, short value) VTK_OVERRIDE;
135  bool BindParameter(int index, unsigned int value) VTK_OVERRIDE;
136 
137  bool BindParameter(int index, int value) VTK_OVERRIDE;
138 
139  bool BindParameter(int index, unsigned long value) VTK_OVERRIDE;
140  bool BindParameter(int index, long value) VTK_OVERRIDE;
141  bool BindParameter(int index, unsigned long long value) VTK_OVERRIDE;
142  bool BindParameter(int index, long long value) VTK_OVERRIDE;
143 
144  bool BindParameter(int index, float value) VTK_OVERRIDE;
145  bool BindParameter(int index, double value) VTK_OVERRIDE;
149  bool BindParameter(int index, const char *stringValue) VTK_OVERRIDE;
153  bool BindParameter(int index, const char *stringValue, size_t length) VTK_OVERRIDE;
154 
155  bool BindParameter(int index, const vtkStdString &string) VTK_OVERRIDE;
156 
157  bool BindParameter(int index, vtkVariant value) VTK_OVERRIDE;
159 
164  bool BindParameter(int index, const void *data, size_t length) VTK_OVERRIDE;
165  bool ClearParameterBindings() VTK_OVERRIDE;
167 
168 protected:
169  vtkSQLiteQuery();
170  ~vtkSQLiteQuery() VTK_OVERRIDE;
171 
172  vtkSetStringMacro(LastErrorText);
173 
174 private:
175  vtkSQLiteQuery(const vtkSQLiteQuery &) VTK_DELETE_FUNCTION;
176  void operator=(const vtkSQLiteQuery &) VTK_DELETE_FUNCTION;
177 
178  vtk_sqlite3_stmt *Statement;
179  bool InitialFetch;
180  int InitialFetchResult;
181  char *LastErrorText;
182  bool TransactionInProgress;
183 
185 
189  bool BindIntegerParameter(int index, int value);
190  bool BindDoubleParameter(int index, double value);
191  bool BindInt64Parameter(int index, vtkTypeInt64 value);
192  bool BindStringParameter(int index, const char *data, int length);
193  bool BindBlobParameter(int index, const void *data, int length);
195 
196 };
197 
198 #endif // vtkSQLiteQuery_h
199 
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
virtual bool SetQuery(const char *query)
The query string to be executed.
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:41
An array holding vtkVariants.
bool HasError() override
Did the last operation generate an error.
bool Execute() override=0
Execute the query.
maintain a connection to an SQLite database
const char * GetLastErrorText() override
Get the last error text from the database.
int vtkIdType
Definition: vtkType.h:345
A atomic type representing the union of many types.
Definition: vtkVariant.h:69
vtkSQLQuery implementation for SQLite databases
a simple class to control print indentation
Definition: vtkIndent.h:33
executes an sql query and retrieves results
Definition: vtkSQLQuery.h:68
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on...