SAP ABAP Class CL_SALV_IDA_GROUPING_SERVICE (Statefull grouping service)

Hierarchy

☛ SAP_UI (Software Component) User Interface Technology
   ⤷ BC-SRV-ALV (Application Component) SAP List Viewer
     ⤷ SALV_IDA_ATS (Package) ATS for IDA

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SALV_IDA_GROUPING_SERVICE	Grouping service	20120821

Properties

Class	CL_SALV_IDA_GROUPING_SERVICE
Short Description	Statefull grouping service
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	SALV_IDA_ATS	ATS for IDA
Created	20120817	SAP
Last change	20141120
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_SALV_IDA_GROUPING_SERVICE has no forward declaration.

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_SALV_IDA_GROUPING_SERVICE	☐	☐	Grouping service	20120821

Friends

Class CL_SALV_IDA_GROUPING_SERVICE has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CS_NODE_TYPE	Constant	Protected	☐	See coding				20120817
2	MO_GRAND_TOTAL_TABLE_DESCR	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_ABAP_TABLEDESCR			20120823
3	MO_QUERY_ENGINE	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_SALV_IDA_QUERY_ENGINE			20140228
4	MO_STRUCTDESCR	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_ABAP_STRUCTDESCR			20120817
5	MR_GROUP_KEYS_SAMPLE_RECORD	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	DATA			20120924
6	MS_FILTER_PARAMS	Instance attribute	Protected	☐	Type reference (TYPE)	IF_SALV_IDA_TYPES_INT=>YS_FILTER_PARAMS			20140314
7	MS_SADL_AGGR_RULES	Instance attribute	Protected	☐	Type reference (TYPE)	IF_SADL_QUERY_ENGINE_TYPES=>TY_AGGREGATION			20140228
8	MT_AGGR_RULES	Instance attribute	Protected	☐	Type reference (TYPE)	IF_SALV_IDA_GROUPING_SERVICE=>YT_AGGR_RULE			20120817
9	MT_AGGR_RULES_INT	Instance attribute	Protected	☐	Type reference (TYPE)	YT_AGGR_RULE_INT			20120817
10	MT_GRAND_TOTAL_NODES	Instance attribute	Protected	☐	Type reference (TYPE)	YT_NODE			20140304
11	MT_GROUP_RULES	Instance attribute	Protected	☐	Type reference (TYPE)	IF_SALV_IDA_GROUPING_SERVICE=>YT_GROUP_RULE			20120817
12	MT_GROUP_RULES_INT	Instance attribute	Protected	☐	Type reference (TYPE)	YT_GROUP_RULE_INT			20120817
13	MT_NODES	Instance attribute	Protected	☐	Type reference (TYPE)	YT_NODE			20120817
14	MT_ORDER_BY	Instance attribute	Protected	☐	Type reference (TYPE)	IF_SALV_IDA_TYPES_INT=>YT_DB_SORT_RULE			20140228
15	M_CACHE_SIZE_ON_EXPAND	Instance attribute	Protected	☐	Type reference (TYPE)	I			20140214
16	M_EXPAND_FIRST_GROUP	Instance attribute	Protected	☐	Type reference (TYPE)	ABAP_BOOL			20140210
17	M_GRAND_TOTAL_IN_RESULT	Instance attribute	Protected	☐	Type reference (TYPE)	ABAP_BOOL			20120823
18	M_NODES_READ	Instance attribute	Protected	☐	Type reference (TYPE)	ABAP_BOOL			20120817
19	M_SALV_FIELD_COUNTER	Instance attribute	Protected	☐	See coding				20130426

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	APPEND_AGGREGATES_TO_RESULT	Instance method	Protected	Method		20120817
2	APPEND_NODE_TO_RESULT	Instance method	Protected	Method		20120817
3	CONSTRUCTOR	Instance method	Public	Constructor		20120817
4	CREATE_INTERNAL_AGGR_RULES	Instance method	Protected	Method		20120817
5	CREATE_INTERNAL_GROUP_RULES	Instance method	Protected	Method		20120817
6	CREATE_SALV_FIELD_NAME	Instance method	Protected	Method		20130426
7	GET_GROUP_PATH_LABEL	Instance method	Protected	Method		20131206
8	GET_LAST_CHILD_TABIX_OF_NODE	Instance method	Protected	Method		20140622
9	GET_NODE_INDEX	Instance method	Protected	Method		20120817
10	GET_NODE_INTERSECTION_RANGE	Static method	Protected	Method		20120817
11	GET_SELECTION_FOR_NODE	Instance method	Protected	Method		20120817
12	INSERT_GROUPS	Instance method	Protected	Method		20120817
13	INSERT_PL_HOLDER_FOR_CHILDREN	Instance method	Protected	Method		20120817
14	READ_AND_EXPAND_GROUP	Instance method	Protected	Method		20140314
15	READ_DATA	Instance method	Protected	Method		20120817
16	READ_GROUPS	Instance method	Protected	Method		20120817
17	READ_INITIAL_NODES	Instance method	Protected	Method		20120817
18	READ_SIZE	Instance method	Protected	Method		20140228
19	REFRESH_RESULT_RANGES_IN_NODES	Instance method	Protected	Method		20120817

