• Skip to content
• Skip to link menu

KDE 4.4 API Reference

• KDE API Reference
• API Reference

• Sitemap
• Contact Us

 

digikam

albumdb.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * http://www.digikam.org
 *
 * Date        : 2004-06-18
 * Description :database album interface.
 *
 * Copyright (C) 2004-2005 by Renchi Raju <renchi@pooh.tam.uiuc.edu>
 * Copyright (C) 2006-2009 by Gilles Caulier <caulier dot gilles at gmail dot com>
 * Copyright (C) 2006-2009 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 ALBUMDB_H
#define ALBUMDB_H

// Qt includes

#include <QtCore/QString>
#include <QtCore/QList>
#include <QtCore/QStringList>
#include <QtCore/QDateTime>
#include <QtCore/QPair>
#include <QtCore/QMap>
#include <QtCore/QUuid>

// KDE includes

#include <kurl.h>

// Local includes

#include "albuminfo.h"
#include "databasefields.h"
#include "databaseaccess.h"
#include "digikam_export.h"

namespace Digikam
{

class DatabaseBackend;
class AlbumDBPriv;

class DIGIKAM_DATABASE_EXPORT AlbumDB
{
public:

    void setSetting(const QString& keyword, const QString& value);

    QString getSetting(const QString& keyword);

    void getFilterSettings(QStringList *imageFilter, QStringList *videoFilter, QStringList *audioFilter);

    void getUserFilterSettings(QString *imageFilterString, QString *videoFilterString, QString *audioFilterString);

    void setFilterSettings(const QStringList& imageFilter, const QStringList& videoFilter, const QStringList& audioFilter);

    void setUserFilterSettings(const QStringList& imageFilter, const QStringList& videoFilter, const QStringList& audioFilter);

    void setUserFilterSettings(const QString& imageFilterString, const QString& videoFilterString, const QString& audioFilterString);

    void addToUserImageFilterSettings(const QString& filterString);

    QUuid databaseUuid();

    // ----------- AlbumRoot operations -----------

    QList<AlbumRootInfo> getAlbumRoots();

    int addAlbumRoot(AlbumRoot::Type type, const QString& identifier, const QString& specificPath, const QString& label);

    void deleteAlbumRoot(int rootId);

    void migrateAlbumRoot(int rootId, const QString& identifier);

    void setAlbumRootLabel(int rootId, const QString& newLabel);

    void changeAlbumRootType(int rootId, AlbumRoot::Type newType);

    // ----------- Album Listing operations -----------
    AlbumInfo::List scanAlbums();

    TagInfo::List scanTags();

    SearchInfo::List scanSearches();

    QList<AlbumShortInfo> getAlbumShortInfos();

    // ----------- Operations on PAlbums -----------

    int addAlbum(int albumRootId, const QString& relativePath,
                 const QString& caption,
                 const QDate& date, const QString& collection);

    /*
    int addAlbum(const QString& albumRoot, const QString& relativePath,
                 const QString& caption,
                 const QDate& date, const QString& collection);
    */

    int  getAlbumForPath(int albumRootId, const QString& relativePath, bool create = true);

    //int  getAlbumForPath(const QString& albumRoot, const QString& relativePath, bool create = true);

    QList<int> getAlbumAndSubalbumsForPath(int albumRootId, const QString& relativePath);

    /* *
     * List the urls of all subalbums of the album specified by albumRoot and path.
     * @param onlyDirectSubalbums if this is true, only first-level subalbums are returned,
     *                            if false, all levels of children are returned (include subalbums of subalbums).
     */
    //QStringList getSubalbumsForPath(const QString& albumRoot, const QString& path, bool onlyDirectSubalbums = true);

    QList<int> getAlbumsOnAlbumRoot(int albumRootId);

    void deleteAlbum(int albumID);

    void makeStaleAlbum(int albumID);

    void deleteStaleAlbums();

    bool copyAlbumProperties(int srcAlbumID, int dstAlbumID);

    void renameAlbum(int albumID, int newAlbumRootId, const QString& newRelativePath);

    void setAlbumCaption(int albumID, const QString& caption);

    void setAlbumCategory(int albumID, const QString& category);

    void setAlbumDate(int albumID, const QDate& date);

    void setAlbumIcon(int albumID, qlonglong iconID);

    bool getAlbumIcon(int albumID, int *iconAlbumRootId, QString *iconAlbumRelativePath);

    int getAlbumRootId(int albumID);

    //QString getAlbumPath(int albumID);

    QString getAlbumRelativePath(int albumID);

    QDate getAlbumLowestDate(int albumID);

    QDate getAlbumHighestDate(int albumID);

    QDate getAlbumAverageDate(int albumID);

    QMap<int, int> getNumberOfImagesInAlbums();

    // ----------- Operations on TAlbums -----------

    int addTag(int parentTagID, const QString& name,
               const QString& iconKDE, qlonglong iconID);

