SAP ABAP Class CL_MSS_PVIEW (MSSQL : Performance snapshot viewer)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-DB-MSS (Application Component) Microsoft SQL Server
     ⤷ SMSS_TOOLS (Package) Utilities for MS SQL Server

Properties

Class	CL_MSS_PVIEW
Short Description	MSSQL : Performance snapshot viewer
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SMSS_TOOLS	Utilities for MS SQL Server
Created	20121109	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	CL_MSS_PSNAP	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
2	CL_MSS_RAT	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)

Interfaces

Class CL_MSS_PVIEW has no interface implemented.

Friends

Class CL_MSS_PVIEW has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CONTENTS	Instance attribute	Private	☐	Type reference (TYPE)	ARSC_EXTENDED_TYPE		Extended sheet content table	20121115
2	DOWNSTACK	Instance attribute	Private	☐	Type reference (TYPE)	STACK_TYPE		Drilldown stack type	20121115
3	HEADER	Instance attribute	Public	☑	Type reference (TYPE)	MSSPPACK		MSSQL : list of DB performance snapshots	20121109
4	RS_ADM	Instance attribute	Private	☐	Type reference (TYPE)	ARDR_UNSORTED		Rowset administration list	20121115
5	RS_TYPE_TEXT	Constant	Public	☐	Type reference (TYPE)	CL_MSS_RAT=>TLIST_L-PTYPE	'Text'	Rowset type	20121116
6	RS_TYPE_XML	Constant	Public	☐	Type reference (TYPE)	CL_MSS_RAT=>TLIST_L-PTYPE	'XML'	Rowset type	20121116
7	SHEETS	Instance attribute	Private	☐	Type reference (TYPE)	CL_MSS_PSNAP=>ARSH_TYPE_30		Basic sap_sheets table type	20121114
8	TX_PACK_PROP	Constant	Public	☐	Type reference (TYPE)	CL_MSS_PSNAP=>ARSH_LINE_30-SHEET_DESC	'Package properties'	Package property sheet	20121114
9	TX_PACK_PSEUDO_PROVIDER	Constant	Public	☐	Type reference (TYPE)	CL_MSS_RAT=>TLIST_L-DESCRIPT	'Performance package metadata'		20121114

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CLASSIFY_SINGLESINGLE	Instance method	Private	Method	Determine the content type of a single string rowset	20121116
2	COMPLEMENT_DRILLDOWN_LINE	Instance method	Private	Method	Fill in various rowset attributes and components	20121116
3	COMPLEMENT_PROPERTY_LINE	Instance method	Private	Method	Special handling of first rowset (package properties)	20121116
4	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20121109
5	DESERIALIZE_XML	Static method	Public	Method	Populate a given rowset from an XML fragment	20121109
6	GET_DRILLDOWN_DEPTH	Instance method	Public	Method	Return the current size of the drilldown stack	20121117
7	GET_FIRST_CONTENT	Instance method	Public	Method	Get the first TABLE_NUM for a given SHEET_NUM	20121115
8	GET_SHEET_CONTENT	Instance method	Public	Method	Return the sheet contents (package or specific sheet)	20121114
9	GET_SHEET_LIST	Instance method	Public	Method	Return the sheet list of the package	20121109
10	GET_STACK_F4TEXT	Instance method	Public	Method	Concatenate a friendly text (RAT provider and parameters)	20121115
11	GET_TABLE_HEADER	Instance method	Public	Method	Concatenate the RAT provider short text, name and parameters	20121117
12	INDX_TO_SHEET	Instance method	Public	Method	Convert 1-based sheet index to sheet (prop included)	20121114
13	INIT_DRILLDOWN_STACK	Instance method	Public	Method	Re-initialize the drilldown stack	20121115
14	OCLIST_TO_FCAT	Instance method	Private	Method	Convert RAT output structure meta data to an ALV field cat	20121116
15	PERFORM_DRILLDOWN	Instance method	Public	Method	Process click on hyperlinked cell	20121116
16	READ_PACKAGE_FRAGMENT	Instance method	Private	Method	Retrieve an XML fragment from table MSSROWSET	20121109
17	REMEMBER_ALV_POSITION	Instance method	Public	Method	Save clicked cell position ahead of drilldown	20121117
18	RENDER_ROWSET	Instance method	Public	Method	Fill dynpro 4300's custom control	20121116

Events