Events

Class CL_SALV_IDA_GROUPING_SERVICE has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	YS_AGGR_RULE_INT	Protected	See coding			20120821	begin of ys_aggr_rule_int, aggr_function type if_salv_service_types=>y_function_code, field type string, aggr_value_field type string, reference_field type string, reference_field_max type string, end of ys_aggr_rule_int
2	YS_GROUP_RULE_INT	Protected	See coding			20120821	begin of ys_group_rule_int, t_sort_rules type if_salv_ida_types_int=>yt_db_sort_rule, " one level t_key_fields type if_salv_service_types=>yt_field_path, " one level o_group_tabledescr type ref to cl_abap_tabledescr, " all levels, incl. aggr fields r_parent_key_record type ref to data, " parent levels o_group_label_provider type ref to if_salv_sti_group_label_prov, s_sadl_aggr_rules type if_sadl_query_engine_types=>ty_aggregation, end of ys_group_rule_int
3	YS_NODE	Protected	See coding			20120817	begin of ys_node, level type i, r_group_record type ref to data, r_parent_group_record type ref to data, size type i, type type y_node_type, " group line, data, place holder is_expanded type abap_bool, result_position type if_salv_service_types=>ys_range, node_offset type i, " used in place holders if not first child end of ys_node
4	YT_AGGR_RULE_INT	Protected	See coding			20120821	yt_aggr_rule_int type standard table of ys_aggr_rule_int with key field
5	YT_GROUP_RULE_INT	Protected	See coding			20120821	yt_group_rule_int type table of ys_group_rule_int with default key
6	YT_NODE	Protected	See coding			20120817	yt_node type standard table of ys_node with default key
7	Y_NODE_TYPE	Protected	Type reference (TYPE)	CHAR1		20120817
8	Y_SIGN	Protected	Type reference (TYPE)	INT1		20120817

Method Signatures

Method APPEND_AGGREGATES_TO_RESULT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ROW_INDEX	Call by reference	☐	Type reference (TYPE)	I			20120906
2	Changing	S_DATA	Call by reference	☐	Type reference (TYPE)	DATA			20120817
3	Importing	S_GROUP_RECORD	Call by reference	☐	Type reference (TYPE)	DATA			20120817
4	Changing	S_ROW_INFO	Call by reference	☐	Type reference (TYPE)	IF_SALV_IDA_TYPES_INT=>YS_RESULT_ROW_INFO			20120817
5	Changing	TS_AGGREGATION_EXCEPTION	Call by reference	☐	Type reference (TYPE)	IF_SALV_ITAB_VIEW_GROUPED_DATA=>YTS_AGGREGATION_EXCEPTION			20120817

Method APPEND_AGGREGATES_TO_RESULT on class CL_SALV_IDA_GROUPING_SERVICE has no exception.

Method APPEND_NODE_TO_RESULT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NODE_LINE_FROM	Value transfer	☐	Type reference (TYPE)	I			20120817
2	Importing	NODE_LINE_TO	Value transfer	☐	Type reference (TYPE)	I			20120817
3	Importing	ROW_INDEX	Call by reference	☐	Type reference (TYPE)	I			20120906
4	Importing	S_NODE	Call by reference	☐	Type reference (TYPE)	YS_NODE			20120817
5	Changing	TS_AGGREGATION_EXCEPTION	Call by reference	☐	Type reference (TYPE)	IF_SALV_ITAB_VIEW_GROUPED_DATA=>YTS_AGGREGATION_EXCEPTION			20120817
6	Changing	T_DATA	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE			20120817
7	Changing	T_ROW_INFO	Call by reference	☑	Type reference (TYPE)	IF_SALV_IDA_TYPES_INT=>YT_RESULT_ROW_INFO			20120817

