SAP ABAP Interface IF_DBA_EXPLAIN_NODE (Explain node interface for JNet XML generation)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-DB (Application Component) Database Interface, Database Platforms
     ⤷ SDBA_COMMON (Package) Cross-Platform DBA cockpit objects

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	CL_DBA_XPL_NODE	abstract EXPLAIN node	20061019

Properties

Interface	IF_DBA_EXPLAIN_NODE
Short Description	Explain node interface for JNet XML generation

General Data

Package	SDBA_COMMON	Cross-Platform DBA cockpit objects
Created	20060809	SAP
Last changed	20130531	SAP
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	ABAP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
2	IF_DBA_EXPLAIN_NODE	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_SERIALIZABLE_OBJECT	☐	☐	Serializable Object	20070403

Friends

Interface IF_DBA_EXPLAIN_NODE has no friend.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	ACC_DETAIL1_DESCR	Static Attribute	Public	☐	Type reference (TYPE)	STRING			20061107
2	ACC_DETAIL2_DESCR	Static Attribute	Public	☐	Type reference (TYPE)	STRING			20061107
3	ACC_DETAIL3_DESCR	Static Attribute	Public	☐	Type reference (TYPE)	STRING			20061107
4	COLLAPSED	Instance attribute	Public	☐	Type reference (TYPE)	ABAP_BOOL			20061010
5	DEFAULT_OUTGOING_EDGE_WIDTH	Constant	Public	☐	Type reference (TYPE)	I	2		20080214
6	DETAIL1	Instance attribute	Public	☐	Type reference (TYPE)	STRING			20070201
7	DETAIL2	Instance attribute	Public	☐	Type reference (TYPE)	STRING			20070201
8	DETAIL3	Instance attribute	Public	☐	Type reference (TYPE)	STRING			20070201
9	DETAIL4	Instance attribute	Public	☐	Type reference (TYPE)	STRING			20070201
10	EDGE_DESCR_PLACEMENT	Instance attribute	Public	☐	Type reference (TYPE)	I			20080225
11	EXPANDED	Instance attribute	Public	☐	Type reference (TYPE)	ABAP_BOOL			20070924
12	IS_SUMMARY_NODE	Instance attribute	Public	☐	Type reference (TYPE)	ABAP_BOOL			20100422
13	NEEDS_UPDATE	Instance attribute	Public	☐	Type reference (TYPE)	ABAP_BOOL		delta JNet update required?	20070924
14	NODE_DESCRIPTION	Instance attribute	Public	☐	Type reference (TYPE)	STRING			20100422
15	NODE_DETAILS	Instance attribute	Public	☐	Type reference (TYPE)	DBAXPLDETOBJ_TAB		EXPLAIN: Table of DBAXPLDETOBJ	20061002
16	NODE_ID	Instance attribute	Public	☐	Type reference (TYPE)	I			20060809
17	NODE_INFO	Instance attribute	Public	☐	Object reference (TYPE REF TO)	IF_DBA_EXPLAIN_NODE_INFO		DBA Explain Model: Node Summary Info	20070207
18	OPERATOR	Instance attribute	Public	☐	Type reference (TYPE)	STRING			20060809
19	OUTGOING_EDGE_DESCR	Instance attribute	Public	☐	Type reference (TYPE)	STRING			20080221
20	OUTGOING_EDGE_TYPE	Instance attribute	Public	☐	Type reference (TYPE)	STRING			20080221
21	OUTGOING_EDGE_WIDTH	Instance attribute	Public	☐	Type reference (TYPE)	I			20080214
22	PARENT_ID	Instance attribute	Public	☐	Type reference (TYPE)	I			20060810
23	PARENT_IS_SUMMARY	Instance attribute	Public	☐	Type reference (TYPE)	ABAP_BOOL			20100422
24	PLACE_DESCR_LEFT	Constant	Public	☐	Type reference (TYPE)	I	1		20080225
25	PLACE_DESCR_RIGHT	Constant	Public	☐	Type reference (TYPE)	I	0		20080225
26	PREDICATES	Instance attribute	Public	☐	Type reference (TYPE)	DBAXPLPREDOBJ_TAB		EXPLAIN: Table of DBAXPLDETOBJ	20061024

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	GET_NODE_DETAILS	Instance method	Public	Method		20061004
2	GET_NODE_ID	Instance method	Public	Method		20060810
3	GET_OPERATOR_DESCR	Instance method	Public	Method		20080227
4	GET_PARENT_ID	Instance method	Public	Method		20060810
5	GET_SG_ACC_TREE	Instance method	Public	Method		20061108
6	GET_WD_ACC_TREE	Instance method	Public	Method		20061108
7	IS_COLLAPSED	Instance method	Public	Method		20061010
8	IS_EXPANDED	Instance method	Public	Method		20070924
9	LINK_TO_PARENT	Instance method	Public	Method		20060810
10	SET_COLLAPSED	Instance method	Public	Method	childs collapsed status	20061010
11	SET_EXPANDED	Instance method	Public	Method	node details expanded status	20070924
12	SET_OUTGOING_EDGE_WIDTH	Instance method	Public	Method		20080214
13	TO_GENERIC_DOWNLOAD	Instance method	Public	Method		20111202
14	TO_XML	Instance method	Public	Method		20060809

