VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends
vtkPostgreSQLQuery Class Reference

vtkSQLQuery implementation for PostgreSQL databases More...

#include <vtkPostgreSQLQuery.h>

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

List of all members.

Public Types

typedef vtkSQLQuery Superclass
- Public Types inherited from vtkSQLQuery
- Public Types inherited from vtkRowQuery
- Public Types inherited from vtkObject

Public Member Functions

void PrintSelf (ostream &os, vtkIndent indent)
virtual const char * GetClassName ()
virtual int IsA (const char *type)
bool Execute ()
int GetNumberOfFields ()
const char * GetFieldName (int i)
int GetFieldType (int i)
bool NextRow ()
bool HasError ()
vtkVariant DataValue (vtkIdType c)
const char * GetLastErrorText ()
virtual vtkStdString EscapeString (vtkStdString s, bool addSurroundingQuotes=true)
int GetNumberOfRows ()
bool BeginTransaction ()
bool RollbackTransaction ()
bool CommitTransaction ()
- Public Member Functions inherited from vtkSQLQuery
bool IsActive ()
virtual bool BindParameter (int index, unsigned char value)
virtual bool BindParameter (int index, unsigned short value)
virtual bool BindParameter (int index, unsigned int value)
virtual bool BindParameter (int index, unsigned long value)
virtual bool BindParameter (int index, signed char value)
virtual bool BindParameter (int index, short value)
virtual bool BindParameter (int index, int value)
virtual bool BindParameter (int index, long value)
virtual bool BindParameter (int index, vtkTypeUInt64 value)
virtual bool BindParameter (int index, vtkTypeInt64 value)
virtual bool BindParameter (int index, float value)
virtual bool BindParameter (int index, double value)
char * EscapeString (const char *src, bool addSurroundingQuotes)
virtual bool SetQuery (const char *query)
virtual const char * GetQuery ()
virtual vtkSQLDatabaseGetDatabase ()
virtual bool BindParameter (int index, const char *stringValue)
virtual bool BindParameter (int index, const char *stringValue, size_t length)
virtual bool BindParameter (int index, const vtkStdString &string)
virtual bool BindParameter (int index, vtkVariant var)
virtual bool BindParameter (int index, const void *data, size_t length)
virtual bool ClearParameterBindings ()
- Public Member Functions inherited from vtkRowQuery
int GetFieldIndex (char *name)
bool NextRow (vtkVariantArray *rowArray)
virtual void SetCaseSensitiveFieldNames (bool)
virtual bool GetCaseSensitiveFieldNames ()
virtual void CaseSensitiveFieldNamesOn ()
virtual void CaseSensitiveFieldNamesOff ()
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char 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)
vtkCommandGetCommand (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)
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 &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

static vtkPostgreSQLQueryNew ()
static int IsTypeOf (const char *type)
static vtkPostgreSQLQuerySafeDownCast (vtkObject *o)

Protected Member Functions

 vtkPostgreSQLQuery ()
 ~vtkPostgreSQLQuery ()
virtual void SetLastErrorText (const char *)
bool IsColumnBinary (int whichColumn)
const char * GetColumnRawData (int whichColumn)
void DeleteQueryResults ()
- Protected Member Functions inherited from vtkSQLQuery
 vtkSQLQuery ()
 ~vtkSQLQuery ()
void SetDatabase (vtkSQLDatabase *db)
- Protected Member Functions inherited from vtkRowQuery
 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 &os)
virtual void ReportReferences (vtkGarbageCollector *)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

bool TransactionInProgress
char * LastErrorText
int CurrentRow
vtkPostgreSQLQueryPrivate * QueryInternals
- Protected Attributes inherited from vtkSQLQuery
char * Query
vtkSQLDatabaseDatabase
bool Active
- Protected Attributes inherited from vtkRowQuery
bool CaseSensitiveFieldNames
- Protected Attributes inherited from vtkObject
unsigned char Debug
vtkTimeStamp MTime
vtkSubjectHelper * SubjectHelper
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
vtkWeakPointerBase ** WeakPointers

Friends

class vtkPostgreSQLDatabase

Detailed Description

vtkSQLQuery implementation for PostgreSQL databases

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

