SAP ABAP Class /TDAG/CPCL_CFPXML (CP: CfPXML handler)

Hierarchy

☛ TDAGBCA (Software Component) TechniData Basic Components
   ⤷ EHS (Application Component) Environment, Health and Safety
     ⤷ /TDAG/CP_EX (Package) CP: Report generation and export

Properties

Class	/TDAG/CPCL_CFPXML
Short Description	CP: CfPXML handler
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	/TDAG/CP_EX	CP: Report generation and export
Created	20070118	SAP
Last change	20141109	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	ESP1	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class /TDAG/CPCL_CFPXML has no interface implemented.

Friends

Class /TDAG/CPCL_CFPXML has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MT_INDEX1	Instance attribute	Protected	☐	Type reference (TYPE)	/TDAG/CPYH_XML_IDX1		CP: CfPXML index hashed table	20070118
2	MT_INDEX2	Instance attribute	Protected	☐	Type reference (TYPE)	/TDAG/CPYH_XML_IDX2		CP: CfPXML index hashed table	20070118
3	MT_INDEX3	Instance attribute	Protected	☐	Type reference (TYPE)	/TDAG/CPYH_XML_IDX3		CP: CfPXML index hashed table	20070118
4	MT_LONGTEXT	Instance attribute	Protected	☐	Type reference (TYPE)	/TDAG/CPY_XML_LONGTEXT		CP: Table type for CfPXML long text	20070213
5	MT_XML	Instance attribute	Protected	☐	Type reference (TYPE)	/TDAG/CPY_XML		XML elements table	20070118
6	M_LAST_ID	Instance attribute	Protected	☐	Type reference (TYPE)	I	0	Last used ID	20070118
7	NODE_TYPE_ATTRIBUTE	Constant	Public	☐	Type reference (TYPE)	/TDAG/CPE_XML_TYPE	'A'	Attribute node type	20070118
8	NODE_TYPE_ELEMENT	Constant	Public	☐	Type reference (TYPE)	/TDAG/CPE_XML_TYPE	'E'	Element node type	20070118

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_ATTRIBUTE	Instance method	Public	Method	CP: Add attribute to XML element	20070118
2	ADD_ELEMENT	Instance method	Public	Method	CP: Add sub-element to XML element	20070118
3	ADD_ROOT	Instance method	Public	Method	CP: Add root XML element	20070118
4	CLEAR	Instance method	Public	Method	CP: Clear the XML data	20070118
5	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20070118
6	DELETE_ATTRIBUTE	Instance method	Public	Method	CP: Delete XML element (including sub-elements)	20070118
7	DELETE_ATTRIBUTES	Instance method	Public	Method	CP: Delete attributes of XML element	20070118
8	DELETE_ELEMENT	Instance method	Public	Method	CP: Delete XML element (including sub-elements)	20070118
9	DELETE_ELEMENT_LONGTEXT	Instance method	Public	Method	Deletes the long text value of an element	20070213
10	DELETE_EMPTY_ELEMENTS	Instance method	Public	Method	Delete all elements having no subelements, atrributes or val	20070214
11	DELETE_SUBELEMENTS	Instance method	Public	Method	CP: Delete sub-elements of XML element	20070118
12	ESCAPE_XML_CHAR	Static method	Public	Method	Escape reserved XML characters <,>,&," and '	20071109
13	FIND_REPLACE	Static method	Public	Method	Finds and replaces substring with another substring	20070119
14	GET_ATTRIBUTES	Instance method	Public	Method	CP: Get XML element attributes	20070118
15	GET_ATTRIBUTE_DATA	Instance method	Public	Method	CP: Get attribute data of XML element	20070118
16	GET_ELEMENT_DATA	Instance method	Public	Method	CP: Get XML element data	20070118
17	GET_ELEMENT_LONGTEXT	Instance method	Public	Method	Gets the long text value of an element	20070213
18	GET_ROOT	Instance method	Public	Method	CP: Get root XML element data	20070118
19	GET_SUBELEMENTS	Instance method	Public	Method	CP: Get sub-elements of XML element	20070118
20	GET_XML	Instance method	Public	Method	CP: Get the XML string	20070118
21	HAS_ATTRIBUTES	Instance method	Public	Method	Checks if element has sub-elements	20070214
22	HAS_SUBELEMENTS	Instance method	Public	Method	Checks if element has attributes	20070215
23	SET_ATTRIBUTE_DATA	Instance method	Public	Method	CP: Set attribute data of XML element	20070118
24	SET_ELEMENT_DATA	Instance method	Public	Method	CP: Set XML element data	20070118
25	SET_ELEMENT_LONGTEXT	Instance method	Public	Method	Sets the long text value of an element	20070213
26	VALIDATE_XML_NAME	Static method	Public	Method	Checks if element or attribute name is valid	20070118

