SAP ABAP Class J_3RF_REP_TREECONTAINER_NG (Tree storage)

Hierarchy

☛ SAP_FIN (Software Component) SAP_FIN
   ⤷ FI-LOC (Application Component) Localization
     ⤷ J3RFTAX (Package) Tax Accounting

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	J_3RF_REPORT	Main object for xml report hierarchy	20130306

Properties

Class	J_3RF_REP_TREECONTAINER_NG
Short Description	Tree storage
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	J3RFTAX	Tax Accounting
Created	20130304	SAP
Last change	20130531	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)
2	J_3RF_REP_TREECONTAINER_NG	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)

Interfaces

Class J_3RF_REP_TREECONTAINER_NG has no interface implemented.

Friends

Class J_3RF_REP_TREECONTAINER_NG has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CHILDS_CACHE	Instance attribute	Protected	☐	See coding			Cache for availability and childs count	20130304
2	INTERNAL_STORAGE	Instance attribute	Protected	☐	See coding			Tree storage	20130304
3	LAST_ACCESSED_OBJECT	Instance attribute	Private	☐	Type reference (TYPE)	J_3RF_REP_TREE_PTR			20130304
4	NEXT_ID	Instance attribute	Private	☐	Type reference (TYPE)	I			20130304

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_CHILD	Instance method	Public	Method		20130304
2	ADD_CHILD_EX	Instance method	Public	Method		20130304
3	APPLY_SORTING	Instance method	Public	Method	Perform sorting by position and repidx	20130306
4	CHECK_NODE_EXISTENCE_BY_REF	Instance method	Public	Method	Checks if supplied reference belongs to hierarchy	20130304
5	CONSTRUCTOR	Instance method	Public	Constructor		20130304
6	DELETE_NODE	Instance method	Public	Method		20130304
7	DELETE_NODE_BY_REF	Instance method	Public	Method	Delete node that matches given reference	20130306
8	DUPLICATE_NODE	Instance method	Public	Method		20130304
9	FREE_TREE	Instance method	Public	Method		20130304
10	GET_ALL_CHILD_NODES	Instance method	Public	Method	Fetch only childs for the selected root. Not a subtree	20130304
11	GET_ALL_CHILD_NODES_WITH_ORDER	Instance method	Public	Method	Fetch only childs for the selected root. Not a subtree	20131111
12	GET_ALL_NODES	Instance method	Public	Method		20130304
13	GET_CHILD_COUNT	Instance method	Public	Method		20130304
14	GET_COUNT	Instance method	Public	Method		20130304
15	GET_FIRST_CHILD	Instance method	Public	Method		20130304
16	GET_NEXT_CHILD	Instance method	Public	Method		20130304
17	GET_NEXT_ID	Instance method	Public	Method		20130304
18	GET_NODE	Instance method	Public	Method	Get node by it's ID	20130304
19	GET_NODE_BY_POSITION	Instance method	Public	Method	Get node with specified position	20130314
20	GET_ROOT_NODE	Instance method	Public	Method	Get root node for given node	20130304
21	GET_SUBTREE	Instance method	Public	Method	Returns all nested nodes of given node	20130304
22	HAVE_CHILD_NODES	Instance method	Public	Method	Checks if given node have child nodes	20130304
23	MOVE_NODE	Instance method	Public	Method		20130304
24	MOVE_NODE_DOWN	Instance method	Public	Method		20130304
25	MOVE_NODE_UP	Instance method	Public	Method		20130304
26	REBUILD_SORT_INDEX	Instance method	Protected	Method		20130304
27	SWAP_ELEMENTS	Instance method	Public	Method		20130304
28	UPDATE_ROOT_ID	Instance method	Private	Method		20130304

Events

