Interface of property persistence service. More...

#include <mitkIPropertyPersistence.h>

Inheritance diagram for mitk::IPropertyPersistence:

Public Types
using	InfoResultType = std::list< PropertyPersistenceInfo::ConstPointer >

using	MimeTypeNameType = PropertyPersistenceInfo::MimeTypeNameType

Public Member Functions
virtual	~IPropertyPersistence ()

virtual bool	AddInfo (const PropertyPersistenceInfo *info, bool overwrite=false)=0
	Add persistence info for a specific base data property. If there is already a property info instance for the passed property name and the same info, it won't be added. Info instances are regarded equal, if the mime types are equal. You may enforce to overwrite the old equal info for a property name by the overwrite parameter. More...

virtual InfoResultType	GetInfo (const std::string &propertyName, bool allowNameRegEx=true) const =0
	Get the persistence info for a specific base data property. More...

virtual InfoResultType	GetInfo (const std::string &propertyName, const MimeTypeNameType &mime, bool allowMimeWildCard=false, bool allowNameRegEx=true) const =0
	Get the persistence info for a specific base data property and mime type. More...

virtual InfoResultType	GetInfoByKey (const std::string &persistenceKey, bool allowKeyRegEx=true) const =0
	Get the persistence info that will use the specified key. More...

virtual bool	HasInfo (const std::string &propertyName, bool allowNameRegEx=true) const =0
	Check if a specific base data property has persistence info. More...

virtual void	RemoveAllInfo ()=0
	Remove all persistence info. More...

virtual void	RemoveInfo (const std::string &propertyName)=0
	Remove persistence info instances of a specific property name/regex. More...

virtual void	RemoveInfo (const std::string &propertyName, const MimeTypeNameType &mime)=0
	Remove persistence info instances of a specific property name/regex and mime type. More...

Detailed Description

Interface of property persistence service.

This service allows you to manage persistence info for base data properties. Persistent properties will be saved if the file format supports custom key value pairs like the .nrrd file format.

Remarks: The service supports the use of regular expressions (regex; ECMAscript syntax) for property names and persistance keys to specifiy persistence rules in a generic way. The getter of the interface (GetInfo and GetInfoByKey) will always ensure that the return containes no regex, thus name and key in the results can directly be used. For details on how the result names and keys are determined, please

Definition at line 38 of file mitkIPropertyPersistence.h.

Member Typedef Documentation

using mitk::IPropertyPersistence::InfoResultType = std::list<PropertyPersistenceInfo::ConstPointer>

Definition at line 43 of file mitkIPropertyPersistence.h.

using mitk::IPropertyPersistence::MimeTypeNameType = PropertyPersistenceInfo::MimeTypeNameType

Definition at line 44 of file mitkIPropertyPersistence.h.

Constructor & Destructor Documentation

mitk::IPropertyPersistence::~IPropertyPersistence ( )

virtual

Definition at line 19 of file mitkIPropertyPersistence.cpp.

Member Function Documentation

virtual bool mitk::IPropertyPersistence::AddInfo	(	const PropertyPersistenceInfo *	info,
		bool	overwrite = `false`
	)

pure virtual

Add persistence info for a specific base data property. If there is already a property info instance for the passed property name and the same info, it won't be added. Info instances are regarded equal, if the mime types are equal. You may enforce to overwrite the old equal info for a property name by the overwrite parameter.

Parameters

[in]	propertyName	Name of the property.
[in]	info	Persistence info of the property.
[in]	overwrite	Overwrite already existing persistence info.

Returns: True if persistence info was added successfully.

Implemented in mitk::PropertyPersistence.

Referenced by mitk::DICOMTagsOfInterestService::AddTagOfInterest(), and mitk::ItkImageIO::Read().

virtual InfoResultType mitk::IPropertyPersistence::GetInfo	(	const std::string &	propertyName,
		bool	allowNameRegEx = `true`
	)		const

pure virtual

Get the persistence info for a specific base data property.

Parameters

[in]	propertyName	Name of the property.
[in]	allowNameRegEx	Indicates if also added info instances with regexs are being checked.

Returns: Property persistence info or null pointer if no persistence info is available.

Implemented in mitk::PropertyPersistence.

Referenced by mitk::ItkImageIO::Write().

virtual InfoResultType mitk::IPropertyPersistence::GetInfo	(	const std::string &	propertyName,
		const MimeTypeNameType &	mime,
		bool	allowMimeWildCard = `false`,
		bool	allowNameRegEx = `true`
	)		const

pure virtual

Get the persistence info for a specific base data property and mime type.

Parameters

[in]	propertyName	Name of the property.
[in]	mime	Name of the mime type the info is specified for.
[in]	allowMimeWildCard	Indicates if wildcard is allowed. If it is allowed, the method will first try to find the specified info. If no info was found but an info exists with the mime type name PropertyPersistenceInfo::ANY_MIMETYPE_NAME(), the later info will be returned as fall back option.
[in]	allowNameRegEx	Indicates if also added info instances with regexs are being checked.

Returns: Property persistence info or null pointer if no persistence info is available.

Implemented in mitk::PropertyPersistence.

virtual InfoResultType mitk::IPropertyPersistence::GetInfoByKey	(	const std::string &	persistenceKey,
		bool	allowKeyRegEx = `true`
	)		const

pure virtual

Get the persistence info that will use the specified key.

Parameters

[in]	propertyName	Name of the property.
[in]	allowKeyRegEx	Indicates if also added info instances with regexs for the key are being checked.

Returns: Property persistence info or null pointer if no persistence info is available.

Implemented in mitk::PropertyPersistence.

Referenced by mitk::ItkImageIO::Read().

virtual bool mitk::IPropertyPersistence::HasInfo	(	const std::string &	propertyName,
		bool	allowNameRegEx = `true`
	)		const

pure virtual

Check if a specific base data property has persistence info.

Parameters

[in]	propertyName	Name of the property.
[in]	allowNameRegEx	Indicates if also added info instances with regexs are being checked.

Returns: True if the property has persistence info, false otherwise.

Implemented in mitk::PropertyPersistence.

virtual void mitk::IPropertyPersistence::RemoveAllInfo ( )

pure virtual

Remove all persistence info.

Implemented in mitk::PropertyPersistence.

virtual void mitk::IPropertyPersistence::RemoveInfo ( const std::string & propertyName )

pure virtual

Remove persistence info instances of a specific property name/regex.

Parameters

[in] propertyName Registered name or regex that should be removed.

Implemented in mitk::PropertyPersistence.

Referenced by mitk::DICOMTagsOfInterestService::RemoveAllTags(), and mitk::DICOMTagsOfInterestService::RemoveTag().

virtual void mitk::IPropertyPersistence::RemoveInfo	(	const std::string &	propertyName,
		const MimeTypeNameType &	mime
	)

pure virtual

Remove persistence info instances of a specific property name/regex and mime type.

Parameters

[in]	propertyName	Registered name or regex that should be removed.
[in]	mime	Name of the mime type.

Implemented in mitk::PropertyPersistence.

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

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation