itemhistorygraph.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2010-10-23
 * Description : Graph data class for item history
 *
 * Copyright (C) 2010-2011 by Marcel Wiesweg <marcel dot wiesweg at gmx dot de>
 *
 * 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, or (at your option)
 * any later version.
 *
 * 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.
 *
 * ============================================================ */
 
#ifndef DIGIKAM_ITEM_HISTORY_GRAPH_H
#define DIGIKAM_ITEM_HISTORY_GRAPH_H
 
// Qt includes
 
#include <QFlags>
#include <QSharedDataPointer>
#include <QDebug>
 
// Local includes
 
#include "iteminfo.h"
#include "historyimageid.h"
#include "digikam_export.h"
 
namespace Digikam
{
 
class ItemHistoryGraphData;
class DImageHistory;
 
class DIGIKAM_DATABASE_EXPORT ItemHistoryGraph
{
public:
 
    enum HistoryLoadingFlag
    {
        LoadRelationCloud  = 1 << 0,
 
        LoadSubjectHistory = 1 << 1,
 
        LoadLeavesHistory  = 1 << 2,
 
        LoadAll            = LoadRelationCloud | LoadSubjectHistory | LoadLeavesHistory
    };
    Q_DECLARE_FLAGS(HistoryLoadingMode, HistoryLoadingFlag)
 
    enum ProcessingMode
    {
        NoProcessing,
        PrepareForDisplay
    };
 
public:
 
    ItemHistoryGraph();
    ItemHistoryGraph(const ItemHistoryGraph& other);
    ~ItemHistoryGraph();
 
    ItemHistoryGraph& operator=(const ItemHistoryGraph& other);
 
    bool isNull()                                                       const;
    bool isEmpty()                                                      const;
    bool isSingleVertex()                                               const;
 
    bool hasEdges()                                                     const;
 
    ItemHistoryGraphData& data();
    const ItemHistoryGraphData& data()                                  const;
 
    static ItemHistoryGraph fromInfo(const ItemInfo& info,
                                      HistoryLoadingMode loadingMode = LoadAll,
                                      ProcessingMode processingMode  = PrepareForDisplay);
 
    void addHistory(const DImageHistory& history, const ItemInfo& historySubject = ItemInfo());
    void addHistory(const DImageHistory& history, const HistoryImageId& historySubject = HistoryImageId());
 
    void addScannedHistory(const DImageHistory& history, qlonglong historySubjectId);
 
    void addRelations(const QList<QPair<qlonglong, qlonglong> >& pairs);
 
    void clear();
 
    void reduceEdges();
 
    bool hasUnresolvedEntries()                                         const;
 
    void dropUnresolvedEntries();
 
    void sortForInfo(const ItemInfo& subject);
 
    void prepareForDisplay(const ItemInfo& subject);
 
    QList<QPair<qlonglong, qlonglong> > relationCloud()                 const;
    QPair<QList<qlonglong>, QList<qlonglong> > relationCloudParallel()  const;
 
    QList<ItemInfo> allImages()                                         const;
    QList<qlonglong> allImageIds()                                      const;
 
    QList<ItemInfo> rootImages()                                        const;
 
    QList<ItemInfo> leafImages()                                        const;
 
    QHash<ItemInfo, HistoryImageId::Types> categorize()                 const;
 
private:
 
    QSharedDataPointer<ItemHistoryGraphData> d;
};
 
QDebug DIGIKAM_DATABASE_EXPORT operator<<(QDebug dbg, const ItemHistoryGraph& g);
 
} // namespace Digikam
 
Q_DECLARE_OPERATORS_FOR_FLAGS(Digikam::ItemHistoryGraph::HistoryLoadingMode)
 
#endif // DIGIKAM_ITEM_HISTORY_GRAPH_H