Events

Interface IF_DBA_EXPLAIN_NODE has no event.

Types

Interface IF_DBA_EXPLAIN_NODE has no local type.

Method Signatures

Method GET_NODE_DETAILS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	DETAILS	Value transfer	☐	Type reference (TYPE)	DBAXPLDETOBJ_TAB		EXPLAIN: Table of DBAXPLDETOBJ	20061004

Method GET_NODE_DETAILS on Interface IF_DBA_EXPLAIN_NODE has no exception.

Method GET_NODE_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ID	Value transfer	☐	Type reference (TYPE)	I			20060810

Method GET_NODE_ID on Interface IF_DBA_EXPLAIN_NODE has no exception.

Method GET_OPERATOR_DESCR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	DESCR	Value transfer	☐	Type reference (TYPE)	STRING			20080227

Method GET_OPERATOR_DESCR on Interface IF_DBA_EXPLAIN_NODE has no exception.

Method GET_PARENT_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	PARENT	Value transfer	☐	Type reference (TYPE)	I			20060810

Method GET_PARENT_ID on Interface IF_DBA_EXPLAIN_NODE has no exception.

Method GET_SG_ACC_TREE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ITEM_TABLE	Call by reference	☐	Type reference (TYPE)	DB6_MTREEITM_TAB		DB6: Table of MTREEITM	20061108
2	Exporting	NODE_KEY	Call by reference	☐	Type reference (TYPE)	DB6CFGTREE		DB6: Table of DB6CFGTREE	20061108
3	Exporting	NODE_TABLE	Call by reference	☐	Type reference (TYPE)	TREEV_NTAB		Tree Control: Node Table	20061108
4	Importing	UI_CFG	Call by reference	☐	Type reference (TYPE)	DBAXPLUICFG		DBA Explain: Node UI Config	20080220

Method GET_SG_ACC_TREE on Interface IF_DBA_EXPLAIN_NODE has no exception.

Method GET_WD_ACC_TREE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	NODEDESCR	Call by reference	☐	Type reference (TYPE)	DBAXPLTREE_ACC		DBA Cockpit: EXPLAIN tree structure for accessibility view	20061108
2	Importing	UI_CFG	Call by reference	☐	Type reference (TYPE)	DBAXPLUICFG		DBA Explain: Node UI Config	20080220

Method GET_WD_ACC_TREE on Interface IF_DBA_EXPLAIN_NODE has no exception.

Method IS_COLLAPSED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	COLLAPSED	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20061010

Method IS_COLLAPSED on Interface IF_DBA_EXPLAIN_NODE has no exception.

Method IS_EXPANDED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	EXPANDED	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20070924

Method IS_EXPANDED on Interface IF_DBA_EXPLAIN_NODE has no exception.

Method LINK_TO_PARENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	LEG_TYPE	Call by reference	☐	Type reference (TYPE)	STRING			20070404
2	Returning	LINK	Value transfer	☐	Type reference (TYPE)	STRING			20060810
3	Importing	UI_CFG	Call by reference	☐	Type reference (TYPE)	DBAXPLUICFG		DBA Explain: Node UI Config	20080219

Method LINK_TO_PARENT on Interface IF_DBA_EXPLAIN_NODE has no exception.

Method SET_COLLAPSED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	COLLAPSED	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20061010

Method SET_COLLAPSED on Interface IF_DBA_EXPLAIN_NODE has no exception.

Method SET_EXPANDED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	EXPANDED	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20070924

Method SET_EXPANDED on Interface IF_DBA_EXPLAIN_NODE has no exception.

Method SET_OUTGOING_EDGE_WIDTH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DESCR_PLACEMENT	Call by reference	☐	Type reference (TYPE)	I	IF_DBA_EXPLAIN_NODE=>PLACE_DESCR_RIGHT		20080225
2	Importing	OUTGOING_EDGE_DESCR	Call by reference	☑	Type reference (TYPE)	STRING			20080221
3	Importing	OUTGOING_EDGE_WIDTH	Call by reference	☐	Type reference (TYPE)	I		width in pixels	20080214

Method SET_OUTGOING_EDGE_WIDTH on Interface IF_DBA_EXPLAIN_NODE has no exception.

Method TO_GENERIC_DOWNLOAD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	INDENT	Call by reference	☐	Type reference (TYPE)	I			20111202
2	Importing	IS_LEAF	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20111209
3	Returning	PLAN	Value transfer	☐	Type reference (TYPE)	EXPL_PLAN_TAB		Access Plan Output Line (FB RS_EXPLAIN_PLAN...)	20111202

Method TO_GENERIC_DOWNLOAD on Interface IF_DBA_EXPLAIN_NODE has no exception.

Method TO_XML Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_LEAF	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20070924
2	Importing	UI_CFG	Call by reference	☐	Type reference (TYPE)	DBAXPLUICFG		DBA Explain: Node UI Config	20070208
3	Returning	XML	Value transfer	☐	Type reference (TYPE)	STRING			20060809

Method TO_XML on Interface IF_DBA_EXPLAIN_NODE has no exception.

History

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