Events

Class /TDAG/CPCL_CFPXML has no event.

Types

Class /TDAG/CPCL_CFPXML 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	Returning	E_ID	Value transfer	☐	Type reference (TYPE)	I		The ID of the new attribute	20070118
2	Importing	I_NAME	Value transfer	☐	Type reference (TYPE)	STRING		The name of the new attribute	20070118
3	Importing	I_ORDER	Value transfer	☑	Type reference (TYPE)	I		The order of the new attribute	20070118
4	Importing	I_PARENTID	Value transfer	☐	Type reference (TYPE)	I		The ID of the element	20070118
5	Importing	I_VALUE	Value transfer	☑	Type reference (TYPE)	STRING		The value of the new attribute	20070118

#	Exception	Resumable	Description	Created on
1	DUPLICATE_ATTRIBUTE_NAME	☐	Duplicate attribute name	20070118
2	ELEMENT_NOT_FOUND	☐	Element I_PARENTID not found	20070118
3	INTERNAL_ERROR	☐	Internal error	20070118
4	INVALID_ATTRIBUTE_NAME	☐	Invalid attribute name	20070118

Method ADD_ELEMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	E_ID	Value transfer	☐	Type reference (TYPE)	I		The ID of the new element	20070118
2	Importing	I_NAME	Value transfer	☐	Type reference (TYPE)	STRING		The name of the new element	20070118
3	Importing	I_ORDER	Value transfer	☑	Type reference (TYPE)	I		The order of the new element	20070118
4	Importing	I_PARENTID	Value transfer	☐	Type reference (TYPE)	I		The ID of the parent element	20070118
5	Importing	I_VALUE	Value transfer	☑	Type reference (TYPE)	STRING		The value of the new element	20070118

#	Exception	Resumable	Description	Created on
1	ELEMENT_NOT_FOUND	☐	Element I_PARENTID not found	20070118
2	INTERNAL_ERROR	☐	Internal error	20070118
3	INVALID_ELEMENT_NAME	☐	invalid element name	20070118

Method ADD_ROOT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	E_ID	Value transfer	☐	Type reference (TYPE)	I		The ID of the root	20070118
2	Importing	I_NAME	Value transfer	☐	Type reference (TYPE)	STRING		The name of the XML root element	20070118
3	Importing	I_VALUE	Value transfer	☑	Type reference (TYPE)	STRING		The value of the XML root element	20070118

#	Exception	Resumable	Description	Created on
1	INTERNAL_ERROR	☐	Internal error	20070118
2	INVALID_ELEMENT_NAME	☐	Invalid root element name	20070118
3	ROOT_ELEMENT_EXISTS	☐	Root element exists	20070118

Method CLEAR Signature

Method CLEAR on class /TDAG/CPCL_CFPXML has no parameter.
Method CLEAR on class /TDAG/CPCL_CFPXML has no exception.

Method CONSTRUCTOR Signature

Method CONSTRUCTOR on class /TDAG/CPCL_CFPXML has no parameter.
Method CONSTRUCTOR on class /TDAG/CPCL_CFPXML has no exception.

