SAP ABAP Class CL_UA_FORMULA_AREA_BUILDER (Builder for shared formula area)

Hierarchy

☛ SEM-BW (Software Component) SEM-BW: Strategic Enterprise Management
   ⤷ FIN-BA (Application Component) Business Analytics
     ⤷ UA_STRUCTURE (Package) Generation of DDIC Objects

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SHM_BUILD_INSTANCE	Flag Interface: Area Constructor for Shared Objects	20051128

Properties

Class	CL_UA_FORMULA_AREA_BUILDER
Short Description	Builder for shared formula area
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	UA_STRUCTURE	Generation of DDIC Objects
Created	20051122	SAP
Last change	20060703	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_UA_FORMULA_AREA_BUILDER has no forward declaration.

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_SHM_BUILD_INSTANCE	☐	☐	Flag Interface: Area Constructor for Shared Objects	20051128

Friends

Class CL_UA_FORMULA_AREA_BUILDER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CD_STRING	Constant	Private	☐	Type reference (TYPE)	UAB_DDIC_TYPENAME	'STRING'		20060111
2	MD_INST_NAME	Instance attribute	Private	☐	Type reference (TYPE)	SHM_INST_NAME		Name of a Shared Object Instance in an Area	20051128
3	MO_CHAR_FACTORY	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_FINB_MD_CHAR_FACTORY			20060111
4	MO_SHM_HANDLE	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_UA_FORMULA_AREA		Shared area for PDCE formula environment	20051128

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_PARAMETER	Instance method	Private	Method	Adding parameter from XML	20051213
2	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20051128
3	CREATE_FROM_XML	Instance method	Private	Method	Create formula from XML	20051213
4	CREATE_FUNCTION	Instance method	Private	Method	Create function from XML	20051213
5	CREATE_FUNCTION_FROM_SHM	Instance method	Private	Method		20060111
6	CREATE_PARAMETER	Instance method	Private	Method	Create parameter from XML	20051213
7	CREATE_PARAMETER_FROM_SHM	Instance method	Private	Method		20060111
8	FILL_INSTANCE	Instance method	Private	Method	Parse formulas into shared area	20051213
9	GET_FORMULAS	Instance method	Public	Method	Get formulas from shared memory	20051128
10	RESET_RETURN_TYPES	Instance method	Private	Method	Reset the return type	20051213
11	SET_FORMULAS	Instance method	Public	Method	Get formulas from shared memory	20051128
12	SET_PARAMETER_FROM_XML	Instance method	Private	Method	Set parameter from XML	20051213
13	SET_VALUE_CONST	Instance method	Private	Method	Set constant value from XML	20051213

Events

Class CL_UA_FORMULA_AREA_BUILDER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	MS_INSTANCE	Private	See coding			20051128	BEGIN OF ms_instance, md_inst_name TYPE shm_inst_name, mo_broker TYPE REF TO cl_ua_formula_area_builder, END OF ms_instance
2	MT_INSTANCE	Private	See coding			20051128	mt_instance TYPE HASHED TABLE OF ms_instance WITH UNIQUE KEY md_inst_name
3	YS_FORMULA	Private	See coding			20051213	BEGIN OF ys_formula, mandt TYPE mandt, relid TYPE indx_relid, guid TYPE uxp_guid, version TYPE uxp_version, sap_object TYPE uxp_sap_object, application TYPE uxb_application, id TYPE uxp_id, xml TYPE string, formula TYPE REF TO cl_ua_formula_, status(1) TYPE c, is_enqueued TYPE boole_d, END OF ys_formula
4	YTH_FORMULA	Private	See coding			20051213	yth_formula TYPE HASHED TABLE OF ys_formula WITH UNIQUE KEY id

Method Signatures

Method ADD_PARAMETER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID_PARAMETER_NAME	Call by reference	☐	Type reference (TYPE)	UAB_PARAMETER_NAME		Technical Name of a Function Parameter	20051213
2	Importing	IO_FUNCTION	Call by reference	☐	Object reference (TYPE REF TO)	CL_UA_FUNCTION		Basisklasse für alle Funktionen	20051213
3	Importing	IO_SHM_HANDLE	Call by reference	☐	Object reference (TYPE REF TO)	CL_UA_FORMULA_AREA		Shared area for PDCE formula environment	20051213
4	Returning	RS_PARAMETER	Value transfer	☐	Type reference (TYPE)	UAB_S_PARAMETER		Values of Function Parameters	20051213

