File indexing completed on 2024-05-12 15:59:16

 /*
  *  SPDX-FileCopyrightText: 2007 Cyrille Berger <cberger@cberger.net>
  *
  *  SPDX-License-Identifier: LGPL-2.1-or-later
  */
 
 
 #ifndef _KIS_META_DATA_STORE_H_
 #define _KIS_META_DATA_STORE_H_
 
 #include <kritametadata_export.h>
 
 #include <QHash>
 
 namespace KisMetaData
 {
 class Schema;
 class Entry;
 class Filter;
 class Value;
 
 /**
  * This class holds the list of metadata entries and schemas (for instance the
  * author of the image, copyright holder, license, aperture, speed...)
  */
 class KRITAMETADATA_EXPORT Store
 {
     struct Private;
 public:
     Store();
     Store(const Store&);
     ~Store();
 public:
 
     /**
      * Copy the entries from store inside this store
      */
     void copyFrom(const Store* store);
 
     /**
      * @return true if there is no metadata in this store.
      */
     bool empty() const;
     bool isEmpty() const;
 
 
     /**
      * Insert a new entry.
      *
      * @param entry the new entry to insert in the metadata store, it
      * must be a key which doesn't already exist
      *
      * @return false if the entry couldn't be included whether because the key already
      *  exists
      */
     bool addEntry(const Entry& entry);
 
     /**
      * Give access to a metadata entry
      * @param entryKey the entryKey as the qualified name of the entry
      */
     Entry& getEntry(const QString & entryKey);
 
     /**
      * Give access to a metadata entry
      * @param uri the uri of the schema
      * @param entryName the name of the entry
      */
     Entry& getEntry(const QString & uri, const QString & entryName);
 
     /**
      * Give access to a metadata entry
      * @param schema the schema
      * @param entryName the name of the entry
      */
     Entry& getEntry(const KisMetaData::Schema* schema, const QString & entryName);
 
     /**
      * Give access to a metadata entry
      * @param entryKey the entryKey as the qualified name of the entry
      */
     const Entry& getEntry(const QString & entryKey) const;
     /**
      * Give access to a metadata entry
      * @param uri the uri of the schema
      * @param entryName the name of the entry
      */
     const Entry& getEntry(const QString & uri, const QString & entryName) const;
 
     /**
      * Give access to a metadata entry
      * @param schema the schema
      * @param entryName the name of the entry
      */
     const Entry& getEntry(const KisMetaData::Schema* schema, const QString & entryName) const;
 
     /**
      * Remove an entry.
      * @param entryKey the entryKey as the qualified name of the entry
      */
     void removeEntry(const QString & entryKey);
 
     /**
      * Remove an entry.
      * @param uri the uri of the schema
      * @param entryName the name of the entry
      */
     void removeEntry(const QString & uri, const QString & entryName);
 
     /**
      * Remove an entry.
      * @param schema the schema
      * @param entryName the name of the entry
      */
     void removeEntry(const KisMetaData::Schema* schema, const QString & entryName);
 
     /**
      * Return the value associated with this entry name and uri.
      * @param uri
      * @param entryName
      * @return the value
      */
     const Value& getValue(const QString & uri, const QString & entryName) const;
 
     QHash<QString, Entry>::const_iterator begin() const;
     QHash<QString, Entry>::const_iterator end() const;
 
     /**
      * @param entryKey the entryKey as the qualified name of the entry
      * @return true if an entry with the given key exist in the store
      */
     bool containsEntry(const QString & entryKey) const;
 
     /**
      * @return true if the store contains this entry
      */
     bool containsEntry(const KisMetaData::Schema* schema, const QString & entryName) const;
 
     /**
      * @param uri
      * @param entryName
      * @return true if an entry with the given uri and entry name exist in the store
      */
     bool containsEntry(const QString & uri, const QString & entryName) const;
 
     /**
      * Dump on kdDebug the metadata store.
      */
     void debugDump() const;
 
     /**
      * Apply a list of filters on a store
      */
     void applyFilters(const QList<const Filter*> & filters);
 
     /**
      * @return the list of keys
      */
     QList<QString> keys() const;
 
     /**
      * @return the list of entries
      */
     QList<Entry> entries() const;
 private:
     Private* const d;
 };
 }
 
 #endif