Inheritance diagram for SqlWorkspace:

Collaboration diagram for SqlWorkspace:

Public Member Functions
void	init () Q_DECL_OVERRIDE
	Initialize the Workspace and set isValid flag. This function must be called, otherwise the workspace can't be valid. More...

void	update () Q_DECL_OVERRIDE
	Update the workspace after property changes. More...

bool	compare (const QSharedPointer< AbstractWorkspace > &otherWorkspace) const Q_DECL_OVERRIDE
	Compare a other Workspace source with this Workspace source (not the Object adress). More...

bool	save () Q_DECL_OVERRIDE
	Save workspace with all settings. More...

bool	test () Q_DECL_OVERRIDE
	Workspace test procedure. The Test-Procedure is defined by the specific workspace class, which inherits from AbstractWorkspace class. More...

bool	deleteProject (const QSharedPointer< AbstractProject > &project) Q_DECL_OVERRIDE
	Delete a project and remove it from workspace. More...

bool	deleteWorkspace (bool deleteProjects=false) Q_DECL_OVERRIDE
	Delete workspace. The function deletes this workspace and all included projects, if the `deleteProjects` flag is set `true`. More...

int	port () const

void	setPort (int port)

QString	user () const

void	setUser (const QString &user)

QString	password () const

void	setPassword (const QString &password)

QString	host () const

void	setHost (const QString &host)

QString	database () const

void	setDatabase (const QString &database)

QString	sourceInformation () const

void	setSourceInformation (const QString &sourceInformation)

Public Member Functions inherited from AbstractWorkspace
bool	removeProject (const QSharedPointer< AbstractProject > &project)
	Remove a project from workspace. The project will not be deleted. More...

bool	removeProjects ()
	Remove all projects from workspace. The projects will not be deleted. More...

bool	saveProjects () const
	Save all projects in workspace. More...

bool	saveExternChangedProjects () const
	Save all projects in workspace which are changed by extern. More...

void	resetProjects () const
	Reset all projects in workspace. Reload the complete project structure from xml. All settings, which are not saved will be discarded and the project isDirty flag will be set to false.

void	resetExternChangedProjects () const
	Reset all projects in workspace which are changed by extern. More...

QStringList	projectNames () const

bool	validateWorkspaceDomDocument (const QDomDocument &domDocument)
	Validate a workspace DomDocument. More...

QDomDocument	workspaceDomDocument () const

QString	name () const

void	setName (const QString &name)
	Set the workspace name. More...

bool	isDefault () const

void	setDefault (bool isDefault)
	Set workspace as default workspace. On Traviz start this workspace will be loaded directly. No workspace manager will be shown. More...

QString	version () const

void	setVersion (const QString &version)
	Set the workspace version. If the version is not compatible with the application condition the workspace could not be loaded. More...

int	majorWorkspaceVersion () const

void	setMajorWorkspaceVersion (int majorWorkspaceVersion)
	Set the workspace major version. If the version is not compatible with the application condition the workspace could not be loaded. More...

int	minorWorkspaceVersion () const

void	setMinorWorkspaceVersion (int minorWorkspaceVersion)
	Set the workspace minor version. If the version is not compatible with the application condition the workspace could not be loaded. More...

QVector< QSharedPointer< AbstractProject > >	projects () const

QSharedPointer< AbstractProject >	project (QString connectionString) const

bool	addProject (const QSharedPointer< AbstractProject > &project)
	Add a project into workspace. More...

void	setProjects (const QVector< QSharedPointer< AbstractProject >> &projects)
	Set the vector of projects for a workspace. More...

int	projectCount () const

void	setConnectionString (const QString &connectionString)
	Set the Workspace connection string. The `connectionString` is unique source identifier inside a running Traviz application. More...

QString	connectionString () const
	The Workspace connection string holds the source connection information (e.g File-Workspace -> filename, Sql-Workspace -> Server and user information). The `connectionString` is unique inside a running Traviz application and can be used to identifier a workspace. More...

