SAP ABAP Class CL_NWECM_PROPERTY_CACHE (ECMI: Node Level Property Cache)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-ECM-ABA-COR (Application Component) ECM Core Infrastructure
     ⤷ S_NWECM_CORE (Package) ECMI: Runtime Implementation

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SERIALIZABLE_OBJECT	Serializable Object	20090827

Properties

Class	CL_NWECM_PROPERTY_CACHE
Short Description	ECMI: Node Level Property Cache
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	S_NWECM_CORE	ECMI: Runtime Implementation
Created	20081202	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
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)

Interfaces

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

Friends

Class CL_NWECM_PROPERTY_CACHE has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MT_OWNER_LIST	Instance attribute	Private	☐	See coding			List of owners with complete properties	20090130
2	MT_PROPERTY_MAP	Instance attribute	Private	☐	See coding			Map of node ids and property names to properties	20090130
3	MV_OWNER_LIST_CUR_NUMBER	Instance attribute	Private	☐	Type reference (TYPE)	I		Current lru number of list of complete owners	20090129
4	MV_OWNER_LIST_SIZE	Instance attribute	Private	☐	Type reference (TYPE)	I		Target maximum size of complete owner list	20090129
5	MV_PROPERTY_MAP_CUR_NUMBER	Instance attribute	Private	☐	Type reference (TYPE)	I		Current lru number of name to property map	20090129
6	MV_PROPERTY_MAP_MULTIPUT	Instance attribute	Private	☐	Type reference (TYPE)	I	SC_NO_MULTIPUT_IN_PROGRESS	Starting lru number reserved for multiput	20090810
7	MV_PROPERTY_MAP_SIZE	Instance attribute	Private	☐	Type reference (TYPE)	I		Target maximum size of name to property map	20090129
8	MV_PUT_SUCCESSFUL	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL		ABAP_TRUE iff last put was successful	20090810
9	SC_EVICTION_EXCEPTED	Static Attribute	Private	☐	Type reference (TYPE)	I		Reserved lru number for non-evictable entries	20090805
10	SC_NO_MULTIPUT_IN_PROGRESS	Constant	Private	☐	Type reference (TYPE)	I	SC_NO_NUMBER	No multiple put in progress	20090810
11	SC_NO_NUMBER	Constant	Private	☐	Type reference (TYPE)	I	-1		20090915

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CLASS_CONSTRUCTOR	Static method	Public	Constructor	CLASS_CONSTRUCTOR	20090805
2	CLEAR	Instance method	Public	Method	Removes all properties from this cache	20081202
3	CLEAR_OWNER_LIST	Instance method	Public	Method	Removes all owners from the complete owner list	20090129
4	CLEAR_PROPERTY_MAP	Instance method	Public	Method	Removes all properties from the id to property map	20090129
5	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20081202
6	DELETE_BY_NAME	Instance method	Public	Method	Deletes a property from this cache by name	20090819
7	DELETE_BY_REF	Instance method	Public	Method	Deletes a property from this cache by reference	20090819
8	DISCARD_BY_NAME	Instance method	Public	Method	Discards a property from this cache by name	20090313
9	DISCARD_BY_NODE_ID	Instance method	Public	Method	Discards all properties from this cache by node id	20090313
10	DISCARD_BY_NODE_REF	Instance method	Public	Method	Discards all properties from this cache by node reference	20090313
11	DISCARD_COMPLETENESS_BY_ID	Instance method	Public	Method	Discards the properties complete flag of a node by id	20090330
12	EVICT_COMPLETE_OWNER	Instance method	Private	Method	Makes room for a new complete owner	20090130
13	EVICT_PROPERTY_MAPPING	Instance method	Private	Method	Makes room for a new id to property mapping	20090129
14	GET_BY_NAME	Instance method	Public	Method	Gets a property from this cache by name	20081202
15	GET_BY_OWNER	Instance method	Public	Method	Gets all properties of a node from this cache	20090128
16	GET_SIZE	Instance method	Public	Method	Gets the initial maximum number of entries	20081202
17	IS_LOCAL	Instance method	Private	Method	Checks whether the storage class of a property is LOCAL	20090907
18	IS_PERSISTENT	Instance method	Private	Method	Checks whether the storage class of a property is PERSISTENT	20090907
19	IS_TRANSIENT	Instance method	Private	Method	Checks whether the storage class of a property is TRANSIENT	20090907
20	NEXT_OWNER_LIST_NUMBER	Instance method	Private	Method	Gets the next lru number for the complete owner list	20090129
21	NEXT_PROPERTY_MAP_NUMBER	Instance method	Private	Method	Gets the next lru number for the id to property map	20090129
22	PUT_BY_OWNER	Instance method	Public	Method	Puts all properties of a node into this cache	20090128
23	PUT_BY_OWNER_INT	Instance method	Private	Method	Puts all properties of a node into this cache	20090909
24	PUT_BY_REF	Instance method	Public	Method	Puts a property into this cache by reference	20081202
25	PUT_BY_REF_INT	Instance method	Private	Method	Puts a property into this cache by reference	20090907
26	REMOVE_BY_NAME	Instance method	Public	Method	Removes a property from this cache by name	20081202
27	REMOVE_BY_NODE_REF	Instance method	Public	Method	Removes all properties from this cache by node reference	20090831
28	REMOVE_BY_REF	Instance method	Public	Method	Removes a property from this cache by reference	20090327
29	SET_BY_OWNER	Instance method	Public	Method	Sets all properties of a node in this cache	20090909
30	SET_BY_REF	Instance method	Public	Method	Sets a property in this cache by reference	20090819
31	SET_SIZE	Instance method	Public	Method	Sets the maximum number of entries	20090120

