SAP ABAP Class CL_RSL_UTIL_DS_READER (Service - Read BW DataSource)

Hierarchy

☛ SAP_BW (Software Component) SAP Business Warehouse
   ⤷ BW-BEX-OT (Application Component) OLAP Technology
     ⤷ RSL_UTILITIES (Package) Services for the Workspaces

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_RSL_DATA_READER	Read Class (Interface)	20110511

Properties

Class	CL_RSL_UTIL_DS_READER
Short Description	Service - Read BW DataSource
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	RSL_UTILITIES	Services for the Workspaces
Created	20110325	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	IF_RSL_DATA_READER	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
2	RS	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_RSL_DATA_READER	☐	☐	Read Class (Interface)	20110511

Friends

Class CL_RSL_UTIL_DS_READER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	N_C_MSGID	Constant	Public	☐	Type reference (TYPE)	SYMSGID	'RSL_UTILITIES'	Message class	20110512
2	P_DSNM	Instance attribute	Private	☐	Type reference (TYPE)	ROOSOURCER		DataSource Name	20110325
3	P_EXTRACT	Instance attribute	Private	☐	Type reference (TYPE)	RSDSACCESS		Access Method DataSource	20110325
4	P_FETCHSIZE	Instance attribute	Private	☐	Type reference (TYPE)	RSMAXSIZE		Like package size	20110511
5	P_IS_READABLE	Instance attribute	Private	☐	Type reference (TYPE)	RS_BOOL		is DataSource readable?	20110325
6	P_LOGSYS	Instance attribute	Private	☐	Type reference (TYPE)	RSSLOGSYS		Logical System	20110325
7	P_MAXROWS	Instance attribute	Private	☐	Type reference (TYPE)	INT4		Maximum Number of Lines to be Read	20110511
8	P_NOFETCH	Instance attribute	Private	☐	Type reference (TYPE)	RS_BOOL		fetch data or not	20110511
9	P_PACKID	Instance attribute	Private	☐	Type reference (TYPE)	RSDATAPID		Packaged Currently Being Read	20110325
10	P_R_DS	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_RSDS_RSDS		Reference to DataSource	20110325
11	P_S_MSG_READABLE	Instance attribute	Private	☐	Type reference (TYPE)	RS_S_MSG		Cause of not READABLE decision	20110726
12	P_T_FIELD	Instance attribute	Private	☐	Type reference (TYPE)	RSDS_T_EXTRACT_FIELDS		Field Selection	20110511
13	P_T_SELECTION	Instance attribute	Private	☐	Type reference (TYPE)	RS_T_RSCEDST		Filter	20110511

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Public	Constructor		20110325
2	EXISTS	Static method	Public	Method	does DataSource exist?	20110325
3	GET_DS_INFO	Instance method	Public	Method	returns DataSource infos	20110325
4	GET_DS_INSTANCE	Instance method	Public	Method	Returns Datasource instance	20110325
5	GET_DS_METADATA	Instance method	Public	Method	returns metadata of datasource	20110325
6	GET_DS_READABLE_ALL	Static method	Public	Method	returns all DataSources that can be read via READ-method	20110325
7	GET_DS_TEXT_STATIC	Static method	Public	Method	Reads texts for list of DS (not all fields are filled)	20110601
8	GET_FIELDTYPE_BY_DATATYPE	Static method	Public	Method	returns fieldtype, derived by specified datatype	20110608
9	GET_STRUCTDESCR	Instance method	Public	Method	returns Structure description	20110325
10	IS_DS_READABLE	Instance method	Public	Method	is DataSource readable?	20110325
11	_GET_ELEMDESCR	Static method	Private	Method	returns reference to comptype compatible to STRUCTDESCR	20110325
12	_GET_KYF_CURR_OR_UNIT	Instance method	Private	Method	returns if Keyfigure is of type CURRENCY or UNIT	20110608
13	_GET_MSG_BY_ID	Instance method	Private	Method	returns message by specified ID	20110726
14	_GET_MSG_BY_ID_STATIC	Static method	Private	Method	returns message by specified ID	20110726
15	_IS_DS_READABLE	Instance method	Private	Method	Is DataSource readable (decision)	20110325
16	_IS_DS_READABLE_PRETEST_STATIC	Static method	Private	Method	is DataSource readable (static method)	20110726
17	_IS_FILE_ON_APPLSERV	Instance method	Private	Method	Is PC file on application server?	20110725

