SAP ABAP Class CL_DBA_XML_UTILS (DBA: XML utilities)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-DB (Application Component) Database Interface, Database Platforms
     ⤷ SDBA_RUNTIME (Package) DBA Cockpit: Runtime

Properties

Class	CL_DBA_XML_UTILS
Short Description	DBA: XML utilities
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SDBA_RUNTIME	DBA Cockpit: Runtime
Created	20060713	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_DBA_XML_UTILS has no forward declaration.

Interfaces

Class CL_DBA_XML_UTILS has no interface implemented.

Friends

Class CL_DBA_XML_UTILS has no friend class.

Attributes

Class CL_DBA_XML_UTILS has no attribute.

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_ATTRIBUTE	Static method	Private	Method		20060822
2	ADD_ELEMENT	Static method	Private	Method	Adds an element to the document under the parent node.	20060821
3	ADD_LPATH	Static method	Public	Method	Adds the node(s) specified by location path.	20060816
4	CHECK_LPATH	Static method	Private	Method	Checks, if provided lpath expression is lpath not xpath.	20060816
5	DELETE_XPATH	Static method	Public	Method	Deletes the node specified by location path.	20060829
6	EVALUATE_XPATH	Static method	Public	Method	Evaluates an XPath expression and returns the nodes.	20060713
7	EVALUATE_XPATH_AS_NUMBER	Static method	Public	Method	Evaluates an XPath expression and returns the node value.	20060829
8	EVALUATE_XPATH_AS_STRING	Static method	Public	Method	Evaluates an XPath expression and returns the node value.	20060714
9	PARSE_AXIS	Static method	Private	Method	Parses the axis specifier.	20060821
10	PARSE_XML_TO_DOM	Static method	Public	Method	Parses an XML document to a DOM tree.	20060713
11	SCREENWRITER	Static method	Public	Method	Writes Documents, Nodes, Node Collections to screen.	20060713
12	SERIALIZE_CSTR_TO_FILE	Static method	Public	Method	Serializes a stream to a file.	20061010
13	SERIALIZE_DOM_TO_FILE	Static method	Public	Method	Serializes a DOM tree to a file.	20061010
14	SERIALIZE_DOM_TO_PRETTY_XML	Static method	Public	Method	Serializes a DOM tree to a string table in pretty print mode	20061013
15	SERIALIZE_DOM_TO_XML_AS_CSTR	Static method	Public	Method	Serializes a DOM tree to an XML document as cstring.	20060713
16	SERIALIZE_DOM_TO_XML_AS_XSTR	Static method	Public	Method	Serializes a DOM tree to an XML document as xstring.	20060713
17	UPDATE_LPATH	Static method	Public	Method	Updates the node specified by location path.	20060714

Events

Class CL_DBA_XML_UTILS has no event.

Types

Class CL_DBA_XML_UTILS has no local type.

Method Signatures

Method ADD_ATTRIBUTE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ATTRIBUTE	Value transfer	☐	Type reference (TYPE)	DBA_XML_NODE			20060822
2	Importing	PARENT	Call by reference	☑	Object reference (TYPE REF TO)	IF_IXML_NODE			20060822
3	Importing	XML_DOCUMENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_DOCUMENT			20060822

#	Exception	Resumable	Description	Created on
1	CX_DBA_XML_ERROR	☐	DBA Cockpit: XML parser error	20060822

Method ADD_ELEMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ATTRIBUTE	Value transfer	☑	Type reference (TYPE)	DBA_XML_NODE			20060821
2	Importing	ELEMENT	Value transfer	☐	Type reference (TYPE)	DBA_XML_NODE			20060821
3	Importing	FILTER	Value transfer	☑	Type reference (TYPE)	DBA_XML_NODE		DBA: XML node	20080318
4	Importing	PARENT	Call by reference	☑	Object reference (TYPE REF TO)	IF_IXML_NODE			20060821
5	Importing	XML_DOCUMENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_DOCUMENT			20060821

#	Exception	Resumable	Description	Created on
1	CX_DBA_XML_ERROR	☐		20060821

