mitkPropertyPersistenceInfo.h

Go to the documentation of this file.

/*============================================================================

The Medical Imaging Interaction Toolkit (MITK)

Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.

Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.

============================================================================*/

#ifndef mitkPropertyPersistenceInfo_h
#define mitkPropertyPersistenceInfo_h

#include <functional>

#include <mitkBaseProperty.h>
#include <mitkCommon.h>

#include <MitkCoreExports.h>
#include <itkObjectFactory.h>

namespace mitk
{
  class MITKCORE_EXPORT PropertyPersistenceInfo : public itk::LightObject
  {
  public:
    using DeserializationFunctionType = std::function<mitk::BaseProperty::Pointer(const std::string &)>;
    using SerializationFunctionType = std::function<std::string(const mitk::BaseProperty *)>;
    using MimeTypeNameType = std::string;

    mitkClassMacroItkParent(PropertyPersistenceInfo, itk::LightObject);
    itkFactorylessNewMacro(Self);
    itkCloneMacro(Self) mitkNewMacro1Param(Self, const std::string &);
    mitkNewMacro2Param(Self, const std::string &, const std::string &);

    std::string GetName() const;
    std::string GetKey() const;
    void SetName(const std::string &name);
    void SetNameAndKey(const std::string &name, const std::string &key);

    bool IsRegEx() const;

    void UseRegEx(const std::string &nameRegEx, const std::string &nameTemplate);
    void UseRegEx(const std::string &nameRegEx,
                  const std::string &nameTemplate,
                  const std::string &keyRegEx,
                  const std::string keyTemplate);

    const std::string &GetKeyTemplate() const;
    const std::string &GetNameTemplate() const;

    const MimeTypeNameType &GetMimeTypeName() const;
    void SetMimeTypeName(const MimeTypeNameType &mimeTypeName);

    const DeserializationFunctionType GetDeserializationFunction() const;
    void SetDeserializationFunction(const DeserializationFunctionType &fnc);

    const SerializationFunctionType GetSerializationFunction() const;
    void SetSerializationFunction(const SerializationFunctionType &fnc);

    PropertyPersistenceInfo::Pointer UnRegExByName(const std::string &propertyName) const;
    PropertyPersistenceInfo::Pointer UnRegExByKey(const std::string &key) const;

    static MimeTypeNameType ANY_MIMETYPE_NAME();

  protected:
    PropertyPersistenceInfo(const std::string &name = "");

    PropertyPersistenceInfo(const std::string &name, const std::string &mimeTypeName);

    ~PropertyPersistenceInfo() override;

    void PrintSelf(std::ostream &os, itk::Indent indent) const override;

  private:
    PropertyPersistenceInfo(const Self &other);
    Self &operator=(const Self &other);

    struct Impl;
    Impl *m_Impl;
  };

  MITKCORE_EXPORT std::ostream &operator<<(std::ostream &os, const PropertyPersistenceInfo &info);

  namespace PropertyPersistenceSerialization
  {
    MITKCORE_EXPORT::std::string serializeByGetValueAsString(const mitk::BaseProperty *prop);
  }

  namespace PropertyPersistenceDeserialization
  {
    MITKCORE_EXPORT mitk::BaseProperty::Pointer deserializeToStringProperty(const std::string &value);
  }
}

#endif