#include <mitkPersistenceService.h>

Inheritance diagram for mitk::PersistenceService:

Collaboration diagram for mitk::PersistenceService:

Public Member Functions
	PersistenceService ()

	~PersistenceService () override

std::string	GetDefaultPersistenceFile () override

mitk::PropertyList::Pointer	GetPropertyList (std::string &id, bool *existed=nullptr) override

bool	RemovePropertyList (std::string &id) override

std::string	GetPersistenceNodePropertyName () override

DataStorage::SetOfObjects::Pointer	GetDataNodes (DataStorage *ds=nullptr) override

bool	Save (const std::string &fileName="", bool appendChanges=false) override

bool	Load (const std::string &fileName="", bool enforeReload=true) override

void	SetAutoLoadAndSave (bool autoLoadAndSave) override

bool	GetAutoLoadAndSave () override

void	AddPropertyListReplacedObserver (PropertyListReplacedObserver *observer) override

void	RemovePropertyListReplacedObserver (PropertyListReplacedObserver *observer) override

bool	RestorePropertyListsFromPersistentDataNodes (const DataStorage *storage) override

void	Clear ()

void	Unitialize ()

Public Member Functions inherited from mitk::IPersistenceService
virtual	~IPersistenceService ()

Static Public Member Functions
static std::string	GetPersistencePropertyName ()

static std::string	GetPersistencePropertyListName ()

static void	LoadModule ()

static us::ModuleContext *	GetModuleContext ()

Detailed Description

implementation of the IPersistenceService

See also: IPersistenceService

Definition at line 26 of file mitkPersistenceService.h.

Constructor & Destructor Documentation

◆ PersistenceService()

mitk::PersistenceService::PersistenceService ( )

Definition at line 31 of file mitkPersistenceService.cpp.

◆ ~PersistenceService()

mitk::PersistenceService::~PersistenceService ( )

override

Definition at line 42 of file mitkPersistenceService.cpp.

References MITK_DEBUG.

Member Function Documentation

◆ AddPropertyListReplacedObserver()

void mitk::PersistenceService::AddPropertyListReplacedObserver ( PropertyListReplacedObserver * observer )

overridevirtual

adds a observer which is informed if a propertyList gets replaced during a Load() procedure

Implements mitk::IPersistenceService.

Definition at line 266 of file mitkPersistenceService.cpp.

◆ Clear()

void mitk::PersistenceService::Clear ( )

Definition at line 35 of file mitkPersistenceService.cpp.

Referenced by RemovePropertyList().

◆ GetAutoLoadAndSave()

bool mitk::PersistenceService::GetAutoLoadAndSave ( )

overridevirtual

Returns: whether AutoLoading is activated or not

Implements mitk::IPersistenceService.

Definition at line 373 of file mitkPersistenceService.cpp.

Referenced by Unitialize().

◆ GetDataNodes()

mitk::DataStorage::SetOfObjects::Pointer mitk::PersistenceService::GetDataNodes ( DataStorage * ds = nullptr )

overridevirtual

Creates a vector of DataNodes that contain all PropertyLists. Additionally, the DataNodes will have the property name set to the PropertyList's id and a BoolProperty equal to GetPersistenceNodePropertyName() set to true. If ds is set the returned DataNodes will also be added to that DS.

Returns: vector of DataNodes with the described attributes

Implements mitk::IPersistenceService.

Definition at line 294 of file mitkPersistenceService.cpp.

References mitk::DataStorage::Add(), GetPersistencePropertyName(), MITK_DEBUG, and mitk::DataNode::New().

Referenced by Save().

◆ GetDefaultPersistenceFile()

std::string mitk::PersistenceService::GetDefaultPersistenceFile ( )

overridevirtual

Get the default name of the PersistenceFile (the one that is loaded at startup)

Implements mitk::IPersistenceService.

Definition at line 47 of file mitkPersistenceService.cpp.

References us::GetModuleContext().

Referenced by Load(), and Save().

◆ GetModuleContext()

us::ModuleContext * mitk::PersistenceService::GetModuleContext ( )

static

Definition at line 283 of file mitkPersistenceService.cpp.

References us::GetModuleContext().

◆ GetPersistenceNodePropertyName()

std::string mitk::PersistenceService::GetPersistenceNodePropertyName ( )

overridevirtual

Returns: The name of the Bool Property that specifies whether a DataNode is a Node carrying Persistence PropertyLists

Implements mitk::IPersistenceService.

Definition at line 288 of file mitkPersistenceService.cpp.

References GetPersistencePropertyName().

◆ GetPersistencePropertyListName()

std::string mitk::PersistenceService::GetPersistencePropertyListName ( )

static

Definition at line 26 of file mitkPersistenceService.cpp.

Referenced by RemovePropertyList(), and SetAutoLoadAndSave().

◆ GetPersistencePropertyName()

std::string mitk::PersistenceService::GetPersistencePropertyName ( )

static

Definition at line 21 of file mitkPersistenceService.cpp.

Referenced by GetDataNodes(), GetPersistenceNodePropertyName(), and RestorePropertyListsFromPersistentDataNodes().

◆ GetPropertyList()

mitk::PropertyList::Pointer mitk::PersistenceService::GetPropertyList	(	std::string &	id,
		bool *	existed = `nullptr`
	)

overridevirtual

If PropertyList with the given id exists, returns it. Otherwise creates a new one and returns it. If id is empty a UUID will be created and set on the variable If existed was passed, it is true if the PropertyList with that id existed, false otherwise

Returns: a valid PropertyList with a StringProperty "Id" containing the passed id

Implements mitk::IPersistenceService.

Definition at line 61 of file mitkPersistenceService.cpp.

References mitk::PropertyList::Clear(), mitk::PropertyList::GetMap(), mitk::UIDGenerator::GetUID(), mitk::PropertyList::New(), and mitk::PropertyList::SetProperty().

Referenced by RemovePropertyList(), RestorePropertyListsFromPersistentDataNodes(), and SetAutoLoadAndSave().

◆ Load()

bool mitk::PersistenceService::Load	(	const std::string &	fileName = `""`,
		bool	enforeReload = `true`
	)

overridevirtual

Load PropertyLists from fileName. If fileName is empty, a special file in the users home directory will be used. If enforeReload is false, the service will take care of modified time flags, i.e. it will not load a file that was loaded before and did not change in the meantime or that was modified by the service itself ATTENTION: If there are PropertyLists with the same id contained in the file, existing PropertyLists will be overwritten!

See also: AddPropertyListReplacedObserver()

Returns: false if an error occured (cannot load from file), true otherwise

Implements mitk::IPersistenceService.

Definition at line 190 of file mitkPersistenceService.cpp.

References GetDefaultPersistenceFile(), MITK_DEBUG, mitk::SceneIO::New(), and RestorePropertyListsFromPersistentDataNodes().

Referenced by RemovePropertyList().

◆ LoadModule()

void mitk::PersistenceService::LoadModule ( )

static

Definition at line 278 of file mitkPersistenceService.cpp.

References MITK_DEBUG.

◆ RemovePropertyList()

bool mitk::PersistenceService::RemovePropertyList ( std::string & id )

overridevirtual

removes the PropertyList with the given id

Returns: true if PropertyList existed and could be removed, false otherwise

Implements mitk::IPersistenceService.

Definition at line 379 of file mitkPersistenceService.cpp.

References Clear(), GetPersistencePropertyListName(), GetPropertyList(), Load(), MITK_DEBUG, mitk::PropertyListsXmlFileReaderAndWriter::New(), and SetAutoLoadAndSave().

◆ RemovePropertyListReplacedObserver()

void mitk::PersistenceService::RemovePropertyListReplacedObserver ( PropertyListReplacedObserver * observer )

overridevirtual

removes a specific observer

Implements mitk::IPersistenceService.

Definition at line 272 of file mitkPersistenceService.cpp.

◆ RestorePropertyListsFromPersistentDataNodes()

bool mitk::PersistenceService::RestorePropertyListsFromPersistentDataNodes ( const DataStorage * storage )

overridevirtual

Searches storage for persistent DataNodes, extracts and inserts the appended property lists to this service

Returns: true if at least one node was found from which a PropertyList could be restored

Implements mitk::IPersistenceService.

Definition at line 320 of file mitkPersistenceService.cpp.

References mitk::DataStorage::GetAll(), mitk::DataNode::GetBoolProperty(), mitk::DataNode::GetName(), GetPersistencePropertyName(), GetPropertyList(), mitk::DataNode::GetPropertyList(), and MITK_DEBUG.

Referenced by Load(), and Save().

◆ Save()

bool mitk::PersistenceService::Save	(	const std::string &	fileName = `""`,
		bool	appendChanges = `false`
	)

overridevirtual

Save the current PropertyLists to fileName. If fileName is empty, a special file in the users home directory will be used. if appendchanges is true, the file will not replaced but first loaded, then overwritten and then replaced