SAP ABAP Class CL_RSDRH_HIER_CACHE (Hierarchy Cache)

Hierarchy

☛ SAP_BW (Software Component) SAP Business Warehouse
   ⤷ BW-BEX-OT (Application Component) OLAP Technology
     ⤷ RSDRC (Package) Data Manager InfoProvider Read Access

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_RSDRH_HIER_CACHE_DB	Hierarchy Cache in DataBase	20040524
2	Inheritance (c INHERITING FROM c_ref)	CL_RSDRH_HIER_CACHE_TREX	Hierarchy Cache in DataBase	20040628

Properties

Class	CL_RSDRH_HIER_CACHE
Short Description	Hierarchy Cache
Super Class
Instantiability of a Class	1	Protected
Final	☐

General Data

Message Class
Program status
Category	0
Package	RSDRC	Data Manager InfoProvider Read Access
Created	20040517	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_RSDRH_HIER_REST	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
2	IF_RSDRH_HIER_STORAGE	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
3	RRHI	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
4	RS	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
5	RSD	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_RSDRH_HIER_CACHE has no interface implemented.

Friends

#	Friend	Modeled only	Created on	Description
1	CL_RSDRH_HIER_REST	☐	20040518	Hierarchy Restriction

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	N_C_HIER_CON	Constant	Public	☐	Type reference (TYPE)	DBCON_NAME	IF_RSDRH_HIER_STORAGE=>N_C_HIER_CON	Database Connection	20051207
2	O_COMMIT_ALLOWED	Instance attribute	Protected	☐	Type reference (TYPE)	RS_BOOL	rs_c_true	Commit on default connection allowed	20060602
3	O_C_TIMESTMP_INI	Constant	Protected	☐	Type reference (TYPE)	RSTIMESTMP	0	Initial timestamp	20040524
4	O_DIR_TABLE	Instance attribute	Protected	☐	Type reference (TYPE)	RSD_TABLNM		Directory Table for cache entries	20040517
5	P_R_STORAGE	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_RSDRH_HIER_STORAGE		Reference to a storage object	20040518
6	P_TH_MEM_CACHE	Instance attribute	Private	☐	Type reference (TYPE)	TP_TH_MEM_CACHE		Cached restrictions of actual query	20050211

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_MEM	Instance method	Protected	Method	Check whether entry is already buffered	20050211
2	CHECK	Instance method	Protected	Method	Check whether entry is already buffered	20040517
3	CHECK_MEM	Instance method	Protected	Method	Check whether entry is already buffered	20050211
4	CHECK_SHRINK	Instance method	Protected	Method	Shrink the cache up to the specified threshold	20040525
5	CLEANUP	Instance method	Public	Method	Cleanup a single entry after a query	20040524
6	CLEANUP_ALL	Instance method	Public	Method	Cleans the complete Cache	20040525
7	COMPARE	Static method	Private	Method	Compare two hierarchy result tables	20040524
8	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20040518
9	DROP	Instance method	Public	Method	Drops an entry of the cache	20040517
10	INSERT	Instance method	Protected	Method	Insert new cache entry	20040517
11	INVALIDATE	Instance method	Public	Method	Invalidates a cache entry	20040517
12	INVALIDATE_HIERARCHY	Instance method	Public	Method	Invalidate all entries belonging to the specified hierarchy	20040527
13	LOCK	Instance method	Protected	Method	Lock a buffer entry	20040517
14	MESSAGE_APPEND	Static method	Private	Method		20040524
15	READ	Instance method	Public	Method	Read a cache entry for a query	20040517
16	UNLOCK	Instance method	Protected	Method	Unlock a cache entry	20040517
17	VERIFY	Instance method	Public	Method	Verify a single Cache Entry	20040525
18	VERIFY_ALL	Instance method	Public	Method	Verify the complete cache	20040524
19	WRITE_MSG	Static method	Protected	Method	Append Message to table with messages	20040525

Events

Class CL_RSDRH_HIER_CACHE has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TP_S_MEM_CACHE	Private	See coding			20050211	begin of TP_S_MEM_CACHE, s_rest TYPE CL_RSDRH_HIER_REST=>TN_S_HIER_REST, r_storage TYPE ref to IF_RSDRH_HIER_STORAGE, end of tp_s_mem_cache
2	TP_TH_MEM_CACHE	Private	See coding			20050211	TP_TH_MEM_CACHE type hashed table of tp_s_mem_cache with unique key s_rest initial size 0

Method Signatures

Method ADD_MEM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_R_HIER_REST	Call by reference	☐	Object reference (TYPE REF TO)	CL_RSDRH_HIER_REST		Hierarchy Resolution to read	20050211

Method ADD_MEM on class CL_RSDRH_HIER_CACHE has no exception.

