Difference between revisions of "Extensions.Xml"
Jump to navigation
Jump to search
(Created page with "{{DISPLAYTITLE:OTX '''Xml''' Extension}}Category:OTX-ExtensionCategory:Xml == Classification == {{ClassificationExtension | Xml | UPDATING... | OtxReference#Extensio...") |
|||
| (5 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:OTX '''Xml''' Extension}}[[Category:OTX-Extension]][[Category:Xml]] | {{DISPLAYTITLE:OTX '''Xml''' Extension}}[[Category:OTX-Extension]][[Category:Xml]] | ||
== Classification == | == Classification == | ||
| − | {{ClassificationExtension | Xml | | + | {{ClassificationExtension | Xml | Reads and interprets '''XML''' documents from the file system or any other source | [[OtxReference#Extensions|OTX Extension]] | - | - }} |
== Introduction == | == Introduction == | ||
| − | + | The '''Xml''' extension makes it possible to read and interpret '''XML''' documents from the file system or any other source. It allows modification of existing documents and creation of new documents. | |
| + | |||
| + | The extension follows the Document Object Model (DOM) approach. It offers actions, terms, and data types for basic tasks such as navigating to child elements, adding e.g. adding a processing instruction to a document. | ||
| + | |||
| + | It is, however, it is not intended as a general-purpose DOM API. Use cases which are not expected in the domain of vehicle diagnostics (e.g. reading comments) are not covered by this extension. | ||
| + | |||
| + | For reasons of interoperability and exchangeability, the usage of relative paths is recommended. | ||
== Actions == | == Actions == | ||
| Line 37: | Line 43: | ||
{{TableRowKeyValueList|[[Extensions.Xml.XmlLoadFromFile|XmlLoadFromFile]]|}} | {{TableRowKeyValueList|[[Extensions.Xml.XmlLoadFromFile|XmlLoadFromFile]]|}} | ||
{{TableRowKeyValueList|[[Extensions.Xml.XmlToByteField|XmlToByteField]]|}} | {{TableRowKeyValueList|[[Extensions.Xml.XmlToByteField|XmlToByteField]]|}} | ||
| − | |||
|} | |} | ||
| Line 52: | Line 57: | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
| + | {{TableRowKeyValueList|[[Extensions.Xml.XmlChangeException|XmlChangeException]]|}} | ||
{{TableRowKeyValueList|[[Extensions.Xml.XmlException|XmlException]]|}} | {{TableRowKeyValueList|[[Extensions.Xml.XmlException|XmlException]]|}} | ||
{{TableRowKeyValueList|[[Extensions.Xml.XmlFormatException|XmlFormatException]]|}} | {{TableRowKeyValueList|[[Extensions.Xml.XmlFormatException|XmlFormatException]]|}} | ||
{{TableRowKeyValueList|[[Extensions.Xml.XPathException|XPathException]]|}} | {{TableRowKeyValueList|[[Extensions.Xml.XPathException|XPathException]]|}} | ||
| + | |||
| + | |} | ||
| + | |||
| + | == Checker Rules == | ||
| + | {| {{TableHeader}} | ||
| + | |||
| + | {{TableRowKeyValueList|[[Extensions.Xml.XmlChk001|Xml_Chk001]]|Type-safe SetXmlElementAttributes}} | ||
| + | {{TableRowKeyValueList|[[Extensions.Xml.XmlChk002|Xml_Chk002]]|Type-safe CreateXmlElement}} | ||
| + | {{TableRowKeyValueList|[[Extensions.Xml.XmlChk003 |Xml_Chk003 ]]|Type-safe GetXmlElementAttributes}} | ||
|} | |} | ||
Latest revision as of 10:23, 5 October 2018
Contents
Classification
| Name | Xml |
| Short Description | Reads and interprets XML documents from the file system or any other source |
| Class | OTX Extension |
| Base Extension | - |
| Pre-Conditions | - |
| Specified by | ISO 13209-3 |
Introduction
The Xml extension makes it possible to read and interpret XML documents from the file system or any other source. It allows modification of existing documents and creation of new documents.
The extension follows the Document Object Model (DOM) approach. It offers actions, terms, and data types for basic tasks such as navigating to child elements, adding e.g. adding a processing instruction to a document.
It is, however, it is not intended as a general-purpose DOM API. Use cases which are not expected in the domain of vehicle diagnostics (e.g. reading comments) are not covered by this extension.
For reasons of interoperability and exchangeability, the usage of relative paths is recommended.
Actions
| AddXmlChildElement | |
| DeleteXmlAttribute | |
| DeleteXmlChildElement | |
| SetXmlComment | |
| SetXmlElementAttribute | |
| SetXmlElementAttributes | |
| SetXmlElementText | |
| SetXmlProcessingInstructions | |
| ValidateXml | |
| XmlSaveToFile |
Terms
Data Types
| XmlDocument | |
| XmlElement |
Exceptions
| XmlChangeException | |
| XmlException | |
| XmlFormatException | |
| XPathException |
Checker Rules
| Xml_Chk001 | Type-safe SetXmlElementAttributes |
| Xml_Chk002 | Type-safe CreateXmlElement |
| Xml_Chk003 | Type-safe GetXmlElementAttributes |
