entity.h

/*
    Copyright (c) 2008 Tobias Koenig <tokoe@kde.org>

    This library is free software; you can redistribute it and/or modify it
    under the terms of the GNU Library General Public License as published by
    the Free Software Foundation; either version 2 of the License, or (at your
    option) any later version.

    This library 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 Library General Public
    License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to the
    Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
    02110-1301, USA.
*/

#ifndef AKONADI_ENTITY_H
#define AKONADI_ENTITY_H

#include "akonadi_export.h"
#include <QString>

namespace Akonadi {
class Entity;
}

AKONADI_EXPORT uint qHash(const Akonadi::Entity &);

#include <akonadi/attribute.h>

#include <KDE/KDebug>

#include <QtCore/QHash>
#include <QtCore/QSharedDataPointer>

#define AKONADI_DECLARE_PRIVATE( Class ) \
    Class##Private *d_func(); \
    const Class##Private *d_func() const; \
    friend class Class##Private;

namespace Akonadi {

class Collection;
class EntityPrivate;

class AKONADI_EXPORT Entity
{
public:
    typedef qint64 Id;

    void setId(Id identifier);

    Id id() const;

    void setRemoteId(const QString &id);

    QString remoteId() const;

    void setRemoteRevision(const QString &revision);

    QString remoteRevision() const;

    bool isValid() const;

    bool operator==(const Entity &other) const;

    bool operator!=(const Entity &other) const;

    Entity &operator=(const Entity &other);

    bool operator<(const Entity &other) const;

    Collection parentCollection() const;

    Collection &parentCollection();

    void setParentCollection(const Collection &parent);

    void addAttribute(Attribute *attribute);

    void removeAttribute(const QByteArray &name);

    bool hasAttribute(const QByteArray &name) const;

    Attribute::List attributes() const;

    void clearAttributes();

    Attribute *attribute(const QByteArray &name) const;

    enum CreateOption {
        AddIfMissing    
    };

    template <typename T> inline T *attribute(CreateOption option)
    {
        Q_UNUSED(option);

        const T dummy;
        if (hasAttribute(dummy.type())) {
            T *attr = dynamic_cast<T *>(attribute(dummy.type()));
            if (attr) {
                return attr;
            }
            kWarning(5250) << "Found attribute of unknown type" << dummy.type()
                           << ". Did you forget to call AttributeFactory::registerAttribute()?";
        }

        T *attr = new T();
        addAttribute(attr);
        return attr;
    }

    template <typename T> inline T *attribute() const
    {
        const T dummy;
        if (hasAttribute(dummy.type())) {
            T *attr = dynamic_cast<T *>(attribute(dummy.type()));
            if (attr) {
                return attr;
            }
            kWarning(5250) << "Found attribute of unknown type" << dummy.type()
                           << ". Did you forget to call AttributeFactory::registerAttribute()?";
        }

        return 0;
    }

    template <typename T> inline void removeAttribute()
    {
        const T dummy;
        removeAttribute(dummy.type());
    }

    template <typename T> inline bool hasAttribute() const
    {
        const T dummy;
        return hasAttribute(dummy.type());
    }

protected:
    Entity(const Entity &other);

    ~Entity();

    //@cond PRIVATE
    Entity(EntityPrivate *dd);
    QSharedDataPointer<EntityPrivate> d_ptr;
    //@endcond

    AKONADI_DECLARE_PRIVATE(Entity)
};

}

#endif