vtkSQLDatabaseTableSource Class Reference

#include <vtkSQLDatabaseTableSource.h>

Inheritance diagram for vtkSQLDatabaseTableSource:

Inheritance graph
[legend]
Collaboration diagram for vtkSQLDatabaseTableSource:

Collaboration graph
[legend]

List of all members.


Detailed Description

Generates a vtkTable based on an SQL query.

This class combines vtkSQLDatabase, vtkSQLQuery, and vtkQueryToTable to provide a convenience class for generating tables from databases. Also this class can be easily wrapped and used within ParaView / OverView.

Examples:
vtkSQLDatabaseTableSource (Examples)
Tests:
vtkSQLDatabaseTableSource (Tests)

Definition at line 43 of file vtkSQLDatabaseTableSource.h.


Public Types

typedef vtkTableAlgorithm Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
vtkStdString GetURL ()
void SetURL (const vtkStdString &url)
void SetPassword (const vtkStdString &password)
vtkStdString GetQuery ()
void SetQuery (const vtkStdString &query)
virtual void SetPedigreeIdArrayName (const char *)
virtual char * GetPedigreeIdArrayName ()
virtual void SetGeneratePedigreeIds (bool)
virtual bool GetGeneratePedigreeIds ()
virtual void GeneratePedigreeIdsOn ()
virtual void GeneratePedigreeIdsOff ()

Static Public Member Functions

static vtkSQLDatabaseTableSourceNew ()
static int IsTypeOf (const char *type)
static vtkSQLDatabaseTableSourceSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkSQLDatabaseTableSource ()
 ~vtkSQLDatabaseTableSource ()
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)

Member Typedef Documentation

Reimplemented from vtkTableAlgorithm.

Definition at line 47 of file vtkSQLDatabaseTableSource.h.


Constructor & Destructor Documentation

vtkSQLDatabaseTableSource::vtkSQLDatabaseTableSource (  )  [protected]

vtkSQLDatabaseTableSource::~vtkSQLDatabaseTableSource (  )  [protected]


Member Function Documentation

static vtkSQLDatabaseTableSource* vtkSQLDatabaseTableSource::New (  )  [static]

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

Reimplemented from vtkTableAlgorithm.

virtual const char* vtkSQLDatabaseTableSource::GetClassName (  )  [virtual]

Reimplemented from vtkTableAlgorithm.

static int vtkSQLDatabaseTableSource::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 vtkTableAlgorithm.

virtual int vtkSQLDatabaseTableSource::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 vtkTableAlgorithm.

static vtkSQLDatabaseTableSource* vtkSQLDatabaseTableSource::SafeDownCast ( vtkObject o  )  [static]

Reimplemented from vtkTableAlgorithm.

void vtkSQLDatabaseTableSource::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 vtkTableAlgorithm.

vtkStdString vtkSQLDatabaseTableSource::GetURL (  ) 

void vtkSQLDatabaseTableSource::SetURL ( const vtkStdString url  ) 

void vtkSQLDatabaseTableSource::SetPassword ( const vtkStdString password  ) 

vtkStdString vtkSQLDatabaseTableSource::GetQuery (  ) 

void vtkSQLDatabaseTableSource::SetQuery ( const vtkStdString query  ) 

virtual void vtkSQLDatabaseTableSource::SetPedigreeIdArrayName ( const char *   )  [virtual]

The name of the array for generating or assigning pedigree ids (default "id").

virtual char* vtkSQLDatabaseTableSource::GetPedigreeIdArrayName (  )  [virtual]

The name of the array for generating or assigning pedigree ids (default "id").

virtual void vtkSQLDatabaseTableSource::SetGeneratePedigreeIds ( bool   )  [virtual]

If on (default), generates pedigree ids automatically. If off, assign one of the arrays to be the pedigree id.

virtual bool vtkSQLDatabaseTableSource::GetGeneratePedigreeIds (  )  [virtual]

If on (default), generates pedigree ids automatically. If off, assign one of the arrays to be the pedigree id.

virtual void vtkSQLDatabaseTableSource::GeneratePedigreeIdsOn (  )  [virtual]

If on (default), generates pedigree ids automatically. If off, assign one of the arrays to be the pedigree id.

virtual void vtkSQLDatabaseTableSource::GeneratePedigreeIdsOff (  )  [virtual]

If on (default), generates pedigree ids automatically. If off, assign one of the arrays to be the pedigree id.

int vtkSQLDatabaseTableSource::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
) [protected, virtual]

This is called by the superclass. This is the method you should override.

Reimplemented from vtkTableAlgorithm.


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

Generated on Mon Sep 27 18:51:59 2010 for VTK by  doxygen 1.5.6