#include <KoGenericRegistry.h>

Public Member Functions
void	add (const QString &id, T item)

void	add (T item)

void	addAlias (const QString &alias, const QString &id)

QHash< QString, T >::const_iterator	constBegin () const

QHash< QString, T >::const_iterator	constEnd () const

bool	contains (const QString &id) const

int	count () const

QList< T >	doubleEntries () const

T	get (const QString &id) const

QList< QString >	keys () const

	KoGenericRegistry ()

void	remove (const QString &id)

void	removeAlias (const QString &alias)

const T	value (const QString &id) const

QList< T >	values () const

virtual	~KoGenericRegistry ()

Private Attributes
QHash< QString, QString >	m_aliases

QList< T >	m_doubleEntries

QHash< QString, T >	m_hash

Detailed Description

template<typename T>
class KoGenericRegistry< T >

Base class for registry objects.

Registered objects are owned by the registry.

Items are mapped by QString as a unique Id.

Example of use:

class KoMyClassRegistry : public KoGenericRegistry<MyClass*> {
public:
  static KoMyClassRegistry * instance();
private:
 static KoMyClassRegistry* s_instance;
};
 
KoMyClassRegistry *KoMyClassRegistry::s_instance = 0;
KoMyClassRegistry * KoMyClassRegistry::instance()
{
   if(s_instance == 0)
   {
     s_instance = new KoMyClassRegistry;
   }
   return s_instance;
}

Definition at line 46 of file KoGenericRegistry.h.

Constructor & Destructor Documentation

◆ KoGenericRegistry()

template<typename T >

KoGenericRegistry< T >::KoGenericRegistry ( )

inline

Definition at line 49 of file KoGenericRegistry.h.

49{ }

◆ ~KoGenericRegistry()

template<typename T >

virtual KoGenericRegistry< T >::~KoGenericRegistry ( )

inlinevirtual

Definition at line 50 of file KoGenericRegistry.h.

    {
        m_doubleEntries.clear();
        m_hash.clear();
    }

References KoGenericRegistry< T >::m_doubleEntries, and KoGenericRegistry< T >::m_hash.

Member Function Documentation

◆ add() [1/2]

template<typename T >

void KoGenericRegistry< T >::add	(	const QString &	id,
		T	item )

inline

add an object to the registry

Parameters

id	the id of the object
item	the item to add

Definition at line 83 of file KoGenericRegistry.h.

    {
        KIS_SAFE_ASSERT_RECOVER_RETURN(item);
        KIS_SAFE_ASSERT_RECOVER_NOOP(!m_aliases.contains(id));
 
        if (m_hash.contains(id)) {
            m_doubleEntries << value(id);
            remove(id);
        }
        m_hash.insert(id, item);
    }

References KIS_SAFE_ASSERT_RECOVER_NOOP, KIS_SAFE_ASSERT_RECOVER_RETURN, KoGenericRegistry< T >::m_aliases, KoGenericRegistry< T >::m_doubleEntries, KoGenericRegistry< T >::m_hash, KoGenericRegistry< T >::remove(), and KoGenericRegistry< T >::value().

◆ add() [2/2]

template<typename T >

void KoGenericRegistry< T >::add ( T item )

inline

Add an object to the registry. If it is a QObject, make sure it isn't in the QObject ownership hierarchy, since the registry itself is responsible for deleting it.

Parameters

item	the item to add (NOTE: T must have an QString id() const function)

Definition at line 64 of file KoGenericRegistry.h.

    {
        KIS_SAFE_ASSERT_RECOVER_RETURN(item);
 
        const QString id = item->id();
        KIS_SAFE_ASSERT_RECOVER_NOOP(!m_aliases.contains(id));
 
        if (m_hash.contains(id)) {
            m_doubleEntries << value(id);
            remove(id);
        }
        m_hash.insert(id, item);
    }

References KIS_SAFE_ASSERT_RECOVER_NOOP, KIS_SAFE_ASSERT_RECOVER_RETURN, KoGenericRegistry< T >::m_aliases, KoGenericRegistry< T >::m_doubleEntries, KoGenericRegistry< T >::m_hash, KoGenericRegistry< T >::remove(), and KoGenericRegistry< T >::value().

◆ addAlias()

template<typename T >

void KoGenericRegistry< T >::addAlias	(	const QString &	alias,
		const QString &	id )

inline

Definition at line 103 of file KoGenericRegistry.h.

    {
        KIS_SAFE_ASSERT_RECOVER_NOOP(!m_hash.contains(alias));
        m_aliases[alias] = id;
    }

References KIS_SAFE_ASSERT_RECOVER_NOOP, KoGenericRegistry< T >::m_aliases, and KoGenericRegistry< T >::m_hash.