    QList<int> getTagsFromTagPaths(const QStringList& tagPaths, bool create);

    //TODO move to other place (AlbumManager)
    QList<int> getRecentlyAssignedTags() const;

    void deleteTag(int tagID);

    void setTagName(int tagID, const QString& name);

    void setTagIcon(int tagID, const QString& iconKDE, qlonglong iconID);

    bool getTagIcon(int tagID, int *iconAlbumRootId, QString *iconAlbumRelativePath, QString *icon);

    void setTagParentID(int tagID, int newParentTagID);

    // ----------- Operations on SAlbums -----------

    int addSearch(DatabaseSearch::Type type, const QString& name, const QString& query);

    void updateSearch(int searchID, DatabaseSearch::Type type,
                      const QString& name, const QString& query);

    void deleteSearch(int searchID);

    void deleteSearches(DatabaseSearch::Type type);

    SearchInfo getSearchInfo(int searchId);

    QString getSearchQuery(int searchId);

    // ----------- Adding and deleting Items -----------
    qlonglong addItem(int albumID, const QString& name,
                      DatabaseItem::Status status,
                      DatabaseItem::Category category,
                      const QDateTime& modificationDate,
                      int fileSize,
                      const QString& uniqueHash);

    void deleteItem(int albumID, const QString& file);

    void removeItemsFromAlbum(int albumID);

    void removeItems(QList<qlonglong> itemIDs, QList<int> albumIDs = QList<int>());

    void deleteRemovedItems();

    void deleteRemovedItems(QList<int> albumIDs);

    // ----------- Finding items -----------

    qlonglong getImageId(int albumID, const QString& name);

    enum ItemSortOrder
    {
        NoItemSorting,
        ByItemName,
        ByItemPath,
        ByItemDate,
        ByItemRating
    };

    QStringList getItemNamesInAlbum(int albumID, bool recurssive=false);

    QList<ItemScanInfo> getItemScanInfos(int albumID);

    QStringList getItemURLsInAlbum(int albumID, ItemSortOrder order = NoItemSorting);

    QList<qlonglong> getItemIDsInAlbum(int albumID);

    QMap<qlonglong, QString> getItemIDsAndURLsInAlbum(int albumID);

    QStringList getItemURLsInTag(int tagID, bool recursive = false);

    QList<qlonglong> getItemIDsInTag(int tagID, bool recursive = false);

    QList<QDateTime> getAllCreationDates();

    QMap<QDateTime, int> getAllCreationDatesAndNumberOfImages();

    // ----------- Item properties -----------

    int getItemAlbum(qlonglong imageID);

    QString getItemName(qlonglong imageID);

    ItemShortInfo getItemShortInfo(qlonglong imageID);

    ItemShortInfo getItemShortInfo(int albumRootId, const QString& relativePath, const QString& name);

    ItemScanInfo getItemScanInfo(qlonglong imageID);

    void updateItem(qlonglong imageID,
                    DatabaseItem::Category category,
                    const QDateTime& modificationDate,
                    int fileSize,
                    const QString& uniqueHash);

    QVariantList getImagesFields(qlonglong imageID, DatabaseFields::Images imagesFields);

    void addImageInformation(qlonglong imageID, const QVariantList& infos,
                             DatabaseFields::ImageInformation fields = DatabaseFields::ImageInformationAll);

    void changeImageInformation(qlonglong imageID, const QVariantList& infos,
                                DatabaseFields::ImageInformation fields = DatabaseFields::ImageInformationAll);

    QVariantList getImageInformation(qlonglong imageID,
                                     DatabaseFields::ImageInformation infoFields = DatabaseFields::ImageInformationAll);

    void addImageMetadata(qlonglong imageID, const QVariantList& infos,
                           DatabaseFields::ImageMetadata fields = DatabaseFields::ImageMetadataAll);

    void changeImageMetadata(qlonglong imageID, const QVariantList& infos,
                             DatabaseFields::ImageMetadata fields = DatabaseFields::ImageMetadataAll);

    QVariantList getImageMetadata(qlonglong imageID,
                                  DatabaseFields::ImageMetadata metadataFields = DatabaseFields::ImageMetadataAll);

    void addImagePosition(qlonglong imageID, const QVariantList& infos,
                           DatabaseFields::ImagePositions fields = DatabaseFields::ImagePositionsAll);

    void changeImagePosition(qlonglong imageID, const QVariantList& infos,
                             DatabaseFields::ImagePositions fields = DatabaseFields::ImagePositionsAll);

    QVariantList getImagePosition(qlonglong imageID,
                                  DatabaseFields::ImagePositions positionFields = DatabaseFields::ImagePositionsAll);

    void removeImagePosition(qlonglong imageid);

    QList<CommentInfo> getImageComments(qlonglong imageID);

    int setImageComment(qlonglong imageID, const QString& comment, DatabaseComment::Type type,
                        const QString& language = QString(), const QString& author = QString(),
                        const QDateTime& date = QDateTime());

