VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Friends | List of all members
vtkSQLiteQuery Class Reference

vtkSQLQuery implementation for SQLite databases More...

#include <vtkSQLiteQuery.h>

Inheritance diagram for vtkSQLiteQuery:
[legend]
Collaboration diagram for vtkSQLiteQuery:
[legend]

Public Types

typedef vtkSQLQuery Superclass
 
- Public Types inherited from vtkSQLQuery
typedef vtkRowQuery Superclass
 
- Public Types inherited from vtkRowQuery
typedef vtkObject Superclass
 
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkSQLiteQuery * NewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
bool SetQuery (const char *query)
 
bool Execute ()
 
int GetNumberOfFields ()
 
const char * GetFieldName (int i)
 
int GetFieldType (int i)
 
bool NextRow ()
 
bool HasError ()
 
vtkVariant DataValue (vtkIdType c)
 
const char * GetLastErrorText ()
 
bool BindParameter (int index, const char *stringValue)
 
bool BeginTransaction ()
 
bool RollbackTransaction ()
 
bool CommitTransaction ()
 
bool BindParameter (int index, unsigned char value)
 
bool BindParameter (int index, signed char value)
 
bool BindParameter (int index, unsigned short value)
 
bool BindParameter (int index, short value)
 
bool BindParameter (int index, unsigned int value)
 
bool BindParameter (int index, int value)
 
bool BindParameter (int index, unsigned long value)
 
bool BindParameter (int index, long value)
 
bool BindParameter (int index, vtkTypeUInt64 value)
 
bool BindParameter (int index, vtkTypeInt64 value)
 
bool BindParameter (int index, float value)
 
bool BindParameter (int index, double value)
 
bool BindParameter (int index, const char *stringValue, size_t length)
 
bool BindParameter (int index, const vtkStdString &string)
 
bool BindParameter (int index, vtkVariant value)
 
bool BindParameter (int index, const void *data, size_t length)
 
bool ClearParameterBindings ()
 
- Public Member Functions inherited from vtkSQLQuery
vtkSQLQuery * NewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
bool IsActive ()
 
char * EscapeString (const char *src, bool addSurroundingQuotes)
 
virtual const char * GetQuery ()
 
virtual vtkSQLDatabase * GetDatabase ()
 
virtual vtkStdString EscapeString (vtkStdString s, bool addSurroundingQuotes=true)
 
- Public Member Functions inherited from vtkRowQuery
vtkRowQuery * NewInstance () const
 
int GetFieldIndex (char *name)
 
bool NextRow (vtkVariantArray *rowArray)
 
virtual void SetCaseSensitiveFieldNames (bool)
 
virtual bool GetCaseSensitiveFieldNames ()
 
virtual void CaseSensitiveFieldNamesOn ()
 
virtual void CaseSensitiveFieldNamesOff ()
 
- Public Member Functions inherited from vtkObject
vtkObject * NewInstance () const
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual unsigned long GetMTime ()
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommand * GetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkSQLiteQuery * SafeDownCast (vtkObjectBase *o)
 
static vtkSQLiteQuery * New ()
 
- Static Public Member Functions inherited from vtkSQLQuery
static int IsTypeOf (const char *type)
 
static vtkSQLQuery * SafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkRowQuery
static int IsTypeOf (const char *type)
 
static vtkRowQuery * SafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObject * SafeDownCast (vtkObjectBase *o)
 
static vtkObject * New ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBase * New ()
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkSQLiteQuery ()
 
 ~vtkSQLiteQuery ()
 
virtual void SetLastErrorText (const char *)
 
- Protected Member Functions inherited from vtkSQLQuery
 vtkSQLQuery ()
 
 ~vtkSQLQuery ()
 
void SetDatabase (vtkSQLDatabase *db)
 
- Protected Member Functions inherited from vtkRowQuery
 vtkRowQuery ()
 
 ~vtkRowQuery ()
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
virtual void RegisterInternal (vtkObjectBase *, int check)
 
virtual void UnRegisterInternal (vtkObjectBase *, int check)
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Friends

