SAP ABAP Class /CRYSTAL/MDX_READ_PROPERTIES (read optional property values)

Hierarchy

☛ SAP_BW (Software Component) SAP Business Warehouse
   ⤷ BW-BEX-ET (Application Component) End User Technology
     ⤷ /CRYSTAL/BC (Package) Business Objects Integrated Reporting

Properties

Class	/CRYSTAL/MDX_READ_PROPERTIES
Short Description	read optional property values
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	/CRYSTAL/BC	Business Objects Integrated Reporting
Created	20050603	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class /CRYSTAL/MDX_READ_PROPERTIES has no forward declaration.

Interfaces

Class /CRYSTAL/MDX_READ_PROPERTIES has no interface implemented.

Friends

Class /CRYSTAL/MDX_READ_PROPERTIES has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CX_MISSING_STREAMINFO	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	/CRYSTAL/CX_MISSING_STREAMINFO		internal error	20050603
2	CX_NO_MORE_PROPERTIES	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	/CRYSTAL/CX_NO_MORE_PROPERTIES		internal error	20050607
3	CX_SAVE_SESSION_STATE	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	/CRYSTAL/CX_SAVE_SESSION_STATE		internal error	20050608
4	DIM_PPTS	Instance attribute	Private	☐	Type reference (TYPE)	DIM_PPT_SET_TABLE		Number of properties etc per dim	20050607
5	HRY_INFO_ID	Instance attribute	Protected	☐	Type reference (TYPE)	SYCHAR60		where hry info is stored in memory	20050610
6	HRY_NODES	Instance attribute	Private	☐	Type reference (TYPE)	HRY_NODES_TABLE		used to build nodeid and parentid fields	20050603
7	PROPERTY_VALUES	Instance attribute	Protected	☐	Type reference (TYPE)	/CRYSTAL/MDX_PROPERTY_VALUES		the list of optional property values	20050603
8	ROW_INDEX	Instance attribute	Protected	☐	Type reference (TYPE)	I		read table index	20050603
9	STREAM	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	/CRYSTAL/MDX_APPEND_DATA		result set stream	20050607

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	APPEND_FIELD_INFO	Static method	Public	Method	build result set metadata	20050609
2	BUILD_NODEID	Static method	Private	Method	construct node id from parent id and canonical node id	20050607
3	CONSTRUCTOR	Instance method	Public	Constructor	set up object relationships	20050603
4	FIND_KEY_PPT	Static method	Protected	Method	Key id for property used to build hry info etc	20050606
5	FREE_SESSION_STATE	Static method	Public	Method	clear what was previously stored	20050610
6	GET_BASE_NAME	Static method	Protected	Method	strip second part of [].[]	20050610
7	INIT	Instance method	Public	Method	set up property parsing structures	20050603
8	RESTORE_SESSION_STATE	Instance method	Protected	Method	read hry node info back in	20050608
9	SAVE_SESSION_STATE	Instance method	Public	Method	Store hierarchy informantion between get_data calls	20050608
10	UPDATE_HRY_NODE_INFO	Instance method	Private	Method	maintain node and parent node id info	20050607
11	WRITE_FIELDS	Instance method	Public	Method	read optional property values as per given dimension	20050603
12	WRITE_HRY_NODE_FIELDS	Instance method	Protected	Method	append node and parent node id fields to result set	20050607

Events

Class /CRYSTAL/MDX_READ_PROPERTIES has no event.

Types

Class /CRYSTAL/MDX_READ_PROPERTIES has no local type.

Method Signatures

Method APPEND_FIELD_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	BASE_NAME	Call by reference	☐	Type reference (TYPE)	RRTLEVELNAME		Unique name of dimension (dimension unique name)	20050610
2	Importing	DIM_KEY	Call by reference	☐	Type reference (TYPE)	RRTDIM		Zero-based ordinal of a dimension on an axis	20050609
3	Importing	DIM_UNAM	Call by reference	☐	Type reference (TYPE)	RRTDIMUNAM		Unique name of dimension (dimension unique name)	20050610
4	Changing	FIELDS	Call by reference	☐	Type reference (TYPE)	/CRYSTAL/MDX_STREAM_LAYOUT_TAB		table for internal processing	20050609
5	Changing	FIELD_IDX	Call by reference	☐	Type reference (TYPE)	SNUMC3		The layout of the MDX Query driver's result stream.	20050609
6	Importing	PROPERTY_KEYS	Call by reference	☐	Type reference (TYPE)	/CRYSTAL/MDX_PROPERTY_KEYS		Optional dimension property keys	20050609
7	Importing	SESSIONID	Call by reference	☐	Type reference (TYPE)	SYCHAR60		pass the sessionid to find_key_property method	20110706

Method APPEND_FIELD_INFO on class /CRYSTAL/MDX_READ_PROPERTIES has no exception.