Method DELETE_ATTRIBUTE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ID	Value transfer	☐	Type reference (TYPE)	I		The ID of the attribute	20070118

#	Exception	Resumable	Description	Created on
1	ATTRIBUTE_NOT_FOUND	☐	Attribute ID not found	20070118
2	INTERNAL_ERROR	☐	Internal error	20070118

Method DELETE_ATTRIBUTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_PARENTID	Value transfer	☐	Type reference (TYPE)	I		The parnet ID of the attributes	20070118

#	Exception	Resumable	Description	Created on
1	ELEMENT_NOT_FOUND	☐	Element I_PARENTID not found	20070118
2	INTERNAL_ERROR	☐	Internal error	20070118

Method DELETE_ELEMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ID	Value transfer	☐	Type reference (TYPE)	I		The ID of the element	20070118

#	Exception	Resumable	Description	Created on
1	ELEMENT_NOT_FOUND	☐	Element ID not found	20070118
2	INTERNAL_ERROR	☐	Internal error	20070118

Method DELETE_ELEMENT_LONGTEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ID	Call by reference	☐	Type reference (TYPE)	/TDAG/CPE_XML_ID		CP: XML Element ID	20070213

#	Exception	Resumable	Description	Created on
1	ELEMENT_NOT_FOUND	☐	Element ID not found	20070213
2	INTERNAL_ERROR	☐	Internal error	20070213

Method DELETE_EMPTY_ELEMENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ID	Call by reference	☐	Type reference (TYPE)	I	1	Element ID	20070214

#	Exception	Resumable	Description	Created on
1	ELEMENT_NOT_FOUND	☐	Element ID not found	20070214
2	INTERNAL_ERROR	☐	Internal error	20070214

Method DELETE_SUBELEMENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_PARENTID	Value transfer	☐	Type reference (TYPE)	I		The ID of the element	20070118

#	Exception	Resumable	Description	Created on
1	ELEMENT_NOT_FOUND	☐	Element I_PARENTID not found	20070118
2	INTERNAL_ERROR	☐	Internal error	20070118

Method ESCAPE_XML_CHAR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_VALUE	Call by reference	☐	Type reference (TYPE)	STRING		XML value to be parsed and converted	20071109
2	Returning	R_VALUE	Value transfer	☐	Type reference (TYPE)	STRING		XML value - corrected	20071109

Method ESCAPE_XML_CHAR on class /TDAG/CPCL_CFPXML has no exception.

Method FIND_REPLACE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_FIND	Value transfer	☐	Type reference (TYPE)	STRING		Find what	20070119
2	Importing	I_REPLACE	Value transfer	☐	Type reference (TYPE)	STRING		Replace with	20070119
3	Importing	I_STRING	Value transfer	☐	Type reference (TYPE)	STRING		Searched string	20070119
4	Returning	R_RESULT	Value transfer	☐	Type reference (TYPE)	STRING		Result	20070125

Method FIND_REPLACE on class /TDAG/CPCL_CFPXML has no exception.

Method GET_ATTRIBUTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_ATTRIBUTES_IDS	Call by reference	☐	Type reference (TYPE)	/TDAG/CPY_IDS		The IDs of the attributes	20070118
2	Importing	I_PARENTID	Value transfer	☐	Type reference (TYPE)	I		The ID of the parent element	20070118

#	Exception	Resumable	Description	Created on
1	ATTRIBUTES_NOT_FOUND	☐	Attributes not found	20070118
2	ELEMENT_NOT_FOUND	☐	Element I_PARENTID not found	20070118