Method APPEND_NODE_TO_RESULT on class CL_SALV_IDA_GROUPING_SERVICE has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CACHE_SIZE_ON_EXPAND	Call by reference	☑	Type reference (TYPE)	I			20140214
2	Importing	EXPAND_FIRST_GROUP	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL			20140210
3	Importing	GRAND_TOTAL_IN_RESULT	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20120823
4	Importing	IO_QUERY_ENGINE	Call by reference	☐	Object reference (TYPE REF TO)	CL_SALV_IDA_QUERY_ENGINE			20140228
5	Importing	IO_STRUCTDESCR	Call by reference	☐	Object reference (TYPE REF TO)	CL_ABAP_STRUCTDESCR			20120817
6	Importing	IS_FILTER_PARAMS	Call by reference	☑	Type reference (TYPE)	IF_SALV_IDA_TYPES_INT=>YS_FILTER_PARAMS			20140314
7	Importing	T_AGGR_RULES	Call by reference	☑	Type reference (TYPE)	IF_SALV_IDA_GROUPING_SERVICE=>YT_AGGR_RULE			20120817
8	Importing	T_GROUP_RULES	Call by reference	☑	Type reference (TYPE)	IF_SALV_IDA_GROUPING_SERVICE=>YT_GROUP_RULE			20120817

Method CONSTRUCTOR on class CL_SALV_IDA_GROUPING_SERVICE has no exception.

Method CREATE_INTERNAL_AGGR_RULES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	S_SRC_DATA_SAMPLE_RECORD	Call by reference	☐	Type reference (TYPE)	DATA			20120817
2	Exporting	T_STRUCTURE_COMP	Call by reference	☐	Type reference (TYPE)	CL_ABAP_STRUCTDESCR=>COMPONENT_TABLE			20120817

Method CREATE_INTERNAL_AGGR_RULES on class CL_SALV_IDA_GROUPING_SERVICE has no exception.

Method CREATE_INTERNAL_GROUP_RULES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	S_SRC_DATA_SAMPLE_RECORD	Call by reference	☐	Type reference (TYPE)	DATA			20120817
2	Importing	T_AGGR_STRUCTURE_COMP	Call by reference	☐	Type reference (TYPE)	CL_ABAP_STRUCTDESCR=>COMPONENT_TABLE			20120817

Method CREATE_INTERNAL_GROUP_RULES on class CL_SALV_IDA_GROUPING_SERVICE has no exception.

Method CREATE_SALV_FIELD_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	SALV_FIELD_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20130426
2	Importing	SRC_FIELD_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20130426

Method CREATE_SALV_FIELD_NAME on class CL_SALV_IDA_GROUPING_SERVICE has no exception.

Method GET_GROUP_PATH_LABEL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_NODE	Call by reference	☐	Type reference (TYPE)	YS_NODE			20131206
2	Returning	RV_GROUP_PATH_LABEL	Value transfer	☐	Type reference (TYPE)	STRING			20131206

Method GET_GROUP_PATH_LABEL on class CL_SALV_IDA_GROUPING_SERVICE has no exception.

Method GET_LAST_CHILD_TABIX_OF_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	LEVEL	Call by reference	☐	Type reference (TYPE)	I			20140622
2	Returning	NODE_TABIX	Value transfer	☐	Type reference (TYPE)	SYTABIX			20140622
3	Importing	R_KEY_RECORD	Call by reference	☐	Object reference (TYPE REF TO)	DATA			20140622

Method GET_LAST_CHILD_TABIX_OF_NODE on class CL_SALV_IDA_GROUPING_SERVICE has no exception.

Method GET_NODE_INDEX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	NODE_INDEX	Value transfer	☐	Type reference (TYPE)	I			20120817
2	Importing	RESULT_INDEX	Value transfer	☐	Type reference (TYPE)	I			20120817

Method GET_NODE_INDEX on class CL_SALV_IDA_GROUPING_SERVICE has no exception.

Method GET_NODE_INTERSECTION_RANGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	LAST_RESULT_TO	Value transfer	☐	Type reference (TYPE)	I			20120817
2	Exporting	NODE_LINE_FROM	Value transfer	☐	Type reference (TYPE)	I			20120817
3	Exporting	NODE_LINE_TO	Value transfer	☐	Type reference (TYPE)	I			20120817
4	Importing	RESULT_FROM	Value transfer	☐	Type reference (TYPE)	I			20120817
5	Importing	RESULT_TO	Value transfer	☐	Type reference (TYPE)	I			20120817
6	Importing	S_NODE	Call by reference	☐	Type reference (TYPE)	YS_NODE			20120817