Thanks:
Thanks to David Thompson and Andy Wilson from Sandia National Laboratories for implementing this class.
See also:
vtkSQLDatabase vtkSQLQuery vtkPostgreSQLDatabase

Definition at line 48 of file vtkPostgreSQLQuery.h.


Member Typedef Documentation

Reimplemented from vtkSQLQuery.

Definition at line 53 of file vtkPostgreSQLQuery.h.


Constructor & Destructor Documentation

vtkPostgreSQLQuery::vtkPostgreSQLQuery ( )
protected
vtkPostgreSQLQuery::~vtkPostgreSQLQuery ( )
protected

Member Function Documentation

static vtkPostgreSQLQuery* vtkPostgreSQLQuery::New ( )
static

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

Reimplemented from vtkObject.

void vtkPostgreSQLQuery::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.

virtual const char* vtkPostgreSQLQuery::GetClassName ( )
virtual

Reimplemented from vtkSQLQuery.

static int vtkPostgreSQLQuery::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 vtkPostgreSQLQuery::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 vtkPostgreSQLQuery* vtkPostgreSQLQuery::SafeDownCast ( vtkObject o)
static

Reimplemented from vtkSQLQuery.

bool vtkPostgreSQLQuery::Execute ( )
virtual

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

Implements vtkSQLQuery.

int vtkPostgreSQLQuery::GetNumberOfFields ( )
virtual

The number of fields in the query result.

Implements vtkRowQuery.

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

Return the name of the specified query field.

Implements vtkRowQuery.

int vtkPostgreSQLQuery::GetFieldType ( int  i)
virtual

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

Implements vtkRowQuery.

bool vtkPostgreSQLQuery::NextRow ( )
virtual

Advance row, return false if past end.

Implements vtkRowQuery.

bool vtkPostgreSQLQuery::HasError ( )
virtual

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

Implements vtkRowQuery.

bool vtkPostgreSQLQuery::BeginTransaction ( )
virtual

Begin, abort (roll back), or commit a transaction.

Reimplemented from vtkSQLQuery.

bool vtkPostgreSQLQuery::RollbackTransaction ( )
virtual

Begin, abort (roll back), or commit a transaction.

Reimplemented from vtkSQLQuery.

bool vtkPostgreSQLQuery::CommitTransaction ( )
virtual

Begin, abort (roll back), or commit a transaction.

Reimplemented from vtkSQLQuery.

vtkVariant vtkPostgreSQLQuery::DataValue ( vtkIdType  c)
virtual

Return data in current row, field c

Implements vtkRowQuery.

const char* vtkPostgreSQLQuery::GetLastErrorText ( )
virtual

Get the last error text from the query

Implements vtkRowQuery.

virtual vtkStdString vtkPostgreSQLQuery::EscapeString ( vtkStdString  s,
bool  addSurroundingQuotes = true 
)
virtual

Escape a string for inclusion into an SQL query

Reimplemented from vtkSQLQuery.

int vtkPostgreSQLQuery::GetNumberOfRows ( )

Unlike some databases, Postgres can tell you right away how many rows are in the results of your query.

virtual void vtkPostgreSQLQuery::SetLastErrorText ( const char *  )
protectedvirtual
bool vtkPostgreSQLQuery::IsColumnBinary ( int  whichColumn)
protected
const char* vtkPostgreSQLQuery::GetColumnRawData ( int  whichColumn)
protected
void vtkPostgreSQLQuery::DeleteQueryResults ( )
protected

Friends And Related Function Documentation

friend class vtkPostgreSQLDatabase
friend

Definition at line 113 of file vtkPostgreSQLQuery.h.


Member Data Documentation

bool vtkPostgreSQLQuery::TransactionInProgress
protected

Definition at line 104 of file vtkPostgreSQLQuery.h.

char* vtkPostgreSQLQuery::LastErrorText
protected

Definition at line 105 of file vtkPostgreSQLQuery.h.

int vtkPostgreSQLQuery::CurrentRow
protected

Definition at line 106 of file vtkPostgreSQLQuery.h.

vtkPostgreSQLQueryPrivate* vtkPostgreSQLQuery::QueryInternals
protected

Definition at line 108 of file vtkPostgreSQLQuery.h.


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