Method CHECK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_R_HIER_REST	Call by reference	☐	Object reference (TYPE REF TO)	CL_RSDRH_HIER_REST		Hierarchy Resolution to read	20040518
2	Importing	I_TIMESTMP	Call by reference	☐	Type reference (TYPE)	RSTIMESTMP		UTC-Zeitstempel in Kurzform (JJJJMMTThhmmss)	20040518

Method CHECK on class CL_RSDRH_HIER_CACHE has no exception.

Method CHECK_MEM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_R_HIER_REST	Call by reference	☐	Object reference (TYPE REF TO)	CL_RSDRH_HIER_REST		Hierarchy Resolution to read	20050211

Method CHECK_MEM on class CL_RSDRH_HIER_CACHE has no exception.

Method CHECK_SHRINK Signature

Method CHECK_SHRINK on class CL_RSDRH_HIER_CACHE has no parameter.
Method CHECK_SHRINK on class CL_RSDRH_HIER_CACHE has no exception.

Method CLEANUP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ACCESS_ID	Call by reference	☑	Type reference (TYPE)	I			20050429
2	Importing	I_SEQ_NR	Value transfer	☐	Type reference (TYPE)	I	0	Query Sequence Number	20040524
3	Importing	I_TABLNM	Call by reference	☐	Type reference (TYPE)	RSD_TABLNM			20040524

Method CLEANUP on class CL_RSDRH_HIER_CACHE has no exception.

Method CLEANUP_ALL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_T_MSG	Value transfer	☐	Type reference (TYPE)	RS_T_MSG		Messages	20040525

Method CLEANUP_ALL on class CL_RSDRH_HIER_CACHE has no exception.

Method COMPARE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_TS_ADDITIONAL	Call by reference	☐	Type reference (TYPE)	RRHI_TS_NODELEAF			20040524
2	Exporting	E_TS_DIFFERENT	Call by reference	☐	Type reference (TYPE)	RRHI_TS_NODELEAF			20040524
3	Exporting	E_TS_MISSING	Call by reference	☐	Type reference (TYPE)	RRHI_TS_NODELEAF			20040524
4	Importing	I_TH_CACHE_HIER	Call by reference	☐	Type reference (TYPE)	IF_RSDRH_HIER_STORAGE=>TN_TH_HIER		Hierarchy from cache	20040524
5	Importing	I_TH_HIER	Call by reference	☐	Type reference (TYPE)	IF_RSDRH_HIER_STORAGE=>TN_TH_HIER		hierarchy result to compare with	20040524

Method COMPARE on class CL_RSDRH_HIER_CACHE has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_COMMIT_ALLOWED	Call by reference	☐	Type reference (TYPE)	RS_BOOL		Commit on default connection allowed	20060602
2	Importing	I_DIR_TABLE	Call by reference	☐	Type reference (TYPE)	RSD_TABLNM		Directory Table	20040518
3	Importing	I_R_STORAGE	Call by reference	☐	Object reference (TYPE REF TO)	IF_RSDRH_HIER_STORAGE		Dummy storage object	20040524

Method CONSTRUCTOR on class CL_RSDRH_HIER_CACHE has no exception.

Method DROP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_S_HIER	Call by reference	☐	Type reference (TYPE)	CL_RSDRH_HIER_REST=>TN_S_HIER_REST		Hierarchy Resolution to drop	20040517
2	Importing	I_TABLNM	Call by reference	☐	Type reference (TYPE)	RSD_TABLNM		Name of table for Hierachy Resolution	20040524

Method DROP on class CL_RSDRH_HIER_CACHE has no exception.

Method INSERT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_R_HIER_REST	Call by reference	☐	Object reference (TYPE REF TO)	CL_RSDRH_HIER_REST		Hierarchy Restriction	20040518
2	Importing	I_TIMESTMP	Call by reference	☐	Type reference (TYPE)	RSTIMESTMP		UTC-Zeitstempel in Kurzform (JJJJMMTThhmmss)	20040518

#	Exception	Resumable	Description	Created on
1	CX_RSDRC_NO_COMMIT	☐	Kein Commit bei Query-Bearbeitung erlaubt	20060602
2	CX_RSR_HIER_MEMBER_NOT_FOUND	☐	Hierarchie-Objekt (Knoten/Blatt) nicht gefunden	20040518
3	CX_RSR_HIER_NOT_FOUND	☐	Hierarchie nicht gefunden	20040518

Method INVALIDATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_S_HIER	Call by reference	☐	Type reference (TYPE)	CL_RSDRH_HIER_REST=>TN_S_HIER_REST		Hierarchy Resolution to invalidate	20040517

Method INVALIDATE on class CL_RSDRH_HIER_CACHE has no exception.

Method INVALIDATE_HIERARCHY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_HIESID	Call by reference	☐	Type reference (TYPE)	RRHI_HIESID		Hierarchy to invalidate	20040527
2	Importing	I_NODESID	Call by reference	☑	Type reference (TYPE)	RSSID		Stammdaten ID	20050620
3	Importing	I_SVER	Call by reference	☑	Type reference (TYPE)	RRHI_SVER		Version of Hierarchy	20040527