Method GET_ATTRIBUTE_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_NAME	Call by reference	☐	Type reference (TYPE)	STRING		The name of the attribute	20070118
2	Exporting	E_ORDER	Call by reference	☐	Type reference (TYPE)	I		The order of the attribute	20070118
3	Exporting	E_PARENTID	Call by reference	☐	Type reference (TYPE)	I		The parent ID of the attribute	20070118
4	Exporting	E_VALUE	Call by reference	☐	Type reference (TYPE)	STRING		The value of the attribute	20070118
5	Importing	I_ID	Value transfer	☐	Type reference (TYPE)	I		The ID of the attribute	20070118

#	Exception	Resumable	Description	Created on
1	ATTRIBUTE_NOT_FOUND	☐	Attribute ID not found	20070118
2	INTERNAL_ERROR	☐	Internal error	20070118

Method GET_ELEMENT_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_FLG_LONGTEXT	Call by reference	☐	Type reference (TYPE)	/TDAG/CPE_XML_LONGTEXT		CP: XML Long text flag	20070213
2	Exporting	E_NAME	Call by reference	☐	Type reference (TYPE)	STRING		The name of the element	20070118
3	Exporting	E_ORDER	Call by reference	☐	Type reference (TYPE)	I		The order of the element	20070118
4	Exporting	E_PARENTID	Call by reference	☐	Type reference (TYPE)	I		The parent ID of the element	20070118
5	Exporting	E_VALUE	Call by reference	☐	Type reference (TYPE)	STRING		The value of the element	20070118
6	Importing	I_ID	Value transfer	☐	Type reference (TYPE)	I		The ID of the element	20070118

#	Exception	Resumable	Description	Created on
1	ELEMENT_NOT_FOUND	☐	Element ID not found	20070118
2	INTERNAL_ERROR	☐	Internal error	20070118

Method GET_ELEMENT_LONGTEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_LONGTEXT	Call by reference	☐	Type reference (TYPE)	/TDAG/CPY_STRING		CP: Table type for CfPXML long text	20070213
2	Exporting	E_ORDER	Call by reference	☐	Type reference (TYPE)	I		Position of the long text value among other sublements	20070319
3	Importing	I_ID	Call by reference	☐	Type reference (TYPE)	/TDAG/CPE_XML_ID		CP: XML Element ID	20070213

#	Exception	Resumable	Description	Created on
1	ELEMENT_HAS_NO_LONGTEXT	☐	Element has no long text	20070213
2	ELEMENT_NOT_FOUND	☐	Element ID not found	20070213
3	INTERNAL_ERROR	☐	Internal error	20070213

Method GET_ROOT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_NAME	Call by reference	☐	Type reference (TYPE)	STRING		The name of the XML root element	20070118
2	Exporting	E_VALUE	Call by reference	☐	Type reference (TYPE)	STRING		The value of the XML root element	20070118

#	Exception	Resumable	Description	Created on
1	INTERNAL_ERROR	☐	Internal error	20070118
2	ROOT_ELEMENT_NOT_FOUND	☐	Root element not found	20070118

Method GET_SUBELEMENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_SUBELEMENTS_IDS	Call by reference	☐	Type reference (TYPE)	/TDAG/CPY_IDS		The IDs of the sub-elements	20070118
2	Importing	I_PARENTID	Value transfer	☐	Type reference (TYPE)	I		The ID of the parent element	20070118

#	Exception	Resumable	Description	Created on
1	ELEMENT_NOT_FOUND	☐	Element I_PARENTID not found	20070118
2	SUBELEMENTS_NOT_FOUND	☐	Subelements not found	20070118

Method GET_XML Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ID	Value transfer	☐	Type reference (TYPE)	I	1	The ID of the element	20070118
2	Returning	RT_XML	Value transfer	☐	Type reference (TYPE)	/TDAG/CPY_STRING		The XML string table	20070125

#	Exception	Resumable	Description	Created on
1	ELEMENT_NOT_FOUND	☐	Element ID not found	20070118
2	INTERNAL_ERROR	☐	Internal error	20070118

Method HAS_ATTRIBUTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_HAS_ATTRIBUTES	Value transfer	☐	Type reference (TYPE)	C		has attributes flag	20070214
2	Importing	I_ID	Value transfer	☐	Type reference (TYPE)	I		Element ID	20070214

