/* Copyright (C) 2015
 * swift project Community / Contributors
 *
 * This file is part of swift project. It is subject to the license terms in the LICENSE file found in the top-level
 * directory of this distribution and at http://www.swift-project.org/license.html. No part of swift project,
 * including this file, may be copied, modified, propagated, or distributed except according to the terms
 * contained in the LICENSE file.
 */

//! \file

#ifndef BLACKMISC_DATABASEOBJECTLIST_H
#define BLACKMISC_DATABASEOBJECTLIST_H

#include "blackmisc/timestampobjectlist.h"
#include "blackmisc/collection.h"
#include "blackmisc/sequence.h"
#include <QList>
#include <QMap>

namespace BlackMisc
{
    //! List of objects read from database.
    //! Such objects should implement \sa ITimestampBased and \sa IDatastoreObjectWithIntegerKey or \sa IDatastoreObjectWithStringKey
    template<class OBJ, class CONTAINER, typename KEYTYPE> class IDatastoreObjectList : public ITimestampObjectList<OBJ, CONTAINER>
    {
    public:
        //! Object with key, notFound otherwise
        OBJ findByKey(KEYTYPE key, const OBJ &notFound = OBJ()) const;

        //! Object with max.key
        OBJ maxKeyObject() const;

        //! Sort by timestamp
        void sortByKey();

        //! All keys as list
        QList<KEYTYPE> toDbKeyList() const;

        //! Max.key value (making sense with integer key)
        KEYTYPE getMaxKey(bool *ok = nullptr) const;

        //! Remove objects with key
        int removeObjectsWithKeys(const QList<KEYTYPE> &keys);

        //! Update or insert data (based on DB key)
        int replaceOrAddObjectsByKey(const CONTAINER &container);

        //! From DB JSON with default prefixes
        static CONTAINER fromDatabaseJson(const QJsonArray &array);

        //! From DB JSON
        static CONTAINER fromDatabaseJson(const QJsonArray &array, const QString &prefix);

    protected:
        //! Constructor
        IDatastoreObjectList();
    };

    //! \cond PRIVATE
    namespace Aviation
    {
        class CLivery;
        class CLiveryList;
    }

    namespace Simulation
    {
        class CDistributor;
        class CDistributorList;
        class CAircraftModel;
        class CAircraftModelList;
    }

    extern template class BLACKMISC_EXPORT_TEMPLATE IDatastoreObjectList<BlackMisc::Aviation::CLivery, BlackMisc::Aviation::CLiveryList, int>;
    extern template class BLACKMISC_EXPORT_TEMPLATE IDatastoreObjectList<BlackMisc::Aviation::CAircraftIcaoCode, BlackMisc::Aviation::CAircraftIcaoCodeList, int>;
    extern template class BLACKMISC_EXPORT_TEMPLATE IDatastoreObjectList<BlackMisc::Aviation::CAirlineIcaoCode, BlackMisc::Aviation::CAirlineIcaoCodeList, int>;
    extern template class BLACKMISC_EXPORT_TEMPLATE IDatastoreObjectList<BlackMisc::Simulation::CAircraftModel, BlackMisc::Simulation::CAircraftModelList, int>;
    extern template class BLACKMISC_EXPORT_TEMPLATE IDatastoreObjectList<BlackMisc::Simulation::CDistributor, BlackMisc::Simulation::CDistributorList, QString>;
    extern template class BLACKMISC_EXPORT_TEMPLATE IDatastoreObjectList<BlackMisc::CCountry, BlackMisc::CCountryList, QString>;
    //! \endcond

} //namespace

#endif //guard