KisMetaData::Store Class Reference

#include <kis_meta_data_store.h>

Public Member Functions
bool	addEntry (const Entry &entry)
void	applyFilters (const QList< const Filter * > &filters)
QHash< QString, Entry >::const_iterator	begin () const
bool	containsEntry (const KisMetaData::Schema *schema, const QString &entryName) const
bool	containsEntry (const QString &entryKey) const
bool	containsEntry (const QString &uri, const QString &entryName) const
void	copyFrom (const Store *store)
void	debugDump () const
bool	empty () const
QHash< QString, Entry >::const_iterator	end () const
QList< Entry >	entries () const
Entry &	getEntry (const KisMetaData::Schema *schema, const QString &entryName)
const Entry &	getEntry (const KisMetaData::Schema *schema, const QString &entryName) const
Entry &	getEntry (const QString &entryKey)
const Entry &	getEntry (const QString &entryKey) const
Entry &	getEntry (const QString &uri, const QString &entryName)
const Entry &	getEntry (const QString &uri, const QString &entryName) const
const Value &	getValue (const QString &uri, const QString &entryName) const
bool	isEmpty () const
QList< QString >	keys () const
void	removeEntry (const KisMetaData::Schema *schema, const QString &entryName)
void	removeEntry (const QString &entryKey)
void	removeEntry (const QString &uri, const QString &entryName)
	Store ()
	Store (const Store &)
	~Store ()

Private Attributes
Private *const	d

Detailed Description

This class holds the list of metadata entries and schemas (for instance the author of the image, copyright holder, license, aperture, speed...)

Definition at line 26 of file kis_meta_data_store.h.

Constructor & Destructor Documentation

Store() [1/2]

Store::Store

(

)

Definition at line 30 of file kis_meta_data_store.cc.

             : d(new Private)
{
 
}

Store() [2/2]

KisMetaData::Store::Store

(

const Store &

)

~Store()

Store::~Store

(

)

Definition at line 40 of file kis_meta_data_store.cc.

{
    delete d;
}

References d.

Member Function Documentation

addEntry()

bool Store::addEntry

(

const Entry &

entry

)

Insert a new entry.

Parameters

entry

the new entry to insert in the metadata store, it must be a key which doesn't already exist

Returns

false if the entry couldn't be included whether because the key already exists

Definition at line 60 of file kis_meta_data_store.cc.

{
    Q_ASSERT(!entry.name().isEmpty());
    if (d->entries.contains(entry.qualifiedName()) && d->entries[entry.qualifiedName()].isValid()) {
        dbgMetaData << "Entry" << entry.qualifiedName() << " already exists in the store, cannot be included twice";
        return false;
    }
    d->entries.insert(entry.qualifiedName(), entry);
    return true;
}

References d, dbgMetaData, KisMetaData::Entry::name(), and KisMetaData::Entry::qualifiedName().

applyFilters()

void Store::applyFilters

(

const QList< const Filter * > &

filters

)

Apply a list of filters on a store

Definition at line 188 of file kis_meta_data_store.cc.

{
    dbgMetaData << "Apply " << filters.size() << " filters";
    Q_FOREACH (const Filter* filter, filters) {
        filter->filter(this);
    }
}

References dbgMetaData, and KisMetaData::Filter::filter().

begin()

QHash< QString, Entry >::const_iterator Store::begin

(

)

const

Definition at line 165 of file kis_meta_data_store.cc.

{
    return d->entries.constBegin();
}

References d.

containsEntry() [1/3]

bool Store::containsEntry	(	const KisMetaData::Schema *	schema,
		const QString &	entryName ) const

Returns

true if the store contains this entry

Definition at line 92 of file kis_meta_data_store.cc.

{
    if (schema) {
        return containsEntry(schema->generateQualifiedName(entryName));
    }
    return false;
}

References containsEntry(), and KisMetaData::Schema::generateQualifiedName().

containsEntry() [2/3]

bool Store::containsEntry

(

const QString &

entryKey

)

const

Parameters

