vtkSQLQuery - executes an sql query and retrieves results More...

Inheritance diagram for Kitware.VTK.vtkSQLQuery:

Collaboration diagram for Kitware.VTK.vtkSQLQuery:

Public Member Functions
	vtkSQLQuery (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
virtual bool	BeginTransaction ()
	Begin, commit, or roll back a transaction. If the underlying database does not support transactions these calls will do nothing.
virtual bool	BindParameter (int index, byte value)
	Return the database associated with the query.
virtual bool	BindParameter (int index, ushort value)
	Return the database associated with the query.
virtual bool	BindParameter (int index, uint value)
	Return the database associated with the query.
virtual bool	BindParameter (int index, sbyte value)
	Return the database associated with the query.
virtual bool	BindParameter (int index, short value)
	Return the database associated with the query.
virtual bool	BindParameter (int index, int value)
	Return the database associated with the query.
virtual bool	BindParameter (int index, ulong value)
	Return the database associated with the query.
virtual bool	BindParameter (int index, long value)
	Return the database associated with the query.
virtual bool	BindParameter (int index, float value)
	Return the database associated with the query.
virtual bool	BindParameter (int index, double value)
	Return the database associated with the query.
virtual bool	BindParameter (int index, string stringValue)
	Bind a string value – string must be null-terminated.
virtual bool	BindParameter (int index, string stringValue, uint length)
	Bind a string value by specifying an array and a size.
virtual bool	BindParameter (int index, IntPtr data, uint length)
	Bind a blob value. Not all databases support blobs as a data type. Check vtkSQLDatabase::IsSupported(VTK_SQL_FEATURE_BLOB) to make sure.
virtual bool	ClearParameterBindings ()
	Reset all parameter bindings to NULL.
virtual bool	CommitTransaction ()
	Begin, commit, or roll back a transaction. If the underlying database does not support transactions these calls will do nothing.
string	EscapeString (string src, bool addSurroundingQuotes)
	Escape a string for inclusion into an SQL query. This method exists to provide a wrappable version of the method that takes and returns vtkStdString objects. You are responsible for calling delete [] on the character array returned by this method. This method simply calls the vtkStdString variant and thus need not be re-implemented by subclasses.
override bool	Execute ()
	Execute the query. This must be performed before any field name or data access functions are used.
virtual vtkSQLDatabase	GetDatabase ()
	Return the database associated with the query.
virtual string	GetQuery ()
	The query string to be executed. Since some databases will process the query string as soon as it's set, this method returns a boolean to indicate success or failure.
override int	IsA (string type)
	*Undocumented Block
override bool	IsActive ()
	Return true if the query is active (i.e. execution was successful and results are ready to be fetched). Returns false on error or inactive query.
new vtkSQLQuery	NewInstance ()
	*Undocumented Block
virtual bool	RollbackTransaction ()
	Begin, commit, or roll back a transaction. If the underlying database does not support transactions these calls will do nothing.
virtual bool	SetQuery (string query)
	The query string to be executed. Since some databases will process the query string as soon as it's set, this method returns a boolean to indicate success or failure.
Public Member Functions inherited from Kitware.VTK.vtkRowQuery
	vtkRowQuery (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
virtual void	CaseSensitiveFieldNamesOff ()
	Many databases do not preserve case in field names. This can cause GetFieldIndex to fail if you search for a field named someFieldName when the database actually stores it as SOMEFIELDNAME. This ivar controls whether GetFieldIndex() expects field names to be case-sensitive. The default is OFF, i.e. case is not preserved.
virtual void	CaseSensitiveFieldNamesOn ()
	Many databases do not preserve case in field names. This can cause GetFieldIndex to fail if you search for a field named someFieldName when the database actually stores it as SOMEFIELDNAME. This ivar controls whether GetFieldIndex() expects field names to be case-sensitive. The default is OFF, i.e. case is not preserved.
virtual bool	GetCaseSensitiveFieldNames ()
	Many databases do not preserve case in field names. This can cause GetFieldIndex to fail if you search for a field named someFieldName when the database actually stores it as SOMEFIELDNAME. This ivar controls whether GetFieldIndex() expects field names to be case-sensitive. The default is OFF, i.e. case is not preserved.
int	GetFieldIndex (string name)
	Return the index of the specified query field. Uses GetNumberOfFields() and GetFieldName() to match field name.
virtual string	GetFieldName (int i)
	Return the name of the specified query field.
virtual int	GetFieldType (int i)
	Return the type of the field, using the constants defined in vtkType.h.
virtual string	GetLastErrorText ()
	Get the last error text from the query.
virtual int	GetNumberOfFields ()
	The number of fields in the query result.
virtual bool	HasError ()
	Returns true if an error is set, otherwise false.
virtual bool	NextRow ()
	Advance row, return false if past end.
bool	NextRow (vtkVariantArray rowArray)
	Advance row, return false if past end. Also, fill array with row values.
virtual void	SetCaseSensitiveFieldNames (bool _arg)
	Many databases do not preserve case in field names. This can cause GetFieldIndex to fail if you search for a field named someFieldName when the database actually stores it as SOMEFIELDNAME. This ivar controls whether GetFieldIndex() expects field names to be case-sensitive. The default is OFF, i.e. case is not preserved.
Public Member Functions inherited from Kitware.VTK.vtkObject
	vtkObject (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
	vtkObject ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
uint	AddObserver (uint arg0, vtkCommand arg1, float priority)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
uint	AddObserver (string arg0, vtkCommand arg1, float priority)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual void	DebugOff ()
	Turn debugging output off.
virtual void	DebugOn ()
	Turn debugging output on.
vtkCommand	GetCommand (uint tag)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
byte	GetDebug ()
	Get the value of the debug flag.
virtual uint	GetMTime ()
	Return this object's modified time.
int	HasObserver (uint arg0, vtkCommand arg1)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	HasObserver (string arg0, vtkCommand arg1)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	HasObserver (uint arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	HasObserver (string arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	InvokeEvent (uint arg0, IntPtr callData)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	InvokeEvent (string arg0, IntPtr callData)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	InvokeEvent (uint arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	InvokeEvent (string arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual void	Modified ()
	Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data. The modification time is a unique monotonically increasing unsigned long integer.
void	RemoveAllObservers ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	RemoveObserver (vtkCommand arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	RemoveObserver (uint tag)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	RemoveObservers (uint arg0, vtkCommand arg1)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	RemoveObservers (string arg0, vtkCommand arg1)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	RemoveObservers (uint arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	RemoveObservers (string arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	SetDebug (byte debugFlag)
	Set the value of the debug flag. A non-zero value turns debugging on.
override string	ToString ()
	Returns the result of calling vtkObject::Print as a C# string.
delegate void	vtkObjectEventHandler (vtkObject sender, vtkObjectEventArgs e)
	Generic signature for all vtkObject events.
void	RemoveAllHandlersForAllEvents ()
	Call RemoveAllHandlers on each non-null vtkObjectEventRelay. TODO: This method needs to get called by the generated Dispose. Make that happen...
Public Member Functions inherited from Kitware.VTK.vtkObjectBase
	vtkObjectBase (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
	vtkObjectBase ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
virtual void	Register (vtkObjectBase o)
	Increase the reference count (mark as used by another object).
virtual void	FastDelete ()
	Delete a reference to this object. This version will not invoke garbage collection and can potentially leak the object if it is part of a reference loop. Use this method only when it is known that the object has another reference and would not be collected if a full garbage collection check were done.
string	GetClassName ()
	Return the class name as a string. This method is defined in all subclasses of vtkObjectBase with the vtkTypeMacro found in vtkSetGet.h.
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int arg0)
	Sets the reference count. (This is very dangerous, use with care.)

Static Public Member Functions
static new int	IsTypeOf (string type)
	*Undocumented Block
static new vtkSQLQuery	SafeDownCast (vtkObjectBase o)
	*Undocumented Block

Public Attributes
new const string	MRFullTypeName = "Kitware.VTK.vtkSQLQuery"
	Automatically generated type registration mechanics.
Public Attributes inherited from Kitware.VTK.vtkRowQuery
Public Attributes inherited from Kitware.VTK.vtkObject
Public Attributes inherited from Kitware.VTK.vtkObjectBase
Public Attributes inherited from Kitware.VTK.WrappedObject
const string	vtkChartsEL_dll = "libKitware.VTK.vtkCharts.Unmanaged.so"
	Export layer functions for 'vtkCharts' are exported from the DLL named by the value of this variable.
const string	vtkCommonEL_dll = "libKitware.VTK.vtkCommon.Unmanaged.so"
	Export layer functions for 'vtkCommon' are exported from the DLL named by the value of this variable.
const string	vtkFilteringEL_dll = "libKitware.VTK.vtkFiltering.Unmanaged.so"
	Export layer functions for 'vtkFiltering' are exported from the DLL named by the value of this variable.
const string	vtkGenericFilteringEL_dll = "libKitware.VTK.vtkGenericFiltering.Unmanaged.so"
	Export layer functions for 'vtkGenericFiltering' are exported from the DLL named by the value of this variable.
const string	vtkGeovisEL_dll = "libKitware.VTK.vtkGeovis.Unmanaged.so"
	Export layer functions for 'vtkGeovis' are exported from the DLL named by the value of this variable.
const string	vtkGraphicsEL_dll = "libKitware.VTK.vtkGraphics.Unmanaged.so"
	Export layer functions for 'vtkGraphics' are exported from the DLL named by the value of this variable.
const string	vtkHybridEL_dll = "libKitware.VTK.vtkHybrid.Unmanaged.so"
	Export layer functions for 'vtkHybrid' are exported from the DLL named by the value of this variable.
const string	vtkIOEL_dll = "libKitware.VTK.vtkIO.Unmanaged.so"
	Export layer functions for 'vtkIO' are exported from the DLL named by the value of this variable.
const string	vtkImagingEL_dll = "libKitware.VTK.vtkImaging.Unmanaged.so"
	Export layer functions for 'vtkImaging' are exported from the DLL named by the value of this variable.
const string	vtkInfovisEL_dll = "libKitware.VTK.vtkInfovis.Unmanaged.so"
	Export layer functions for 'vtkInfovis' are exported from the DLL named by the value of this variable.
const string	vtkParallelEL_dll = "libKitware.VTK.vtkParallel.Unmanaged.so"
	Export layer functions for 'vtkParallel' are exported from the DLL named by the value of this variable.
const string	vtkRenderingEL_dll = "libKitware.VTK.vtkRendering.Unmanaged.so"
	Export layer functions for 'vtkRendering' are exported from the DLL named by the value of this variable.
const string	vtkViewsEL_dll = "libKitware.VTK.vtkViews.Unmanaged.so"
	Export layer functions for 'vtkViews' are exported from the DLL named by the value of this variable.
const string	vtkVolumeRenderingEL_dll = "libKitware.VTK.vtkVolumeRendering.Unmanaged.so"
	Export layer functions for 'vtkVolumeRendering' are exported from the DLL named by the value of this variable.
const string	vtkWidgetsEL_dll = "libKitware.VTK.vtkWidgets.Unmanaged.so"
	Export layer functions for 'vtkWidgets' are exported from the DLL named by the value of this variable.

Static Public Attributes
static new readonly string	MRClassNameKey = "11vtkSQLQuery"
	Automatically generated type registration mechanics.
Static Public Attributes inherited from Kitware.VTK.vtkRowQuery
Static Public Attributes inherited from Kitware.VTK.vtkObject
Static Public Attributes inherited from Kitware.VTK.vtkObjectBase

Protected Member Functions
override void	Dispose (bool disposing)
	Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Static Private Member Functions
static	vtkSQLQuery ()
	Automatically generated type registration mechanics.

Detailed Description

vtkSQLQuery - executes an sql query and retrieves results

Description The abstract superclass of SQL query classes. Instances of subclasses of vtkSQLQuery are created using the GetQueryInstance() function in vtkSQLDatabase. To implement a query connection for a new database type, subclass both vtkSQLDatabase and vtkSQLQuery, and implement the required functions. For the query class, this involves the following:

Execute() - Execute the query on the database. No results need to be retrieved at this point, unless you are performing caching.

GetNumberOfFields() - After Execute() is performed, returns the number of fields in the query results.

GetFieldName() - The name of the field at an index.

GetFieldType() - The data type of the field at an index.

NextRow() - Advances the query results by one row, and returns whether there are more rows left in the query.

DataValue() - Extract a single data value from the current row.

Begin/Rollback/CommitTransaction() - These methods are optional but recommended if the database supports transactions.

Thanks Thanks to Andrew Wilson from Sandia National Laboratories for his work on the database classes.

vtkSQLDatabase

Constructor & Destructor Documentation

static Kitware.VTK.vtkSQLQuery.vtkSQLQuery ( )

staticprivate

Automatically generated type registration mechanics.

Kitware.VTK.vtkSQLQuery.vtkSQLQuery	(	IntPtr	rawCppThis,
		bool	callDisposalMethod,
		bool	strong
	)

Automatically generated constructor - called from generated code. DO NOT call directly.

Member Function Documentation

virtual bool Kitware.VTK.vtkSQLQuery.BeginTransaction ( )

virtual

Begin, commit, or roll back a transaction. If the underlying database does not support transactions these calls will do nothing.

Reimplemented in Kitware.VTK.vtkMySQLQuery, Kitware.VTK.vtkSQLiteQuery, and Kitware.VTK.vtkPostgreSQLQuery.

virtual bool Kitware.VTK.vtkSQLQuery.BindParameter	(	int	index,
		byte	value
	)

virtual

Return the database associated with the query.

Reimplemented in Kitware.VTK.vtkMySQLQuery, and Kitware.VTK.vtkSQLiteQuery.

virtual bool Kitware.VTK.vtkSQLQuery.BindParameter	(	int	index,
		ushort	value
	)

virtual

Return the database associated with the query.

Reimplemented in Kitware.VTK.vtkMySQLQuery, and Kitware.VTK.vtkSQLiteQuery.

virtual bool Kitware.VTK.vtkSQLQuery.BindParameter	(	int	index,
		uint	value
	)

virtual

Return the database associated with the query.

Reimplemented in Kitware.VTK.vtkMySQLQuery, and Kitware.VTK.vtkSQLiteQuery.

virtual bool Kitware.VTK.vtkSQLQuery.BindParameter	(	int	index,
		sbyte	value
	)

virtual

Return the database associated with the query.

Reimplemented in Kitware.VTK.vtkMySQLQuery, and Kitware.VTK.vtkSQLiteQuery.

virtual bool Kitware.VTK.vtkSQLQuery.BindParameter	(	int	index,
		short	value
	)

virtual

Return the database associated with the query.

Reimplemented in Kitware.VTK.vtkMySQLQuery, and Kitware.VTK.vtkSQLiteQuery.

virtual bool Kitware.VTK.vtkSQLQuery.BindParameter	(	int	index,
		int	value
	)

virtual

Return the database associated with the query.

Reimplemented in Kitware.VTK.vtkMySQLQuery, and Kitware.VTK.vtkSQLiteQuery.

virtual bool Kitware.VTK.vtkSQLQuery.BindParameter	(	int	index,
		ulong	value
	)

virtual

Return the database associated with the query.

Reimplemented in Kitware.VTK.vtkMySQLQuery, and Kitware.VTK.vtkSQLiteQuery.

virtual bool Kitware.VTK.vtkSQLQuery.BindParameter	(	int	index,
		long	value
	)

virtual

Return the database associated with the query.

Reimplemented in Kitware.VTK.vtkMySQLQuery, and Kitware.VTK.vtkSQLiteQuery.

virtual bool Kitware.VTK.vtkSQLQuery.BindParameter	(	int	index,
		float	value
	)

virtual

Return the database associated with the query.

Reimplemented in Kitware.VTK.vtkMySQLQuery, and Kitware.VTK.vtkSQLiteQuery.

virtual bool Kitware.VTK.vtkSQLQuery.BindParameter	(	int	index,
		double	value
	)

virtual

Return the database associated with the query.

Reimplemented in Kitware.VTK.vtkMySQLQuery, and Kitware.VTK.vtkSQLiteQuery.

virtual bool Kitware.VTK.vtkSQLQuery.BindParameter	(	int	index,
		string	stringValue
	)

virtual

Bind a string value – string must be null-terminated.

Reimplemented in Kitware.VTK.vtkMySQLQuery, and Kitware.VTK.vtkSQLiteQuery.

virtual bool Kitware.VTK.vtkSQLQuery.BindParameter	(	int	index,
		string	stringValue,
		uint	length
	)

virtual

Bind a string value by specifying an array and a size.

Reimplemented in Kitware.VTK.vtkMySQLQuery, and Kitware.VTK.vtkSQLiteQuery.

virtual bool Kitware.VTK.vtkSQLQuery.BindParameter	(	int	index,
		IntPtr	data,
		uint	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 in Kitware.VTK.vtkMySQLQuery, and Kitware.VTK.vtkSQLiteQuery.

virtual bool Kitware.VTK.vtkSQLQuery.ClearParameterBindings ( )

virtual

Reset all parameter bindings to NULL.

Reimplemented in Kitware.VTK.vtkMySQLQuery, and Kitware.VTK.vtkSQLiteQuery.

virtual bool Kitware.VTK.vtkSQLQuery.CommitTransaction ( )

virtual

Begin, commit, or roll back a transaction. If the underlying database does not support transactions these calls will do nothing.

Reimplemented in Kitware.VTK.vtkMySQLQuery, Kitware.VTK.vtkSQLiteQuery, and Kitware.VTK.vtkPostgreSQLQuery.

override void Kitware.VTK.vtkSQLQuery.Dispose ( bool disposing )

protected

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkRowQuery.

Reimplemented in Kitware.VTK.vtkSQLiteQuery, Kitware.VTK.vtkMySQLQuery, and Kitware.VTK.vtkPostgreSQLQuery.

string Kitware.VTK.vtkSQLQuery.EscapeString	(	string	src,
		bool	addSurroundingQuotes
	)

Escape a string for inclusion into an SQL query. This method exists to provide a wrappable version of the method that takes and returns vtkStdString objects. You are responsible for calling delete [] on the character array returned by this method. This method simply calls the vtkStdString variant and thus need not be re-implemented by subclasses.

override bool Kitware.VTK.vtkSQLQuery.Execute ( )

virtual

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

Reimplemented from Kitware.VTK.vtkRowQuery.

Reimplemented in Kitware.VTK.vtkMySQLQuery, Kitware.VTK.vtkSQLiteQuery, and Kitware.VTK.vtkPostgreSQLQuery.

virtual vtkSQLDatabase Kitware.VTK.vtkSQLQuery.GetDatabase ( )

virtual

Return the database associated with the query.

Here is the call graph for this function:

virtual string Kitware.VTK.vtkSQLQuery.GetQuery ( )

virtual

The query string to be executed. Since some databases will process the query string as soon as it's set, this method returns a boolean to indicate success or failure.

override int Kitware.VTK.vtkSQLQuery.IsA ( string type )

virtual

*Undocumented Block

Reimplemented from Kitware.VTK.vtkRowQuery.

Reimplemented in Kitware.VTK.vtkMySQLQuery, Kitware.VTK.vtkSQLiteQuery, and Kitware.VTK.vtkPostgreSQLQuery.

override bool Kitware.VTK.vtkSQLQuery.IsActive ( )

virtual

Return true if the query is active (i.e. execution was successful and results are ready to be fetched). Returns false on error or inactive query.

Reimplemented from Kitware.VTK.vtkRowQuery.

static new int Kitware.VTK.vtkSQLQuery.IsTypeOf ( string type )

static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkRowQuery.

Reimplemented in Kitware.VTK.vtkMySQLQuery, Kitware.VTK.vtkSQLiteQuery, and Kitware.VTK.vtkPostgreSQLQuery.

new vtkSQLQuery Kitware.VTK.vtkSQLQuery.NewInstance ( )

*Undocumented Block

Reimplemented from Kitware.VTK.vtkRowQuery.

Reimplemented in Kitware.VTK.vtkMySQLQuery, Kitware.VTK.vtkSQLiteQuery, and Kitware.VTK.vtkPostgreSQLQuery.

virtual bool Kitware.VTK.vtkSQLQuery.RollbackTransaction ( )

virtual

Begin, commit, or roll back a transaction. If the underlying database does not support transactions these calls will do nothing.

Reimplemented in Kitware.VTK.vtkMySQLQuery, Kitware.VTK.vtkSQLiteQuery, and Kitware.VTK.vtkPostgreSQLQuery.

static new vtkSQLQuery Kitware.VTK.vtkSQLQuery.SafeDownCast ( vtkObjectBase o )

static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkRowQuery.

Reimplemented in Kitware.VTK.vtkMySQLQuery, Kitware.VTK.vtkSQLiteQuery, and Kitware.VTK.vtkPostgreSQLQuery.

Here is the call graph for this function:

virtual bool Kitware.VTK.vtkSQLQuery.SetQuery ( string query )

virtual

The query string to be executed. Since some databases will process the query string as soon as it's set, this method returns a boolean to indicate success or failure.

Reimplemented in Kitware.VTK.vtkMySQLQuery, and Kitware.VTK.vtkSQLiteQuery.