Events

Class CL_RSL_UTIL_DS_READER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	NT_S_DSF4	Public	See coding			20110325	BEGIN OF nt_s_dsf4, datasource TYPE roosourcer, logsys TYPE rsslogsys, type TYPE rsds_requtype, txtlg TYPE rstxtlg, tlogo TYPE rstlogo, objstat TYPE rsobjstat, END OF nt_s_dsf4
2	NT_S_FIELDTYPE	Public	See coding			20110325	BEGIN OF nt_s_fieldtype, fieldnm TYPE rsfieldnm, is_kyf TYPE rs_bool, END OF nt_s_fieldtype
3	NT_S_FLDSEL	Public	See coding			20110325	BEGIN OF nt_s_fldsel, fieldnm TYPE rsfieldnm, selected TYPE rs_bool, is_kyf TYPE rs_bool, datatype TYPE rsdatatype, length TYPE int2, decimals TYPE int2, END OF nt_s_fldsel
4	NT_TH_FLDSEL	Public	See coding			20110325	nt_th_fldsel TYPE HASHED TABLE OF nt_s_fldsel WITH UNIQUE KEY fieldnm
5	NT_TS_DSF4	Public	See coding			20110325	nt_ts_dsf4 TYPE SORTED TABLE OF nt_s_dsf4 WITH UNIQUE KEY datasource logsys
6	NT_T_FIELDTYPE	Public	See coding			20110325	nt_t_fieldtype TYPE HASHED TABLE OF nt_s_fieldtype WITH UNIQUE KEY fieldnm

Method Signatures

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_DSNM	Call by reference	☐	Type reference (TYPE)	ROOSOURCER		DataSourcename	20110325
2	Importing	I_LOGSYS	Call by reference	☐	Type reference (TYPE)	RSSLOGSYS		LogischesSystem	20110325

#	Exception	Resumable	Description	Created on
1	CX_RS_NOT_FOUND	☐		20110325

Method EXISTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_DSNM	Call by reference	☐	Type reference (TYPE)	ROOSOURCER		DataSourcename	20110325
2	Importing	I_LOGSYS	Call by reference	☐	Type reference (TYPE)	RSSLOGSYS		Quellsystem	20110325
3	Returning	R_EXISTS	Value transfer	☐	Type reference (TYPE)	RS_BOOL		Boolean	20110325

Method EXISTS on class CL_RSL_UTIL_DS_READER has no exception.

Method GET_DS_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_DSNM	Call by reference	☐	Type reference (TYPE)	ROOSOURCER		DataSource (OSOA/OSOD)	20110325
2	Exporting	E_IS_READABLE	Call by reference	☐	Type reference (TYPE)	RS_BOOL		DataSource ist lesbar	20110325
3	Exporting	E_LOGSYS	Call by reference	☐	Type reference (TYPE)	RSSLOGSYS		Quellsystem	20110325
4	Exporting	E_TXTLG	Call by reference	☐	Type reference (TYPE)	RSTXTLG		Beschreibung lang	20110331

Method GET_DS_INFO on class CL_RSL_UTIL_DS_READER has no exception.

Method GET_DS_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_DSNM	Call by reference	☐	Type reference (TYPE)	ROOSOURCER		DataSourcename	20110325
2	Importing	I_LOGSYS	Call by reference	☐	Type reference (TYPE)	RSSLOGSYS		LogischesSystem	20110325
3	Returning	R_R_DATASOURCE	Value transfer	☐	Object reference (TYPE REF TO)	CL_RSDS_RSDS		Referenz auf DataSource	20110325

