similaritydb.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2017-07-07
 * Description : Similarity database interface.
 *
 * Copyright (C)      2009 by Marcel Wiesweg <marcel dot wiesweg at gmx dot de>
 * Copyright (C) 2009-2017 by Gilles Caulier <caulier dot gilles at gmail dot com>
 * Copyright (C)      2017 by Swati Lodha    <swatilodha27 at gmail dot com>
 * Copyright (C)      2018 by Mario Frank    <mario dot frank at uni minus potsdam 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_SIMILARITY_DB_H
#define DIGIKAM_SIMILARITY_DB_H
 
// Qt includes
 
#include <QStringList>
#include <QString>
#include <QList>
#include <QPair>
#include <QSet>
 
// Local includes
 
#include "dbenginesqlquery.h"
#include "similaritydbbackend.h"
#include "similaritydbaccess.h"
#include "digikam_export.h"
#include "iteminfo.h"
 
namespace Digikam
{
 
enum class FuzzyAlgorithm
{
    Unknown = 0,
    Haar    = 1,
    TfIdf   = 2
};
 
 
class DIGIKAM_DATABASE_EXPORT SimilarityDb
{
public:
 
    bool setSetting(const QString& keyword, const QString& value);
 
    QString getSetting(const QString& keyword);
 
    QString getLegacySetting(const QString& keyword);
 
    QSet<qlonglong> registeredImageIds() const;
 
    // ----------- Methods for fingerprint (ImageHaarMatrix) table access ----------
 
    bool hasFingerprint(qlonglong imageId, FuzzyAlgorithm algorithm) const;
 
    bool hasFingerprints();
 
    bool hasFingerprints(FuzzyAlgorithm algorithm) const;
 
    bool hasDirtyOrMissingFingerprint(const ItemInfo& imageInfo,
                                      FuzzyAlgorithm algorithm = FuzzyAlgorithm::Haar) const;
 
    QList<qlonglong> getDirtyOrMissingFingerprints(const QList<ItemInfo>& imageInfos,
                                                   FuzzyAlgorithm algorithm = FuzzyAlgorithm::Haar);
 
    QStringList      getDirtyOrMissingFingerprintURLs(const QList<ItemInfo>& imageInfos,
                                                      FuzzyAlgorithm algorithm = FuzzyAlgorithm::Haar);
 
    void removeImageFingerprint(qlonglong imageID,
                                FuzzyAlgorithm algorithm = FuzzyAlgorithm::Haar);
 
    void copySimilarityAttributes(qlonglong srcId,
                                  qlonglong destId);
 
    // ----------- Methods for image similarity table access ----------
 
    double getImageSimilarity(qlonglong imageID1,
                              qlonglong imageID2,
                              FuzzyAlgorithm algorithm = FuzzyAlgorithm::Haar);
 
    void setImageSimilarity(qlonglong imageID1,
                            qlonglong imageID2,
                            double value,
                            FuzzyAlgorithm algorithm = FuzzyAlgorithm::Haar);
 
    void removeImageSimilarity(qlonglong imageID,
                               FuzzyAlgorithm algorithm = FuzzyAlgorithm::Haar);
 
    void removeImageSimilarity(qlonglong imageID1,
                               qlonglong imageID2,
                               FuzzyAlgorithm algorithm = FuzzyAlgorithm::Haar);
 
    QList<FuzzyAlgorithm> getImageSimilarityAlgorithms(qlonglong imageID1,
                                                       qlonglong imageID2);
 
    // ----------- Database shrinking and integrity check methods ----------
 
    bool integrityCheck();
 
    void vacuum();
 
private:
 
    QString getImageSimilarityOrdered(qlonglong imageID1,
                                      qlonglong imageID2,
                                      FuzzyAlgorithm algorithm = FuzzyAlgorithm::Haar);
 
    QPair<qlonglong, qlonglong> orderIds(qlonglong id1, qlonglong id2);
 
    explicit SimilarityDb(SimilarityDbBackend* const backend);
 
    ~SimilarityDb();
 
private:
 
    // Disable
    SimilarityDb(const SimilarityDb&)            = delete;
    SimilarityDb& operator=(const SimilarityDb&) = delete;
 
    class Private;
    Private* const d;
 
    friend class SimilarityDbAccess;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_SIMILARITY_DB_H