6.88. sibl_gui.components.addons.databaseOperations.databaseOperations

databaseOperations.py

Platform:

Windows, Linux, Mac Os X.

Description:

This module defines the DatabaseOperations Component Interface class and others helper objects.

Others:

6.88.1. Module Attributes

sibl_gui.components.addons.databaseOperations.databaseOperations.LOGGER

sibl_gui.components.addons.databaseOperations.databaseOperations.COMPONENT_UI_FILE

6.88.2. Classes

class sibl_gui.components.addons.databaseOperations.databaseOperations.DatabaseType(**kwargs)

Bases: foundations.dataStructures.Structure

This class represents a storage object for manipulation methods associated to a given Database type.

See sibl_gui.components.core.database.types module for more informations about the available Database types.

Parameters:kwargs – type, getMethod, updateContentMethod, removeMethod, modelContainer, updateLocationMethod ( Key / Value pairs )

class sibl_gui.components.addons.databaseOperations.databaseOperations.DatabaseOperations(parent=None, name=None, *args, **kwargs)

Bases: manager.qwidgetComponent.QWidgetComponent

This class is the sibl_gui.components.addons.databaseOperations.databaseOperations Component Interface class.

It provides various methods to operate on the Database.

Parameters:

• parent – Object parent. ( QObject )
• name – Component name. ( String )
• *args – Arguments. ( * )
• **kwargs – Keywords arguments. ( ** )

engine

This method is the property for self.__engine attribute.

Returns:self.__engine. ( QObject )

settings

This method is the property for self.__settings attribute.

Returns:self.__settings. ( QSettings )

settingsSection

This method is the property for self.__settingsSection attribute.

Returns:self.__settingsSection. ( String )

preferencesManager

This method is the property for self.__preferencesManager attribute.

Returns:self.__preferencesManager. ( QWidget )

iblSetsOutliner

This method is the property for self.__iblSetsOutliner attribute.

Returns:self.__iblSetsOutliner. ( QWidget )

templatesOutliner

This method is the property for self.__templatesOutliner attribute.

Returns:self.__templatesOutliner. ( QWidget )

types

This method is the property for self.__types attribute.

Returns:self.__types. ( Tuple )

activate(engine)

This method activates the Component.

Parameters:engine – Engine to attach the Component to. ( QObject ) Returns:Method success. ( Boolean )

deactivate()

This method deactivates the Component.

Returns:Method success. ( Boolean )

initializeUi()

This method initializes the Component ui.

Returns:Method success. ( Boolean )

uninitializeUi()

This method uninitializes the Component ui.

Returns:Method success. ( Boolean )

addWidget()

This method adds the Component Widget to the engine.

Returns:Method success. ( Boolean )

removeWidget()

This method removes the Component Widget from the engine.

Returns:Method success. ( Boolean )

updateDatabase()

This method updates the Database.

Each type defined by DatabaseOperations.sibl_gui.components.core.database.types() attribute will have its instances checked and updated by their associated methods.

Returns:Method success. ( Boolean )

removeInvalidData()

This method removes invalid data from the Database.

Returns:Method success. ( Boolean )