XmlSerializationContext.hpp

 
//
//  Copyright Phoenix Contact GmbH & Co. KG
//
#pragma once
#include "Arp/System/Core/Arp.h"
#include "Arp/System/Commons/Logging.h"
#include "Arp/System/Commons/Diagnostics/Logging/Loggable.hxx"
#include "Arp/System/Commons/Exceptions/KeyNotFoundException.hpp"
#include "Arp/System/Commons/Configuration/PlaceholderExpression.hpp"
 
namespace Arp { namespace System { namespace Commons { namespace Xml
{
 
using namespace Arp::System::Commons::Configuration;
 
// forwards
class XmlReader;
class XmlWriter;
class XmlConfigDocument;
class MultiXmlConfigDocument;
class DocumentTraits;
 
class XmlSerializationContext : private Loggable<XmlSerializationContext>
{
    friend class MultiXmlConfigDocument;
 
private: // typedefs
    typedef std::map<String, String>    Attributes;
 
public: // construction/destruction
    XmlSerializationContext(XmlConfigDocument& document,  Version docSchemaVersion = Version(1, 0));
    XmlSerializationContext(XmlSerializationContext& arg) = default;
    XmlSerializationContext& operator=(XmlSerializationContext& arg) = default;
    ~XmlSerializationContext(void) = default;
 
public: // operators
    String&         operator[](const String& attributeName);
    const String&   operator[](const String& attributeName)const;
 
public: // static properties
    static const char* IncludeXmlName;
    static const char* IncludesXmlName;
 
public: // setter/getter operations
    Version             GetDocumentSchemaVersion(void) const;
    XmlConfigDocument&  GetDocument(void);
 
public: // operations
    void    ReadDocumentContext(XmlReader& reader);
    void    WriteDocumentContext(XmlWriter& writer)const;
    void    InvalidXmlElementOccurs(XmlReader& reader, const char* xmlElementName);
    void    MissingXmlElementOccurs(XmlReader& reader, const char* xmlElementName);
    void    ReadIncludesElement(XmlReader& reader);
    String  ResolvePath(const char* documentPath);
    String  ResolveRelativePath(const String& path);
    String  ResolvePlaceholder(const char* input);
    DocumentTraits  DetermineDocumentTraits(XmlReader& reader)const;
    void    AddIncludeFile(const String& pathArg, const DocumentTraits& traits);
    void    AddAttribute(const String& attributeName, const String& value);
    bool    HasAttribute(const String& attributeName);
    bool    HasAttributeValue(const String& attributeName, const String& expectedValue);
    String  GetAttributeValue(const String& attributeName);
    const DocumentTraits& GetDocumentTraits(void)const;
 
private: // static methods
    static void ResolveWildcards(const String& path, const DocumentTraits& traits, MultiXmlConfigDocument& doc);
 
private: // methods
    void    ResolveWildcards(const String& path, const DocumentTraits& traits);
 
private: // fields
    XmlConfigDocument&    document;
    Version               documentSchemaVersion;
    Attributes            additionalAttributes;
    PlaceholderExpression placeholderExpression;
 
private: // static fields
    static const char* traitsXmlName;
};
 
}}}} // end of namespace Arp::System::Commons::Xml