ActiViz .NET  5.8.0
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Member Functions | Static Private Member Functions
Kitware.VTK.vtkSQLDatabase Class Reference

vtkSQLDatabase - maintain a connection to an sql database More...

Inheritance diagram for Kitware.VTK.vtkSQLDatabase:
[legend]
Collaboration diagram for Kitware.VTK.vtkSQLDatabase:
[legend]

List of all members.

Public Member Functions

 vtkSQLDatabase (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
delegate IntPtr CreateFunction (string arg0)
 Effect a database schema.
virtual void Close ()
 Close the connection to the database.
virtual bool EffectSchema (vtkSQLDatabaseSchema arg0, bool dropIfExists)
 Effect a database schema.
virtual string GetDatabaseType ()
 Get the type of the database (e.g. mysql, psql,..).
virtual string GetLastErrorText ()
 Get the last error text from the database I'm using const so that people do NOT use the standard vtkGetStringMacro in their implementation, because 99% of the time that will not be the correct thing to do...
virtual vtkSQLQuery GetQueryInstance ()
 Return an empty query on this database.
virtual vtkStringArray GetRecord (string table)
 Get the list of fields for a particular table.
virtual vtkStringArray GetTables ()
 Get the list of tables from the database.
virtual bool HasError ()
 Did the last operation generate an error.
override int IsA (string type)
 Undocumented Block.
virtual bool IsOpen ()
 Return whether the database has an open connection.
virtual bool IsSupported (int arg0)
 Return whether a feature is supported by the database.
new vtkSQLDatabase NewInstance ()
 Undocumented Block.
virtual bool Open (string password)
 Open a new connection to the database. You need to set up any database parameters before calling this function. For database connections that do not require a password, pass an empty string. Returns true is the database was opened sucessfully, and false otherwise.

Static Public Member Functions

static vtkSQLDatabase CreateFromURL (string URL)
 Create a the proper subclass given a URL. The URL format for SQL databases is a true URL of the form: 'protocol://'[[username[':'password]'']hostname[':'port]]'/'[dbname] .
static vtkInformationObjectBaseKey DATABASE ()
 Stores the database class pointer as an information key. This is currently used to store database pointers as part of 'data on demand' data objects. For example: The application may have a table/tree/whatever of documents, the data structure is storing the meta-data but not the full text. Further down the pipeline algorithms or views may want to retrieve additional information (full text)for specific documents.
static new int IsTypeOf (string type)
 Undocumented Block.
static void RegisterCreateFromURLCallback (CreateFunction callback)
 Provides mechanism to register/unregister additional callbacks to create concrete subclasses of vtkSQLDatabase to handle different protocols. The registered callbacks are tried in the order they are registered.
static new vtkSQLDatabase SafeDownCast (vtkObjectBase o)
 Undocumented Block.
static void UnRegisterAllCreateFromURLCallbacks ()
 Provides mechanism to register/unregister additional callbacks to create concrete subclasses of vtkSQLDatabase to handle different protocols. The registered callbacks are tried in the order they are registered.
static void UnRegisterCreateFromURLCallback (CreateFunction callback)
 Provides mechanism to register/unregister additional callbacks to create concrete subclasses of vtkSQLDatabase to handle different protocols. The registered callbacks are tried in the order they are registered.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkSQLDatabase"
 Automatically generated type registration mechanics.

Static Public Attributes

static new readonly string MRClassNameKey = "14vtkSQLDatabase"
 Automatically generated type registration mechanics.

Protected Member Functions

override void Dispose (bool disposing)
 Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Private Member Functions

static internal void vtkSQLDatabase_Close_01 (HandleRef pThis)
static internal IntPtr vtkSQLDatabase_CreateFromURL_02 (string URL, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkSQLDatabase_DATABASE_03 (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal byte vtkSQLDatabase_EffectSchema_04 (HandleRef pThis, HandleRef arg0, byte dropIfExists)
static internal IntPtr vtkSQLDatabase_GetDatabaseType_05 (HandleRef pThis)
static internal IntPtr vtkSQLDatabase_GetLastErrorText_06 (HandleRef pThis)
static internal IntPtr vtkSQLDatabase_GetQueryInstance_07 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkSQLDatabase_GetRecord_08 (HandleRef pThis, string table, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkSQLDatabase_GetTables_09 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal byte vtkSQLDatabase_HasError_10 (HandleRef pThis)
static internal int vtkSQLDatabase_IsA_11 (HandleRef pThis, string type)
static internal byte vtkSQLDatabase_IsOpen_12 (HandleRef pThis)
static internal byte vtkSQLDatabase_IsSupported_13 (HandleRef pThis, int arg0)
static internal int vtkSQLDatabase_IsTypeOf_14 (string type)
static internal IntPtr vtkSQLDatabase_NewInstance_15 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal byte vtkSQLDatabase_Open_16 (HandleRef pThis, string password)
static internal void vtkSQLDatabase_RegisterCreateFromURLCallback_17 (CreateFunction callback)
static internal IntPtr vtkSQLDatabase_SafeDownCast_18 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkSQLDatabase_UnRegisterAllCreateFromURLCallbacks_19 ()
static internal void vtkSQLDatabase_UnRegisterCreateFromURLCallback_20 (CreateFunction callback)

Static Private Member Functions

static vtkSQLDatabase ()
 Automatically generated type registration mechanics.

Detailed Description

vtkSQLDatabase - maintain a connection to an sql database

Description Abstract base class for all SQL database connection classes. Manages a connection to the database, and is responsible for creating instances of the associated vtkSQLQuery objects associated with this class in order to perform execute queries on the database. To allow connections to a new type of database, create both a subclass of this class and vtkSQLQuery, and implement the required functions:

Open() - open the database connection, if possible. Close() - close the connection. GetQueryInstance() - create and return an instance of the vtkSQLQuery subclass associated with the database type.

The subclass should also provide API to set connection parameters.

This class also provides the function EffectSchema to transform a database schema into a SQL database.

Thanks Thanks to Andrew Wilson from Sandia National Laboratories for his work on the database classes and for the SQLite example. Thanks to David Thompson and Philippe Pebay from Sandia National Laboratories for implementing this class.

vtkSQLQuery vtkSQLDatabaseSchema


Constructor & Destructor Documentation

static Kitware.VTK.vtkSQLDatabase.vtkSQLDatabase ( ) [static, private]

Automatically generated type registration mechanics.

Kitware.VTK.vtkSQLDatabase.vtkSQLDatabase ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

Automatically generated constructor - called from generated code. DO NOT call directly.


Member Function Documentation

virtual void Kitware.VTK.vtkSQLDatabase.Close ( ) [virtual]

Close the connection to the database.

Reimplemented in Kitware.VTK.vtkSQLiteDatabase, Kitware.VTK.vtkPostgreSQLDatabase, and Kitware.VTK.vtkMySQLDatabase.

Create a the proper subclass given a URL. The URL format for SQL databases is a true URL of the form: 'protocol://'[[username[':'password]'']hostname[':'port]]'/'[dbname] .

Here is the call graph for this function:

delegate IntPtr Kitware.VTK.vtkSQLDatabase.CreateFunction ( string  arg0)

Effect a database schema.

Stores the database class pointer as an information key. This is currently used to store database pointers as part of 'data on demand' data objects. For example: The application may have a table/tree/whatever of documents, the data structure is storing the meta-data but not the full text. Further down the pipeline algorithms or views may want to retrieve additional information (full text)for specific documents.

Here is the call graph for this function:

override void Kitware.VTK.vtkSQLDatabase.Dispose ( bool  disposing) [protected]

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkSQLiteDatabase, Kitware.VTK.vtkPostgreSQLDatabase, and Kitware.VTK.vtkMySQLDatabase.

virtual bool Kitware.VTK.vtkSQLDatabase.EffectSchema ( vtkSQLDatabaseSchema  arg0,
bool  dropIfExists 
) [virtual]

Effect a database schema.

virtual string Kitware.VTK.vtkSQLDatabase.GetDatabaseType ( ) [virtual]

Get the type of the database (e.g. mysql, psql,..).

Reimplemented in Kitware.VTK.vtkPostgreSQLDatabase, Kitware.VTK.vtkSQLiteDatabase, and Kitware.VTK.vtkMySQLDatabase.

virtual string Kitware.VTK.vtkSQLDatabase.GetLastErrorText ( ) [virtual]

Get the last error text from the database I'm using const so that people do NOT use the standard vtkGetStringMacro in their implementation, because 99% of the time that will not be the correct thing to do...

Reimplemented in Kitware.VTK.vtkPostgreSQLDatabase, Kitware.VTK.vtkMySQLDatabase, and Kitware.VTK.vtkSQLiteDatabase.

Return an empty query on this database.

Reimplemented in Kitware.VTK.vtkPostgreSQLDatabase, Kitware.VTK.vtkMySQLDatabase, and Kitware.VTK.vtkSQLiteDatabase.

Here is the call graph for this function:

virtual vtkStringArray Kitware.VTK.vtkSQLDatabase.GetRecord ( string  table) [virtual]

Get the list of fields for a particular table.

Reimplemented in Kitware.VTK.vtkPostgreSQLDatabase, Kitware.VTK.vtkMySQLDatabase, and Kitware.VTK.vtkSQLiteDatabase.

Here is the call graph for this function:

Get the list of tables from the database.

Reimplemented in Kitware.VTK.vtkPostgreSQLDatabase, Kitware.VTK.vtkMySQLDatabase, and Kitware.VTK.vtkSQLiteDatabase.

Here is the call graph for this function:

virtual bool Kitware.VTK.vtkSQLDatabase.HasError ( ) [virtual]

Did the last operation generate an error.

Reimplemented in Kitware.VTK.vtkPostgreSQLDatabase, Kitware.VTK.vtkMySQLDatabase, and Kitware.VTK.vtkSQLiteDatabase.

override int Kitware.VTK.vtkSQLDatabase.IsA ( string  type) [virtual]
virtual bool Kitware.VTK.vtkSQLDatabase.IsOpen ( ) [virtual]

Return whether the database has an open connection.

Reimplemented in Kitware.VTK.vtkPostgreSQLDatabase, Kitware.VTK.vtkMySQLDatabase, and Kitware.VTK.vtkSQLiteDatabase.

virtual bool Kitware.VTK.vtkSQLDatabase.IsSupported ( int  arg0) [virtual]

Return whether a feature is supported by the database.

Reimplemented in Kitware.VTK.vtkPostgreSQLDatabase, Kitware.VTK.vtkMySQLDatabase, and Kitware.VTK.vtkSQLiteDatabase.

static new int Kitware.VTK.vtkSQLDatabase.IsTypeOf ( string  type) [static]
virtual bool Kitware.VTK.vtkSQLDatabase.Open ( string  password) [virtual]

Open a new connection to the database. You need to set up any database parameters before calling this function. For database connections that do not require a password, pass an empty string. Returns true is the database was opened sucessfully, and false otherwise.

Reimplemented in Kitware.VTK.vtkPostgreSQLDatabase, Kitware.VTK.vtkMySQLDatabase, and Kitware.VTK.vtkSQLiteDatabase.

Provides mechanism to register/unregister additional callbacks to create concrete subclasses of vtkSQLDatabase to handle different protocols. The registered callbacks are tried in the order they are registered.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkPostgreSQLDatabase, Kitware.VTK.vtkMySQLDatabase, and Kitware.VTK.vtkSQLiteDatabase.

Here is the call graph for this function:

Provides mechanism to register/unregister additional callbacks to create concrete subclasses of vtkSQLDatabase to handle different protocols. The registered callbacks are tried in the order they are registered.

Provides mechanism to register/unregister additional callbacks to create concrete subclasses of vtkSQLDatabase to handle different protocols. The registered callbacks are tried in the order they are registered.

static internal void Kitware.VTK.vtkSQLDatabase.vtkSQLDatabase_Close_01 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkSQLDatabase.vtkSQLDatabase_CreateFromURL_02 ( string  URL,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkSQLDatabase.vtkSQLDatabase_DATABASE_03 ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal byte Kitware.VTK.vtkSQLDatabase.vtkSQLDatabase_EffectSchema_04 ( HandleRef  pThis,
HandleRef  arg0,
byte  dropIfExists 
) [private]
static internal IntPtr Kitware.VTK.vtkSQLDatabase.vtkSQLDatabase_GetDatabaseType_05 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkSQLDatabase.vtkSQLDatabase_GetLastErrorText_06 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkSQLDatabase.vtkSQLDatabase_GetQueryInstance_07 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkSQLDatabase.vtkSQLDatabase_GetRecord_08 ( HandleRef  pThis,
string  table,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkSQLDatabase.vtkSQLDatabase_GetTables_09 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal byte Kitware.VTK.vtkSQLDatabase.vtkSQLDatabase_HasError_10 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkSQLDatabase.vtkSQLDatabase_IsA_11 ( HandleRef  pThis,
string  type 
) [private]
static internal byte Kitware.VTK.vtkSQLDatabase.vtkSQLDatabase_IsOpen_12 ( HandleRef  pThis) [private]
static internal byte Kitware.VTK.vtkSQLDatabase.vtkSQLDatabase_IsSupported_13 ( HandleRef  pThis,
int  arg0 
) [private]
static internal int Kitware.VTK.vtkSQLDatabase.vtkSQLDatabase_IsTypeOf_14 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkSQLDatabase.vtkSQLDatabase_NewInstance_15 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal byte Kitware.VTK.vtkSQLDatabase.vtkSQLDatabase_Open_16 ( HandleRef  pThis,
string  password 
) [private]
static internal IntPtr Kitware.VTK.vtkSQLDatabase.vtkSQLDatabase_SafeDownCast_18 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkSQLDatabase.MRClassNameKey = "14vtkSQLDatabase" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkSQLiteDatabase, Kitware.VTK.vtkPostgreSQLDatabase, and Kitware.VTK.vtkMySQLDatabase.

new const string Kitware.VTK.vtkSQLDatabase.MRFullTypeName = "Kitware.VTK.vtkSQLDatabase"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkSQLiteDatabase, Kitware.VTK.vtkPostgreSQLDatabase, and Kitware.VTK.vtkMySQLDatabase.


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