    void changeImageComment(int commentId, qlonglong imageID, const QVariantList& infos,
                            DatabaseFields::ImageComments fields = DatabaseFields::ImageCommentsAll);


    void removeImageComment(int commentId, qlonglong imageid);

    QString getImageProperty(qlonglong imageID, const QString& property);

    void setImageProperty(qlonglong imageID, const QString& property, const QString& value);
    void removeImageProperty(qlonglong imageID, const QString& property);

    QList<CopyrightInfo> getImageCopyright(qlonglong imageID, const QString& property = QString());

    enum CopyrightPropertyUnique
    {
        PropertyUnique,
        PropertyExtraValueUnique,
        PropertyNoConstraint
    };
    void setImageCopyrightProperty(qlonglong imageID, const QString& property,
                                   const QString& value, const QString& extraValue = QString(),
                                   CopyrightPropertyUnique uniqueness = PropertyUnique);

    void removeImageCopyrightProperties(qlonglong imageID, const QString& property = QString(),
                                        const QString& extraValue = QString(),
                                        const QString& value = QString() /* NOTE parameter order */);
    bool hasHaarFingerprints();

    QList<qlonglong> getDirtyOrMissingFingerprints();
    QStringList getDirtyOrMissingFingerprintURLs();

    QList<ItemScanInfo> getIdenticalFiles(qlonglong id);
    QList<ItemScanInfo> getIdenticalFiles(int fileSize, const QString& uniqueHash, qlonglong sourceId = -1);
    //QDateTime getItemDate(qlonglong imageID);

    //int getItemRating(qlonglong imageID);

    //bool setItemDate(qlonglong imageID, const QDateTime& datetime);

    //void setItemRating(qlonglong imageID, int rating);


    //QDateTime getItemDate(int albumID, const QString& name);


    //bool setItemDate(int albumID, const QString& name,
      //               const QDateTime& datetime);

    //QString getItemCaption(qlonglong imageID);

    //QString getItemCaption(int albumID, const QString& name);

    //void setItemCaption(qlonglong imageID, const QString& caption);

    //void setItemCaption(int albumID, const QString& name, const QString& caption);


    // ----------- Items and their tags -----------

    void addItemTag(qlonglong imageID, int tagID);

    void addItemTag(int albumID, const QString& name, int tagID);

    void addTagsToItems(QList<qlonglong> imageIDs, QList<int> tagIDs);

    void removeItemTag(qlonglong imageID, int tagID);

    void removeItemAllTags(qlonglong imageID, QList<int> currentTagIds);

    void removeTagsFromItems(QList<qlonglong> imageIDs, QList<int> tagIDs);

    QStringList getItemTagNames(qlonglong imageID);

    QList<int> getItemTagIDs(qlonglong imageID);

    bool hasTags(const QList<qlonglong>& imageIDList);

    QList<int> getItemCommonTagIDs(const QList<qlonglong>& imageIDList);

    QMap<int, int> getNumberOfImagesInTags();

    QMap<QString,int> getImageFormatStatistics();

    // ----------- Moving and Copying Items -----------

    void moveItem(int srcAlbumID, const QString& srcName,
                  int dstAlbumID, const QString& dstName);

    int copyItem(int srcAlbumID, const QString& srcName,
                 int dstAlbumID, const QString& dstName);

    void copyImageAttributes(qlonglong srcId, qlonglong destId);


    // ----------- Download history methods -----------

    int findInDownloadHistory(const QString& identifier, const QString& name, int fileSize, const QDateTime& date);

    int addToDownloadHistory(const QString& identifier, const QString& name, int fileSize, const QDateTime& date);

    // ----------- Static helper methods for constructing SQL queries -----------

    static QStringList imagesFieldList(DatabaseFields::Images fields);
    static QStringList imageInformationFieldList(DatabaseFields::ImageInformation fields);
    static QStringList imageMetadataFieldList(DatabaseFields::ImageMetadata fields);
    static QStringList imagePositionsFieldList(DatabaseFields::ImagePositions fields);
    static QStringList imageCommentsFieldList(DatabaseFields::ImageComments fields);
    static void addBoundValuePlaceholders(QString& query, int count);

private:

    friend class Digikam::DatabaseAccess;

    AlbumDB(DatabaseBackend *backend);

    ~AlbumDB();

private:

    AlbumDBPriv* const d;
};

}  // namespace Digikam

#endif /* ALBUMDB_H */

digikam

Skip menu "digikam"

• Main Page
• Namespace List
• Class Hierarchy
• Alphabetical List
• Class List
• File List
• Namespace Members
• Class Members

API Reference

Skip menu "API Reference"

• digikam

Generated for API Reference by doxygen 1.5.9-20090814
This website is maintained by Adriaan de Groot and Allen Winter.
KDE^® and the K Desktop Environment^® logo are registered trademarks of KDE e.V. | Legal