Class J_3RF_REP_TREECONTAINER_NG has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	J_3RF_REP_CHILDS_CACHE	Public	See coding			20130304	begin of j_3rf_rep_childs_cache, node_id type i, have_childs type abap_bool, childs_count type i, end of j_3rf_rep_childs_cache
2	J_3RF_REP_TREE_ELEMENT	Public	See coding			20130304	BEGIN OF J_3RF_REP_TREE_ELEMENT, SELF_ID TYPE I, ROOT_ID TYPE I, POSITION TYPE I, REPIDX TYPE I, " > 0 if node is repeatable. ACTUAL_NODE TYPE REF TO J_3RF_REP_TREE_NODE_INTERFACE, END OF J_3RF_REP_TREE_ELEMENT
3	J_3RF_REP_TREE_PTR	Public	See coding			20130304	BEGIN OF J_3RF_REP_TREE_PTR, ROOT_ID TYPE I, NODE_ID TYPE I, node_pos TYPE i, END OF J_3RF_REP_TREE_PTR
4	LT_CHILD_LIST	Public	See coding			20130304	lt_child_list TYPE STANDARD TABLE OF REF TO J_3RF_REP_TREE_NODE_INTERFACE
5	TAB_CHILD_LIST_WITH_ORDER	Public	See coding			20131111	tab_child_list_with_order type hashed table of j_3rf_rep_tree_element with unique key root_id self_id position repidx

Method Signatures

Method ADD_CHILD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	INSERTED_NODE_ID	Value transfer	☐	Type reference (TYPE)	I			20130304
2	Importing	IN_OBJ	Call by reference	☐	Object reference (TYPE REF TO)	J_3RF_REP_TREE_NODE_INTERFACE			20130304
3	Importing	ROOT_NODE_ID	Call by reference	☐	Type reference (TYPE)	I			20130304

Method ADD_CHILD on class J_3RF_REP_TREECONTAINER_NG has no exception.

Method ADD_CHILD_EX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IN_FORCE_INSERT	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Adjust position to if adding duplicates	20130306
2	Importing	IN_INDEX	Call by reference	☐	Type reference (TYPE)	I			20130304
3	Importing	IN_OBJ	Call by reference	☐	Object reference (TYPE REF TO)	J_3RF_REP_TREE_NODE_INTERFACE			20130304
4	Importing	IN_REPIDX	Call by reference	☐	Type reference (TYPE)	I	0		20130306
5	Importing	IN_ROOT_NODE_ID	Call by reference	☐	Type reference (TYPE)	I			20130304
6	Importing	IN_SELF_ID	Call by reference	☐	Type reference (TYPE)	I			20130304

Method ADD_CHILD_EX on class J_3RF_REP_TREECONTAINER_NG has no exception.

Method APPLY_SORTING Signature

Method APPLY_SORTING on class J_3RF_REP_TREECONTAINER_NG has no parameter.
Method APPLY_SORTING on class J_3RF_REP_TREECONTAINER_NG has no exception.

Method CHECK_NODE_EXISTENCE_BY_REF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IN_NODE_REF	Call by reference	☐	Object reference (TYPE REF TO)	J_3RF_REP_HIER_OBJ		Node reference	20130304
2	Returning	OUT_RESULT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		Result of the check	20130304

Method CHECK_NODE_EXISTENCE_BY_REF on class J_3RF_REP_TREECONTAINER_NG has no exception.

Method CONSTRUCTOR Signature

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

Method DELETE_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DELETE_CHILDREN	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20130304
2	Importing	NODE_ID	Call by reference	☐	Type reference (TYPE)	I			20130304

Method DELETE_NODE on class J_3RF_REP_TREECONTAINER_NG has no exception.

Method DELETE_NODE_BY_REF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IN_NODE_REF	Call by reference	☐	Object reference (TYPE REF TO)	J_3RF_REP_TREE_NODE_INTERFACE		Tree node interface	20130306

Method DELETE_NODE_BY_REF on class J_3RF_REP_TREECONTAINER_NG has no exception.

Method DUPLICATE_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IN_KEEP_INDEXES	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Keep original indexes or create new indexes	20130304
2	Importing	IN_NODE_REF	Call by reference	☐	Object reference (TYPE REF TO)	J_3RF_REP_HIER_OBJ		Actual reference to the source node	20130304
3	Importing	IN_TARGET_ROOT_REF	Call by reference	☐	Object reference (TYPE REF TO)	J_3RF_REP_HIER_OBJ		Actual reference to the parent node	20130304
4	Exporting	OUT_CLONE	Call by reference	☐	Object reference (TYPE REF TO)	J_3RF_REP_OBJECT		Node object for xml reporting hier	20130304
5	Exporting	OUT_RESULT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20130304

Method DUPLICATE_NODE on class J_3RF_REP_TREECONTAINER_NG has no exception.

Method FREE_TREE Signature

