datamodel_xml_configuration.h File Reference

#include <a_util/base/enums.h>
#include <ddl/mapping/datamodel/datamodel_configuration.h>
#include <string>

Include dependency graph for datamodel_xml_configuration.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces
namespace	ddl
	definition of the ddl namespace
namespace	ddl::mapping
	definition of the mapping namespace

Functions
MappingConfiguration	ddl::mapping::datamodel::fromXMLString (const std::string &xml_string, const mapping::Version &version={})
	creates a datamodel from a xml string
std::string	ddl::mapping::datamodel::toXMLString (const MappingConfiguration &config)
	creates a XML from the MappingConfiguration.
MappingConfiguration	ddl::mapping::datamodel::fromXMLFile (const std::string &xml_filepath)
	creates a datamodel from a xml file
void	ddl::mapping::datamodel::toXMLFile (const MappingConfiguration &config, const std::string &xml_filepath)
	creates a XML file from the given MappingConfiguration datamodel.
void	ddl::mapping::datamodel::toXMLFile (const MappingConfiguration &config, const std::string &xml_filepath, a_util::SortingOrder order)
	creates a XML file from the given MappingConfiguration datamodel.

Detailed Description

MappingConfiguration datamodel XML reader and writer

Copyright

Copyright 2025 Digitalwerk GmbH.

    This Source Code Form is subject to the terms of the Mozilla
    Public License, v. 2.0. If a copy of the MPL was not distributed
    with this file, You can obtain one at https://mozilla.org/MPL/2.0/.

If it is not possible or desirable to put the notice in a particular file, then
You may include the notice in a location (such as a LICENSE file in a
relevant directory) where a recipient would be likely to look for such a notice.

You may add additional accurate notices of copyright ownership.

Function Documentation

fromXMLFile()

MappingConfiguration ddl::mapping::datamodel::fromXMLFile

(

const std::string &

xml_filepath

)

creates a datamodel from a xml file

Parameters

xml_filepath

a valid file path (if relative the current working directory is base)

Returns

MappingConfiguration

Exceptions

throws

mapping::Error if the XML given is not valid. More information on exception.

fromXMLString()

MappingConfiguration ddl::mapping::datamodel::fromXMLString	(	const std::string &	xml_string,
		const mapping::Version &	version = {} )

creates a datamodel from a xml string

Parameters

xml_string	the string as xml
version	the mapping version to set into model if possible

Returns

MappingConfiguration

Exceptions

throws

mapping::Error if the XML given is not valid. More information on exception.

toXMLFile() [1/2]

void ddl::mapping::datamodel::toXMLFile	(	const MappingConfiguration &	config,
		const std::string &	xml_filepath )

creates a XML file from the given MappingConfiguration datamodel.

Parameters

config	the MappingConfiguration the xml file is to create
xml_filepath	a valid file path (if relative the current working directory is base)

Exceptions

throws

mapping::Error if the version of the config is not valid for the items used within model.

toXMLFile() [2/2]

void ddl::mapping::datamodel::toXMLFile	(	const MappingConfiguration &	config,
		const std::string &	xml_filepath,
		a_util::SortingOrder	order )

creates a XML file from the given MappingConfiguration datamodel.

Parameters

config	the MappingConfiguration the xml file is to create
xml_filepath	a valid file path (if relative the current working directory is base)
order	Sort nodes either in ascending or in descending order

Exceptions

throws

mapping::Error if the version of the config is not valid for the items used within model.

toXMLString()

std::string ddl::mapping::datamodel::toXMLString

(

const MappingConfiguration &

config

)

creates a XML from the MappingConfiguration.

Parameters

config

the MappingConfiguration the xml string is to create

Returns

std::string the xml string