SAP ABAP Class CL_DB4_EXPLAIN_INSTANCE (DB4: Explain Instance)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-DB-DB4 (Application Component) DB2 for AS/400
⤷
STU4 (Package) CCMS / AS/400
⤷
⤷
Meta Relationship - Using
| # | Relationship type | Using | Short Description | Created on |
|---|---|---|---|---|
| 1 | Inheritance (c INHERITING FROM c_ref) | CL_DBA_EXPLAIN_INSTANCE | General Explain Instance | 20130719 |
Properties
| Class | CL_DB4_EXPLAIN_INSTANCE | |
| Short Description | DB4: Explain Instance | |
| Super Class | CL_DBA_EXPLAIN_INSTANCE | General Explain Instance |
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | STU4 | CCMS / AS/400 |
| Created | 20130719 | SAP |
| Last change | 20141121 | |
| 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) | |
| 2 | Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) |
Interfaces
Class CL_DB4_EXPLAIN_INSTANCE has no interface implemented.
Friends
Class CL_DB4_EXPLAIN_INSTANCE has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Constant | Public | Type reference (TYPE) | STRING | 'DB4CPUCOST' | 20130802 | |||
| 2 | Constant | Public | Type reference (TYPE) | STRING | 'DB4CUMTIME' | 20130802 | |||
| 3 | Constant | Public | Type reference (TYPE) | STRING | 'DB4IOCOST' | 20130802 | |||
| 4 | Constant | Public | Type reference (TYPE) | STRING | 'DB4IOCOUNT' | 20130802 | |||
| 5 | Instance attribute | Private | Type reference (TYPE) | TY_CATOBJECTS_TAB | 20130807 | ||||
| 6 | Instance attribute | Private | Type reference (TYPE) | DBAXPLDETOBJ_TAB | General details table | 20130809 | |||
| 7 | Instance attribute | Private | Type reference (TYPE) | TY_EXPLINFOS_TAB | 20130719 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Private | Method | Add level information to each node | 20130809 | |
| 2 | Instance method | Private | Method | Add a new node | 20130722 | |
| 3 | Instance method | Private | Method | Build the explain tree | 20130719 | |
| 4 | Instance method | Public | Constructor | 20130719 | ||
| 5 | Instance method | Private | Method | Load records to the object | 20131001 | |
| 6 | Instance method | Private | Method | Prepare the node details for a node | 20130723 | |
| 7 | Instance method | Private | Method | Read the catalog information | 20130807 | |
| 8 | Instance method | Private | Method | Remove unknown record types | 20130805 | |
| 9 | Instance method | Private | Method | Set the general details for explain | 20130809 |
Events
Class CL_DB4_EXPLAIN_INSTANCE has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | TY_CATOBJECT | Private | See coding | 20130807 | begin of ty_catobject,
kind type string,
table_schema type string,
table_name type string,
index_schema type string,
index_name type string,
catalog type qsystables,
object type ref to cl_dba_xplm_object,
cat_cols_tab type db4_syscol,
columns_tab type ty_columns_tab,
icol_tab type dbaxplm_icol_tab,
indexes_tab type ty_indexes_tab,
iix_tab type dbaxplm_iix_tab,
end of ty_catobject
|
||
| 2 | TY_CATOBJECTS_TAB | Private | See coding | 20130807 | ty_catobjects_tab type standard table of ty_catobject with key kind table_schema table_name
|
||
| 3 | TY_COLUMN | Private | See coding | 20130807 | begin of ty_column,
dbname type string,
tbname type string,
name type string,
colno type i,
details type dbaxplndet_tab,
end of ty_column
|
||
| 4 | TY_COLUMNS_TAB | Private | See coding | 20130807 | ty_columns_tab type standard table of ty_column with key dbname tbname name
|
||
| 5 | TY_EXPLINFO | Public | See coding | 20130722 | begin of TY_EXPLINFO,
IFA_ICON type i ,
IFA_COLTYP type i ,
IFA_CTXTYP type i ,
IFA_CTXORD type i ,
IFA_FLYORD type i ,
IFA_ARWORD type i ,
IFA_ARWVAL type i ,
IFA_FMTVAL type i ,
IFA_IFLAG type c length 1,
IFA_TYPOUT type c length 1 ,
IFA_COLHDG type string ,
IFA_DESCR type i ,
IFA_CHROUT type string ,
IFA_NUMOUT type i ,
end of TY_EXPLINFO
|
||
| 6 | TY_EXPLINFOS_TAB | Public | See coding | 20130722 | TY_EXPLINFOS_TAB type standard table of TY_EXPLINFO with key IFA_ICON IFA_COLTYP
|
||
| 7 | TY_INDEX | Private | See coding | 20130807 | begin of ty_index,
dbname type string,
tbname type string,
name type string,
uniquerule type c length 1,
colcount type i,
keys type ty_indexkeys_tab,
end of ty_index
|
||
| 8 | TY_INDEXES_TAB | Private | See coding | 20130807 | ty_indexes_tab type standard table of ty_index with key dbname tbname name
|
||
| 9 | TY_INDEXKEY | Private | See coding | 20130807 | begin of ty_indexkey,
ixname type string,
colname type string,
colseq type i,
ordering type c length 1,
end of ty_indexkey
|
||
| 10 | TY_INDEXKEYS_TAB | Private | See coding | 20130807 | ty_indexkeys_tab type standard table of ty_indexkey with key ixname
|
Method Signatures
Method ADD_LEVEL_INFORMATION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ACC_TREE_TAB | Call by reference | Type reference (TYPE) | DBAXPLTREE_ACC_TAB | DBA Cockpit: Table of DBAXPLTREE_ACC | 20130809 |
Method ADD_LEVEL_INFORMATION on class CL_DB4_EXPLAIN_INSTANCE has no exception.
Method ADD_NODE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_NODE_INFO | Call by reference | Type reference (TYPE) | TY_EXPLINFO | 20130722 | ||||
| 2 | I_PARENT_ID | Call by reference | Type reference (TYPE) | I | 20130722 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | DBA Cockpit: ADBC Errors | 20130722 |
Method BUILD_TREE Signature
Method BUILD_TREE on class CL_DB4_EXPLAIN_INSTANCE has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | DBA Cockpit: ADBC Errors | 20130722 |
Method CONSTRUCTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_EXPLINFO_TAB | Call by reference | Type reference (TYPE) | TY_EXPLINFOS_TAB | 20130719 | ||||
| 2 | I_PLAN_VERSION_ID | Call by reference | Type reference (TYPE) | CLIKE | 20131129 | ||||
| 3 | I_R_SYS | Call by reference | Object reference (TYPE REF TO) | CL_DB6_SYS | DB6: Remote System Administration | 20130719 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | DBA Cockpit: ADBC Errors | 20130722 |
Method LOAD_RECORDS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_EXPLINFOS_TAB | Call by reference | Type reference (TYPE) | TY_EXPLINFOS_TAB | 20131001 |
Method LOAD_RECORDS on class CL_DB4_EXPLAIN_INSTANCE has no exception.
Method PREPARE_NODE_DETAILS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | E_DETAILS_TAB | Call by reference | Type reference (TYPE) | DBAXPLDETOBJ_TAB | EXPLAIN: Table of DBAXPLDETOBJ | 20130723 | |||
| 2 | E_INDEX_NAME | Call by reference | Type reference (TYPE) | STRING | 20130807 | ||||
| 3 | E_KEY_COLCNT | Call by reference | Type reference (TYPE) | I | 20130807 | ||||
| 4 | E_KEY_COLS | Call by reference | Type reference (TYPE) | STRING | 20130807 | ||||
| 5 | E_OUTGOING_EDGE_DESCR | Call by reference | Type reference (TYPE) | STRING | 20130802 | ||||
| 6 | E_R_NODE_INFO | Call by reference | Object reference (TYPE REF TO) | CL_DBA_XPLM_NODE_INFO | DBA Explain Model: Node Summary Info | 20130802 | |||
| 7 | E_R_XPLM_OBJECT | Call by reference | Object reference (TYPE REF TO) | CL_DBA_XPLM_OBJECT | DBA EXPLAIN Model: catalog object | 20130805 | |||
| 8 | I_IFA_ICON | Call by reference | Type reference (TYPE) | I | 20130723 |
Method PREPARE_NODE_DETAILS on class CL_DB4_EXPLAIN_INSTANCE has no exception.
Method READ_CATALOG Signature
Method READ_CATALOG on class CL_DB4_EXPLAIN_INSTANCE has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | DBA Cockpit: Root exception class | 20130809 |
Method REMOVE_UNKNOWN_RECORD_TYPES Signature
Method REMOVE_UNKNOWN_RECORD_TYPES on class CL_DB4_EXPLAIN_INSTANCE has no parameter.
Method REMOVE_UNKNOWN_RECORD_TYPES on class CL_DB4_EXPLAIN_INSTANCE has no exception.
Method SET_GENERAL_DETAILS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_PLAN_VERSION_ID | Call by reference | Type reference (TYPE) | CLIKE | 20131129 |
Method SET_GENERAL_DETAILS on class CL_DB4_EXPLAIN_INSTANCE has no exception.
History
| Last changed by/on | SAP | 20141121 |
| SAP Release Created in | 740 |