#	Exception	Resumable	Description	Created on
1	ELEMENT_NOT_FOUND	☐	Element not found	20070214
2	INTERNAL_ERROR	☐	Internal error	20070214

Method HAS_SUBELEMENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_HAS_SUBELEMENTS	Value transfer	☐	Type reference (TYPE)	C		Has subelements flag	20070215
2	Importing	I_ID	Value transfer	☐	Type reference (TYPE)	I		Element ID	20070215

#	Exception	Resumable	Description	Created on
1	ELEMENT_NOT_FOUND	☐	Element not found	20070215
2	INTERNAL_ERROR	☐	Internal error	20070215

Method SET_ATTRIBUTE_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ID	Value transfer	☐	Type reference (TYPE)	I		The ID of the attribute	20070118
2	Importing	I_NAME	Value transfer	☑	Type reference (TYPE)	STRING		The name of the attribute	20070118
3	Importing	I_ORDER	Value transfer	☑	Type reference (TYPE)	I		The order of the attribute	20070118
4	Importing	I_VALUE	Value transfer	☑	Type reference (TYPE)	STRING		The value of the attribute	20070118

#	Exception	Resumable	Description	Created on
1	ATTRIBUTE_NOT_FOUND	☐	Attribute ID not found	20070118
2	DUPLICATE_ATTRIBUTE_NAME	☐	Duplicate attribute name	20070118
3	INTERNAL_ERROR	☐	Internal error	20070118
4	INVALID_ATTRIBUTE_NAME	☐	Invalid attribute name	20070118

Method SET_ELEMENT_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ID	Value transfer	☐	Type reference (TYPE)	I		The ID of the element	20070118
2	Importing	I_NAME	Value transfer	☑	Type reference (TYPE)	STRING		The name of the element	20070118
3	Importing	I_ORDER	Value transfer	☑	Type reference (TYPE)	I		The order of the element	20070118
4	Importing	I_VALUE	Value transfer	☑	Type reference (TYPE)	STRING		The value of the element	20070118

#	Exception	Resumable	Description	Created on
1	ELEMENT_NOT_FOUND	☐	Element ID not found	20070118
2	INTERNAL_ERROR	☐	Internal error	20070118
3	INVALID_ELEMENT_NAME	☐	Invalid element name	20070118

Method SET_ELEMENT_LONGTEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_LONGTEXT	Value transfer	☐	Type reference (TYPE)	/TDAG/CPY_STRING		CP: Table type for CfPXML long text	20070213
2	Importing	I_ID	Value transfer	☐	Type reference (TYPE)	/TDAG/CPE_XML_ID		CP: XML Element ID	20070213
3	Importing	I_ORDER	Value transfer	☐	Type reference (TYPE)	I	0	Position of the long text value among other sublements	20070319

#	Exception	Resumable	Description	Created on
1	ELEMENT_NOT_FOUND	☐	Element ID not found	20070213
2	INTERNAL_ERROR	☐	Internal error	20070213
3	TEXT_TABLE_EMPTY	☐	Long text table is empty	20070213

Method VALIDATE_XML_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Name to check	20070118

#	Exception	Resumable	Description	Created on
1	INVALID_CHARACTER_AMPERSAND	☐	Value contains ampersand	20070118
2	INVALID_CHARACTER_APOSTROPHE	☐	Value contains apostrophe	20070118
3	INVALID_CHARACTER_GREATERTHAN	☐	Value contains greater than	20070118
4	INVALID_CHARACTER_LESSTHAN	☐	Value contains less than	20070118
5	INVALID_CHARACTER_QUOTES	☐	Value contains quotation mark cha	20070118
6	INVALID_CHARACTER_SPACE	☐	Value contains space	20070118

History

Last changed by/on	SAP	20141109
SAP Release Created in	0207B0406C