Method GET_NODE_INTERSECTION_RANGE on class CL_SALV_IDA_GROUPING_SERVICE has no exception.

Method GET_SELECTION_FOR_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	LEVEL	Call by reference	☐	Type reference (TYPE)	I			20120817
2	Importing	R_KEY_RECORD	Call by reference	☐	Object reference (TYPE REF TO)	DATA			20120817
3	Exporting	S_SELECTION	Call by reference	☐	Type reference (TYPE)	IF_SALV_IDA_TYPES_INT=>YS_FIXED_VALUE_SELECTION			20140304

Method GET_SELECTION_FOR_NODE on class CL_SALV_IDA_GROUPING_SERVICE has no exception.

Method INSERT_GROUPS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	INSERT_NODE_LINE_FROM	Value transfer	☐	Type reference (TYPE)	I			20120817
2	Importing	INSERT_NODE_LINE_TO	Value transfer	☐	Type reference (TYPE)	I			20120817
3	Importing	PL_HOLDER_NODE_INDEX	Value transfer	☐	Type reference (TYPE)	I			20120817
4	Importing	T_NEW_NODES	Call by reference	☐	Type reference (TYPE)	YT_NODE			20120817

Method INSERT_GROUPS on class CL_SALV_IDA_GROUPING_SERVICE has no exception.

Method INSERT_PL_HOLDER_FOR_CHILDREN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NODE_INSERT_POSITION	Value transfer	☐	Type reference (TYPE)	I			20130123
2	Importing	S_PARENT_NODE	Call by reference	☐	Type reference (TYPE)	YS_NODE			20130123

Method INSERT_PL_HOLDER_FOR_CHILDREN on class CL_SALV_IDA_GROUPING_SERVICE has no exception.

Method READ_AND_EXPAND_GROUP Signature

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

Method READ_AND_EXPAND_GROUP on class CL_SALV_IDA_GROUPING_SERVICE has no exception.

Method READ_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NODE_LINE_FROM	Value transfer	☐	Type reference (TYPE)	I			20120817
2	Importing	NODE_LINE_TO	Value transfer	☐	Type reference (TYPE)	I			20120817
3	Importing	S_NODE	Call by reference	☐	Type reference (TYPE)	YS_NODE			20120817
4	Exporting	T_DATA	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE			20120817
5	Importing	T_REQUESTED_FIELDS	Call by reference	☐	Type reference (TYPE)	IF_SALV_SERVICE_TYPES=>YT_FIELD_PATH			20120817

Method READ_DATA on class CL_SALV_IDA_GROUPING_SERVICE has no exception.

Method READ_GROUPS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FILL_NODE_COUNT	Value transfer	☑	Type reference (TYPE)	ABAP_BOOL			20140214
2	Importing	NODE_LINE_FROM	Value transfer	☐	Type reference (TYPE)	I			20120817
3	Importing	NODE_LINE_TO	Value transfer	☐	Type reference (TYPE)	I			20120817
4	Exporting	ROW_COUNT	Value transfer	☐	Type reference (TYPE)	I			20140214
5	Importing	S_PL_HOLDER_NODE	Call by reference	☐	Type reference (TYPE)	YS_NODE			20120817
6	Exporting	T_NODES	Call by reference	☐	Type reference (TYPE)	YT_NODE			20120817

Method READ_GROUPS on class CL_SALV_IDA_GROUPING_SERVICE has no exception.

Method READ_INITIAL_NODES Signature

Method READ_INITIAL_NODES on class CL_SALV_IDA_GROUPING_SERVICE has no parameter.
Method READ_INITIAL_NODES on class CL_SALV_IDA_GROUPING_SERVICE has no exception.

Method READ_SIZE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	SIZE	Value transfer	☐	Type reference (TYPE)	I			20140228
2	Importing	S_PARENT_SELECTION	Call by reference	☑	Type reference (TYPE)	IF_SALV_IDA_TYPES_INT=>YS_FIXED_VALUE_SELECTION			20140304
3	Importing	T_GROUP_BY_FIELDS	Call by reference	☑	Type reference (TYPE)	IF_SALV_SERVICE_TYPES=>YT_FIELD_PATH			20140228

Method READ_SIZE on class CL_SALV_IDA_GROUPING_SERVICE has no exception.

Method REFRESH_RESULT_RANGES_IN_NODES Signature

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

Method REFRESH_RESULT_RANGES_IN_NODES on class CL_SALV_IDA_GROUPING_SERVICE has no exception.

History

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