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

 Program: Visualization Toolkit
 Module: vtkSQLDatabaseTableSource.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.
-------------------------------------------------------------------------*/
/**
 * @class vtkSQLDatabaseTableSource
 * @brief 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.
*/

#ifndef vtkSQLDatabaseTableSource_h
#define vtkSQLDatabaseTableSource_h

#include "vtkIOSQLModule.h" // For export macro
#include "vtkStdString.h"
#include "vtkTableAlgorithm.h"

class vtkEventForwarderCommand;

class VTKIOSQL_EXPORT vtkSQLDatabaseTableSource : public vtkTableAlgorithm
{
public:
 static vtkSQLDatabaseTableSource* New();
 vtkTypeMacro(vtkSQLDatabaseTableSource, vtkTableAlgorithm);
 void PrintSelf(ostream& os, vtkIndent indent) override;

 vtkStdString GetURL();
 void SetURL(const vtkStdString& url);

 void SetPassword(const vtkStdString& password);

 vtkStdString GetQuery();
 void SetQuery(const vtkStdString& query);

 //@{
 /**
 * The name of the array for generating or assigning pedigree ids
 * (default "id").
 */
 vtkSetStringMacro(PedigreeIdArrayName);
 vtkGetStringMacro(PedigreeIdArrayName);
 //@}

 //@{
 /**
 * If on (default), generates pedigree ids automatically.
 * If off, assign one of the arrays to be the pedigree id.
 */
 vtkSetMacro(GeneratePedigreeIds, bool);
 vtkGetMacro(GeneratePedigreeIds, bool);
 vtkBooleanMacro(GeneratePedigreeIds, bool);
 //@}

protected:
 vtkSQLDatabaseTableSource();
 ~vtkSQLDatabaseTableSource() override;

 int RequestData(
 vtkInformation*,
 vtkInformationVector**,
 vtkInformationVector*) override;

private:
 vtkSQLDatabaseTableSource(const vtkSQLDatabaseTableSource&) = delete;
 void operator=(const vtkSQLDatabaseTableSource&) = delete;

 char* PedigreeIdArrayName;
 bool GeneratePedigreeIds;

 /**
 * This intercepts events from the graph layout class
 * and re-emits them as if they came from this class.
 */
 vtkEventForwarderCommand *EventForwarder;

 class implementation;
 implementation* const Implementation;

};

#endif

// VTK-HeaderTest-Exclude: vtkSQLDatabaseTableSource.h