Class CL_MSS_PVIEW has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	ARDR_UNSORTED	Private	See coding		Standard table of AR_DR	20121115	ARDR_UNSORTED TYPE STANDARD TABLE OF CL_MSS_PSNAP=>ARDR_LINE_30
2	ARSC_EXTENDED_LINE	Public	See coding		Sheet content definition plus data provider description	20121114	BEGIN OF ARSC_EXTENDED_LINE . INCLUDE TYPE CL_MSS_PSNAP=>ARSC_LINE_30. TYPES : DESCRIPT TYPE CL_MSS_RAT=>TLIST_L-DESCRIPT , END OF ARSC_EXTENDED_LINE
3	ARSC_EXTENDED_TYPE	Public	See coding		Extended sheet content table	20121114	ARSC_EXTENDED_TYPE TYPE STANDARD TABLE OF ARSC_EXTENDED_LINE
4	PARASTACK_L	Private	See coding		Parameter stack line type	20121116	BEGIN OF PARASTACK_L , CLPARAM TYPE CL_MSS_RAT=>ISTRUCT_L-COLNAME , VALUE TYPE CL_MSS_PSNAP=>ARIP_LINE_30-VALUE , END OF PARASTACK_L
5	STACK_LINE	Private	See coding		Line of drilldown stack	20121115	BEGIN OF STACK_LINE , SEQ_NO TYPE CL_MSS_PSNAP=>ARDR_LINE_30-SEQ_NO , META_SEQ TYPE CL_MSS_PSNAP=>ARDR_LINE_30-META_SEQ , OBJNAME TYPE CL_MSS_RAT=>TLIST_L-OBJNAME , NRKEYS TYPE I , PTYPE TYPE CL_MSS_RAT=>TLIST_L-PTYPE , DESCRIPT TYPE CL_MSS_RAT=>TLIST_L-DESCRIPT , RESITAB TYPE REF TO DATA , OCLIST TYPE REF TO DATA , IPLIST TYPE REF TO DATA , OUTFCAT TYPE LVC_T_FCAT , ROW_ID TYPE LVC_S_ROW , " ALV scroll position COLUMN_ID TYPE LVC_S_COL , " ALV scroll position CLICK_ROW TYPE I , END OF STACK_LINE
6	STACK_TYPE	Private	See coding		Drilldown stack type	20121115	STACK_TYPE TYPE STANDARD TABLE OF STACK_LINE
7	STRING_TAB	Public	See coding		Standard table of strings	20121115	STRING_TAB TYPE STANDARD TABLE OF STRING

Method Signatures

Method CLASSIFY_SINGLESINGLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	PTYPE	Call by reference	☐	Type reference (TYPE)	CL_MSS_RAT=>TLIST_L-PTYPE		Rowset type	20121116
2	Importing	RESITAB	Call by reference	☐	Object reference (TYPE REF TO)	DATA		Rowset	20121116

Method CLASSIFY_SINGLESINGLE on class CL_MSS_PVIEW has no exception.

Method COMPLEMENT_DRILLDOWN_LINE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	DLINE	Call by reference	☐	Type reference (TYPE)	STACK_LINE			20121116

#	Exception	Resumable	Description	Created on
1	CX_SMSS_TOOLS	☐		20121116

Method COMPLEMENT_PROPERTY_LINE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	DLINE	Call by reference	☐	Type reference (TYPE)	STACK_LINE			20121116

#	Exception	Resumable	Description	Created on
1	CX_SMSS_TOOLS	☐		20121116

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PACK_ID	Call by reference	☐	Type reference (TYPE)	MSSPPACK-PACK_ID		UUID in character form	20121109

#	Exception	Resumable	Description	Created on
1	CX_SMSS_TOOLS	☐	MSSQL exception class	20121109

Method DESERIALIZE_XML Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	ITAB	Call by reference	☐	Object reference (TYPE REF TO)	DATA		Pointer to internal table	20121109
2	Importing	XMLSTRING	Call by reference	☐	Type reference (TYPE)	XSTRING		XML fragment	20121109

#	Exception	Resumable	Description	Created on
1	CX_SMSS_TOOLS	☐	MSSQL exception class	20121109

Method GET_DRILLDOWN_DEPTH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	DEPTH	Value transfer	☐	Type reference (TYPE)	I		Stack depth	20121117

Method GET_DRILLDOWN_DEPTH on class CL_MSS_PVIEW has no exception.

Method GET_FIRST_CONTENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	SHEET_NUM	Call by reference	☐	Type reference (TYPE)	NUM4		Sheet index (including property sheet)	20121115
2	Returning	TABLE_NUM	Value transfer	☐	Type reference (TYPE)	NUM4		Data table index (including property entry)	20121115

Method GET_FIRST_CONTENT on class CL_MSS_PVIEW has no exception.

Method GET_SHEET_CONTENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	CONTENT_LIST	Call by reference	☐	Type reference (TYPE)	ARSC_EXTENDED_TYPE		sap_sheet_contents table type	20121114

#	Exception	Resumable	Description	Created on
1	CX_SMSS_TOOLS	☐	MSSQL exception class	20121114