Method INVALIDATE_HIERARCHY on class CL_RSDRH_HIER_CACHE has no exception.

Method LOCK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_DEL_TIMESTMP	Call by reference	☐	Type reference (TYPE)	RSTIMESTMP	O_C_TIMESTMP_INI	UTC-Zeitstempel in Kurzform (JJJJMMTThhmmss)	20040524
2	Importing	I_S_HIER	Call by reference	☐	Type reference (TYPE)	CL_RSDRH_HIER_REST=>TN_S_HIER_REST		Hierarchy Resolution to read	20040518

Method LOCK on class CL_RSDRH_HIER_CACHE has no exception.

Method MESSAGE_APPEND Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_T_MSG	Call by reference	☐	Type reference (TYPE)	RS_T_MSG		BW: Tabelle mit Nachrichten (Application Log Protokoll)	20040524
2	Importing	I_MSGNO	Call by reference	☐	Type reference (TYPE)	RS_S_MSG-MSGNO			20040524
3	Importing	I_TS_NODELEAF	Call by reference	☐	Type reference (TYPE)	RRHI_TS_NODELEAF			20040524

Method MESSAGE_APPEND on class CL_RSDRH_HIER_CACHE has no exception.

Method READ Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_R_HIER_REST	Call by reference	☐	Object reference (TYPE REF TO)	CL_RSDRH_HIER_REST		Hierarchy Resolution to read	20040518

#	Exception	Resumable	Description	Created on
1	CX_RSDRC_NO_COMMIT	☐	Kein Commit bei Query-Bearbeitung erlaubt	20060602
2	CX_RSR_HIER_MEMBER_NOT_FOUND	☐	Hierarchie-Objekt (Knoten/Blatt) nicht gefunden	20040518
3	CX_RSR_HIER_NOT_FOUND	☐	Hierarchie nicht gefunden	20040518

Method UNLOCK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_DEL_TIMESTMP	Call by reference	☐	Type reference (TYPE)	RSTIMESTMP	O_C_TIMESTMP_INI	UTC-Zeitstempel in Kurzform (JJJJMMTThhmmss)	20040524
2	Importing	I_S_HIER	Call by reference	☐	Type reference (TYPE)	CL_RSDRH_HIER_REST=>TN_S_HIER_REST		Hierarchy Resolution to read	20040518

Method UNLOCK on class CL_RSDRH_HIER_CACHE has no exception.

Method VERIFY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_TS_ADDITIONAL	Call by reference	☐	Type reference (TYPE)	RRHI_TS_NODELEAF			20040525
2	Exporting	E_TS_DIFFERENT	Call by reference	☐	Type reference (TYPE)	RRHI_TS_NODELEAF			20040525
3	Exporting	E_TS_MISSING	Call by reference	☐	Type reference (TYPE)	RRHI_TS_NODELEAF			20040525
4	Importing	I_S_HIER	Call by reference	☐	Type reference (TYPE)	CL_RSDRH_HIER_REST=>TN_S_HIER_REST			20040525

#	Exception	Resumable	Description	Created on
1	CX_RSDRC_NO_COMMIT	☐	Kein Commit bei Query-Bearbeitung erlaubt	20060602
2	CX_RSR_HIER_MEMBER_NOT_FOUND	☐	Hierarchie-Objekt (Knoten/Blatt) nicht gefunden	20040525
3	CX_RSR_HIER_NOT_FOUND	☐	Hierarchie nicht gefunden	20040525

Method VERIFY_ALL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_T_MSG	Value transfer	☐	Type reference (TYPE)	RS_T_MSG		BW: Tabelle mit Nachrichten (Application Log Protokoll)	20040524

Method VERIFY_ALL on class CL_RSDRH_HIER_CACHE has no exception.

Method WRITE_MSG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_T_MSG	Call by reference	☑	Type reference (TYPE)	RS_T_MSG		BW: Tabelle mit Nachrichten (Application Log Protokoll)	20040525
2	Importing	I_MSGID	Call by reference	☐	Type reference (TYPE)	SYMSGID	'DBMAN'	Nachrichten, Nachrichtenklasse	20040525
3	Importing	I_MSGNO	Call by reference	☐	Type reference (TYPE)	RS_S_MSG-MSGNO			20040525
4	Importing	I_MSGTY	Call by reference	☐	Type reference (TYPE)	SYMSGTY	'E'	Nachrichten, Nachrichtentyp	20040525
5	Importing	I_MSGV1	Call by reference	☑	Type reference (TYPE)	C			20040525
6	Importing	I_MSGV2	Call by reference	☑	Type reference (TYPE)	C			20040525
7	Importing	I_MSGV3	Call by reference	☑	Type reference (TYPE)	C			20040525
8	Importing	I_MSGV4	Call by reference	☑	Type reference (TYPE)	C			20040525

Method WRITE_MSG on class CL_RSDRH_HIER_CACHE has no exception.

History

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