entryKey

the entryKey as the qualified name of the entry

Returns

true if an entry with the given key exist in the store

Definition at line 81 of file kis_meta_data_store.cc.

{
    return d->entries.contains(entryKey);
}

References d.

containsEntry() [3/3]

bool Store::containsEntry	(	const QString &	uri,
		const QString &	entryName ) const

Parameters

uri
entryName

Returns

true if an entry with the given uri and entry name exist in the store

Definition at line 86 of file kis_meta_data_store.cc.

{
    const Schema* schema = SchemaRegistry::instance()->schemaFromUri(uri);
    return containsEntry(schema->generateQualifiedName(entryName));
}

References containsEntry(), KisMetaData::Schema::generateQualifiedName(), KisMetaData::SchemaRegistry::instance(), and KisMetaData::SchemaRegistry::schemaFromUri().

copyFrom()

void Store::copyFrom

(

const Store *

store

)

Copy the entries from store inside this store

Definition at line 45 of file kis_meta_data_store.cc.

{
    for (QHash<QString, Entry>::const_iterator entryIt = store->begin();
            entryIt != store->end(); ++entryIt) {
        const Entry& entry = entryIt.value();
        if (entry.value().type() != KisMetaData::Value::Invalid) {
            if (containsEntry(entry.qualifiedName())) {
                getEntry(entry.qualifiedName()).value() = entry.value();
            } else {
                addEntry(entry);
            }
        }
    }
}

References addEntry(), begin(), containsEntry(), end(), getEntry(), KisMetaData::Value::Invalid, KisMetaData::Entry::qualifiedName(), KisMetaData::Value::type(), and KisMetaData::Entry::value().

debugDump()

void Store::debugDump

(

)

const

Dump on kdDebug the metadata store.

Definition at line 175 of file kis_meta_data_store.cc.

{
    dbgMetaData << "=== Dumping MetaData Store ===";
    dbgMetaData << " - Metadata (there are" << d->entries.size() << " entries)";
    Q_FOREACH (const Entry& e, d->entries) {
        if (e.isValid()) {
            dbgMetaData << e;
        } else {
            dbgMetaData << "Invalid entry";
        }
    }
}

References d, dbgMetaData, and KisMetaData::Entry::isValid().

empty()

bool Store::empty

(

)

const

Returns

true if there is no metadata in this store.

Definition at line 71 of file kis_meta_data_store.cc.

{
    return d->entries.isEmpty();
}

References d.

end()

QHash< QString, Entry >::const_iterator Store::end

(

)

const

Definition at line 170 of file kis_meta_data_store.cc.

{
    return d->entries.constEnd();
}

References d.

entries()

QList< Entry > KisMetaData::Store::entries

(

)

const

Returns

the list of entries

getEntry() [1/6]

Entry & Store::getEntry	(	const KisMetaData::Schema *	schema,
		const QString &	entryName )

Give access to a metadata entry

Parameters

schema	the schema
entryName	the name of the entry

Definition at line 120 of file kis_meta_data_store.cc.

{
    return getEntry(schema->generateQualifiedName(entryName));
}

References KisMetaData::Schema::generateQualifiedName(), and getEntry().

getEntry() [2/6]

const Entry & Store::getEntry	(	const KisMetaData::Schema *	schema,
		const QString &	entryName ) const

Give access to a metadata entry

Parameters

schema	the schema
entryName	the name of the entry

Definition at line 138 of file kis_meta_data_store.cc.

{
    return getEntry(schema->generateQualifiedName(entryName));
}

References KisMetaData::Schema::generateQualifiedName(), and getEntry().

getEntry() [3/6]

Entry & Store::getEntry

(

const QString &

entryKey

)

Give access to a metadata entry

Parameters

entryKey

the entryKey as the qualified name of the entry

Definition at line 100 of file kis_meta_data_store.cc.

