Entity.h

/* Copyright (c) 2011 Telemidia/PUC-Rio.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *    Telemidia/PUC-Rio - initial API and implementation
 */
#ifndef ENTITY_H
#define ENTITY_H

#include "../util/ComposerCoreControl_global.h"

#include <QObject>
#include <QMutex>
#include <QMutexLocker>
#include <QMap>
#include <QUuid>
#include <QDebug>

namespace composer{
    namespace core {
        class MessageControl;
        class ProjectReader;

        namespace model {
            class Project;
        }
        namespace util {
          class EditCommand;
          class AddCommand;
          class RemoveCommand;
        }
} } //end namespace

namespace composer {
    namespace core {
        namespace model {
class COMPOSERCORESHARED_EXPORT Entity : public QObject
{
    Q_OBJECT

    // The following classes are "reliable" and can acess the
    // private and protected members of Entity.
    friend class composer::core::model::Project;
    friend class composer::core::MessageControl;
    friend class composer::core::ProjectReader;

    friend class composer::core::util::EditCommand;
    friend class composer::core::util::AddCommand;
    friend class composer::core::util::RemoveCommand;

private:
    QMutex lockAtts;
    QMutex lockID;
    QMutex lockType;
    QMutex lockChildren;
    QMutex lockParent;
    QString _id;
    QString type;
    Entity* parent;
    bool deleteChildren; /* initial value is true */
    QVector <Entity*> children;
    QMap<QString, QString> atts;

protected:
    explicit Entity(QObject *parent = 0);
    explicit Entity(QMap<QString,QString> &atts, QObject *parent = 0);
    explicit Entity(QString uniqueId, QString type, QMap<QString,QString> &atts,
                    QObject *parent = 0);

    ~Entity();
    void setAttribute(QString name, QString value);

    void setAtrributes(QMap<QString,QString> &newatts);

    void setType(QString type);

    void setUniqueID(QString uniqueId);

    void setParent(Entity *parent);

    //OBS: This addChild updates the parent referency
    bool addChild(Entity *entity);

    bool deleteChild(Entity *entity);
    bool removeChildAppendChildren(Entity *entity);
    void print();

public:
    QString getAttribute(QString name);
    void getAttributeIterator (QMap<QString,QString>::iterator &begin,
                               QMap<QString,QString>::iterator &end);
    bool hasAttribute(const QString &name);

    QString getUniqueId();

    QString getType();

    Entity* getParent();

    QString getParentUniqueId();
    void setDeleteChildren(bool mustDelete);

    QVector <Entity *> getChildren();

    QString toString(int ntabs, bool writeuid = true);

    Entity *cloneEntity();
};

} } } //end namespace

#endif // ENTITY_H