class vtkSQLiteDatabase
 

Additional Inherited Members

- Protected Attributes inherited from vtkSQLQuery
char * Query
 
vtkSQLDatabase * Database
 
bool Active
 
- Protected Attributes inherited from vtkRowQuery
bool CaseSensitiveFieldNames
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

vtkSQLQuery implementation for SQLite databases

This is an implementation of vtkSQLQuery for SQLite databases. See the documentation for vtkSQLQuery for information about what the methods do.

Bug:
Sometimes Execute() will return false (meaning an error) but GetLastErrorText() winds up null. I am not certain why this is happening.
Thanks:
Thanks to Andrew Wilson from Sandia National Laboratories for implementing this class.
See also
vtkSQLDatabase vtkSQLQuery vtkSQLiteDatabase

Definition at line 54 of file vtkSQLiteQuery.h.

Member Typedef Documentation

typedef vtkSQLQuery vtkSQLiteQuery::Superclass

Definition at line 61 of file vtkSQLiteQuery.h.

Constructor & Destructor Documentation

vtkSQLiteQuery::vtkSQLiteQuery ( )
protected
vtkSQLiteQuery::~vtkSQLiteQuery ( )
protected

Member Function Documentation

static int vtkSQLiteQuery::IsTypeOf ( const char *  type)
static
virtual int vtkSQLiteQuery::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkSQLQuery.

static vtkSQLiteQuery* vtkSQLiteQuery::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkSQLiteQuery::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkSQLQuery.

vtkSQLiteQuery* vtkSQLiteQuery::NewInstance ( ) const
void vtkSQLiteQuery::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkRowQuery.

static vtkSQLiteQuery* vtkSQLiteQuery::New ( )
static
bool vtkSQLiteQuery::SetQuery ( const char *  query)
virtual

Set the SQL query string. This must be performed before Execute() or BindParameter() can be called.

Reimplemented from vtkSQLQuery.

bool vtkSQLiteQuery::Execute ( )
virtual

Execute the query. This must be performed before any field name or data access functions are used.

Implements vtkSQLQuery.

int vtkSQLiteQuery::GetNumberOfFields ( )
virtual

The number of fields in the query result.

Implements vtkRowQuery.

const char* vtkSQLiteQuery::GetFieldName ( int  i)
virtual

Return the name of the specified query field.

Implements vtkRowQuery.

int vtkSQLiteQuery::GetFieldType ( int  i)
virtual

Return the type of the field, using the constants defined in vtkType.h.

Implements vtkRowQuery.

bool vtkSQLiteQuery::NextRow ( )
virtual

Advance row, return false if past end.

Implements vtkRowQuery.

bool vtkSQLiteQuery::HasError ( )
virtual

Return true if there is an error on the current query.

Implements vtkRowQuery.

bool vtkSQLiteQuery::BeginTransaction ( )
virtual

Begin, abort (roll back), or commit a transaction.

Reimplemented from vtkSQLQuery.

bool vtkSQLiteQuery::RollbackTransaction ( )
virtual

Begin, abort (roll back), or commit a transaction.

Reimplemented from vtkSQLQuery.

bool vtkSQLiteQuery::CommitTransaction ( )
virtual

Begin, abort (roll back), or commit a transaction.

Reimplemented from vtkSQLQuery.

vtkVariant vtkSQLiteQuery::DataValue ( vtkIdType  c)
virtual

Return data in current row, field c

Implements vtkRowQuery.

const char* vtkSQLiteQuery::GetLastErrorText ( )
virtual

Get the last error text from the query

Implements vtkRowQuery.

bool vtkSQLiteQuery::BindParameter ( int  index,
unsigned char  value 
)
virtual

