SAP ABAP Class CL_XML_OPERATIONS (Generic XML operations)
Hierarchy
☛
BBPCRM (Software Component) BBPCRM
⤷
CA-GTF-CSC (Application Component) Country-Specific Objects
⤷
ID-FI (Package) International development: FI-GL/AP/AR
⤷
⤷
Properties
| Class | CL_XML_OPERATIONS | |
| Short Description | Generic XML operations | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | ID-FI | International development: FI-GL/AP/AR |
| Created | 20100602 | SAP |
| Last change | 20130531 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
Class CL_XML_OPERATIONS has no forward declaration.
Interfaces
Class CL_XML_OPERATIONS has no interface implemented.
Friends
Class CL_XML_OPERATIONS has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Static Attribute | Public | Type reference (TYPE) | I | Byte order defined in the schema document | 20100602 | |||
| 2 | Constant | Public | Type reference (TYPE) | CHAR50 | 'BASE' | Base attirbute | 20100602 | ||
| 3 | Constant | Public | Type reference (TYPE) | CHAR50 | 'CONTENT' | Content attribute | 20100602 | ||
| 4 | Constant | Public | Type reference (TYPE) | CHAR50 | 'DEFAULT' | Default attribute | 20100602 | ||
| 5 | Constant | Public | Type reference (TYPE) | CHAR50 | 'FIXED' | Fixed attribute | 20100602 | ||
| 6 | Constant | Public | Type reference (TYPE) | CHAR50 | 'MAXOCCURS' | Maxoccurs attribute | 20100602 | ||
| 7 | Constant | Public | Type reference (TYPE) | CHAR50 | 'MINOCCURS' | Minoccurs attribute | 20100602 | ||
| 8 | Constant | Public | Type reference (TYPE) | CHAR50 | 'NAME' | Name attribute | 20100602 | ||
| 9 | Constant | Public | Type reference (TYPE) | CHAR50 | 'ORDER' | Order attribute | 20100602 | ||
| 10 | Constant | Public | Type reference (TYPE) | CHAR50 | 'REF' | Reference attribute | 20100602 | ||
| 11 | Constant | Public | Type reference (TYPE) | CHAR50 | 'SCHEMALOCATION' | Schemalocation attribute | 20100602 | ||
| 12 | Constant | Public | Type reference (TYPE) | CHAR50 | 'TYPE' | Type attribute | 20100602 | ||
| 13 | Constant | Public | Type reference (TYPE) | CHAR50 | 'USE' | Use attribute | 20100602 | ||
| 14 | Constant | Public | Type reference (TYPE) | CHAR50 | 'ALL' | All element | 20100602 | ||
| 15 | Constant | Public | Type reference (TYPE) | CHAR50 | 'ANNOTATION' | Annotation element | 20100602 | ||
| 16 | Constant | Public | Type reference (TYPE) | CHAR50 | 'APPINFO' | Appinfo element | 20100602 | ||
| 17 | Constant | Public | Type reference (TYPE) | CHAR50 | 'ATTRIBUTEGROUP' | Attributegroup element | 20100602 | ||
| 18 | Constant | Public | Type reference (TYPE) | CHAR50 | 'ATTRIBUTE' | Attribute element | 20100602 | ||
| 19 | Constant | Public | Type reference (TYPE) | CHAR50 | 'COMPLEXCONTENT' | Complex content element | 20100602 | ||
| 20 | Constant | Public | Type reference (TYPE) | CHAR50 | 'CHOICE' | Choice element | 20100602 | ||
| 21 | Constant | Public | Type reference (TYPE) | CHAR50 | 'COMPLEXTYPE' | Complex Type element | 20100602 | ||
| 22 | Constant | Public | Type reference (TYPE) | CHAR50 | 'DOCUMENTATION' | Documentation element | 20100602 | ||
| 23 | Constant | Public | Type reference (TYPE) | CHAR50 | 'ELEMENT' | Element element | 20100602 | ||
| 24 | Constant | Public | Type reference (TYPE) | CHAR50 | 'EXTENSION' | Extension element | 20100602 | ||
| 25 | Constant | Public | Type reference (TYPE) | CHAR50 | 'GROUP' | Group element | 20100602 | ||
| 26 | Constant | Public | Type reference (TYPE) | CHAR50 | 'RESTRICTION' | Restriction element | 20100602 | ||
| 27 | Constant | Public | Type reference (TYPE) | CHAR50 | 'SEQUENCE' | Sequence element | 20100602 | ||
| 28 | Constant | Public | Type reference (TYPE) | CHAR50 | 'SIMPLETYPE' | Simple Type element | 20100602 | ||
| 29 | Constant | Public | Type reference (TYPE) | CHAR05 | '&' | Entity & | 20100602 | ||
| 30 | Constant | Public | Type reference (TYPE) | CHAR05 | '''' | Entity ' | 20100602 | ||
| 31 | Constant | Public | Type reference (TYPE) | CHAR05 | '>' | Entity > | 20100602 | ||
| 32 | Constant | Public | Type reference (TYPE) | CHAR05 | '<' | Entity < | 20100602 | ||
| 33 | Constant | Public | Type reference (TYPE) | CHAR05 | '"' | Entity " | 20100602 | ||
| 34 | Constant | Public | Type reference (TYPE) | CHAR50 | 'SCHEMA' | Schema element | 20100602 | ||
| 35 | Static Attribute | Public | Type reference (TYPE) | STRING | Encoding defined in the schema document | 20100602 | |||
| 36 | Constant | Public | Type reference (TYPE) | BOOLEAN | SPACE | Flase | 20100602 | ||
| 37 | Instance attribute | Public | Type reference (TYPE) | STRING | Minoccurs for a group | 20100602 | |||
| 38 | Instance attribute | Public | Type reference (TYPE) | BOOLEAN | Flag to indicate a group element | 20100602 | |||
| 39 | Static Attribute | Protected | Object reference (TYPE REF TO) | IF_IXML | Main XML factory | 20100602 | |||
| 40 | Instance attribute | Public | Type reference (TYPE) | STRING | Parent name of a node | 20100602 | |||
| 41 | Constant | Public | Type reference (TYPE) | BOOLEAN | 'X' | True | 20100602 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Public | Method | Append message table | 20100602 | |
| 2 | Instance method | Protected | Method | Append nodes to the XML document | 20100602 | |
| 3 | Instance method | Protected | Method | Check and create directory | 20100602 | |
| 4 | Instance method | Protected | Method | Check if the download file already exists | 20100602 | |
| 5 | Instance method | Public | Constructor | Constructor | 20100602 | |
| 6 | Instance method | Public | Method | Create XML data from table | 20100602 | |
| 7 | Instance method | Protected | Method | Create XML root element | 20100602 | |
| 8 | Instance method | Public | Method | Create logical document for the dowloaded schema | 20100602 | |
| 9 | Instance method | Private | Method | Delete optional complextype nodes in XML document | 20100602 | |
| 10 | Instance method | Protected | Method | Delete optional nodes in the XML document | 20100602 | |
| 11 | Instance method | Public | Method | Export XML file (download) | 20100602 | |
| 12 | Instance method | Protected | Method | Get encoding and byte order of the schema | 20100602 | |
| 13 | Instance method | Public | Method | Get nodes from schema document | 20100602 | |
| 14 | Instance method | Public | Method | Import XML schema file (upload) | 20100602 | |
| 15 | Instance method | Public | Method | Render the XML document | 20100602 | |
| 16 | Instance method | Public | Method | Set encoding for the document | 20100602 | |
| 17 | Instance method | Public | Method | Validate XML file agianst the XML schema | 20100602 |
Events
Class CL_XML_OPERATIONS has no event.
Types
Class CL_XML_OPERATIONS has no local type.
Method Signatures
Method APPEND_MESSAGE_TAB Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | MSGID | Value transfer | Type reference (TYPE) | SYMSGID | Message class | 20100602 | |||
| 2 | MSGNO | Value transfer | Type reference (TYPE) | SYMSGNO | Message number | 20100602 | |||
| 3 | MSGTY | Value transfer | Type reference (TYPE) | SYMSGTY | Message type | 20100602 | |||
| 4 | MSGV1 | Value transfer | Type reference (TYPE) | ANY | Message variable 1 | 20100602 | |||
| 5 | MSGV2 | Value transfer | Type reference (TYPE) | ANY | Message variable 2 | 20100602 | |||
| 6 | MSGV3 | Value transfer | Type reference (TYPE) | ANY | Message variable 3 | 20100602 | |||
| 7 | MSGV4 | Value transfer | Type reference (TYPE) | ANY | Message variable 4 | 20100602 | |||
| 8 | MSG_TAB | Call by reference | Type reference (TYPE) | STANDARD TABLE | Message table | 20100602 |
Method APPEND_MESSAGE_TAB on class CL_XML_OPERATIONS has no exception.
Method APPEND_NODES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ATTR_LIST | Call by reference | Type reference (TYPE) | ATTR_XML_T | List of attributes | 20100602 | |||
| 2 | DOCUMENT | Value transfer | Object reference (TYPE REF TO) | IF_IXML_DOCUMENT | Document reference | 20100602 | |||
| 3 | ELEMENT | Value transfer | Object reference (TYPE REF TO) | IF_IXML_ELEMENT | Element reference | 20100602 | |||
| 4 | INDEX | Value transfer | Type reference (TYPE) | SY-TABIX | Table index | 20100602 | |||
| 5 | NODE_LIST | Call by reference | Type reference (TYPE) | NODE_XML_T | List of nodes | 20100602 |
Method APPEND_NODES on class CL_XML_OPERATIONS has no exception.
Method CHECK_CREATE_DIR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | FPATH | Call by reference | Type reference (TYPE) | STRING | File path | 20100602 | |||
| 2 | IS_OK | Call by reference | Type reference (TYPE) | BOOLEAN | Return code | 20100602 | |||
| 3 | MSGLOG | Call by reference | Type reference (TYPE) | STANDARD TABLE | Message log | 20100602 |
Method CHECK_CREATE_DIR on class CL_XML_OPERATIONS has no exception.
Method CHECK_FILE_EXISTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | FILENAME | Call by reference | Type reference (TYPE) | STRING | Existing file name | 20100602 | |||
| 2 | FILEPATH | Call by reference | Type reference (TYPE) | STRING | Existing file path | 20100602 | |||
| 3 | IS_OK | Call by reference | Type reference (TYPE) | BOOLEAN | Return code | 20100602 | |||
| 4 | MSGLOG | Call by reference | Type reference (TYPE) | STANDARD TABLE | Message log | 20100602 | |||
| 5 | RET_FILENAME | Call by reference | Type reference (TYPE) | STRING | New file name with path | 20100602 |
Method CHECK_FILE_EXISTS on class CL_XML_OPERATIONS has no exception.
Method CONSTRUCTOR Signature
Method CONSTRUCTOR on class CL_XML_OPERATIONS has no parameter.
Method CONSTRUCTOR on class CL_XML_OPERATIONS has no exception.
Method CONVERT_TO_XML Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ATTR_LIST | Call by reference | Type reference (TYPE) | ATTR_XML_T | Table containing attributes for a node with value | 20100602 | |||
| 2 | DEL_OPTIO | Call by reference | Type reference (TYPE) | BOOLEAN | Delete optional node(s) | 20100602 | |||
| 3 | DOCUMENT | Call by reference | Object reference (TYPE REF TO) | IF_IXML_DOCUMENT | Document reference | 20100602 | |||
| 4 | FILENAME | Call by reference | Type reference (TYPE) | STRING | Download file name | 20100602 | |||
| 5 | IS_OK | Call by reference | Type reference (TYPE) | BOOLEAN | Return code | 20100602 | |||
| 6 | MSGLOG | Call by reference | Type reference (TYPE) | STANDARD TABLE | Message log | 20100602 | |||
| 7 | NODE_LIST | Call by reference | Type reference (TYPE) | NODE_XML_T | Table containing node name with data | 20100602 | |||
| 8 | ROOT | Call by reference | Type reference (TYPE) | STRING | Name of the root element | 20100602 |
Method CONVERT_TO_XML on class CL_XML_OPERATIONS has no exception.
Method CREATE_ROOT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ATTR_LIST | Call by reference | Type reference (TYPE) | ATTR_XML_T | List of attributes | 20100602 | |||
| 2 | DOCUMENT | Call by reference | Object reference (TYPE REF TO) | IF_IXML_DOCUMENT | Document reference | 20100602 | |||
| 3 | ROOT | Call by reference | Type reference (TYPE) | STRING | Name of root element | 20100602 | |||
| 4 | ROOT_ELEMENT | Call by reference | Object reference (TYPE REF TO) | IF_IXML_ELEMENT | Root element reference | 20100602 |
Method CREATE_ROOT on class CL_XML_OPERATIONS has no exception.
Method CREATE_SCHEMA_DOCUMENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | DATA_TAB | Call by reference | Type reference (TYPE) | STANDARD TABLE | Data table for which to create the document | 20100602 | |||
| 2 | DOCUMENT | Call by reference | Object reference (TYPE REF TO) | IF_IXML_DOCUMENT | Logical document | 20100602 | |||
| 3 | FILESIZE | Call by reference | Type reference (TYPE) | I | File size | 20100602 | |||
| 4 | IS_OK | Call by reference | Type reference (TYPE) | BOOLEAN | Return code | 20100602 | |||
| 5 | MSGLOG | Call by reference | Type reference (TYPE) | STANDARD TABLE | Message log | 20100602 | |||
| 6 | SCHEMA | Call by reference | Type reference (TYPE) | STRING | Local file for upload/download | 20100602 |
Method CREATE_SCHEMA_DOCUMENT on class CL_XML_OPERATIONS has no exception.
Method DELETE_OPTIONAL_CTYPE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | DELETE_PARENT | Value transfer | Type reference (TYPE) | BOOLEAN | Flag to delete the complextype | 20100602 | |||
| 2 | INDEX | Value transfer | Type reference (TYPE) | SY-TABIX | Internal table, current line index | 20100602 | |||
| 3 | NODES | Call by reference | Type reference (TYPE) | NODE_XML_T | List of nodes | 20100602 |
Method DELETE_OPTIONAL_CTYPE on class CL_XML_OPERATIONS has no exception.
Method DELETE_OPTIONAL_NODE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | NODES | Call by reference | Type reference (TYPE) | NODE_XML_T | List of nodes | 20100602 |
Method DELETE_OPTIONAL_NODE on class CL_XML_OPERATIONS has no exception.
Method EXPORT_TO_FILE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | DATA_TAB | Call by reference | Type reference (TYPE) | STANDARD TABLE | Data table to be downloaded in XML format | 20100602 | |||
| 2 | FILENAME | Call by reference | Type reference (TYPE) | STRING | Name and path of download file | 20100602 | |||
| 3 | FILESIZE | Call by reference | Type reference (TYPE) | I | Size of the download file | 20100602 | |||
| 4 | IS_OK | Call by reference | Type reference (TYPE) | BOOLEAN | Return code | 20100602 | |||
| 5 | LOGFILENAME | Call by reference | Type reference (TYPE) | FILEINTERN | Logical file name | 20121207 | |||
| 6 | MSGLOG | Call by reference | Type reference (TYPE) | STANDARD TABLE | Message log | 20100602 | |||
| 7 | TO_APPSERVER | Call by reference | Type reference (TYPE) | BOOLEAN | SPACE | Download to frontend or appserver | 20100602 |
Method EXPORT_TO_FILE on class CL_XML_OPERATIONS has no exception.
Method GET_ENCODING Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | DOCUMENT | Value transfer | Object reference (TYPE REF TO) | IF_IXML_DOCUMENT | Document reference | 20100602 |
Method GET_ENCODING on class CL_XML_OPERATIONS has no exception.
Method GET_NODES_FROM_DATA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ATTR_LIST | Call by reference | Type reference (TYPE) | ATTR_XML_T | Attributes of nodes of the XML file | 20100602 | |||
| 2 | IS_OK | Call by reference | Type reference (TYPE) | BOOLEAN | Return code | 20100602 | |||
| 3 | I_NODE | Call by reference | Object reference (TYPE REF TO) | IF_IXML_NODE | Node reference | 20100602 | |||
| 4 | MSGLOG | Call by reference | Type reference (TYPE) | STANDARD TABLE | Error message log | 20100602 | |||
| 5 | NODE_LIST | Call by reference | Type reference (TYPE) | NODE_XML_T | Nodes of the XML file | 20100602 |
Method GET_NODES_FROM_DATA on class CL_XML_OPERATIONS has no exception.
Method IMPORT_FROM_FILE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | DATA_TAB | Call by reference | Type reference (TYPE) | STANDARD TABLE | Data table | 20100602 | |||
| 2 | FILENAME | Call by reference | Type reference (TYPE) | STRING | Schema file name | 20100602 | |||
| 3 | FILESIZE | Call by reference | Type reference (TYPE) | I | File size | 20100602 | |||
| 4 | FROM_APPSERVER | Call by reference | Type reference (TYPE) | BOOLEAN | SPACE | Upload from frontend or application server | 20100602 | ||
| 5 | IS_OK | Call by reference | Type reference (TYPE) | BOOLEAN | Return code | 20100602 | |||
| 6 | LOGICAL_FILE_PATH | Call by reference | Type reference (TYPE) | FILEINTERN | Logical file name | 20110610 | |||
| 7 | MSGLOG | Call by reference | Type reference (TYPE) | STANDARD TABLE | Messsage log | 20100602 |
Method IMPORT_FROM_FILE on class CL_XML_OPERATIONS has no exception.
Method RENDER_XML_DOCUMENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | DOCUMENT | Call by reference | Object reference (TYPE REF TO) | IF_IXML_DOCUMENT | Document reference | 20100602 | |||
| 2 | FILENAME | Call by reference | Type reference (TYPE) | STRING | Download file name | 20100602 | |||
| 3 | FILESIZE | Call by reference | Type reference (TYPE) | I | Return file size | 20100602 | |||
| 4 | IS_NORMALIZING | Call by reference | Type reference (TYPE) | BOOLEAN | TRUE | Flag to check if normalizing parser should be created | 20100602 | ||
| 5 | IS_OK | Call by reference | Type reference (TYPE) | BOOLEAN | Return code | 20100602 | |||
| 6 | MSGLOG | Call by reference | Type reference (TYPE) | STANDARD TABLE | Message log | 20100602 | |||
| 7 | XML_DATA | Call by reference | Type reference (TYPE) | STANDARD TABLE | Converted XML data | 20100602 |
Method RENDER_XML_DOCUMENT on class CL_XML_OPERATIONS has no exception.
Method SET_ENCODING Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | BYTE_ORDER | Call by reference | Type reference (TYPE) | I | BYTE_ORDER | The byte order to use when representing characters | 20100602 | ||
| 2 | CHARACTER_SET | Call by reference | Type reference (TYPE) | STRING | ENCODING | The name of the character set for the encoding | 20100602 | ||
| 3 | DOCUMENT | Call by reference | Object reference (TYPE REF TO) | IF_IXML_DOCUMENT | XML document reference | 20100602 | |||
| 4 | IS_OK | Call by reference | Type reference (TYPE) | BOOLEAN | Return code | 20100602 | |||
| 5 | MSGLOG | Call by reference | Type reference (TYPE) | STANDARD TABLE | Message log | 20100602 |
Method SET_ENCODING on class CL_XML_OPERATIONS has no exception.
Method VALIDATE_XML_FILE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | AT_APPSERVER | Call by reference | Type reference (TYPE) | BOOLEAN | SPACE | Validation to be performed at frontend or appserver | 20100602 | ||
| 2 | FILENAME | Call by reference | Type reference (TYPE) | STRING | Name of the XML file with path to be validated | 20100602 | |||
| 3 | IS_OK | Call by reference | Type reference (TYPE) | BOOLEAN | Return code | 20100602 | |||
| 4 | MSGLOG | Call by reference | Type reference (TYPE) | STANDARD TABLE | Message log | 20100602 | |||
| 5 | SCHEMA | Call by reference | Type reference (TYPE) | STRING | Name of the XML schema with path | 20100602 | |||
| 6 | TARGET_NAMESPACE | Call by reference | Type reference (TYPE) | STRING | SPACE | Name of the Target Namespace | 20100602 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Validation cannot be executed in batch | 20100602 |
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in | 606 |