Events

Class CL_NWECM_PROPERTY_CACHE has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	COMPLETE_OWNER	Private	See coding			20090130	BEGIN OF complete_owner, node_id TYPE string, number TYPE i, END OF complete_owner
2	NAME_PROPERTY	Private	See coding			20090130	BEGIN OF name_property, node_id TYPE string, name TYPE string, number TYPE i, property TYPE REF TO if_nwecm_property, is_modified TYPE abap_bool, END OF name_property

Method Signatures

Method CLASS_CONSTRUCTOR Signature

Method CLASS_CONSTRUCTOR on class CL_NWECM_PROPERTY_CACHE has no parameter.
Method CLASS_CONSTRUCTOR on class CL_NWECM_PROPERTY_CACHE has no exception.

Method CLEAR Signature

Method CLEAR on class CL_NWECM_PROPERTY_CACHE has no parameter.
Method CLEAR on class CL_NWECM_PROPERTY_CACHE has no exception.

Method CLEAR_OWNER_LIST Signature

Method CLEAR_OWNER_LIST on class CL_NWECM_PROPERTY_CACHE has no parameter.
Method CLEAR_OWNER_LIST on class CL_NWECM_PROPERTY_CACHE has no exception.

Method CLEAR_PROPERTY_MAP Signature

Method CLEAR_PROPERTY_MAP on class CL_NWECM_PROPERTY_CACHE has no parameter.
Method CLEAR_PROPERTY_MAP on class CL_NWECM_PROPERTY_CACHE has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SIZE	Value transfer	☐	Type reference (TYPE)	I	750	Initial maximum number of entries	20081202

Method CONSTRUCTOR on class CL_NWECM_PROPERTY_CACHE has no exception.

Method DELETE_BY_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_NAME	Value transfer	☐	Object reference (TYPE REF TO)	CL_NWECM_NAME		NW ECM: Namespace-Qualified Names	20090819
2	Importing	IV_NODE_ID	Value transfer	☐	Type reference (TYPE)	STRING			20090819

Method DELETE_BY_NAME on class CL_NWECM_PROPERTY_CACHE has no exception.

Method DELETE_BY_REF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_PROPERTY	Value transfer	☐	Object reference (TYPE REF TO)	IF_NWECM_PROPERTY		Property to be deleted	20090819

Method DELETE_BY_REF on class CL_NWECM_PROPERTY_CACHE has no exception.

Method DISCARD_BY_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_NAME	Value transfer	☐	Object reference (TYPE REF TO)	CL_NWECM_NAME		NW ECM: Namespace-Qualified Names	20090313
2	Importing	IV_NODE_ID	Value transfer	☐	Type reference (TYPE)	STRING			20090313

Method DISCARD_BY_NAME on class CL_NWECM_PROPERTY_CACHE has no exception.

Method DISCARD_BY_NODE_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_NODE_ID	Value transfer	☐	Type reference (TYPE)	STRING			20090313

Method DISCARD_BY_NODE_ID on class CL_NWECM_PROPERTY_CACHE has no exception.

Method DISCARD_BY_NODE_REF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_NODE	Value transfer	☐	Object reference (TYPE REF TO)	IF_NWECM_NODE		NW ECM: Generic Node	20090313

