vtkQtSQLDatabase.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkQtSQLDatabase.h

  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
/*-------------------------------------------------------------------------
  Copyright 2008 Sandia Corporation.
  Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
  the U.S. Government retains certain rights in this software.
-------------------------------------------------------------------------*/
#ifndef vtkQtSQLDatabase_h
#define vtkQtSQLDatabase_h

// Check for Qt SQL module before defining this class.
#include <qglobal.h> // Needed to check if SQL is available
#if (QT_EDITION & QT_MODULE_SQL)

#include "vtkGUISupportQtSQLModule.h" // For export macro
#include "vtkSQLDatabase.h"

#include <QtSql/QSqlDatabase> // For the database member

class vtkSQLQuery;
class vtkStringArray;

class VTKGUISUPPORTQTSQL_EXPORT vtkQtSQLDatabase : public vtkSQLDatabase
{
public:
  static vtkQtSQLDatabase* New();
  vtkTypeMacro(vtkQtSQLDatabase, vtkSQLDatabase);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  bool Open(const char* password) override;

  void Close() override;

  bool IsOpen() override;

  vtkSQLQuery* GetQueryInstance() override;

  vtkStringArray* GetTables() override;

  vtkStringArray* GetRecord(const char *table) override;

  vtkStringArray* GetColumns();

  void SetColumnsTable(const char* table);

  bool IsSupported(int feature) override;

  bool HasError() override;

  const char* GetLastErrorText() override;


  const char* GetDatabaseType() override
  {
    return this->DatabaseType;
  }
  vtkSetStringMacro(DatabaseType);


  vtkSetStringMacro(HostName);
  vtkGetStringMacro(HostName);


  vtkSetStringMacro(UserName);
  vtkGetStringMacro(UserName);


  vtkSetStringMacro(DatabaseName);
  vtkGetStringMacro(DatabaseName);


  vtkSetStringMacro(ConnectOptions);
  vtkGetStringMacro(ConnectOptions);


  vtkSetClampMacro(Port, int, 0, 65535);
  vtkGetMacro(Port, int);

  static vtkSQLDatabase* CreateFromURL( const char* URL );

  vtkStdString GetURL() override;

protected:
  vtkQtSQLDatabase();
  ~vtkQtSQLDatabase();

  char* DatabaseType;
  char* HostName;
  char* UserName;
  char* DatabaseName;
  int Port;
  char* ConnectOptions;

  QSqlDatabase QtDatabase;

  friend class vtkQtSQLQuery;

  bool ParseURL(const char* url) override;
private:

  // Storing the tables in the database, this array
  // is accessible through GetTables() method
  vtkStringArray *myTables;

  // Storing the correct record list from any one
  // of the tables in the database, this array is
  // accessible through GetRecord(const char *table)
  vtkStringArray *currentRecord;

  // Used to assign unique identifiers for database instances
  static int id;

  vtkQtSQLDatabase(const vtkQtSQLDatabase &) = delete;
  void operator=(const vtkQtSQLDatabase &) = delete;
};

#endif // (QT_EDITION & QT_MODULE_SQL)
#endif // vtkQtSQLDatabase_h