abstract_workspace.h

/*
 * abstract_workspace.h
 *
 *  Created on: Nov 1, 2015
 *      Author: Marcus Pfaff
 */

#ifndef ABSTRACT_WORKSPACE_H
#define ABSTRACT_WORKSPACE_H

#include <QDate>
#include <QVector>
#include "abstract_project.h"
#include "export_import_helper.h"

class AbstractWorkspace : public QObject
{
    Q_OBJECT
    Q_PROPERTY(bool isDefault READ isDefault WRITE setDefault USER true)

public:
    virtual ~AbstractWorkspace();

    static QDomDocument workspaceDomDocumentTemplate(const QString& name, const QString& version, const QString& description);

    virtual void init() = 0;

    virtual void update() = 0;

    virtual bool compare(const QSharedPointer<AbstractWorkspace>& otherWorkspace) const = 0;

    virtual bool save() = 0;

    virtual bool test() = 0;

    virtual bool deleteWorkspace(bool deleteProjects = false) = 0;

    virtual bool deleteProject(const QSharedPointer<AbstractProject>& project) = 0;

    bool removeProject(const QSharedPointer<AbstractProject>& project);

    bool removeProjects();

    bool saveProjects() const;

    bool saveExternChangedProjects() const;

    void resetProjects() const;

    void resetExternChangedProjects() const;

    QStringList projectNames() const;

    bool validateWorkspaceDomDocument(const QDomDocument& domDocument);

    QDomDocument workspaceDomDocument() const;

    QString name() const;

    void setName(const QString& name);

    bool isDefault() const;

    void setDefault(bool isDefault);

    QString version() const;

    void setVersion(const QString& version);

    int majorWorkspaceVersion() const;

    void setMajorWorkspaceVersion(int majorWorkspaceVersion);

    int minorWorkspaceVersion() const;

    void setMinorWorkspaceVersion(int minorWorkspaceVersion);

    QVector<QSharedPointer<AbstractProject>> projects() const;

    QSharedPointer<AbstractProject> project(QString connectionString) const;

    bool addProject(const QSharedPointer<AbstractProject>& project);

    void setProjects(const QVector<QSharedPointer<AbstractProject>>& projects);

    int projectCount() const;

    void setConnectionString(const QString& connectionString);

    QString connectionString() const;

    QString description() const;

    void setDescription(const QString& description);

    bool isOpen() const;

    virtual void setOpen(bool isOpen);

    QString className() const;

    SettingsScope* settingsScope();

    QString typeString() const;

    bool isValid() const;

    const QString lastError() const;

    void clearLastError();

    bool contains(const QSharedPointer<AbstractProject>& project) const;

    QString lastUsedDateTime() const;

    void setLastUsedDateTime(const QString& lastUsedDateTime);

protected:
    AbstractWorkspace(const QString& typeString);

    void setValid(bool isValid);

    void setLastError(const QString& lastError);

    bool setWorkspaceProperties(const QDomDocument& domDocument);

    void setWorkspaceDomDocument(const QDomDocument &workspaceDomDocument);

private:
    QScopedPointer<SettingsScope> _settingsScope;
    QVector<QSharedPointer<AbstractProject>> _projects;
    bool _isOpen = false;
    bool _isDefault = false;
    bool _isValid = false;
    QString _description;
    QString _name;
    QString _typeString;
    QString _lastError;
    QString _version;
    QString _connectionString;
    int _majorWorkspaceVersion = -1;
    int _minorWorkspaceVersion = -1;
    QDateTime _lastUsedDateTime;
    QDomDocument _workspaceDomDocument;

signals:
    void workspaceUpdated();
    void isValidChanged(bool isValid);
    void workspaceNameChanged(const QString& workspaceName);
    void workspaceConnectionChanged(const QString& workspaceConnection);
    void workspaceDescriptionChanged(const QString& workspaceDescription);
    void projectDomDocumentChanged(const QSharedPointer<AbstractProject>& project);
};

#endif // ABSTRACT_WORKSPACE_H