Method FREE_TREE on class J_3RF_REP_TREECONTAINER_NG has no parameter.
Method FREE_TREE on class J_3RF_REP_TREECONTAINER_NG has no exception.

Method GET_ALL_CHILD_NODES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CHILDS	Call by reference	☐	Type reference (TYPE)	LT_CHILD_LIST			20130304
2	Importing	CLEAR_TAB	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Clear childs table inside method	20130304
3	Changing	COUNT	Call by reference	☐	Type reference (TYPE)	I			20130304
4	Importing	ONLY_INCLUDED	Call by reference	☐	Type reference (TYPE)	FLAG	ABAP_FALSE	Include only items with no inc.crit,or eval to true	20130304
5	Importing	ONLY_MATCHING_REF	Call by reference	☑	Object reference (TYPE REF TO)	OBJECT		Include only object that have specified ref as parent	20130304
6	Importing	ROOT_ID	Call by reference	☐	Type reference (TYPE)	I			20130304

#	Exception	Resumable	Description	Created on
1	CX_TAXOBJECT_NOT_FOUND	☐	Object not found in hierarchy	20130304

Method GET_ALL_CHILD_NODES_WITH_ORDER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CHILDS	Call by reference	☐	Type reference (TYPE)	J_3RF_REP_TREECONTAINER_NG=>TAB_CHILD_LIST_WITH_ORDER			20131111
2	Importing	CLEAR_TAB	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Clear childs table inside method	20131111
3	Changing	COUNT	Call by reference	☐	Type reference (TYPE)	I			20131111
4	Importing	ONLY_INCLUDED	Call by reference	☐	Type reference (TYPE)	FLAG	ABAP_FALSE	Include only items with no inc.crit,or eval to true	20131111
5	Importing	ONLY_MATCHING_REF	Call by reference	☑	Object reference (TYPE REF TO)	OBJECT		Include only object that have specified ref as parent	20131111
6	Importing	ROOT_ID	Call by reference	☐	Type reference (TYPE)	I			20131111

#	Exception	Resumable	Description	Created on
1	CX_TAXOBJECT_NOT_FOUND	☐	Object not found in hierarchy	20131111

Method GET_ALL_NODES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CHILDREN	Call by reference	☐	Type reference (TYPE)	LT_CHILD_LIST			20130304
2	Changing	COUNT	Call by reference	☐	Type reference (TYPE)	I			20130304

Method GET_ALL_NODES on class J_3RF_REP_TREECONTAINER_NG has no exception.

Method GET_CHILD_COUNT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IN_ROOT_NODE_ID	Call by reference	☐	Type reference (TYPE)	I			20130304
2	Returning	OUT_COUNT	Value transfer	☐	Type reference (TYPE)	I			20130304

Method GET_CHILD_COUNT on class J_3RF_REP_TREECONTAINER_NG has no exception.

Method GET_COUNT Signature

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

Method GET_COUNT on class J_3RF_REP_TREECONTAINER_NG has no exception.

Method GET_FIRST_CHILD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	OUT_OBJ	Value transfer	☐	Object reference (TYPE REF TO)	J_3RF_REP_TREE_NODE_INTERFACE			20130304
2	Importing	ROOT_ID	Call by reference	☐	Type reference (TYPE)	I			20130304

Method GET_FIRST_CHILD on class J_3RF_REP_TREECONTAINER_NG has no exception.

Method GET_NEXT_CHILD Signature

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

#	Exception	Resumable	Description	Created on
1	CX_TAXOBJECT_NOT_FOUND	☐	Object not found in hierarchy	20130314

Method GET_NEXT_ID Signature

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

Method GET_NEXT_ID on class J_3RF_REP_TREECONTAINER_NG has no exception.

Method GET_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID	Call by reference	☐	Type reference (TYPE)	I			20130304
2	Returning	NODE	Value transfer	☐	Object reference (TYPE REF TO)	J_3RF_REP_TREE_NODE_INTERFACE			20130304

#	Exception	Resumable	Description	Created on
1	CX_TAXOBJECT_NOT_FOUND	☐	Parse formula family class	20130304

Method GET_NODE_BY_POSITION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IN_POSITION	Call by reference	☐	Type reference (TYPE)	I			20130314
2	Importing	IN_ROOT_ID	Call by reference	☐	Type reference (TYPE)	I			20130314
3	Returning	OUT_NODE	Value transfer	☐	Object reference (TYPE REF TO)	J_3RF_REP_TREE_NODE_INTERFACE		Object of the xml hierarchy	20130314