#	Exception	Resumable	Description	Created on
1	CX_RS_NOT_FOUND	☐		20110325

Method GET_DS_METADATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_T_METATEXTS	Call by reference	☐	Type reference (TYPE)	RSDS_T_RSDSSEGFDT		DataSource Feld-Texte	20110531
2	Exporting	E_T_META_INT	Call by reference	☐	Type reference (TYPE)	RSDS_T_SEGFD_INT		DataSource - Segmentfelder mit internem Typ und Länge	20110520

Method GET_DS_METADATA on class CL_RSL_UTIL_DS_READER has no exception.

Method GET_DS_READABLE_ALL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_TS_DSF4	Value transfer	☐	Type reference (TYPE)	NT_TS_DSF4		Hashtabelle mit Referenzen auf Workspace Objekte	20110325

Method GET_DS_READABLE_ALL on class CL_RSL_UTIL_DS_READER has no exception.

Method GET_DS_TEXT_STATIC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_TS_DS	Call by reference	☐	Type reference (TYPE)	NT_TS_DSF4		DataSource (OSOA/OSOD)	20110601

Method GET_DS_TEXT_STATIC on class CL_RSL_UTIL_DS_READER has no exception.

Method GET_FIELDTYPE_BY_DATATYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_DATATYPE	Call by reference	☐	Type reference (TYPE)	DATATYPE_D		Datentyp im ABAP Dictionary	20110608
2	Returning	R_FIELDTYPE	Value transfer	☐	Type reference (TYPE)	IF_RSL_DATA_READER=>GT_FIELDTYPE		Datenfeld-Typ (KYF/CHA/leer)	20110608

Method GET_FIELDTYPE_BY_DATATYPE on class CL_RSL_UTIL_DS_READER has no exception.

Method GET_STRUCTDESCR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_R_STRUCTDESCR	Call by reference	☐	Object reference (TYPE REF TO)	CL_ABAP_STRUCTDESCR		Strukturbeschreibung	20110325
2	Exporting	E_TH_FIELDTYPE	Call by reference	☐	Type reference (TYPE)	NT_T_FIELDTYPE		Felder mit Datentypen	20110325
3	Importing	I_T_FIELD	Call by reference	☑	Type reference (TYPE)	IF_RSL_DATA_READER=>GT_T_FIELDNAMES		Feldauswahl	20110325

Method GET_STRUCTDESCR on class CL_RSL_UTIL_DS_READER has no exception.

Method IS_DS_READABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_IS_READABLE	Call by reference	☐	Type reference (TYPE)	RS_BOOL		Boolean	20110512
2	Exporting	E_S_MSG	Call by reference	☐	Type reference (TYPE)	RS_S_MSG			20110512

Method IS_DS_READABLE on class CL_RSL_UTIL_DS_READER has no exception.

Method _GET_ELEMDESCR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_R_ELEMDESCR	Call by reference	☐	Object reference (TYPE REF TO)	CL_ABAP_DATADESCR		Datentypbeschreibung	20110325
2	Exporting	E_SUGG_IS_KYF	Call by reference	☐	Type reference (TYPE)	RS_BOOL		Vorschlag ob Kennzahl oder Merkmal	20110325
3	Importing	I_DECIMALS	Call by reference	☐	Type reference (TYPE)	DECIMALS		Anzahl Dezimalstellen	20110325
4	Importing	I_FIELDTYPE	Call by reference	☐	Type reference (TYPE)	RSDATATYPE		Datentyp	20110325
5	Importing	I_INTLENGTH	Call by reference	☐	Type reference (TYPE)	INTLEN		Länge (Anzahl der Zeichen)	20110725
6	Importing	I_LENGTH	Call by reference	☐	Type reference (TYPE)	DDLENG		Länge	20110325

Method _GET_ELEMDESCR on class CL_RSL_UTIL_DS_READER has no exception.

