SAP ABAP Class CL_FMHIE_TREE_DATA_STRING (Handling of hierarchical data in memory)

Hierarchy

☛ EA-PS (Software Component) SAP Enterprise Extension Public Services
   ⤷ PSM-FM-BCS-BU (Application Component) Budgeting
     ⤷ FMBMA_E (Package) Budgeting Rules, BCS

Properties

Class	CL_FMHIE_TREE_DATA_STRING
Short Description	Handling of hierarchical data in memory
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	FMBMA_E	Budgeting Rules, BCS
Created	20050324	SAP
Last change	20050411	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_FMHIE_TREE_DATA_STRING has no forward declaration.

Interfaces

Class CL_FMHIE_TREE_DATA_STRING has no interface implemented.

Friends

Class CL_FMHIE_TREE_DATA_STRING has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	FIRST_ROOT	Instance attribute	Protected	☐	Type reference (TYPE)	FMHIE_NODE_ID_STRING		Node ID for traversal (character based)	20050326
2	INS_MODE_SIBLING	Constant	Public	☐	Type reference (TYPE)	I	2		20050324
3	INS_MODE_SON	Constant	Public	☐	Type reference (TYPE)	I	1		20050324
4	OFF	Constant	Public	☐	Type reference (TYPE)	BOOLE_D	''	Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20050324
5	ON	Constant	Public	☐	Type reference (TYPE)	BOOLE_D	'X'	Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20050324
6	REF_TREE	Instance attribute	Private	☐	Object reference (TYPE REF TO)	DATA		direct reference to the buffer	20050324
7	TREE_DATA	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_BUBAS_MASS_HASHED_BUFFER		Hashed buffer with direct reference methods	20050324

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	APPEND_NODES_FROM_EXT_DATA	Instance method	Public	Method	no check or upd of hierarchical relationship	20050324
2	CHECK_CONSISTENCY	Instance method	Public	Method	Checks the hierarchy consistency (no loops, pointers)	20050406
3	CHECK_DATA_MISSING	Instance method	Public	Method	Check if data are missing (default for the child)	20050324
4	CONSTRUCTOR	Instance method	Public	Constructor		20050324
5	COUNT	Instance method	Public	Method	Gets number of nodes	20050324
6	FIND_NODE	Instance method	Public	Method	Finds node with given node_objnr	20050324
7	GET_DIRECT_REFERENCE	Instance method	Public	Method	Gets the reference to the table of nodes	20050324
8	GET_FIRST_ROOT	Instance method	Public	Method		20050326
9	GET_NODES	Instance method	Public	Method	Gets the table of nodes	20050324
10	GET_TREE_DATA_REFERENCE	Instance method	Public	Method	Reference to buffer - for traversal	20050326
11	INSERT_NODE	Instance method	Public	Method	Inserts new node into hierarchy - update of hie.relationship	20050324
12	INSERT_NODES	Instance method	Public	Method	Inserts new node into hierarchy - update of hie.relationship	20050328
13	REFRESH	Instance method	Public	Method		20050324
14	REPAIR_TREE	Instance method	Public	Method	Adjust Level and root after reading master data	20050331

Events

Class CL_FMHIE_TREE_DATA_STRING has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	T_NODES	Public	See coding			20050324	t_nodes TYPE HASHED TABLE OF fmhie_s_node_string WITH UNIQUE KEY node_objnr

Method Signatures

Method APPEND_NODES_FROM_EXT_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_T_NODES	Call by reference	☐	Type reference (TYPE)	FMHIE_T_NODE_STRING		Table of hierarchy nodes (of a given hierarchy ID)	20050324

Method APPEND_NODES_FROM_EXT_DATA on class CL_FMHIE_TREE_DATA_STRING has no exception.

Method CHECK_CONSISTENCY Signature

Method CHECK_CONSISTENCY on class CL_FMHIE_TREE_DATA_STRING has no parameter.

#	Exception	Resumable	Description	Created on
1	LOOP_FOUND	☐	The traversal finds more nodes than number of data records	20050406
2	MISSING_NODES	☐	The traversal finds fewer nodes than number of data records	20050406
3	WRONG_POINTER	☐	A pointer (child, parent, ...) points to not existing node	20050406

Method CHECK_DATA_MISSING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_NODE	Call by reference	☐	Type reference (TYPE)	FMHIE_S_NODE_STRING		Object number for FM budgeting and AVC	20050324
2	Exporting	E_FLG_DATA_MISSING	Call by reference	☐	Type reference (TYPE)	BOOLE_D		Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20050324
3	Exporting	E_NODE_RELAT	Call by reference	☐	Type reference (TYPE)	FMHIE_S_NODE_STRING		Node of the Hierarchy	20050324
4	Importing	IM_SUPERIOR	Call by reference	☐	Type reference (TYPE)	BOOLE_D	OFF	Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20050324