Method GET_SHEET_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	SHEET_LIST	Value transfer	☐	Type reference (TYPE)	CL_MSS_PSNAP=>ARSH_TYPE_30		Basic sap_sheets table type	20121109

Method GET_SHEET_LIST on class CL_MSS_PVIEW has no exception.

Method GET_STACK_F4TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	TEXT_TAB	Value transfer	☐	Type reference (TYPE)	STRING_TAB		Friendly text	20121115

#	Exception	Resumable	Description	Created on
1	CX_SMSS_TOOLS	☐	MSSQL exception class	20121115

Method GET_TABLE_HEADER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	DESCRIPT	Value transfer	☐	Type reference (TYPE)	STRING		Text	20121117
2	Importing	STACK_NUM	Call by reference	☐	Type reference (TYPE)	NUM4		Drilldown stack level	20121117

Method GET_TABLE_HEADER on class CL_MSS_PVIEW has no exception.

Method INDX_TO_SHEET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	SHEET_LINE	Value transfer	☐	Type reference (TYPE)	CL_MSS_PSNAP=>ARSH_LINE_30		Basic sap_sheets line type	20121114
2	Importing	SHEET_NUM	Call by reference	☐	Type reference (TYPE)	NUM4		Sheet index (including property sheet)	20121114

Method INDX_TO_SHEET on class CL_MSS_PVIEW has no exception.

Method INIT_DRILLDOWN_STACK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	SHEET_NUM	Call by reference	☐	Type reference (TYPE)	NUM4		Sheet index (including properties)	20121115
2	Importing	TABLE_NUM	Call by reference	☐	Type reference (TYPE)	NUM4		Data table index on sheet	20121115

#	Exception	Resumable	Description	Created on
1	CX_SMSS_TOOLS	☐	MSSQL exception class	20121115

Method OCLIST_TO_FCAT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	FCAT	Call by reference	☐	Type reference (TYPE)	LVC_T_FCAT		Field Catalog for List Viewer Control	20121116
2	Importing	NRKEYS	Call by reference	☐	Type reference (TYPE)	CL_MSS_RAT=>TLIST_L-NRKEYS		Number of key fields	20121116
3	Importing	OCLIST	Call by reference	☐	Object reference (TYPE REF TO)	DATA		RAT output structure	20121116

Method OCLIST_TO_FCAT on class CL_MSS_PVIEW has no exception.

Method PERFORM_DRILLDOWN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	COLNAME	Call by reference	☐	Type reference (TYPE)	CL_MSS_RAT=>OSTRUCT_L-COLNAME		Name of clicked column	20121116
2	Importing	ROWNUM	Call by reference	☐	Type reference (TYPE)	I		Number of clicked row	20121116
3	Importing	STACK_NUM	Call by reference	☐	Type reference (TYPE)	NUM4		Active stack level	20121116

#	Exception	Resumable	Description	Created on
1	CX_SMSS_TOOLS	☐	MSSQL exception class	20121116

Method READ_PACKAGE_FRAGMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	AREA_ID	Call by reference	☐	Type reference (TYPE)	MSSROWSET-RELID		INDX-style area specification	20121109
2	Importing	SEQ_NO	Call by reference	☐	Type reference (TYPE)	MSSROWSET-SEQ_NO		Rowset index within performance snapshot	20121109
3	Returning	XMLSTRING	Value transfer	☐	Type reference (TYPE)	XSTRING		XML fragment	20121109

#	Exception	Resumable	Description	Created on
1	CX_SMSS_TOOLS	☐	MSSQL exception class	20121109

Method REMEMBER_ALV_POSITION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	COLUMN_ID	Call by reference	☐	Type reference (TYPE)	LVC_S_COL		ALV Control: Column ID	20121117
2	Importing	ROW_ID	Call by reference	☐	Type reference (TYPE)	LVC_S_ROW		ALV control: Line description	20121117
3	Importing	STACK_NUM	Call by reference	☐	Type reference (TYPE)	NUM4		Current stack level	20121117

Method REMEMBER_ALV_POSITION on class CL_MSS_PVIEW has no exception.

Method RENDER_ROWSET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ACTION_REF	Call by reference	☐	Object reference (TYPE REF TO)	CL_MSS_ACTION_PACKAGE_VIEWER		MSSQL: View selected performance package	20121116
2	Importing	GUI_CONTAINER	Call by reference	☐	Object reference (TYPE REF TO)	CL_GUI_CUSTOM_CONTAINER		Container for Custom Controls in the Screen Area	20121116
3	Importing	STACK_NUM	Call by reference	☐	Type reference (TYPE)	NUM4		Stack index to render	20121116

Method RENDER_ROWSET on class CL_MSS_PVIEW has no exception.

History

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