Method ADD_LPATH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	EXPRESSION	Call by reference	☐	Type reference (TYPE)	STRING			20060829
2	Importing	NAMESPACES_TAB	Call by reference	☑	Type reference (TYPE)	DBA_XML_NAMESPACE_TAB			20060816
3	Importing	VALUE_NUMBER	Call by reference	☑	Type reference (TYPE)	I			20060828
4	Importing	VALUE_STRING	Call by reference	☐	Type reference (TYPE)	STRING	'@@EMPTY_STRING@@'		20060828
5	Importing	VALUE_TREE	Call by reference	☑	Object reference (TYPE REF TO)	IF_IXML_NODE		IF_IXML_NODE	20060828
6	Importing	XML_DOCUMENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_DOCUMENT			20060816
7	Importing	XML_NODE	Call by reference	☑	Object reference (TYPE REF TO)	IF_IXML_NODE		IF_IXML_NODE	20060828
8	Importing	XSLT_PROCESSOR	Call by reference	☑	Object reference (TYPE REF TO)	CL_XSLT_PROCESSOR		XSLT processor	20060828

#	Exception	Resumable	Description	Created on
1	CX_DBA_XML_ERROR	☐	DBA Cockpit: XML parser error	20060816

Method CHECK_LPATH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	EXPRESSION	Call by reference	☐	Type reference (TYPE)	STRING			20060829

#	Exception	Resumable	Description	Created on
1	CX_DBA_XML_ERROR	☐	DBA Cockpit: XML parser error	20060816

Method DELETE_XPATH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	EXPRESSION	Call by reference	☐	Type reference (TYPE)	STRING			20060829
2	Importing	NAMESPACES_TAB	Call by reference	☑	Type reference (TYPE)	DBA_XML_NAMESPACE_TAB			20060829
3	Importing	XML_DOCUMENT	Call by reference	☑	Object reference (TYPE REF TO)	IF_IXML_DOCUMENT			20060829
4	Importing	XML_NODE	Call by reference	☑	Object reference (TYPE REF TO)	IF_IXML_NODE		IF_IXML_NODE	20060829

#	Exception	Resumable	Description	Created on
1	CX_DBA_XML_ERROR	☐		20060829

Method EVALUATE_XPATH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	EXPRESSION	Call by reference	☐	Type reference (TYPE)	STRING			20060829
2	Importing	NAMESPACES_TAB	Call by reference	☑	Type reference (TYPE)	DBA_XML_NAMESPACE_TAB		DBA: XML namespace table	20060713
3	Returning	RESULTSET	Value transfer	☐	Object reference (TYPE REF TO)	IF_IXML_NODE_COLLECTION		IF_IXML_NODE_COLLECTION	20060713
4	Importing	XML_CSTRING	Call by reference	☑	Type reference (TYPE)	STRING			20060713
5	Importing	XML_DOCUMENT	Call by reference	☑	Object reference (TYPE REF TO)	IF_IXML_DOCUMENT		IF_IXML_DOCUMENT	20060713
6	Importing	XML_NODE	Call by reference	☑	Object reference (TYPE REF TO)	IF_IXML_NODE		IF_IXML_NODE	20060828
7	Importing	XML_STREAM	Call by reference	☑	Object reference (TYPE REF TO)	IF_IXML_ISTREAM		IF_IXML_ISTREAM	20060713
8	Importing	XML_XSTRING	Call by reference	☑	Type reference (TYPE)	XSTRING			20060713
9	Importing	XSLT_PROCESSOR	Call by reference	☑	Object reference (TYPE REF TO)	CL_XSLT_PROCESSOR		XSLT processor	20060828

#	Exception	Resumable	Description	Created on
1	CX_DBA_XML_ERROR	☐	DBA Cockpit: XML parser error	20060714

Method EVALUATE_XPATH_AS_NUMBER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	EXPRESSION	Call by reference	☐	Type reference (TYPE)	STRING			20060829
2	Importing	NAMESPACES_TAB	Call by reference	☑	Type reference (TYPE)	DBA_XML_NAMESPACE_TAB			20060829
3	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	I			20060829
4	Importing	XML_CSTRING	Call by reference	☑	Type reference (TYPE)	STRING			20060829
5	Importing	XML_DOCUMENT	Call by reference	☑	Object reference (TYPE REF TO)	IF_IXML_DOCUMENT			20060829
6	Importing	XML_NODE	Call by reference	☑	Object reference (TYPE REF TO)	IF_IXML_NODE			20060829
7	Importing	XML_STREAM	Call by reference	☑	Object reference (TYPE REF TO)	IF_IXML_ISTREAM			20060829
8	Importing	XML_XSTRING	Call by reference	☑	Type reference (TYPE)	XSTRING			20060829
9	Importing	XSLT_PROCESSOR	Call by reference	☑	Object reference (TYPE REF TO)	CL_XSLT_PROCESSOR			20060829