Method _GET_KYF_CURR_OR_UNIT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_CURRENCY	Call by reference	☐	Type reference (TYPE)	WAERS		Währungsschlüssel	20110727
2	Exporting	E_CURRENY_COLUMN	Call by reference	☐	Type reference (TYPE)	FIELDNAME		Boolean	20110608
3	Exporting	E_UNIT	Call by reference	☐	Type reference (TYPE)	RSDBUNIT		Maßeinheiten verschiedener Art (BW)	20110727
4	Exporting	E_UNIT_COLUMN	Call by reference	☐	Type reference (TYPE)	FIELDNAME		Boolean	20110608
5	Importing	I_DATATYPE	Call by reference	☐	Type reference (TYPE)	RSDATATYPE		Feldname	20110608
6	Importing	I_UNITFIELDNM	Call by reference	☐	Type reference (TYPE)	RSDS_UNIFIELDNM		Feldname	20110608

Method _GET_KYF_CURR_OR_UNIT on class CL_RSL_UTIL_DS_READER has no exception.

Method _GET_MSG_BY_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_MESSAGEID	Call by reference	☐	Type reference (TYPE)	MSGID		Nachrichtenidentifikation	20110726
2	Returning	R_S_MSG	Value transfer	☐	Type reference (TYPE)	RS_S_MSG			20110726

Method _GET_MSG_BY_ID on class CL_RSL_UTIL_DS_READER has no exception.

Method _GET_MSG_BY_ID_STATIC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_DSNM	Call by reference	☑	Type reference (TYPE)	ROOSOURCER		Kopf Tabelle für SAP BW OLTP Sources (ab 2.0 relevant)	20110726
2	Importing	I_LOGSYS	Call by reference	☑	Type reference (TYPE)	RSSLOGSYS		Quellsystem	20110726
3	Importing	I_MESSAGEID	Call by reference	☐	Type reference (TYPE)	MSGID		Nachrichtenidentifikation	20110726
4	Returning	R_S_MSG	Value transfer	☐	Type reference (TYPE)	RS_S_MSG			20110726

Method _GET_MSG_BY_ID_STATIC on class CL_RSL_UTIL_DS_READER has no exception.

Method _IS_DS_READABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_EXTRACT	Call by reference	☐	Type reference (TYPE)	RSDSACCESS		Zugriffsmethode DataSource	20110325
2	Exporting	E_IS_READABLE	Call by reference	☐	Type reference (TYPE)	RS_BOOL		Boolean	20110325
3	Exporting	E_S_MSG	Call by reference	☐	Type reference (TYPE)	RS_S_MSG			20110726

Method _IS_DS_READABLE on class CL_RSL_UTIL_DS_READER has no exception.

Method _IS_DS_READABLE_PRETEST_STATIC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_DSNM	Call by reference	☐	Type reference (TYPE)	ROOSOURCER		DataSource (OSOA/OSOD)	20110726
2	Importing	I_LOGSYS	Call by reference	☐	Type reference (TYPE)	RSSLOGSYS		Quellsystem	20110726
3	Importing	I_VIRTCUBE	Call by reference	☑	Type reference (TYPE)	ROVIRTFL		DataSource: Extraktor unterstützt Direktzugriff	20110726
4	Returning	R_IS_READABLE	Value transfer	☐	Type reference (TYPE)	RS_BOOL		Boolean	20110726

#	Exception	Resumable	Description	Created on
1	CX_RS_NOT_FOUND	☐	Objekt nicht gefunden	20110726

Method _IS_FILE_ON_APPLSERV Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_IS_FILE_ON_APPLSERV	Call by reference	☐	Type reference (TYPE)	RS_BOOL		Boolean	20110726
2	Exporting	E_S_MSG	Call by reference	☐	Type reference (TYPE)	RS_S_MSG			20110726

Method _IS_FILE_ON_APPLSERV on class CL_RSL_UTIL_DS_READER has no exception.

History

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