#	Exception	Resumable	Description	Created on
1	SHM_ERROR	☐		20051213

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID_INST_NAME	Call by reference	☐	Type reference (TYPE)	SHM_INST_NAME		Name einer Shared Object Instanz eines Areas	20051128

Method CONSTRUCTOR on class CL_UA_FORMULA_AREA_BUILDER has no exception.

Method CREATE_FROM_XML Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID_XML	Call by reference	☐	Type reference (TYPE)	STRING			20051213
2	Importing	IO_BUILD_ENVIRONMENT	Call by reference	☐	Object reference (TYPE REF TO)	CL_UA_FORMULA_BUILD_ENV		Umgebung einer Formel zum Build-Zeitpunkt	20051213
3	Importing	IO_SHM_HANDLE	Call by reference	☐	Object reference (TYPE REF TO)	CL_UA_FORMULA_AREA		Shared area for PDCE formula environment	20051213
4	Returning	RO_FORMULA	Value transfer	☐	Object reference (TYPE REF TO)	CL_UA_FORMULA_		Formel	20051213

#	Exception	Resumable	Description	Created on
1	SHM_ERROR	☐		20051213

Method CREATE_FUNCTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID_ID	Call by reference	☐	Type reference (TYPE)	UAB_FUNCTION_ID		ID of a Function	20051213
2	Importing	ID_RETURN_TYPE	Call by reference	☐	Type reference (TYPE)	UAB_DDIC_TYPENAME		Type Name	20051213
3	Importing	IO_FORMULA	Call by reference	☐	Object reference (TYPE REF TO)	CL_UA_FORMULA_		Formel	20051213
4	Importing	IO_PARENT	Call by reference	☐	Object reference (TYPE REF TO)	CL_UA_PARAMETER		Basisklasse für alle Funktionen	20051213
5	Importing	IO_SHM_HANDLE	Call by reference	☐	Object reference (TYPE REF TO)	CL_UA_FORMULA_AREA		Shared area for PDCE formula environment	20051213
6	Importing	IS_FUNC_DESCR	Call by reference	☐	Type reference (TYPE)	UAB_S_FUNC_DESCR		Function	20051213
7	Returning	RO_FUNCTION	Value transfer	☐	Object reference (TYPE REF TO)	CL_UA_FUNCTION		Basisklasse für alle Funktionen	20051213

#	Exception	Resumable	Description	Created on
1	SHM_ERROR	☐		20051213

Method CREATE_FUNCTION_FROM_SHM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID_ID	Call by reference	☐	Type reference (TYPE)	UAB_FUNCTION_ID			20060111
2	Importing	IO_FORMULA	Call by reference	☐	Object reference (TYPE REF TO)	CL_UA_FORMULA_			20060111
3	Importing	IO_FUNCTION	Call by reference	☐	Object reference (TYPE REF TO)	CL_UA_FUNCTION			20060111
4	Importing	IO_PARENT	Call by reference	☐	Object reference (TYPE REF TO)	CL_UA_PARAMETER			20060111
5	Returning	RO_FUNCTION	Value transfer	☐	Object reference (TYPE REF TO)	CL_UA_FUNCTION			20060111

#	Exception	Resumable	Description	Created on
1	SHM_ERROR	☐		20060111

Method CREATE_PARAMETER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID_ID	Call by reference	☐	Type reference (TYPE)	UAB_FUNCTION_ID		ID of a Function	20051213
2	Importing	ID_IDX	Call by reference	☑	Type reference (TYPE)	UAB_PARAMETER_IDX		Counter for Function Parameters that Can Occur Several Times	20051213
3	Importing	IO_FORMULA	Call by reference	☐	Object reference (TYPE REF TO)	CL_UA_FORMULA_		Formel	20051213
4	Importing	IO_PARENT	Call by reference	☑	Object reference (TYPE REF TO)	CL_UA_FUNCTION		Basisklasse für alle Funktionen	20051213
5	Importing	IO_SHM_HANDLE	Call by reference	☐	Object reference (TYPE REF TO)	CL_UA_FORMULA_AREA		Shared area for PDCE formula environment	20051213
6	Importing	IS_SIGNATURE	Call by reference	☐	Type reference (TYPE)	UAB_S_ABSTRACT_SIGNATURE		Abstract Signature of a Method	20051213
7	Returning	RO_PARAMETER	Value transfer	☐	Object reference (TYPE REF TO)	CL_UA_PARAMETER		Basisklasse für alle Funktionen	20051213