#	Exception	Resumable	Description	Created on
1	CX_DBA_XML_ERROR	☐		20060829

Method EVALUATE_XPATH_AS_STRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	EXPRESSION	Call by reference	☐	Type reference (TYPE)	STRING			20060829
2	Importing	NAMESPACES_TAB	Call by reference	☑	Type reference (TYPE)	DBA_XML_NAMESPACE_TAB			20060714
3	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	STRING			20060714
4	Importing	XML_CSTRING	Call by reference	☑	Type reference (TYPE)	STRING			20060714
5	Importing	XML_DOCUMENT	Call by reference	☑	Object reference (TYPE REF TO)	IF_IXML_DOCUMENT			20060714
6	Importing	XML_NODE	Call by reference	☑	Object reference (TYPE REF TO)	IF_IXML_NODE		IF_IXML_NODE	20060829
7	Importing	XML_STREAM	Call by reference	☑	Object reference (TYPE REF TO)	IF_IXML_ISTREAM			20060714
8	Importing	XML_XSTRING	Call by reference	☑	Type reference (TYPE)	XSTRING			20060714
9	Importing	XSLT_PROCESSOR	Call by reference	☑	Object reference (TYPE REF TO)	CL_XSLT_PROCESSOR			20060828

#	Exception	Resumable	Description	Created on
1	CX_DBA_XML_ERROR	☐		20060714

Method PARSE_AXIS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	AXIS	Value transfer	☐	Type reference (TYPE)	DBA_XML_AXIS		DBA_ XML axis	20060821
2	Importing	AXIS_EXPRESSION	Call by reference	☐	Type reference (TYPE)	STRING			20060821
3	Importing	NAMESPACES_TAB	Call by reference	☑	Type reference (TYPE)	DBA_XML_NAMESPACE_TAB			20060821

#	Exception	Resumable	Description	Created on
1	CX_DBA_XML_ERROR	☐	DBA Cockpit: XML parser error	20060821

Method PARSE_XML_TO_DOM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	DOCUMENT	Value transfer	☐	Object reference (TYPE REF TO)	IF_IXML_DOCUMENT		IF_IXML_DOCUMENT	20060713
2	Importing	IXML_REF	Call by reference	☑	Object reference (TYPE REF TO)	IF_IXML		IF_IXML	20060714
3	Importing	IXML_STREAM_FACTORY_REF	Call by reference	☑	Object reference (TYPE REF TO)	IF_IXML_STREAM_FACTORY			20060714
4	Importing	XML_CSTRING	Call by reference	☑	Type reference (TYPE)	STRING			20060713
5	Importing	XML_STRING	Call by reference	☑	Type reference (TYPE)	STRING			20060713
6	Importing	XML_XSTRING	Call by reference	☑	Type reference (TYPE)	XSTRING			20060713

#	Exception	Resumable	Description	Created on
1	CX_DBA_XML_ERROR	☐	DBA Cockpit: XML parser error	20060714

Method SCREENWRITER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	INDENT	Call by reference	☑	Type reference (TYPE)	STRING	''		20060713
2	Importing	XML_DOCUMENT	Call by reference	☑	Object reference (TYPE REF TO)	IF_IXML_DOCUMENT		IF_IXML_DOCUMENT	20060713
3	Importing	XML_NODE	Call by reference	☑	Object reference (TYPE REF TO)	IF_IXML_NODE		IF_IXML_NODE	20060713
4	Importing	XML_NODES_COLLECTION	Call by reference	☑	Object reference (TYPE REF TO)	IF_IXML_NODE_COLLECTION		IF_IXML_NODE_COLLECTION	20060713
5	Importing	XML_NODES_LIST	Call by reference	☑	Object reference (TYPE REF TO)	IF_IXML_NODE_LIST		IF_IXML_NODE_LIST	20060713

Method SCREENWRITER on class CL_DBA_XML_UTILS has no exception.

Method SERIALIZE_CSTR_TO_FILE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FILE_CONTENT	Value transfer	☐	Type reference (TYPE)	STRING			20061010
2	Importing	FILE_PATH	Call by reference	☐	Type reference (TYPE)	STRING			20061010

Method SERIALIZE_CSTR_TO_FILE on class CL_DBA_XML_UTILS has no exception.