◆ constBegin()

template<typename T >

QHash< QString, T >::const_iterator KoGenericRegistry< T >::constBegin ( ) const

inline

Definition at line 179 of file KoGenericRegistry.h.

                                                                {
        return m_hash.constBegin();
    }

References KoGenericRegistry< T >::m_hash.

◆ constEnd()

template<typename T >

QHash< QString, T >::const_iterator KoGenericRegistry< T >::constEnd ( ) const

inline

Definition at line 183 of file KoGenericRegistry.h.

                                                              {
        return m_hash.constEnd();
    }

References KoGenericRegistry< T >::m_hash.

◆ contains()

template<typename T >

bool KoGenericRegistry< T >::contains ( const QString & id ) const

inline

Returns: if there is an object stored in the registry identified by the id.

Parameters

id	the unique identifier string

Definition at line 130 of file KoGenericRegistry.h.

    {
        bool result = m_hash.contains(id);
 
        if (!result && m_aliases.contains(id)) {
            result = m_hash.contains(m_aliases.value(id));
        }
 
        return result;
    }

References KoGenericRegistry< T >::m_aliases, and KoGenericRegistry< T >::m_hash.

◆ count()

template<typename T >

int KoGenericRegistry< T >::count ( ) const

inline

Definition at line 164 of file KoGenericRegistry.h.

    {
        return m_hash.count();
    }

References KoGenericRegistry< T >::m_hash.

◆ doubleEntries()

template<typename T >

QList< T > KoGenericRegistry< T >::doubleEntries ( ) const

inline

Definition at line 174 of file KoGenericRegistry.h.

    {
        return m_doubleEntries;
    }

References KoGenericRegistry< T >::m_doubleEntries.

◆ get()

template<typename T >

T KoGenericRegistry< T >::get ( const QString & id ) const

inline

Retrieve the object from the registry based on the unique identifier string.

Parameters

id the id

Definition at line 120 of file KoGenericRegistry.h.

    {
        return value(id);
    }

References KoGenericRegistry< T >::value().

◆ keys()

template<typename T >

QList< QString > KoGenericRegistry< T >::keys ( ) const

inline

Returns: a list of all keys

Definition at line 159 of file KoGenericRegistry.h.

    {
        return m_hash.keys();
    }

References KoGenericRegistry< T >::m_hash.

◆ remove()

template<typename T >

void KoGenericRegistry< T >::remove ( const QString & id )

inline

This function removes an item from the registry

Definition at line 98 of file KoGenericRegistry.h.

    {
        m_hash.remove(id);
    }

References KoGenericRegistry< T >::m_hash.

◆ removeAlias()

template<typename T >

void KoGenericRegistry< T >::removeAlias ( const QString & alias )

inline

Definition at line 109 of file KoGenericRegistry.h.

    {
        m_aliases.remove(alias);
    }

References KoGenericRegistry< T >::m_aliases.

◆ value()

template<typename T >

const T KoGenericRegistry< T >::value ( const QString & id ) const

inline

Retrieve the object from the registry based on the unique identifier string

Parameters

id the id

Definition at line 145 of file KoGenericRegistry.h.

    {
        T result = m_hash.value(id);
 
        if (!result && m_aliases.contains(id)) {
            result = m_hash.value(m_aliases.value(id));
        }
 
        return result;
    }

References KoGenericRegistry< T >::m_aliases, and KoGenericRegistry< T >::m_hash.

◆ values()

template<typename T >

QList< T > KoGenericRegistry< T >::values ( ) const

inline

Definition at line 169 of file KoGenericRegistry.h.

    {
        return m_hash.values();
    }

References KoGenericRegistry< T >::m_hash.

Member Data Documentation

◆ m_aliases

template<typename T >

QHash<QString, QString> KoGenericRegistry< T >::m_aliases

private

Definition at line 194 of file KoGenericRegistry.h.

◆ m_doubleEntries

template<typename T >

QList<T> KoGenericRegistry< T >::m_doubleEntries

private

Definition at line 189 of file KoGenericRegistry.h.

◆ m_hash

template<typename T >

QHash<QString, T> KoGenericRegistry< T >::m_hash

private

Definition at line 193 of file KoGenericRegistry.h.

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

libs/global/KoGenericRegistry.h

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ KoGenericRegistry()

◆ ~KoGenericRegistry()

Member Function Documentation

◆ add() [1/2]

◆ add() [2/2]

◆ addAlias()

◆ constBegin()

◆ constEnd()

◆ contains()

◆ count()

◆ doubleEntries()

◆ get()

◆ keys()

◆ remove()

◆ removeAlias()

◆ value()

◆ values()

Member Data Documentation

◆ m_aliases

◆ m_doubleEntries

◆ m_hash