#	Exception	Resumable	Description	Created on
1	CX_TAXOBJECT_NOT_FOUND	☐	Object not found in hierarchy	20130314

Method GET_ROOT_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID	Call by reference	☐	Type reference (TYPE)	I	1		20130304
2	Returning	NODE	Value transfer	☐	Object reference (TYPE REF TO)	J_3RF_REP_TREE_NODE_INTERFACE			20130304

#	Exception	Resumable	Description	Created on
1	CX_TAXOBJECT_NOT_FOUND	☐	Object not found in hierarchy	20130304

Method GET_SUBTREE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CHILDS	Call by reference	☐	Type reference (TYPE)	LT_CHILD_LIST			20130304
2	Exporting	COUNT	Call by reference	☐	Type reference (TYPE)	I			20130304
3	Importing	ONLY_INCLUDED	Call by reference	☐	Type reference (TYPE)	FLAG	ABAP_FALSE	Include only nodes and subnodes with included flag	20130304
4	Importing	ROOT_ID	Call by reference	☐	Type reference (TYPE)	I			20130304

#	Exception	Resumable	Description	Created on
1	CX_TAXOBJECT_NOT_FOUND	☐	Object not found in hierarchy	20130315

Method HAVE_CHILD_NODES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	HAVE_CHILDS	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20130304
2	Importing	ID	Call by reference	☐	Type reference (TYPE)	I			20130304

Method HAVE_CHILD_NODES on class J_3RF_REP_TREECONTAINER_NG has no exception.

Method MOVE_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IN_NODE_ID	Call by reference	☐	Type reference (TYPE)	I			20130304
2	Importing	IN_TARGET_ROOT_ID	Call by reference	☐	Type reference (TYPE)	I			20130304
3	Returning	OUT_RESULT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		abap_true, if node is relocated	20130304

#	Exception	Resumable	Description	Created on
1	CX_TAXOBJECT_NOT_FOUND	☐	Object not found in hierarchy	20130304

Method MOVE_NODE_DOWN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IN_NODE_ID	Call by reference	☐	Type reference (TYPE)	I			20130304
2	Importing	IN_STEPS	Call by reference	☐	Type reference (TYPE)	I	1		20130304
3	Exporting	OUT_ERROR_OCCURED	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20130304
4	Exporting	OUT_OTHER_NODE_ID	Call by reference	☐	Type reference (TYPE)	I		ID of node where movement is done	20130304

#	Exception	Resumable	Description	Created on
1	CX_TAXOBJECT_NOT_FOUND	☐	Object not found in hierarchy	20130315

Method MOVE_NODE_UP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IN_NODE_ID	Call by reference	☐	Type reference (TYPE)	I			20130304
2	Importing	IN_STEPS	Call by reference	☐	Type reference (TYPE)	I	1		20130304
3	Exporting	OUT_ERROR_OCCURED	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20130304
4	Exporting	OUT_OTHER_NODE_ID	Call by reference	☐	Type reference (TYPE)	I			20130304

#	Exception	Resumable	Description	Created on
1	CX_TAXOBJECT_NOT_FOUND	☐	Object not found in hierarchy	20130315

Method REBUILD_SORT_INDEX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IN_ROOT_NODE_ID	Call by reference	☐	Type reference (TYPE)	I			20130304

Method REBUILD_SORT_INDEX on class J_3RF_REP_TREECONTAINER_NG has no exception.

Method SWAP_ELEMENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IN_ID1	Call by reference	☐	Type reference (TYPE)	I			20130304
2	Importing	IN_ID2	Call by reference	☐	Type reference (TYPE)	I			20130304

#	Exception	Resumable	Description	Created on
1	CX_TAXOBJECT_NOT_FOUND	☐	Object not found in hierarchy	20130314

Method UPDATE_ROOT_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IN_NEW_ROOT_ID	Call by reference	☐	Type reference (TYPE)	I			20130304
2	Importing	IN_OLD_ROOT_ID	Call by reference	☐	Type reference (TYPE)	I			20130304

Method UPDATE_ROOT_ID on class J_3RF_REP_TREECONTAINER_NG has no exception.

History

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