XmlConfigDocument.hpp

 
//
//  Copyright Phoenix Contact GmbH & Co. KG
//
#pragma once
#include "Arp/System/Core/Arp.h"
#include "Arp/System/Commons/Xml/IXmlSerializable.hpp"
#include "Arp/System/Commons/Xml/XmlSerializationContext.hpp"
#include "Arp/System/Commons/Configuration/ConfigSettings.hpp"
#include "Arp/System/Commons/Xml/DocumentTraits.hpp"
 
namespace Arp { namespace System { namespace Commons { namespace Xml
{
 
// forwards
class MultiXmlConfigDocument;
 
// TContent policy: implement IXmlSerializable and default contructable
class XmlConfigDocument
{
    friend class XmlSerializationContext;
 
public: // construction/destruction
    XmlConfigDocument(const String& documentXmlElementName, IXmlSerializable& content);
    XmlConfigDocument(MultiXmlConfigDocument& rootDocument, IXmlSerializable& content);
    virtual ~XmlConfigDocument(void) = default;
 
public: // setter/getter operations
    const String&           GetPath(void)const;
    IXmlSerializable&       GetContent(void);
    MultiXmlConfigDocument* GetRootDocument(void);
    Version                 GetRecentVersion(void)const;
    const DocumentTraits&   GetTraits(void)const;
 
public: // operations
    void    Load(const String& documentPath);
    void    Load(const String& documentPath, const DocumentTraits& documentTraits);
    bool    TryLoad(const String& documentPath);
    bool    TryLoad(const String& documentPath, const DocumentTraits& documentTraits);
    void    Save(const String& documentPath);
    void    Save(const String& documentPath, bool syncFilesystem);
    void    Save(const String& documentPath, bool syncFilesystem, const Version& schemaVersion);
    void    Save(void);
    void    Save(bool syncFilesystem);
    void    LoadString(const String& xmlContent, const String& contentTraits = String::Empty);
 
protected: // virtual methods to override
    virtual void    ReadDocument(XmlReader& reader);
 
private: // deleted methods
    XmlConfigDocument(const XmlConfigDocument& arg) = delete;
    XmlConfigDocument& operator=(const XmlConfigDocument& arg) = delete;
 
protected: // fields
    MultiXmlConfigDocument* pRootDoc;
    IXmlSerializable&       content;
    String                  documentXmlElementName;
    String                  path;
    DocumentTraits          traits;
    Version                 recentVersion;
};
 
}}}} // end of namespace Arp::System::Commons::Xml