SAP ABAP Class /TDAG/CPCL_HTML_DATA (CP: Data provider for HTML_VIEW_CTRL)
Hierarchy
☛
TDAGBCA (Software Component) TechniData Basic Components
⤷
EHS (Application Component) Environment, Health and Safety
⤷
/TDAG/CP (Package) Compliance for products
⤷
⤷
Meta Relationship - Using
| # | Relationship type | Using | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | /TDAG/CPIF_DATA | CP: Interface für Objekte zur Datenverwaltung | 20070903 |
Properties
| Class | /TDAG/CPCL_HTML_DATA | |
| Short Description | CP: Data provider for HTML_VIEW_CTRL | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | /TDAG/CP | Compliance for products |
| Created | 20070903 | SAP |
| Last change | 20141109 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
| # | Interface | Abstract | Final | Description | Created on |
|---|---|---|---|---|---|
| 1 | /TDAG/CPIF_DATA | CP: Interface für Objekte zur Datenverwaltung | 20070903 |
Friends
Class /TDAG/CPCL_HTML_DATA has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Constant | Protected | Type reference (TYPE) | CHAR03 | 'CFP' | TempSubsdirectory | 20070904 | ||
| 2 | Instance attribute | Protected | Object reference (TYPE REF TO) | /TDAG/IF_EX_CP_BADI_004 | Business add-in interface /TDAG/IF_EX_CP_BADI_004 | 20070910 | |||
| 3 | Instance attribute | Protected | Object reference (TYPE REF TO) | IF_IXML | IF_IXML | 20070904 | |||
| 4 | Instance attribute | Protected | Object reference (TYPE REF TO) | IF_IXML_PARSER | IF_IXML_PARSER | 20070904 | |||
| 5 | Instance attribute | Protected | Object reference (TYPE REF TO) | DATA | XML file data | 20071022 | |||
| 6 | Instance attribute | Protected | Type reference (TYPE) | L_CACHE_TAB_TYPE | Cache table with already processed nodes | 20070904 | |||
| 7 | Instance attribute | Private | Type reference (TYPE) | BAL_T_MSG | Application Log: Table with Messages | 20071022 | |||
| 8 | Instance attribute | Private | Type reference (TYPE) | I | 1-Level 1; 2-Full Disclosure | 20070911 | |||
| 9 | Instance attribute | Private | Type reference (TYPE) | ESEBOOLE | True if an error during XML parsing occirred | 20071022 | |||
| 10 | Instance attribute | Private | Type reference (TYPE) | /TDAG/CPE_VIEWERNO | Internal key of the document viewer | 20071012 | |||
| 11 | Instance attribute | Protected | Type reference (TYPE) | STRING | Directory, where the files will be stored | 20070904 | |||
| 12 | Instance attribute | Protected | Type reference (TYPE) | I | Size of the XMLf ile | 20070903 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Private | Method | Add element | 20070910 | |
| 2 | Instance method | Public | Constructor | Constructor of the class | 20071012 | |
| 3 | Instance method | Private | Method | Download XSL, CSS and head.xml file to frontend | 20071005 | |
| 4 | Instance method | Private | Method | Download a web object to the presentation server | 20071023 | |
| 5 | Instance method | Private | Method | Extract |
20070905 | |
| 6 | Instance method | Private | Method | Extract element and its sub-elements | 20070904 | |
| 7 | Instance method | Private | Method | Extract data for current node | 20070904 | |
| 8 | Instance method | Private | Method | Find xml element | 20070904 | |
| 9 | Instance method | Private | Method | Check, whether CfP XML file is Level1 or Full Disclosure | 20070911 | |
| 10 | Instance method | Public | Method | Extract |
20070911 | |
| 11 | Instance method | Public | Method | Extract data for given node and save it to file | 20070904 | |
| 12 | Instance method | Private | Method | Return directory, where the files to be stored | 20070904 | |
| 13 | Instance method | Private | Method | Initialize parser objects | 20070904 | |
| 14 | Instance method | Private | Method | Parse xml element | 20070904 | |
| 15 | Instance method | Private | Method | Parse reference xml data (substances, homogeneous materials) | 20071005 | |
| 16 | Instance method | Private | Method | Parse reference xml data (substances, homogeneous materials) | 20071002 | |
| 17 | Instance method | Public | Method | Set CfP XML file to be parsed | 20070903 |
Events
Class /TDAG/CPCL_HTML_DATA has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | L_CACHE_TAB_TYPE | Protected | See coding | 20070904 | |
||
| 2 | L_CACHE_WA | Protected | See coding | 20070904 | |
||
| 3 | L_LOCALID_REF_TAB_TYPE | Protected | See coding | 20071002 | |
||
| 4 | L_LOCALID_REF_WA | Protected | See coding | 20071002 | |
Method Signatures
Method ADD_STYLESHEET Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | E_XSL_LOCATION | Call by reference | Type reference (TYPE) | /TDAG/CPE_XSL_LOCATION | Location of a XSL file | 20071023 | |||
| 2 | E_XSL_PATH | Call by reference | Type reference (TYPE) | STRING | Path to the XSL program | 20071023 | |||
| 3 | IO_DOCUMENT | Call by reference | Object reference (TYPE REF TO) | IF_IXML_DOCUMENT | IF_IXML_DOCUMENT | 20070910 | |||
| 4 | IS_NODE | Call by reference | Type reference (TYPE) | /TDAG/CPS_PSTRDATA | CP: Struktur eines Knotens der Produktstruktur-Daten | 20070910 | |||
| 5 | I_FLG_LEVEL1 | Call by reference | Type reference (TYPE) | ESEBOOLE | Truth Value | 20070911 | |||
| 6 | XT_MESSAGE | Call by reference | Type reference (TYPE) | BAL_T_MSG | Application Log: Table with Messages | 20071023 | |||
| 7 | X_FLG_ERROR | Call by reference | Type reference (TYPE) | ESEBOOLE | Truth Value | 20071023 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Error during generation of result XML file | 20070910 |
Method CONSTRUCTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_FLT_VAL | Call by reference | Type reference (TYPE) | /TDAG/CPE_VIEWERNO | BADI Filter value | 20071012 |
Method CONSTRUCTOR on class /TDAG/CPCL_HTML_DATA has no exception.
Method DOWNLOAD_FILES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | E_XSL_PATH | Call by reference | Type reference (TYPE) | STRING | Returned path to the XSL file | 20071012 | |||
| 2 | I_CSS_LOCATION | Call by reference | Type reference (TYPE) | /TDAG/CPE_XSL_LOCATION | Location of the CSS file | 20071022 | |||
| 3 | I_CSS_PATH | Call by reference | Type reference (TYPE) | STRING | CSS path or key | 20071012 | |||
| 4 | I_HEAD_LOCATION | Call by reference | Type reference (TYPE) | /TDAG/CPE_XSL_LOCATION | location of the "head.xml" file | 20071022 | |||
| 5 | I_HEAD_PATH | Call by reference | Type reference (TYPE) | STRING | "head.xml" path or key | 20071022 | |||
| 6 | I_XSL_LOCATION | Call by reference | Type reference (TYPE) | /TDAG/CPE_XSL_LOCATION | Location of the XSL file | 20071022 | |||
| 7 | I_XSL_PATH | Call by reference | Type reference (TYPE) | STRING | XSL path or key | 20071012 | |||
| 8 | XT_MESSAGE | Call by reference | Type reference (TYPE) | BAL_T_MSG | Application Log: Table with Messages | 20071023 | |||
| 9 | X_FLG_ERROR | Call by reference | Type reference (TYPE) | ESEBOOLE | Truth Value | 20071023 |
Method DOWNLOAD_FILES on class /TDAG/CPCL_HTML_DATA has no exception.
Method DOWNLOAD_WEB_OBJECT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | E_PATH | Call by reference | Type reference (TYPE) | STRING | Path to the object | 20071023 | |||
| 2 | I_FILE_EXTENSION | Call by reference | Type reference (TYPE) | /TDAG/CPE_FILEEXT | File extension | 20071023 | |||
| 3 | I_FILE_NAME | Call by reference | Type reference (TYPE) | STRING | Hardcoded file name | 20071023 | |||
| 4 | I_PATH | Call by reference | Type reference (TYPE) | STRING | Path to the object | 20071023 | |||
| 5 | XT_MESSAGE | Call by reference | Type reference (TYPE) | BAL_T_MSG | Application Log: Table with Messages | 20071023 | |||
| 6 | X_FLG_ERROR | Call by reference | Type reference (TYPE) | ESEBOOLE | Truth Value | 20071023 |
Method DOWNLOAD_WEB_OBJECT on class /TDAG/CPCL_HTML_DATA has no exception.
Method EXTRACT_DOC_INFO Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | E_PATH | Call by reference | Type reference (TYPE) | STRING | URL to the XML/HTML file with the document information | 20071023 | |||
| 2 | I_FILE_NAME | Call by reference | Type reference (TYPE) | C | File name for the document information | 20071023 | |||
| 3 | XT_MESSAGE | Call by reference | Type reference (TYPE) | BAL_T_MSG | Application Log: Table with Messages | 20071023 | |||
| 4 | X_FLG_ERROR | Call by reference | Type reference (TYPE) | ESEBOOLE | Truth Value | 20071023 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Error during generation of result XML file | 20070905 |
Method EXTRACT_ELEMENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_BIN_DATA | Call by reference | Type reference (TYPE) | ANY TABLE | XML or HTML data | 20071022 | |||
| 2 | E_BIN_SIZE | Call by reference | Type reference (TYPE) | I | Size of the XML/HTML in bytes | 20071022 | |||
| 3 | E_EXTENSION | Call by reference | Type reference (TYPE) | STRING | File extension | 20071022 | |||
| 4 | IS_NODE | Call by reference | Type reference (TYPE) | /TDAG/CPS_PSTRDATA | CP: Struktur eines Knotens der Produktstruktur-Daten | 20070910 | |||
| 5 | XT_MESSAGE | Call by reference | Type reference (TYPE) | BAL_T_MSG | Application Log: Table with Messages | 20071023 | |||
| 6 | X_FLG_ERROR | Call by reference | Type reference (TYPE) | ESEBOOLE | Truth Value | 20071023 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Error during generation of result XML file | 20070904 | ||
| 2 | Element does not exist in the XML file | 20070904 | ||
| 3 | Error during parsing | 20070904 |
Method EXTRACT_NODE_DATA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | E_PATH | Call by reference | Type reference (TYPE) | STRING | Return path to the file | 20070904 | |||
| 2 | IS_NODE | Call by reference | Type reference (TYPE) | /TDAG/CPS_PSTRDATA | CP: Struktur eines Knotens der Produktstruktur-Daten | 20070904 | |||
| 3 | XT_MESSAGE | Call by reference | Type reference (TYPE) | BAL_T_MSG | Application Log: Table with Messages | 20071022 | |||
| 4 | X_FLG_ERROR | Call by reference | Type reference (TYPE) | ESEBOOLE | Truth Value | 20071022 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Error during generation of result XML file | 20070904 | ||
| 2 | Can not initialize parser objects | 20070904 | ||
| 3 | Error writing the result xml file to disk | 20070904 | ||
| 4 | 20070904 | |||
| 5 | Error during parsing | 20070904 |
Method FIND_ELEMENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | E_FLG_FOUND | Call by reference | Type reference (TYPE) | ESEBOOLE | Flag, whether element is found | 20070904 | |||
| 2 | I_ELEMENT_NAME | Call by reference | Type reference (TYPE) | STRING | Element name | 20070905 |
Method FIND_ELEMENT on class /TDAG/CPCL_HTML_DATA has no exception.
Method GET_DISCLOSURE_LEVEL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | E_FLG_LEVEL1 | Call by reference | Type reference (TYPE) | ESEBOOLE | Truth Value | 20070911 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Element does not exist in the XML file | 20070911 | ||
| 2 | Error during parsing | 20070911 |
Method GET_DOC_INFO Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_MESSAGE | Call by reference | Type reference (TYPE) | BAL_T_MSG | Application Log: Table with Messages | 20071022 | |||
| 2 | E_FLG_ERROR | Call by reference | Type reference (TYPE) | ESEBOOLE | Truth Value | 20071022 | |||
| 3 | E_URL | Call by reference | Type reference (TYPE) | STRING | Return URL | 20070911 |
Method GET_DOC_INFO on class /TDAG/CPCL_HTML_DATA has no exception.
Method GET_NODE_DATA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_MESSAGE | Call by reference | Type reference (TYPE) | BAL_T_MSG | Application Log: Table with Messages | 20071022 | |||
| 2 | E_FLG_ERROR | Call by reference | Type reference (TYPE) | ESEBOOLE | Truth Value | 20071022 | |||
| 3 | E_URL | Call by reference | Type reference (TYPE) | STRING | Return URL | 20070904 | |||
| 4 | IT_NODES | Call by reference | Type reference (TYPE) | /TDAG/CPY_PSTRDATA | Tree node, for which data will be parsed | 20070904 |
Method GET_NODE_DATA on class /TDAG/CPCL_HTML_DATA has no exception.
Method GET_SAVE_DIRECTORY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | E_DIRECTORY | Value transfer | Type reference (TYPE) | STRING | Directory to save | 20070904 |
Method GET_SAVE_DIRECTORY on class /TDAG/CPCL_HTML_DATA has no exception.
Method INIT_PARSER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | XT_MESSAGE | Call by reference | Type reference (TYPE) | BAL_T_MSG | Application Log: Table with Messages | 20071023 | |||
| 2 | X_FLG_ERROR | Call by reference | Type reference (TYPE) | ESEBOOLE | Truth Value | 20071023 |
Method INIT_PARSER on class /TDAG/CPCL_HTML_DATA has no exception.
Method PARSE_ELEMENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IO_DOCUMENT | Call by reference | Object reference (TYPE REF TO) | IF_IXML_DOCUMENT | IF_IXML_DOCUMENT | 20070904 | |||
| 2 | IO_PARENT | Call by reference | Object reference (TYPE REF TO) | IF_IXML_ELEMENT | IF_IXML_ELEMENT | 20070904 | |||
| 3 | I_ELEMENT_NAME | Call by reference | Type reference (TYPE) | STRING | Element name | 20070904 | |||
| 4 | XT_LOCAL_ID_REF | Call by reference | Type reference (TYPE) | L_LOCALID_REF_TAB_TYPE | Table with localIDRefs | 20071002 | |||
| 5 | XT_MESSAGE | Call by reference | Type reference (TYPE) | BAL_T_MSG | Application Log: Table with Messages | 20071023 | |||
| 6 | X_FLG_ERROR | Call by reference | Type reference (TYPE) | ESEBOOLE | Truth Value | 20071023 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Error during generation of result XML file | 20070904 |
Method PARSE_PROD_STRUCT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IO_DOCUMENT | Call by reference | Object reference (TYPE REF TO) | IF_IXML_DOCUMENT | IF_IXML_DOCUMENT | 20071005 | |||
| 2 | IO_PARENT | Call by reference | Object reference (TYPE REF TO) | IF_IXML_ELEMENT | IF_IXML_ELEMENT | 20071005 | |||
| 3 | IS_NODE | Call by reference | Type reference (TYPE) | /TDAG/CPS_PSTRDATA | CP: Struktur eines Knotens der Produktstruktur-Daten | 20071005 | |||
| 4 | XT_LOCAL_ID_REF | Call by reference | Type reference (TYPE) | L_LOCALID_REF_TAB_TYPE | Table with localIDRefs | 20071005 | |||
| 5 | XT_MESSAGE | Call by reference | Type reference (TYPE) | BAL_T_MSG | Application Log: Table with Messages | 20071023 | |||
| 6 | X_FLG_ERROR | Call by reference | Type reference (TYPE) | ESEBOOLE | Truth Value | 20071023 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Error during generation of result XML file | 20071005 |
Method PARSE_REF_DATA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IO_DOCUMENT | Call by reference | Object reference (TYPE REF TO) | IF_IXML_DOCUMENT | IF_IXML_DOCUMENT | 20071002 | |||
| 2 | IO_PARENT | Call by reference | Object reference (TYPE REF TO) | IF_IXML_ELEMENT | IF_IXML_ELEMENT | 20071002 | |||
| 3 | IT_LOCAL_ID_REF | Call by reference | Type reference (TYPE) | L_LOCALID_REF_TAB_TYPE | Table with localIDRefs | 20071002 | |||
| 4 | XT_MESSAGE | Call by reference | Type reference (TYPE) | BAL_T_MSG | Application Log: Table with Messages | 20071023 | |||
| 5 | X_FLG_ERROR | Call by reference | Type reference (TYPE) | ESEBOOLE | Truth Value | 20071023 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Error during generation of result XML file | 20071002 |
Method SET_XML_FILE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IT_XML_DATA | Call by reference | Type reference (TYPE) | STANDARD TABLE | Data to be displayed | 20070903 | |||
| 2 | I_FILE_SIZE | Call by reference | Type reference (TYPE) | I | Size of the xml file | 20070903 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | IT_XML_DATA table is empty | 20070903 | ||
| 2 | I_FILE_SIZE parameter is initial | 20070903 |
History
| Last changed by/on | SAP | 20141109 |
| SAP Release Created in | 222_46C |