VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkRowQuery Class Referenceabstract

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

#include <vtkRowQuery.h>

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

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. More...
 
vtkRowQueryNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual bool Execute ()=0
 Execute the query. More...
 
virtual int GetNumberOfFields ()=0
 The number of fields in the query result. More...
 
virtual const char * GetFieldName (int i)=0
 Return the name of the specified query field. More...
 
virtual int GetFieldType (int i)=0
 Return the type of the field, using the constants defined in vtkType.h. More...
 
int GetFieldIndex (const char *name)
 Return the index of the specified query field. More...
 
virtual bool NextRow ()=0
 Advance row, return false if past end. More...
 
virtual bool IsActive ()=0
 Return true if the query is active (i.e. More...
 
bool NextRow (vtkVariantArray *rowArray)
 Advance row, return false if past end. More...
 
virtual vtkVariant DataValue (vtkIdType c)=0
 Return data in current row, field c. More...
 
virtual bool HasError ()=0
 Returns true if an error is set, otherwise false. More...
 
virtual const char * GetLastErrorText ()=0
 Get the last error text from the query. More...
 
virtual void SetCaseSensitiveFieldNames (bool)
 Many databases do not preserve case in field names. More...
 
virtual bool GetCaseSensitiveFieldNames ()
 
virtual void CaseSensitiveFieldNamesOn ()
 
virtual void CaseSensitiveFieldNamesOff ()
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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. More...
 
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)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
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
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkRowQuerySafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () 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. More...
 
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
std::atomic< int32_t > 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 62 of file vtkRowQuery.h.

Member Typedef Documentation

◆ Superclass

Definition at line 65 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 vtkSQLQuery, vtkSQLiteQuery, vtkPostgreSQLQuery, vtkODBCQuery, and vtkMySQLQuery.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkRowQuery::NewInstanceInternal ( ) const
protectedvirtual

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

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

◆ GetNumberOfFields()

virtual int vtkRowQuery::GetNumberOfFields ( )
pure virtual

The number of fields in the query result.

Implemented in vtkMySQLQuery, vtkSQLiteQuery, vtkODBCQuery, and vtkPostgreSQLQuery.

◆ GetFieldName()

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

Return the name of the specified query field.

Implemented in vtkMySQLQuery, vtkSQLiteQuery, vtkODBCQuery, and vtkPostgreSQLQuery.

◆ GetFieldType()

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.

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

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

◆ HasError()

virtual bool vtkRowQuery::HasError ( )
pure virtual

Returns true if an error is set, otherwise false.

Implemented in vtkMySQLQuery, vtkSQLiteQuery, vtkODBCQuery, and vtkPostgreSQLQuery.

◆ GetLastErrorText()

virtual const char* vtkRowQuery::GetLastErrorText ( )
pure virtual

Get the last error text from the query.

Implemented in vtkSQLiteQuery, vtkMySQLQuery, vtkPostgreSQLQuery, and vtkODBCQuery.

◆ 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

◆ CaseSensitiveFieldNamesOn()

virtual void vtkRowQuery::CaseSensitiveFieldNamesOn ( )
virtual

◆ CaseSensitiveFieldNamesOff()

virtual void vtkRowQuery::CaseSensitiveFieldNamesOff ( )
virtual

Member Data Documentation

◆ CaseSensitiveFieldNames

bool vtkRowQuery::CaseSensitiveFieldNames
protected

Definition at line 147 of file vtkRowQuery.h.


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