vtkODBCQuery Class Reference

#include <vtkODBCQuery.h>

Inheritance diagram for vtkODBCQuery:

[legend]

Collaboration diagram for vtkODBCQuery:

[legend]

List of all members.

Detailed Description

vtkSQLQuery implementation for ODBC connections to databases

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

See also:: vtkSQLDatabase vtkSQLQuery vtkODBCDatabase

Definition at line 46 of file vtkODBCQuery.h.


Public Types
typedef vtkSQLQuery	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
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	BeginTransaction ()
bool	CommitTransaction ()
bool	RollbackTransaction ()

bool	SetQuery (const char *queryString)
const char *	GetQuery ()

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, signed 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, signed 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)
bool	BindParameter (int index, const char *stringValue, size_t length)
bool	BindParameter (int index, const vtkStdString &string)
bool	BindParameter (int index, const void *data, size_t length)
bool	ClearParameterBindings ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkODBCQuery *	SafeDownCast (vtkObject *o)
static vtkODBCQuery *	New ()
Protected Member Functions
	vtkODBCQuery ()
	~vtkODBCQuery ()
virtual void	SetLastErrorText (const char *)
virtual void	SetQueryText (const char *)
virtual char *	GetQueryText ()
Protected Attributes
char *	QueryText
Friends
class	vtkODBCDatabase

Member Typedef Documentation

typedef vtkSQLQuery vtkODBCQuery::Superclass

Reimplemented from vtkSQLQuery.

Definition at line 53 of file vtkODBCQuery.h.

Constructor & Destructor Documentation

vtkODBCQuery::vtkODBCQuery ( ) [protected]

vtkODBCQuery::~vtkODBCQuery ( ) [protected]

Member Function Documentation

virtual const char* vtkODBCQuery::GetClassName ( ) [virtual]

Reimplemented from vtkSQLQuery.

static int vtkODBCQuery::IsTypeOf ( const char * name ) [static]

Return 1 if this class type 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.

virtual int vtkODBCQuery::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 vtkODBCQuery* vtkODBCQuery::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkSQLQuery.

void vtkODBCQuery::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 vtkSQLQuery.

static vtkODBCQuery* vtkODBCQuery::New ( ) [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

bool vtkODBCQuery::Execute ( ) [virtual]

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

Implements vtkSQLQuery.

int vtkODBCQuery::GetNumberOfFields ( ) [virtual]

The number of fields in the query result.

Implements vtkRowQuery.

const char* vtkODBCQuery::GetFieldName ( int i ) [virtual]

Return the name of the specified query field.

Implements vtkRowQuery.

int vtkODBCQuery::GetFieldType ( int i ) [virtual]

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

Implements vtkRowQuery.

bool vtkODBCQuery::NextRow ( ) [virtual]

Advance row, return false if past end.

Implements vtkRowQuery.

bool vtkODBCQuery::HasError ( ) [virtual]

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

Implements vtkRowQuery.

vtkVariant vtkODBCQuery::DataValue ( vtkIdType c ) [virtual]

Return data in current row, field c

Implements vtkRowQuery.

const char* vtkODBCQuery::GetLastErrorText ( ) [virtual]

Get the last error text from the query

Implements vtkRowQuery.

bool vtkODBCQuery::BeginTransaction ( ) [virtual]

Begin, commit, or roll back a transaction.

Reimplemented from vtkSQLQuery.

bool vtkODBCQuery::CommitTransaction ( ) [virtual]

Begin, commit, or roll back a transaction.

Reimplemented from vtkSQLQuery.

bool vtkODBCQuery::RollbackTransaction ( ) [virtual]

Begin, commit, or roll back a transaction.

Reimplemented from vtkSQLQuery.

bool vtkODBCQuery::SetQuery ( const char * queryString ) [virtual]

Set the query string to be used. Returns true if the query is OK; false if there's some problem with it that can be detected before execution.

Reimplemented from vtkSQLQuery.

const char* vtkODBCQuery::GetQuery ( ) [virtual]

Set the query string to be used. Returns true if the query is OK; false if there's some problem with it that can be detected before execution.

Reimplemented from vtkSQLQuery.

bool vtkODBCQuery::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 vtkODBCQuery::BindParameter	(	int	index,
		signed char	value
	)			`[virtual]`

Reimplemented from vtkSQLQuery.

bool vtkODBCQuery::BindParameter	(	int	index,
		unsigned short	value
	)			`[virtual]`

Reimplemented from vtkSQLQuery.

bool vtkODBCQuery::BindParameter	(	int	index,
		signed short	value
	)

bool vtkODBCQuery::BindParameter	(	int	index,
		unsigned int	value
	)			`[virtual]`

Reimplemented from vtkSQLQuery.

bool vtkODBCQuery::BindParameter	(	int	index,
		int	value
	)			`[virtual]`

Reimplemented from vtkSQLQuery.

bool vtkODBCQuery::BindParameter	(	int	index,
		unsigned long	value
	)			`[virtual]`

Reimplemented from vtkSQLQuery.

bool vtkODBCQuery::BindParameter	(	int	index,
		signed long	value
	)

bool vtkODBCQuery::BindParameter	(	int	index,
		vtkTypeUInt64	value
	)			`[virtual]`

Reimplemented from vtkSQLQuery.

bool vtkODBCQuery::BindParameter	(	int	index,
		vtkTypeInt64	value
	)			`[virtual]`

Reimplemented from vtkSQLQuery.

bool vtkODBCQuery::BindParameter	(	int	index,
		float	value
	)			`[virtual]`

Reimplemented from vtkSQLQuery.

bool vtkODBCQuery::BindParameter	(	int	index,
		double	value
	)			`[virtual]`

Reimplemented from vtkSQLQuery.

bool vtkODBCQuery::BindParameter	(	int	index,
		const char *	stringValue
	)			`[virtual]`