Method BUILD_NODEID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	NODEID	Value transfer	☐	Type reference (TYPE)	STRING			20050607
2	Importing	PARENTNODEID	Call by reference	☐	Type reference (TYPE)	STRING			20050607
3	Importing	PPT_VALUE	Call by reference	☐	Type reference (TYPE)	STRING			20050607

Method BUILD_NODEID on class /CRYSTAL/MDX_READ_PROPERTIES has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	STREAM	Call by reference	☐	Object reference (TYPE REF TO)	/CRYSTAL/MDX_APPEND_DATA		Builds result set stream	20050603

Method CONSTRUCTOR on class /CRYSTAL/MDX_READ_PROPERTIES has no exception.

Method FIND_KEY_PPT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DIM_KEY	Call by reference	☐	Type reference (TYPE)	RRTDIM		Zero-based ordinal of a dimension on an axis	20050606
2	Importing	DIM_UNAM	Call by reference	☐	Type reference (TYPE)	RRTDIMUNAM		Unique name of dimension (dimension unique name)	20050610
3	Returning	KEY_PPT	Value transfer	☐	Type reference (TYPE)	RRTNUMKEY3		Numeric key with 3 numbers	20050606
4	Importing	PROPERTY_KEYS	Call by reference	☐	Type reference (TYPE)	/CRYSTAL/MDX_PROPERTY_KEYS		Optional dimension property keys	20050606
5	Importing	SESSIONID	Call by reference	☐	Type reference (TYPE)	SYCHAR60		get cube name from session id	20110706

Method FIND_KEY_PPT on class /CRYSTAL/MDX_READ_PROPERTIES has no exception.

Method FREE_SESSION_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	SESSIONID	Call by reference	☐	Type reference (TYPE)	SYCHAR60		CHAR60 data element for SYST	20050610

Method FREE_SESSION_STATE on class /CRYSTAL/MDX_READ_PROPERTIES has no exception.

Method GET_BASE_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	BASE_NAME	Value transfer	☐	Type reference (TYPE)	RRTLEVELNAME		Unique name of a hierarchy level	20050610
2	Importing	LVL_UNAM	Call by reference	☐	Type reference (TYPE)	RRTLEVELNAME		Unique name of a hierarchy level	20050610

Method GET_BASE_NAME on class /CRYSTAL/MDX_READ_PROPERTIES has no exception.

Method INIT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PROPERTY_KEYS	Call by reference	☐	Type reference (TYPE)	/CRYSTAL/MDX_PROPERTY_KEYS		Optional dimension property keys	20050603
2	Importing	PROPERTY_VALUES	Call by reference	☐	Type reference (TYPE)	/CRYSTAL/MDX_PROPERTY_VALUES		Optional dimension property values	20050603
3	Importing	SESSIONID	Call by reference	☐	Type reference (TYPE)	SYCHAR60		CHAR60 data element for SYST	20050610

#	Exception	Resumable	Description	Created on
1	/CRYSTAL/CX_MISSING_STREAMINFO	☐	internal error	20050603

Method RESTORE_SESSION_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RESTORED	Value transfer	☐	Type reference (TYPE)	SYCHAR01		'X' for restored, space for not found	20050608

Method RESTORE_SESSION_STATE on class /CRYSTAL/MDX_READ_PROPERTIES has no exception.

Method SAVE_SESSION_STATE Signature

Method SAVE_SESSION_STATE on class /CRYSTAL/MDX_READ_PROPERTIES has no parameter.

#	Exception	Resumable	Description	Created on
1	/CRYSTAL/CX_SAVE_SESSION_STATE	☐	Hry node info etc	20050608

Method UPDATE_HRY_NODE_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DIM_DATA	Call by reference	☐	Type reference (TYPE)	BAPI6111MPP		Default Features of Member	20050607
2	Changing	DIM_PPT	Call by reference	☐	Type reference (TYPE)	DIM_PPT_SET		Metadata for contructing hierarchy node info	20050607
3	Importing	DIM_PPT_INDEX	Call by reference	☐	Type reference (TYPE)	I			20050607
4	Importing	PPT_VALUE	Call by reference	☐	Type reference (TYPE)	STRING			20050607

Method UPDATE_HRY_NODE_INFO on class /CRYSTAL/MDX_READ_PROPERTIES has no exception.

Method WRITE_FIELDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DIM_DATA	Call by reference	☐	Type reference (TYPE)	BAPI6111MPP		Default Features of Member	20050607

#	Exception	Resumable	Description	Created on
1	/CRYSTAL/CX_NO_MORE_PROPERTIES	☐	ran out of optional property values	20050607

Method WRITE_HRY_NODE_FIELDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DIM_KEY	Call by reference	☐	Type reference (TYPE)	RRTDIM		Zero-based ordinal of a dimension on an axis	20050607

Method WRITE_HRY_NODE_FIELDS on class /CRYSTAL/MDX_READ_PROPERTIES has no exception.

History

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