/****************************************************************************
**
** https://www.qxorm.com/
** Copyright (C) 2013 XDL Team (ic-east.com)
**
** This file is part of the QxOrm library
**
** This software is provided 'as-is', without any express or implied
** warranty. In no event will the authors be held liable for any
** damages arising from the use of this software
**
** Commercial Usage
** Licensees holding valid commercial QxOrm licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and XDL Team
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file 'license.gpl3.txt' included in the
** packaging of this file. Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met : http://www.gnu.org/copyleft/gpl.html
**
** If you are unsure which license is appropriate for your use, or
** if you have questions regarding the use of this file, please contact :
** ic-east.com
**
****************************************************************************/

#ifndef _IX_SQL_ELEMENT_H_
#define _IX_SQL_ELEMENT_H_

#ifdef _MSC_VER
#pragma once
#endif

/*!
 * \file IxSqlElement.h
 * \author XDL Team
 * \ingroup QxDao
 * \brief Common interface for all SQL elements to build SQL query
 */

#ifdef _QX_ENABLE_BOOST_SERIALIZATION
#include <boost/serialization/serialization.hpp>
#include <boost/serialization/split_free.hpp>
#include <boost/serialization/nvp.hpp>
#endif // _QX_ENABLE_BOOST_SERIALIZATION

#include <QtCore/qdatastream.h>

#ifndef _QX_NO_JSON
#include <QtCore/qjsonvalue.h>
#endif // _QX_NO_JSON

#include <QtSql/qsqlquery.h>

#include <QxCollection/QxCollection.h>

#include <QxDao/QxSqlGenerator/IxSqlGenerator.h>

#include <QxSerialize/Qt/QxSerialize_QList.h>
#include <QxSerialize/Qt/QxSerialize_QStringList.h>
#include <QxSerialize/Qt/QxSerialize_QVariant.h>

#include <QxConvert/QxConvert.h>

namespace qx
{
   namespace dao
   {
      namespace detail
      {
         class IxSqlElement;
      } // namespace detail
   } // namespace dao
} // namespace qx

QX_DLL_EXPORT QDataStream &operator<<(QDataStream &stream, const qx::dao::detail::IxSqlElement &t) QX_USED;
QX_DLL_EXPORT QDataStream &operator>>(QDataStream &stream, qx::dao::detail::IxSqlElement &t) QX_USED;

#ifndef _QX_NO_JSON
namespace qx
{
   namespace cvt
   {
      namespace detail
      {
         template <>
         struct QxConvert_ToJson<qx::dao::detail::IxSqlElement>;
         template <>
         struct QxConvert_FromJson<qx::dao::detail::IxSqlElement>;
         QX_DLL_EXPORT QJsonValue QxConvert_ToJson_Helper(const qx::dao::detail::IxSqlElement &t, const QString &format) QX_USED;
         QX_DLL_EXPORT qx_bool QxConvert_FromJson_Helper(const QJsonValue &j, qx::dao::detail::IxSqlElement &t, const QString &format) QX_USED;
      } // namespace detail
   } // namespace cvt
} // namespace qx
#endif // _QX_NO_JSON

namespace qx
{
   namespace dao
   {
      namespace detail
      {

         /*!
          * \ingroup QxDao
          * \brief qx::dao::detail::IxSqlElement : common interface for all SQL elements to build SQL query
          */
         class QX_DLL_EXPORT IxSqlElement
         {

            friend QX_DLL_EXPORT QDataStream & ::operator<<(QDataStream &stream, const qx::dao::detail::IxSqlElement &t);
            friend QX_DLL_EXPORT QDataStream & ::operator>>(QDataStream &stream, qx::dao::detail::IxSqlElement &t);

#ifndef _QX_NO_JSON
            friend struct qx::cvt::detail::QxConvert_ToJson<qx::dao::detail::IxSqlElement>;
            friend struct qx::cvt::detail::QxConvert_FromJson<qx::dao::detail::IxSqlElement>;
            friend QX_DLL_EXPORT QJsonValue qx::cvt::detail::QxConvert_ToJson_Helper(const qx::dao::detail::IxSqlElement &t, const QString &format);
            friend QX_DLL_EXPORT qx_bool qx::cvt::detail::QxConvert_FromJson_Helper(const QJsonValue &j, qx::dao::detail::IxSqlElement &t, const QString &format);
#endif // _QX_NO_JSON

         public:
            enum type_class
            {
               _no_type,
               _sql_compare,
               _sql_element_temp,
               _sql_expression,
               _sql_free_text,
               _sql_in,
               _sql_is_between,
               _sql_is_null,
               _sql_limit,
               _sql_sort,
               _sql_embed_query
            };

         protected:
            int m_iIndex;                    //!< Index of SQL element to build unique string
            QStringList m_lstColumns;        //!< List of columns associated to SQL element
            QStringList m_lstKeys;           //!< List of keys associated to SQL element
            QList<QVariant> m_lstValues;     //!< List of values associated to SQL element
            IxSqlGenerator *m_pSqlGenerator; //!< SQL generator to build SQL query specific for each database

         public:
            IxSqlElement(int index);
            virtual ~IxSqlElement();

            void setColumn(const QString &column);
            void setColumns(const QStringList &columns);
            void setValue(const QVariant &val);
            void setValues(const QVariantList &values);

            virtual IxSqlElement::type_class getTypeClass() const = 0;

            virtual QString toString() const = 0;
            virtual void resolve(QSqlQuery &query, qx::QxCollection<QString, QVariantList> *pLstExecBatch = NULL) const = 0;
            virtual void postProcess(QString &sql) const = 0;

            virtual void clone(IxSqlElement *other);

#ifdef _QX_ENABLE_BOOST_SERIALIZATION
            template <class Archive>
            void qxSave(Archive &ar) const
            {
               QString sExtraSettings = getExtraSettings();
               ar << boost::serialization::make_nvp("index", m_iIndex);
               ar << boost::serialization::make_nvp("list_columns", m_lstColumns);
               ar << boost::serialization::make_nvp("list_keys", m_lstKeys);
               ar << boost::serialization::make_nvp("list_values", m_lstValues);
               ar << boost::serialization::make_nvp("extra_settings", sExtraSettings);
            }
#endif // _QX_ENABLE_BOOST_SERIALIZATION

#ifdef _QX_ENABLE_BOOST_SERIALIZATION
            template <class Archive>
            void qxLoad(Archive &ar)
            {
               QString sExtraSettings;
               ar >> boost::serialization::make_nvp("index", m_iIndex);
               ar >> boost::serialization::make_nvp("list_columns", m_lstColumns);
               ar >> boost::serialization::make_nvp("list_keys", m_lstKeys);
               ar >> boost::serialization::make_nvp("list_values", m_lstValues);
               ar >> boost::serialization::make_nvp("extra_settings", sExtraSettings);
               setExtraSettings(sExtraSettings);
            }
#endif // _QX_ENABLE_BOOST_SERIALIZATION

         protected:
            void updateKeys();

            virtual QString getExtraSettings() const = 0;
            virtual void setExtraSettings(const QString &s) = 0;
         };

         typedef std::shared_ptr<IxSqlElement> IxSqlElement_ptr;

         QX_DLL_EXPORT IxSqlElement_ptr create_sql_element(IxSqlElement::type_class e) QX_USED;

      } // namespace detail
   } // namespace dao
} // namespace qx

#endif // _IX_SQL_ELEMENT_H_