#	Exception	Resumable	Description	Created on
1	SHM_ERROR	☐		20051213

Method CREATE_PARAMETER_FROM_SHM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID_ID	Call by reference	☐	Type reference (TYPE)	UAB_FUNCTION_ID			20060111
2	Importing	ID_IDX	Call by reference	☑	Type reference (TYPE)	UAB_PARAMETER_IDX			20060111
3	Importing	IO_FORMULA	Call by reference	☐	Object reference (TYPE REF TO)	CL_UA_FORMULA_			20060111
4	Importing	IO_PARAMETER	Call by reference	☐	Object reference (TYPE REF TO)	CL_UA_PARAMETER			20060111
5	Importing	IO_PARENT	Call by reference	☑	Object reference (TYPE REF TO)	CL_UA_FUNCTION			20060111
6	Returning	RO_PARAMETER	Value transfer	☐	Object reference (TYPE REF TO)	CL_UA_PARAMETER			20060111

#	Exception	Resumable	Description	Created on
1	SHM_ERROR	☐		20060111

Method FILL_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_FORMULA_USAGE	Call by reference	☐	Type reference (TYPE)	UAB_T_FORMULA_USAGE			20051213
2	Exporting	ET_FUNC_DESCR	Call by reference	☐	Type reference (TYPE)	UAB_T_FUNC_DESCR			20061116
3	Importing	IO_SHM_HANDLE	Call by reference	☐	Object reference (TYPE REF TO)	CL_UA_FORMULA_AREA		Shared area for PDCE formula environment	20051213

#	Exception	Resumable	Description	Created on
1	SHM_ERROR	☐		20051213

Method GET_FORMULAS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_FORMULAS	Value transfer	☐	Type reference (TYPE)	UAB_T_FORMULA_USAGE		Formelverwendung	20051128

#	Exception	Resumable	Description	Created on
1	SHM_ERROR	☐		20051128

Method RESET_RETURN_TYPES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_PARAMETER	Call by reference	☐	Object reference (TYPE REF TO)	CL_UA_PARAMETER		Basisklasse für alle Funktionen	20051213
2	Importing	IO_SHM_HANDLE	Call by reference	☐	Object reference (TYPE REF TO)	CL_UA_FORMULA_AREA		Shared area for PDCE formula environment	20051213

Method RESET_RETURN_TYPES on class CL_UA_FORMULA_AREA_BUILDER has no exception.

Method SET_FORMULAS Signature

Method SET_FORMULAS on class CL_UA_FORMULA_AREA_BUILDER has no parameter.

#	Exception	Resumable	Description	Created on
1	SHM_ERROR	☐		20051128

Method SET_PARAMETER_FROM_XML Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID_TOLERATE_ERRORS	Value transfer	☑	Type reference (TYPE)	BOOLE_D	'X'	Formel	20051213
2	Importing	IO_NODE	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_NODE		Umgebung einer Formel zum Build-Zeitpunkt	20051213
3	Importing	IO_PARAMETER	Call by reference	☐	Object reference (TYPE REF TO)	CL_UA_PARAMETER		Basisklasse für alle Funktionen	20051213
4	Importing	IO_SHM_HANDLE	Call by reference	☐	Object reference (TYPE REF TO)	CL_UA_FORMULA_AREA		Shared area for PDCE formula environment	20051213

#	Exception	Resumable	Description	Created on
1	SHM_ERROR	☐		20051213

Method SET_VALUE_CONST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID_TYPENAME	Call by reference	☐	Type reference (TYPE)	UAB_DDIC_TYPENAME		Type Name	20051213
2	Importing	IO_PARAMETER	Call by reference	☐	Object reference (TYPE REF TO)	CL_UA_PARAMETER		Basisklasse für alle Funktionen	20051213
3	Importing	IO_SHM_HANDLE	Call by reference	☐	Object reference (TYPE REF TO)	CL_UA_FORMULA_AREA		Shared area for PDCE formula environment	20051213
4	Importing	IR_VALUE	Call by reference	☐	Object reference (TYPE REF TO)	DATA			20051213

#	Exception	Resumable	Description	Created on
1	SHM_ERROR	☐		20051213

History

Last changed by/on	SAP	20060703
SAP Release Created in