Method SERIALIZE_DOM_TO_FILE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DOCUMENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_DOCUMENT		IF_IXML_DOCUMENT	20061010
2	Importing	FILE_PATH	Call by reference	☐	Type reference (TYPE)	STRING			20061010
3	Importing	IXML_REF	Call by reference	☑	Object reference (TYPE REF TO)	IF_IXML			20061010
4	Importing	IXML_STREAM_FACTORY_REF	Call by reference	☑	Object reference (TYPE REF TO)	IF_IXML_STREAM_FACTORY			20061010

Method SERIALIZE_DOM_TO_FILE on class CL_DBA_XML_UTILS has no exception.

Method SERIALIZE_DOM_TO_PRETTY_XML Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	INDENT	Call by reference	☐	Type reference (TYPE)	STRING	''		20061013
2	Changing	RESULT	Call by reference	☐	Type reference (TYPE)	DB6_STRING_TAB		Result as table of strings.	20061013
3	Importing	XML_DOCUMENT	Call by reference	☑	Object reference (TYPE REF TO)	IF_IXML_DOCUMENT		IF_IXML_DOCUMENT	20061013
4	Importing	XML_NODE	Call by reference	☑	Object reference (TYPE REF TO)	IF_IXML_NODE		IF_IXML_NODE	20061013
5	Importing	XML_NODES_COLLECTION	Call by reference	☑	Object reference (TYPE REF TO)	IF_IXML_NODE_COLLECTION		IF_IXML_NODE_COLLECTION	20061013
6	Importing	XML_NODES_LIST	Call by reference	☑	Object reference (TYPE REF TO)	IF_IXML_NODE_LIST		IF_IXML_NODE_LIST	20061013

Method SERIALIZE_DOM_TO_PRETTY_XML on class CL_DBA_XML_UTILS has no exception.

Method SERIALIZE_DOM_TO_XML_AS_CSTR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DOCUMENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_DOCUMENT		IF_IXML_DOCUMENT	20060713
2	Importing	IXML_REF	Call by reference	☑	Object reference (TYPE REF TO)	IF_IXML			20060714
3	Importing	IXML_STREAM_FACTORY_REF	Call by reference	☑	Object reference (TYPE REF TO)	IF_IXML_STREAM_FACTORY			20060714
4	Returning	XML	Value transfer	☐	Type reference (TYPE)	STRING			20060713

Method SERIALIZE_DOM_TO_XML_AS_CSTR on class CL_DBA_XML_UTILS has no exception.

Method SERIALIZE_DOM_TO_XML_AS_XSTR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DOCUMENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_DOCUMENT		IF_IXML_DOCUMENT	20060713
2	Importing	IXML_REF	Call by reference	☑	Object reference (TYPE REF TO)	IF_IXML			20060714
3	Importing	IXML_STREAM_FACTORY_REF	Call by reference	☑	Object reference (TYPE REF TO)	IF_IXML_STREAM_FACTORY			20060714
4	Returning	XML	Value transfer	☐	Type reference (TYPE)	XSTRING			20060713

Method SERIALIZE_DOM_TO_XML_AS_XSTR on class CL_DBA_XML_UTILS has no exception.

Method UPDATE_LPATH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	EXPRESSION	Call by reference	☐	Type reference (TYPE)	STRING			20060829
2	Importing	NAMESPACES_TAB	Call by reference	☑	Type reference (TYPE)	DBA_XML_NAMESPACE_TAB			20060810
3	Importing	VALUE_NUMBER	Call by reference	☑	Type reference (TYPE)	I			20060828
4	Importing	VALUE_STRING	Call by reference	☐	Type reference (TYPE)	STRING	'@@EMPTY_STRING@@'		20060828
5	Importing	VALUE_TREE	Call by reference	☑	Object reference (TYPE REF TO)	IF_IXML_NODE		IF_IXML_NODE	20060828
6	Importing	XML_DOCUMENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_DOCUMENT			20060810
7	Importing	XML_NODE	Call by reference	☑	Object reference (TYPE REF TO)	IF_IXML_NODE		IF_IXML_NODE	20060828
8	Importing	XSLT_PROCESSOR	Call by reference	☑	Object reference (TYPE REF TO)	CL_XSLT_PROCESSOR		XSLT processor	20060828

#	Exception	Resumable	Description	Created on
1	CX_DBA_XML_ERROR	☐	DBA Cockpit: XML parser error	20061011

History

Last changed by/on	SAP	20110908
SAP Release Created in	710