#	Exception	Resumable	Description	Created on
1	NODE_NOT_FOUND	☐		20050324

Method CONSTRUCTOR Signature

Method CONSTRUCTOR on class CL_FMHIE_TREE_DATA_STRING has no parameter.
Method CONSTRUCTOR on class CL_FMHIE_TREE_DATA_STRING has no exception.

Method COUNT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_COUNT	Value transfer	☐	Type reference (TYPE)	SYTABIX		Internal Table, Current Row Index	20050324

Method COUNT on class CL_FMHIE_TREE_DATA_STRING has no exception.

Method FIND_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_NODE_ID	Call by reference	☐	Type reference (TYPE)	FMHIE_NODE_ID_STRING		Object number for FM budgeting and AVC	20050324
2	Returning	R_NODE_DATA	Value transfer	☐	Type reference (TYPE)	FMHIE_S_NODE_STRING		Node of the Hierarchy	20050331

Method FIND_NODE on class CL_FMHIE_TREE_DATA_STRING has no exception.

Method GET_DIRECT_REFERENCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_REF_TREE	Value transfer	☐	Object reference (TYPE REF TO)	DATA			20050324

Method GET_DIRECT_REFERENCE on class CL_FMHIE_TREE_DATA_STRING has no exception.

Method GET_FIRST_ROOT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_ROOT_ID	Value transfer	☐	Type reference (TYPE)	FMHIE_NODE_ID_STRING		Node ID for traversal (character based)	20050326

Method GET_FIRST_ROOT on class CL_FMHIE_TREE_DATA_STRING has no exception.

Method GET_NODES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_T_NODES	Call by reference	☐	Type reference (TYPE)	FMHIE_T_NODE		Table of hierarchy nodes (of a given hierarchy ID)	20050324

Method GET_NODES on class CL_FMHIE_TREE_DATA_STRING has no exception.

Method GET_TREE_DATA_REFERENCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_TREE_DATA	Value transfer	☐	Object reference (TYPE REF TO)	CL_BUBAS_MASS_HASHED_BUFFER		Hashed buffer with direct reference methods	20050326

Method GET_TREE_DATA_REFERENCE on class CL_FMHIE_TREE_DATA_STRING has no exception.

Method INSERT_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_FLG_CHECK_ONLY	Call by reference	☐	Type reference (TYPE)	BOOLE_D	OFF	Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20050324
2	Importing	IM_INS_MODE	Call by reference	☐	Type reference (TYPE)	I		Son or sibling?	20050324
3	Importing	IM_NEW_NODE_ID	Call by reference	☐	Type reference (TYPE)	FMHIE_NODE_ID_STRING		New node	20050324
4	Importing	IM_RELAT_NODE_ID	Call by reference	☐	Type reference (TYPE)	FMHIE_NODE_ID_STRING		Existing node that will be in relation with the new one	20050324

#	Exception	Resumable	Description	Created on
1	DATA_MISSING	☐	Data has to be read from DB before the insertion	20050324
2	NODE_EXISTS	☐	Node already exists in the TREE_DATA instance	20050324
3	RELAT_NOT_FOUND	☐	The original node does not exist in the instance	20050324

Method INSERT_NODES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_T_EXISTING_NODES	Call by reference	☐	Type reference (TYPE)	FMHIE_T_NODE_ID_STRING		Relevant when exception node_exists	20050328
2	Importing	IM_FLG_CHECK_ONLY	Call by reference	☐	Type reference (TYPE)	BOOLE_D	OFF	Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20050328
3	Importing	IM_INS_MODE	Call by reference	☐	Type reference (TYPE)	I		Son or sibling?	20050328
4	Importing	IM_RELAT_NODE_ID	Call by reference	☐	Type reference (TYPE)	FMHIE_NODE_ID_STRING		Existing node that will be in relation with the new one	20050328
5	Importing	IM_T_NEW_NODES	Call by reference	☐	Type reference (TYPE)	FMHIE_T_NODE_ID_STRING		New node	20050328

#	Exception	Resumable	Description	Created on
1	DATA_MISSING	☐	Data has to be read from DB before the insertion	20050328
2	NODE_EXISTS	☐	Node already exists in the TREE_DATA instance	20050328
3	RELAT_NOT_FOUND	☐	The original node does not exist in the instance	20050328

Method REFRESH Signature

Method REFRESH on class CL_FMHIE_TREE_DATA_STRING has no parameter.
Method REFRESH on class CL_FMHIE_TREE_DATA_STRING has no exception.

Method REPAIR_TREE Signature

Method REPAIR_TREE on class CL_FMHIE_TREE_DATA_STRING has no parameter.
Method REPAIR_TREE on class CL_FMHIE_TREE_DATA_STRING has no exception.

History

Last changed by/on	SAP	20050411
SAP Release Created in	600