Method DISCARD_BY_NODE_REF on class CL_NWECM_PROPERTY_CACHE has no exception.

Method DISCARD_COMPLETENESS_BY_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_NODE_ID	Value transfer	☐	Type reference (TYPE)	STRING			20090330

Method DISCARD_COMPLETENESS_BY_ID on class CL_NWECM_PROPERTY_CACHE has no exception.

Method EVICT_COMPLETE_OWNER Signature

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

Method EVICT_COMPLETE_OWNER on class CL_NWECM_PROPERTY_CACHE has no exception.

Method EVICT_PROPERTY_MAPPING Signature

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

Method EVICT_PROPERTY_MAPPING on class CL_NWECM_PROPERTY_CACHE has no exception.

Method GET_BY_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_NAME	Value transfer	☐	Object reference (TYPE REF TO)	CL_NWECM_NAME		NW ECM: Namespace-Qualified Names	20081202
2	Importing	IV_NODE_ID	Value transfer	☐	Type reference (TYPE)	STRING			20081202
3	Returning	RO_PROPERTY	Value transfer	☐	Object reference (TYPE REF TO)	IF_NWECM_PROPERTY		NW ECM: Property Implementation	20081202

Method GET_BY_NAME on class CL_NWECM_PROPERTY_CACHE has no exception.

Method GET_BY_OWNER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_PROPERTIES	Call by reference	☐	Type reference (TYPE)	NWECM_T_PROPERTY		Cached properties	20090128
2	Exporting	EV_PROPERTIES_COMPLETE	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		ABAP_TRUE if the returned table of properties is complete	20090128
3	Importing	IV_NODE_ID	Value transfer	☐	Type reference (TYPE)	STRING		Id of owner node	20090128

Method GET_BY_OWNER on class CL_NWECM_PROPERTY_CACHE has no exception.

Method GET_SIZE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_SIZE	Value transfer	☐	Type reference (TYPE)	I		Initial maximum number of entries	20081202

Method GET_SIZE on class CL_NWECM_PROPERTY_CACHE has no exception.

Method IS_LOCAL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_PROPERTY	Value transfer	☐	Object reference (TYPE REF TO)	IF_NWECM_PROPERTY			20090907
2	Returning	RV_IS_LOCAL	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20090907

Method IS_LOCAL on class CL_NWECM_PROPERTY_CACHE has no exception.

Method IS_PERSISTENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_PROPERTY	Value transfer	☐	Object reference (TYPE REF TO)	IF_NWECM_PROPERTY			20090907
2	Returning	RV_IS_PERSISTENT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20090907

Method IS_PERSISTENT on class CL_NWECM_PROPERTY_CACHE has no exception.

Method IS_TRANSIENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_PROPERTY	Value transfer	☐	Object reference (TYPE REF TO)	IF_NWECM_PROPERTY			20090907
2	Returning	RV_IS_TRANSIENT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20090907

Method IS_TRANSIENT on class CL_NWECM_PROPERTY_CACHE has no exception.

Method NEXT_OWNER_LIST_NUMBER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CUR_NUMBER	Value transfer	☐	Type reference (TYPE)	I	SC_NO_NUMBER		20090915
2	Returning	RV_NEXT_NUMBER	Value transfer	☐	Type reference (TYPE)	I		Next lru number	20090130

Method NEXT_OWNER_LIST_NUMBER on class CL_NWECM_PROPERTY_CACHE has no exception.

Method NEXT_PROPERTY_MAP_NUMBER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CUR_NUMBER	Value transfer	☐	Type reference (TYPE)	I	SC_NO_NUMBER		20090915
2	Returning	RV_NEXT_NUMBER	Value transfer	☐	Type reference (TYPE)	I		Next lru number	20090130

Method NEXT_PROPERTY_MAP_NUMBER on class CL_NWECM_PROPERTY_CACHE has no exception.

Method PUT_BY_OWNER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_PROPERTIES	Call by reference	☐	Type reference (TYPE)	NWECM_T_PROPERTY		Table of all properties	20090128
2	Importing	IV_NODE_ID	Value transfer	☐	Type reference (TYPE)	STRING		Id of owner node	20090128
3	Returning	RT_PROPERTIES	Value transfer	☐	Type reference (TYPE)	NWECM_T_PROPERTY		Table of refreshed properties	20090818

Method PUT_BY_OWNER on class CL_NWECM_PROPERTY_CACHE has no exception.

