/* Copyright (C) 2014 InfiniDB, Inc.

   This program is free software; you can redistribute it and/or
   modify it under the terms of the GNU General Public License
   as published by the Free Software Foundation; version 2 of
   the License.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
   MA 02110-1301, USA. */

/***********************************************************************
 *   $Id: altertableprocessor.h 9303 2013-03-07 16:07:12Z chao $
 *
 *
 ***********************************************************************/
/** @file */
#ifndef ALTERTABLEPROCESSOR_H
#define ALTERTABLEPROCESSOR_H

#include "ddlpackageprocessor.h"

#if defined(_MSC_VER) && defined(DDLPKGPROC_DLLEXPORT)
#define EXPORT __declspec(dllexport)
#else
#define EXPORT
#endif

namespace ddlpackageprocessor
{
/** @brief specialization of a DDLPackageProcessor
 * for interacting with the Write Engine
 * to process alter table ddl statements.
 */
class AlterTableProcessor : public DDLPackageProcessor
{
public:
    AlterTableProcessor(BRM::DBRM* aDbrm) : DDLPackageProcessor(aDbrm) {}
    /** @brief process an alter table statement
     *
     * @param alterTableStmt the AlterTableStatement
     */
    EXPORT DDLResult processPackage(ddlpackage::AlterTableStatement& alterTableStmt);
    /** @brief add a physical column file
     *
     * @param result the result of the operation
     * @param addColumn the AtaAddColumn object
     * @param fTableName the QualifiedName of the table
     */
    EXPORT void addColumn(uint32_t sessionID, execplan::CalpontSystemCatalog::SCN txnID, DDLResult& result,
                          ddlpackage::ColumnDef* columnDefPtr,
                          ddlpackage::QualifiedName& fTableName, const uint64_t uniqueId);

    /** @brief drop a column
     *
     * @param result the result of the operation
     * @param ataDropColumn the AtaDropColumn object
     * @param fTableName the QualifiedName for the table
     */
    EXPORT void dropColumn(uint32_t sessionID, execplan::CalpontSystemCatalog::SCN txnID, DDLResult& result,
                           ddlpackage::AtaDropColumn& ataDropColumn,
                           ddlpackage::QualifiedName& fTableName, const uint64_t uniqueId);

    /** @brief drop columns
     *
     * @param result the result of the operation
     * @param ataDropColumns the AtaDropColumn object
     * @param fTableName the QualifiedName for the table
     */
    EXPORT void dropColumns(uint32_t sessionID, execplan::CalpontSystemCatalog::SCN txnID, DDLResult& result,
                            ddlpackage::AtaDropColumns& ataDropColumns,
                            ddlpackage::QualifiedName& fTableName, const uint64_t uniqueId );

    /** @brief add table constraint
     *
     * @param result the result of the operation
     * @param ataAddTableConstraint the AtaDropColumn object
     * @param fTableName the QualifiedName for the table
     */
    EXPORT void addTableConstraint(uint32_t sessionID, execplan::CalpontSystemCatalog::SCN txnID, DDLResult& result,
                                   ddlpackage::AtaAddTableConstraint& ataAddTableConstraint,
                                   ddlpackage::QualifiedName& fTableName );

    /** @brief set column default
     *
     * @param result the result of the operation
     * @param ataSetColumnDefault the AtaSetColumnDefault object
     * @param fTableName the QualifiedName for the table
     */
    EXPORT void setColumnDefault(uint32_t sessionID, execplan::CalpontSystemCatalog::SCN txnID, DDLResult& result,
                                 ddlpackage::AtaSetColumnDefault& ataSetColumnDefault,
                                 ddlpackage::QualifiedName& fTableName, const uint64_t uniqueId );

    /** @brief drop column default
     *
     * @param result the result of the operation
     * @param ataDropColumnDefault the AtaDropColumnDefault object
     * @param fTableName the QualifiedName for the table
     */
    EXPORT void dropColumnDefault(uint32_t sessionID, execplan::CalpontSystemCatalog::SCN txnID, DDLResult& result,
                                  ddlpackage::AtaDropColumnDefault& ataDropColumnDefault,
                                  ddlpackage::QualifiedName& fTableName, const uint64_t uniqueId );

    /** @brief drop table constraint
     *
     * @param result the result of the operation
     * @param ataDropTableConstraint the AtaDropTableConstraint object
     * @param fTableName the QualifiedName for the table
     */
    EXPORT void dropTableConstraint(uint32_t sessionID, execplan::CalpontSystemCatalog::SCN txnID, DDLResult& result,
                                    ddlpackage::AtaDropTableConstraint& ataDropTableConstraint,
                                    ddlpackage::QualifiedName& fTableName );
    /** @brief rename a table
     *
     * @param result the result of the operation
     * @param ataRenameTable the AtaRenameTable object
     * @param fTableName the QualifiedName for the table
     */
    EXPORT void renameTable(uint32_t sessionID, execplan::CalpontSystemCatalog::SCN txnID,
                            DDLResult& result, ddlpackage::AtaRenameTable& ataRenameTable,
                            ddlpackage::QualifiedName& fTableName, const uint64_t uniqueId);

    /** @brief rename a column
     *
     * @param result the result of the operation
     * @param ataRenameColumn the AtaRenameColumn object
     * @param fTableName the QualifiedName for the table
     */
    EXPORT void renameColumn(uint32_t sessionID, execplan::CalpontSystemCatalog::SCN txnID, DDLResult& result,
                             ddlpackage::AtaRenameColumn& ataRenameColumn,
                             ddlpackage::QualifiedName& fTableName, const uint64_t uniqueId);

    /** @brief change a table autoincrement via a comment
     *
     * @param result the result of the operation
     * @param ataTableComment the AtaTableComment object
     * @param fTableName the QualifiedName for the table
     */
    EXPORT void tableComment(uint32_t sessionID, execplan::CalpontSystemCatalog::SCN txnID, DDLResult& result,
                             ddlpackage::AtaTableComment& ataTableComment,
                             ddlpackage::QualifiedName& fTableName, const uint64_t uniqueId);

    std::string fTimeZone;

protected:
    void rollBackAlter(const std::string& error, BRM::TxnID txnID, int sessionId, DDLResult& result, uint64_t uniqueId);

private:

};

}                                                 //namespace ddlpackageprocessor

#undef EXPORT

#endif                                            //ALTERTABLEPROCESSOR_H