QString	description () const

void	setDescription (const QString &description)
	Set the workspace description. More...

bool	isOpen () const

virtual void	setOpen (bool isOpen)
	Set the workspace open (in use) state. More...

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)
	Set the workspace last used date value ("MM/dd/yyyy hh:mm:ss") More...

Properties
int	port

QString	user

QString	password

QString	host

QString	database

Properties inherited from AbstractWorkspace
bool	isDefault

Additional Inherited Members
Signals inherited from AbstractWorkspace
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)

Static Public Member Functions inherited from AbstractWorkspace
static QDomDocument	workspaceDomDocumentTemplate (const QString &name, const QString &version, const QString &description)
	This static function creates a clean workspace DomDocument. More...

Protected Member Functions inherited from AbstractWorkspace
	AbstractWorkspace (const QString &typeString)
	AbstractWorkspace constructor with typeString definition (e,g. File, Sql). More...

void	setValid (bool isValid)
	Set the workspace valid. This property decides if a workspace is loadable or not. More...

void	setLastError (const QString &lastError)
	Set the last occured workspace error string. More...

bool	setWorkspaceProperties (const QDomDocument &domDocument)
	Set the workspace properties. The properties will be read from domDocument. More...

void	setWorkspaceDomDocument (const QDomDocument &workspaceDomDocument)
	Set the workspace dom document. The domdocument hold all information about the workspace (e.g version, name, last used date, projects). More...

Member Function Documentation

◆ compare()

bool SqlWorkspace::compare ( const QSharedPointer< AbstractWorkspace > & otherWorkspace ) const

virtual

Compare a other Workspace source with this Workspace source (not the Object adress).

Parameters

otherWorkspace The Workspace to compare with.

Returns: Returns true if the other Workspace is equil (e.g. File-Workspace: same file), otherwise returns false.

Implements AbstractWorkspace.

◆ deleteProject()

bool SqlWorkspace::deleteProject ( const QSharedPointer< AbstractProject > & project )

virtual

Delete a project and remove it from workspace.

Parameters

project The project which should be deleted.

Returns: Returns true if the process was successfull, otherwise returns false.

See also: removeProject; removeProjects; saveProjects

Implements AbstractWorkspace.

◆ deleteWorkspace()

bool SqlWorkspace::deleteWorkspace ( bool deleteProjects = false )

virtual

Delete workspace. The function deletes this workspace and all included projects, if the deleteProjects flag is set true.

Parameters

deleteProjects The delete all projects flag (default = false).

Returns: Returns true if the process was successfull, otherwise returns false.

See also: deleteProject

Implements AbstractWorkspace.

◆ init()

void SqlWorkspace::init ( )

virtual

Initialize the Workspace and set isValid flag. This function must be called, otherwise the workspace can't be valid.

See also: update

Implements AbstractWorkspace.

◆ save()

bool SqlWorkspace::save ( )

virtual

Save workspace with all settings.

Returns: Returns true if the Workspace was successfully saved, otherwise returns false.

Implements AbstractWorkspace.

◆ test()

bool SqlWorkspace::test ( )

virtual

Workspace test procedure. The Test-Procedure is defined by the specific workspace class, which inherits from AbstractWorkspace class.

Returns: Returns true if the process was successfull, otherwise returns false.

Implements AbstractWorkspace.

◆ update()

void SqlWorkspace::update ( )

virtual

Update the workspace after property changes.

See also: init

Implements AbstractWorkspace.

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

itemframework/itemframework/src/project/sql_workspace.h
itemframework/itemframework/src/project/sql_workspace.cpp

Public Member Functions

Properties

Additional Inherited Members

Member Function Documentation

◆ compare()

◆ deleteProject()

◆ deleteWorkspace()

◆ init()

◆ save()

◆ test()

◆ update()