Method PUT_BY_OWNER_INT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_PROPERTIES	Call by reference	☐	Type reference (TYPE)	NWECM_T_PROPERTY		Table of all properties	20090909
2	Importing	IV_IS_MODIFIED	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	ABAP_TRUE if put is transient or local	20090909
3	Importing	IV_NODE_ID	Value transfer	☐	Type reference (TYPE)	STRING		Id of owner node	20090909
4	Returning	RT_PROPERTIES	Value transfer	☐	Type reference (TYPE)	NWECM_T_PROPERTY		Table of refreshed properties	20090909

Method PUT_BY_OWNER_INT on class CL_NWECM_PROPERTY_CACHE has no exception.

Method PUT_BY_REF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_PROPERTY	Value transfer	☐	Object reference (TYPE REF TO)	IF_NWECM_PROPERTY		Property to be cached	20081202
2	Importing	IV_NODE_ID	Value transfer	☐	Type reference (TYPE)	STRING		Id of property owner node	20081202
3	Returning	RO_PROPERTY	Value transfer	☐	Object reference (TYPE REF TO)	IF_NWECM_PROPERTY		Refreshed property	20090818

Method PUT_BY_REF on class CL_NWECM_PROPERTY_CACHE has no exception.

Method PUT_BY_REF_INT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_PROPERTY	Value transfer	☐	Object reference (TYPE REF TO)	IF_NWECM_PROPERTY		Property to be cached	20090907
2	Importing	IV_IS_MODIFIED	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	ABAP_TRUE iff put is transient or local	20090907
3	Importing	IV_NODE_ID	Value transfer	☐	Type reference (TYPE)	STRING		Id of property owner node	20090907
4	Returning	RO_PROPERTY	Value transfer	☐	Object reference (TYPE REF TO)	IF_NWECM_PROPERTY		Refreshed property	20090907

Method PUT_BY_REF_INT on class CL_NWECM_PROPERTY_CACHE has no exception.

Method REMOVE_BY_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_NAME	Value transfer	☐	Object reference (TYPE REF TO)	CL_NWECM_NAME		NW ECM: Namespace-Qualified Names	20081202
2	Importing	IV_NODE_ID	Value transfer	☐	Type reference (TYPE)	STRING			20081202

Method REMOVE_BY_NAME on class CL_NWECM_PROPERTY_CACHE has no exception.

Method REMOVE_BY_NODE_REF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_NODE	Value transfer	☐	Object reference (TYPE REF TO)	IF_NWECM_NODE		NW ECM: Generic Node	20090831

Method REMOVE_BY_NODE_REF on class CL_NWECM_PROPERTY_CACHE has no exception.

Method REMOVE_BY_REF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_PROPERTY	Value transfer	☐	Object reference (TYPE REF TO)	IF_NWECM_PROPERTY		Property to be removed	20090327

Method REMOVE_BY_REF on class CL_NWECM_PROPERTY_CACHE has no exception.

Method SET_BY_OWNER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_STORAGE_CLASS	Value transfer	☐	Object reference (TYPE REF TO)	CL_NWECM_STORAGE_CLASS			20090909
2	Importing	IT_PROPERTIES	Call by reference	☐	Type reference (TYPE)	NWECM_T_PROPERTY			20090909
3	Importing	IV_NODE_ID	Value transfer	☐	Type reference (TYPE)	STRING			20090909
4	Returning	RT_PROPERTIES	Value transfer	☐	Type reference (TYPE)	NWECM_T_PROPERTY			20090909

Method SET_BY_OWNER on class CL_NWECM_PROPERTY_CACHE has no exception.

Method SET_BY_REF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_PROPERTY	Value transfer	☐	Object reference (TYPE REF TO)	IF_NWECM_PROPERTY			20090819
2	Importing	IV_NODE_ID	Value transfer	☐	Type reference (TYPE)	STRING			20090819
3	Returning	RO_PROPERTY	Value transfer	☐	Object reference (TYPE REF TO)	IF_NWECM_PROPERTY			20090819

Method SET_BY_REF on class CL_NWECM_PROPERTY_CACHE has no exception.

Method SET_SIZE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SIZE	Value transfer	☐	Type reference (TYPE)	I	750	Maximum number of entries	20090120

Method SET_SIZE on class CL_NWECM_PROPERTY_CACHE has no exception.

History

Last changed by/on	SAP	20110908
SAP Release Created in	720