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 Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkRowQuery *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

virtual bool	Execute ()=0
	Execute the query.

virtual int	GetNumberOfFields ()=0
	The number of fields in the query result.

virtual const char *	GetFieldName (int i)=0
	Return the name of the specified query field.

virtual int	GetFieldType (int i)=0
	Return the type of the field, using the constants defined in vtkType.h.

int	GetFieldIndex (const char *name)
	Return the index of the specified query field.

virtual bool	NextRow ()=0
	Advance row, return false if past end.

virtual bool	IsActive ()=0
	Return true if the query is active (i.e.

bool	NextRow (vtkVariantArray *rowArray)
	Advance row, return false if past end.

virtual vtkVariant	DataValue (vtkIdType c)=0
	Return data in current row, field c.

virtual bool	HasError ()=0
	Returns true if an error is set, otherwise false.

virtual const char *	GetLastErrorText ()=0
	Get the last error text from the query.


virtual void	SetCaseSensitiveFieldNames (bool)
	Many databases do not preserve case in field names.

virtual bool	GetCaseSensitiveFieldNames ()
	Many databases do not preserve case in field names.

virtual void	CaseSensitiveFieldNamesOn ()
	Many databases do not preserve case in field names.

virtual void	CaseSensitiveFieldNamesOff ()
	Many databases do not preserve case in field names.

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.

vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

virtual void	Delete ()
	Delete a VTK object.

virtual void	FastDelete ()
	Delete a reference to this object.

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream.

void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

int	GetReferenceCount ()
	Return the current reference count of this object.

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not.

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)

static vtkRowQuery *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkRowQuery ()

	~vtkRowQuery () override

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	ObjectFinalize ()

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
bool	CaseSensitiveFieldNames

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

std::string	ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

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 47 of file vtkRowQuery.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkRowQuery::Superclass

Definition at line 50 of file vtkRowQuery.h.

Constructor & Destructor Documentation

◆ vtkRowQuery()

vtkRowQuery::vtkRowQuery ( )

protected

◆ ~vtkRowQuery()

vtkRowQuery::~vtkRowQuery ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool 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 vtkObjectBase.

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

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkRowQuery::NewInstanceInternal ( ) const

protectedvirtual

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

◆ NewInstance()

vtkRowQuery * vtkRowQuery::NewInstance ( ) const

◆ PrintSelf()

void vtkRowQuery::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

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 vtkSQLiteQuery, and vtkSQLQuery.

◆ Execute()

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 vtkQtSQLQuery, vtkMySQLQuery, vtkODBCQuery, vtkPostgreSQLQuery, vtkSQLiteQuery, and vtkSQLQuery.

◆ GetNumberOfFields()

virtual int vtkRowQuery::GetNumberOfFields ( )

pure virtual

The number of fields in the query result.

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

◆ GetFieldName()

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

pure virtual

Return the name of the specified query field.

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

◆ GetFieldType()

virtual int vtkRowQuery::GetFieldType ( int i )

pure virtual

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

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

◆ GetFieldIndex()

int vtkRowQuery::GetFieldIndex ( const char * name )

Return the index of the specified query field.

Uses GetNumberOfFields() and GetFieldName() to match field name.

◆ NextRow() [1/2]

virtual bool vtkRowQuery::NextRow ( )

pure virtual

Advance row, return false if past end.

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

◆ IsActive()

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.

◆ NextRow() [2/2]

bool vtkRowQuery::NextRow ( vtkVariantArray * rowArray )

Advance row, return false if past end.

Also, fill array with row values.

◆ DataValue()

virtual vtkVariant vtkRowQuery::DataValue ( vtkIdType c )

pure virtual

Return data in current row, field c.

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

◆ HasError()

virtual bool vtkRowQuery::HasError ( )

pure virtual

Returns true if an error is set, otherwise false.

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

◆ GetLastErrorText()

virtual const char * vtkRowQuery::GetLastErrorText ( )

pure virtual

Get the last error text from the query.

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

◆ SetCaseSensitiveFieldNames()

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.

◆ GetCaseSensitiveFieldNames()

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.

◆ CaseSensitiveFieldNamesOn()

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.

◆ CaseSensitiveFieldNamesOff()

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

◆ CaseSensitiveFieldNames

bool vtkRowQuery::CaseSensitiveFieldNames

protected

Definition at line 132 of file vtkRowQuery.h.

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

IO/SQL/vtkRowQuery.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkRowQuery()

◆ ~vtkRowQuery()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ Execute()

◆ GetNumberOfFields()

◆ GetFieldName()

◆ GetFieldType()

◆ GetFieldIndex()

◆ NextRow() [1/2]

◆ IsActive()

◆ NextRow() [2/2]

◆ DataValue()

◆ HasError()

◆ GetLastErrorText()

◆ SetCaseSensitiveFieldNames()

◆ GetCaseSensitiveFieldNames()

◆ CaseSensitiveFieldNamesOn()

◆ CaseSensitiveFieldNamesOff()

Member Data Documentation

◆ CaseSensitiveFieldNames