{
    if (!d->entries.contains(entryKey)) {
        QStringList splitKey = entryKey.split(':');
        QString prefix = splitKey[0];
        splitKey.pop_front();
        d->entries[entryKey] = Entry(SchemaRegistry::instance()->schemaFromPrefix(prefix),
                                     splitKey.join(":"),
                                     Value());
    }
    return d->entries [entryKey];
}

References d, and KisMetaData::SchemaRegistry::instance().

getEntry() [4/6]

const Entry & Store::getEntry

(

const QString &

entryKey

)

const

Give access to a metadata entry

Parameters

entryKey

the entryKey as the qualified name of the entry

Definition at line 126 of file kis_meta_data_store.cc.

{
    return d->entries[entryKey];
}

References d.

getEntry() [5/6]

Entry & Store::getEntry	(	const QString &	uri,
		const QString &	entryName )

Give access to a metadata entry

Parameters

uri	the uri of the schema
entryName	the name of the entry

Definition at line 113 of file kis_meta_data_store.cc.

{
    const Schema* schema = SchemaRegistry::instance()->schemaFromUri(uri);
    Q_ASSERT(schema);
    return getEntry(schema, entryName);
}

References getEntry(), KisMetaData::SchemaRegistry::instance(), and KisMetaData::SchemaRegistry::schemaFromUri().

getEntry() [6/6]

const Entry & Store::getEntry	(	const QString &	uri,
		const QString &	entryName ) const

Give access to a metadata entry

Parameters

uri	the uri of the schema
entryName	the name of the entry

Definition at line 131 of file kis_meta_data_store.cc.

{
    const Schema* schema = SchemaRegistry::instance()->schemaFromUri(uri);
    Q_ASSERT(schema);
    return getEntry(schema, entryName);
}

References getEntry(), KisMetaData::SchemaRegistry::instance(), and KisMetaData::SchemaRegistry::schemaFromUri().

getValue()

const Value & Store::getValue	(	const QString &	uri,
		const QString &	entryName ) const

Return the value associated with this entry name and uri.

Parameters

uri
entryName

Returns

the value

Definition at line 160 of file kis_meta_data_store.cc.

{
    return getEntry(uri, entryName).value();
}

References getEntry(), and KisMetaData::Entry::value().

isEmpty()

bool Store::isEmpty

(

)

const

Definition at line 76 of file kis_meta_data_store.cc.

{
    return d->entries.isEmpty();
}

References d.

keys()

QList< QString > Store::keys

(

)

const

Returns

the list of keys

Definition at line 196 of file kis_meta_data_store.cc.

{
    return d->entries.keys();
}

References d.

removeEntry() [1/3]

void Store::removeEntry	(	const KisMetaData::Schema *	schema,
		const QString &	entryName )

Remove an entry.

Parameters

schema	the schema
entryName	the name of the entry

Definition at line 155 of file kis_meta_data_store.cc.

{
    removeEntry(schema->generateQualifiedName(entryName));
}

References KisMetaData::Schema::generateQualifiedName(), and removeEntry().

removeEntry() [2/3]

void Store::removeEntry

(

const QString &

entryKey

)

Remove an entry.

Parameters

entryKey

the entryKey as the qualified name of the entry

Definition at line 143 of file kis_meta_data_store.cc.

{
    d->entries.remove(entryKey);
}

References d.

removeEntry() [3/3]

void Store::removeEntry	(	const QString &	uri,
		const QString &	entryName )

Remove an entry.

Parameters

uri	the uri of the schema
entryName	the name of the entry

Definition at line 148 of file kis_meta_data_store.cc.

{
    const Schema* schema = SchemaRegistry::instance()->schemaFromUri(uri);
    Q_ASSERT(schema);
    removeEntry(schema, entryName);
}

References KisMetaData::SchemaRegistry::instance(), removeEntry(), and KisMetaData::SchemaRegistry::schemaFromUri().

Member Data Documentation

d

Private* const KisMetaData::Store::d

private

Definition at line 166 of file kis_meta_data_store.h.

---

The documentation for this class was generated from the following files:

• libs/metadata/kis_meta_data_store.h
• libs/metadata/kis_meta_data_store.cc