vtkRowQuery Class Reference

abstract interface for queries that return row-oriented results. More...

#include <vtkRowQuery.h>

Inheritance diagram for vtkRowQuery:

Collaboration diagram for vtkRowQuery:

Public Types
typedef vtkObject	Superclass
Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)
vtkRowQuery *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual bool	Execute ()=0
virtual int	GetNumberOfFields ()=0
virtual const char *	GetFieldName (int i)=0
virtual int	GetFieldType (int i)=0
int	GetFieldIndex (char *name)
virtual bool	NextRow ()=0
virtual bool	IsActive ()=0
bool	NextRow (vtkVariantArray *rowArray)
virtual vtkVariant	DataValue (vtkIdType c)=0
virtual bool	HasError ()=0
virtual const char *	GetLastErrorText ()=0
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 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
	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 &)

Protected Attributes
bool	CaseSensitiveFieldNames
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Detailed Description

abstract interface for queries that return row-oriented results.

The abstract superclass of query classes that return row-oriented (table) results. A subclass will provide database-specific query parameters and implement the vtkRowQuery API to return query results:

Execute() - Execute the query. 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.

Thanks:

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

See also

vtkRowQueryToTable

Definition at line 61 of file vtkRowQuery.h.

Member Typedef Documentation

typedef vtkObject vtkRowQuery::Superclass

Definition at line 64 of file vtkRowQuery.h.

Constructor & Destructor Documentation

vtkRowQuery::vtkRowQuery ( )

protected

vtkRowQuery::~vtkRowQuery ( )

protected

Member Function Documentation

static int vtkRowQuery::IsTypeOf ( const char *  type )

static

virtual int vtkRowQuery::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 vtkObject.

Reimplemented in vtkSQLQuery, vtkSQLiteQuery, vtkODBCQuery, vtkPostgreSQLQuery, and vtkMySQLQuery.

static vtkRowQuery* vtkRowQuery::SafeDownCast ( vtkObjectBase *  o )

static

virtual vtkObjectBase* vtkRowQuery::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

Reimplemented in vtkSQLQuery, vtkSQLiteQuery, vtkODBCQuery, vtkPostgreSQLQuery, and vtkMySQLQuery.

vtkRowQuery* vtkRowQuery::NewInstance

(

)

const

void vtkRowQuery::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 vtkObject.

Reimplemented in vtkSQLQuery, and vtkSQLiteQuery.

virtual bool vtkRowQuery::Execute ( )

pure virtual

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

Implemented in vtkSQLQuery, vtkSQLiteQuery, vtkMySQLQuery, vtkODBCQuery, and vtkPostgreSQLQuery.

virtual int vtkRowQuery::GetNumberOfFields ( )

pure virtual

The number of fields in the query result.

Implemented in vtkMySQLQuery, vtkSQLiteQuery, vtkODBCQuery, and vtkPostgreSQLQuery.

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

pure virtual

Return the name of the specified query field.

Implemented in vtkMySQLQuery, vtkSQLiteQuery, vtkODBCQuery, and vtkPostgreSQLQuery.

virtual int vtkRowQuery::GetFieldType ( int  i )

pure virtual

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

Implemented in vtkMySQLQuery, vtkSQLiteQuery, vtkODBCQuery, and vtkPostgreSQLQuery.

int vtkRowQuery::GetFieldIndex

(

char *

name

)

Return the index of the specified query field. Uses GetNumberOfFields() and GetFieldName() to match field name.

virtual bool vtkRowQuery::NextRow ( )

pure virtual

Advance row, return false if past end.

Implemented in vtkMySQLQuery, vtkSQLiteQuery, vtkODBCQuery, and vtkPostgreSQLQuery.

virtual bool vtkRowQuery::IsActive ( )

pure 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.

Implemented in vtkSQLQuery.

bool vtkRowQuery::NextRow

(

vtkVariantArray *

rowArray

)

Advance row, return false if past end. Also, fill array with row values.

virtual vtkVariant vtkRowQuery::DataValue ( vtkIdType  c )

pure virtual

Return data in current row, field c

Implemented in vtkSQLiteQuery, vtkMySQLQuery, vtkPostgreSQLQuery, and vtkODBCQuery.

virtual bool vtkRowQuery::HasError ( )

pure virtual

Returns true if an error is set, otherwise false.

Implemented in vtkMySQLQuery, vtkSQLiteQuery, vtkODBCQuery, and vtkPostgreSQLQuery.

virtual const char* vtkRowQuery::GetLastErrorText ( )

pure virtual

Get the last error text from the query

Implemented in vtkSQLiteQuery, vtkMySQLQuery, vtkPostgreSQLQuery, and vtkODBCQuery.

virtual void vtkRowQuery::SetCaseSensitiveFieldNames ( bool  )

virtual

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 vtkRowQuery::GetCaseSensitiveFieldNames ( )

virtual

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 vtkRowQuery::CaseSensitiveFieldNamesOn ( )

virtual

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 vtkRowQuery::CaseSensitiveFieldNamesOff ( )

virtual

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.

Member Data Documentation

bool vtkRowQuery::CaseSensitiveFieldNames

protected

Definition at line 120 of file vtkRowQuery.h.

---

The documentation for this class was generated from the following file:

• dox/IO/SQL/vtkRowQuery.h