/*
 * This file is part of libdanbooru.
 * Copyright 2013  Luca Beltrame <lbeltrame@kde.org>
 *
 * 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; either version 2 of
 * the License or (at your option) version 3 or any later version
 * accepted by the membership of KDE e.V. (or its successor approved
 * by the membership of KDE e.V.), which shall act as a proxy
 * defined in Section 14 of version 3 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, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef DANBOORUPOOL_H
#define DANBOORUPOOL_H

/**
 * @brief This file includes classes which models Danbooru pools.
 * @file danboorupool.h
 *
 **/

#include <QtCore/QObject>
#include <QtCore/QVariant>
#include <QtCore/QList>
#include <QtCore/QStringList>
#include <QtXml/QXmlStreamAttributes>

namespace Danbooru {

    /**
     * @brief Class representing a Danbooru pool.
     *
     * Pools are organized groups of images, often by a common theme, for
     * example taken from the same artbook. They are identified by unique IDs
     * and are represented by a name, a description, and the posts they
     * contain.
     *
     * @author Luca Beltrame (lbeltrame@kde.org)
     *
     * **/
    class DanbooruPool : public QObject
    {

    Q_OBJECT

    private:
        int m_id;
        int m_postCount;
        QString m_name;
        QString m_description;
        QList<int> m_posts;

    public:

        /**
         * @brief Construct a Danbooru pool from a QVariantMap.
         *
         * This form is the easiest to use and should be used when dealing with
         * responses in JSON format. Unfortunately most Danbooru
         * implementations produce broken JSON for some responses.
         *
         * @param postData A QVariantMap from parsed JSON representing the
         *      data from a single pool.
         *
         *
         **/
        DanbooruPool(const QVariantMap& postData, QObject* parent = 0);

        /**
         * @brief Construct a Danbooru pool from a QVariantMap.
         *
         * This form is the easiest to use and should be used when dealing with
         * responses in JSON format. Unfortunately most Danbooru
         * implementations produce broken JSON for some responses.
         *
         * @param postData A QXmlStreamAttributes instance holding the
         *      attributes for the given pool.
         *
         *
         **/
        DanbooruPool(const QXmlStreamAttributes& postData, QObject* parent=0);

        int id() const;
        int postCount() const;
        QString name() const;
        QString description() const;
        QList<int> posts() const;

        void addPost(int post);
        void addPosts(QList<int> posts);
        void addPosts(QStringList posts);
    };

}; // namespace Danbooru

Q_DECLARE_METATYPE(Danbooru::DanbooruPool*)

#endif // DANBOORUPOOL_H