Bind a parameter to a placeholder in a query. A full discussion of this feature is beyond the scope of this header file, but in short, here's how it works: Instead of saying "SELECT foo FROM mytable WHERE myfield = 12345" you can say "SELECT foo FROM mytable WHERE myfield = ?". The ? character is a placeholder for a parameter that must then be bound. Call BindParameter(0, 12345) to bind the integer value 12345 to that field. Placeholders are indexed starting at 0. You are responsible for making sure that the types match when you call BindParameter. You don't have to get it precisely correct: in general, the SQL driver is smart enough to do things like cast a short to a long or a float to a double. Bound parameters were introduced in ANSI SQL 92. Please see that standard for more information. Most of these methods are excluded from wrapping because the Java wrapper treats all integer types from char up through 64-bit long as 'int'. This is incorrect behavior but what else am I going to do? Finally, the default implementation for BindParameter(int, vtkVariant) dispatches to one of the more type-specific versions. It should be OK to use in database drivers without modification.

Reimplemented from vtkSQLQuery.

bool vtkSQLiteQuery::BindParameter ( int  index,
signed char  value 
)
virtual

Reimplemented from vtkSQLQuery.

bool vtkSQLiteQuery::BindParameter ( int  index,
unsigned short  value 
)
virtual

Reimplemented from vtkSQLQuery.

bool vtkSQLiteQuery::BindParameter ( int  index,
short  value 
)
virtual

Reimplemented from vtkSQLQuery.

bool vtkSQLiteQuery::BindParameter ( int  index,
unsigned int  value 
)
virtual

Reimplemented from vtkSQLQuery.

bool vtkSQLiteQuery::BindParameter ( int  index,
int  value 
)
virtual

Reimplemented from vtkSQLQuery.

bool vtkSQLiteQuery::BindParameter ( int  index,
unsigned long  value 
)
virtual

Reimplemented from vtkSQLQuery.

bool vtkSQLiteQuery::BindParameter ( int  index,
long  value 
)
virtual

Reimplemented from vtkSQLQuery.

bool vtkSQLiteQuery::BindParameter ( int  index,
vtkTypeUInt64  value 
)
virtual

Reimplemented from vtkSQLQuery.

bool vtkSQLiteQuery::BindParameter ( int  index,
vtkTypeInt64  value 
)
virtual

Reimplemented from vtkSQLQuery.

bool vtkSQLiteQuery::BindParameter ( int  index,
float  value 
)
virtual

Reimplemented from vtkSQLQuery.

bool vtkSQLiteQuery::BindParameter ( int  index,
double  value 
)
virtual

Reimplemented from vtkSQLQuery.

bool vtkSQLiteQuery::BindParameter ( int  index,
const char *  stringValue 
)
virtual

Bind a string value – string must be null-terminated

Reimplemented from vtkSQLQuery.

bool vtkSQLiteQuery::BindParameter ( int  index,
const char *  stringValue,
size_t  length 
)
virtual

Bind a string value by specifying an array and a size

Reimplemented from vtkSQLQuery.

bool vtkSQLiteQuery::BindParameter ( int  index,
const vtkStdString &  string 
)
virtual

Bind a string value by specifying an array and a size

Reimplemented from vtkSQLQuery.

bool vtkSQLiteQuery::BindParameter ( int  index,
vtkVariant  value 
)
virtual

Bind a string value by specifying an array and a size

Reimplemented from vtkSQLQuery.

bool vtkSQLiteQuery::BindParameter ( int  index,
const void *  data,
size_t  length 
)
virtual

Bind a blob value. Not all databases support blobs as a data type. Check vtkSQLDatabase::IsSupported(VTK_SQL_FEATURE_BLOB) to make sure.

Reimplemented from vtkSQLQuery.

bool vtkSQLiteQuery::ClearParameterBindings ( )
virtual

Bind a blob value. Not all databases support blobs as a data type. Check vtkSQLDatabase::IsSupported(VTK_SQL_FEATURE_BLOB) to make sure.

Reimplemented from vtkSQLQuery.

virtual void vtkSQLiteQuery::SetLastErrorText ( const char *  )
protectedvirtual

Friends And Related Function Documentation

friend class vtkSQLiteDatabase
friend

Definition at line 57 of file vtkSQLiteQuery.h.

The documentation for this class was generated from the following file:
Generated on Wed Dec 16 2015 17:19:54 for VTK by   doxygen 1.8.9.1