SAP ABAP Class CL_RSAN_UT_EXCEL_FILE_READER (Class encapulating block reading from MS Excel file)

Hierarchy

☛ SAP_BW (Software Component) SAP Business Warehouse
   ⤷ BW-BEX-OT (Application Component) OLAP Technology
     ⤷ RSDD_LTIP_APD (Package) Services for the APD to access logical indexes

Properties

Class	CL_RSAN_UT_EXCEL_FILE_READER
Short Description	Class encapulating block reading from MS Excel file
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class	RSAN_UT
Program status
Category	0
Package	RSDD_LTIP_APD	Services for the APD to access logical indexes
Created	20081027	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	RSANM	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
2	SABC	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_RSAN_UT_EXCEL_FILE_READER has no interface implemented.

Friends

Class CL_RSAN_UT_EXCEL_FILE_READER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	P_COLS	Instance attribute	Private	☐	Type reference (TYPE)	I			20081103
2	P_CURRENT_ROW	Instance attribute	Private	☐	Type reference (TYPE)	I			20081103
3	P_FIELD_TYPE_SEPARATOR	Instance attribute	Private	☐	Type reference (TYPE)	RSDD_XLS_FIELD_SEPARATOR		Separator for Fields in CSV Files	20100111
4	P_FILENAME	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20081029
5	P_READ	Instance attribute	Private	☐	Type reference (TYPE)	RS_BOOL		Boolean	20081104
6	P_RFC_DEST	Instance attribute	Private	☐	Type reference (TYPE)	RFCDEST		Logical destination (specified when calling function)	20081125
7	P_ROWS	Instance attribute	Private	☐	Type reference (TYPE)	I			20081103
8	P_R_APP	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_RSDD_XLS_APPLICATION		Excel Application	20081029
9	P_R_DATA_DESCR	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_RSDD_XLS_DATA_DESC		Data Description	20081103
10	P_R_RANGE	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_RSDD_XLS_RANGE		Excel Range	20081029
11	P_STATE	Instance attribute	Private	☐	Type reference (TYPE)	I			20081029
12	P_TH_FIELD	Instance attribute	Private	☐	Type reference (TYPE)	RSANM_TH_MAP_SOURCE_FIELD			20081104
13	P_XLS_DATA_RANGE	Instance attribute	Private	☐	Type reference (TYPE)	RSAN_MDL_XLS_DATA_RANGE		Excel Data Area	20081029
14	P_XLS_WORKSHEET	Instance attribute	Private	☐	Type reference (TYPE)	RSAN_MDL_XLS_WORKSHEET		Excel Worksheet	20081029
15	_C_STATE	Constant	Private	☐	See coding				20081027

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CLOSE	Instance method	Public	Method	Close File	20081027
2	CONSTRUCTOR	Instance method	Public	Constructor		20081027
3	FREE	Instance method	Public	Method	Free Resources	20081027
4	GET_DATA_DESC	Instance method	Public	Method		20100503
5	GET_SOURCE_FIELDS	Instance method	Public	Method	Get source fields (from header line)	20081027
6	GET_WORKSHEET_CATALOG	Static method	Public	Method		20081028
7	OPEN	Instance method	Public	Method	Open File	20081027
8	READ	Instance method	Public	Method	Read block of data lines	20081027
9	_GET_RANGE	Instance method	Private	Method	Get XLS range	20081030

Events

Class CL_RSAN_UT_EXCEL_FILE_READER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	T_S_WORKSHEET	Public	See coding			20081028	BEGIN OF t_s_worksheet, name type string, address type string, END OF t_s_worksheet
2	T_T_WORKSHEET	Public	See coding			20081028	t_t_worksheet type STANDARD TABLE OF t_s_worksheet with DEFAULT KEY

Method Signatures

Method CLOSE Signature

Method CLOSE on class CL_RSAN_UT_EXCEL_FILE_READER has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_RS_FAILED	☐	Operation gescheitert	20081028

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_FIELD_TYPE_SEPARATOR	Call by reference	☐	Type reference (TYPE)	RSAN_MDL_FIELD_SEPARATOR	':'	Fieldname/InfoObject separator	20081027
2	Importing	I_FILENAME	Call by reference	☐	Type reference (TYPE)	STRING			20081027
3	Importing	I_XLS_DATA_RANGE	Call by reference	☑	Type reference (TYPE)	RSAN_MDL_XLS_DATA_RANGE		Excel Datenbereich	20081027
4	Importing	I_XLS_WORKSHEET	Call by reference	☑	Type reference (TYPE)	RSAN_MDL_XLS_WORKSHEET		Excel Arbeitsblatt	20081027

Method CONSTRUCTOR on class CL_RSAN_UT_EXCEL_FILE_READER has no exception.

Method FREE Signature

Method FREE on class CL_RSAN_UT_EXCEL_FILE_READER has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_RS_FAILED	☐	Operation gescheitert	20090930

Method GET_DATA_DESC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_R_DATA_DESC	Value transfer	☐	Object reference (TYPE REF TO)	CL_RSDD_XLS_DATA_DESC		Daten Beschreibung	20100503

Method GET_DATA_DESC on class CL_RSAN_UT_EXCEL_FILE_READER has no exception.

Method GET_SOURCE_FIELDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ETH_FIELD	Call by reference	☐	Type reference (TYPE)	RSANM_TH_MAP_SOURCE_FIELD			20081027

#	Exception	Resumable	Description	Created on
1	CX_RS_FAILED	☐	Operation gescheitert	20081028

Method GET_WORKSHEET_CATALOG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_FILENAME	Call by reference	☐	Type reference (TYPE)	STRING			20081028
2	Importing	I_PATTERN	Call by reference	☑	Type reference (TYPE)	STRING			20081028
3	Returning	R_T_LIST	Value transfer	☐	Type reference (TYPE)	T_T_WORKSHEET			20081028

#	Exception	Resumable	Description	Created on
1	CX_RS_FAILED	☐	Operation gescheitert	20081028

Method OPEN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CHECK_AUTHORITY	Value transfer	☐	Type reference (TYPE)	AS4FLAG	'X'	Before opening do authority check ???	20081027

#	Exception	Resumable	Description	Created on
1	CX_RS_FAILED	☐	Operation gescheitert	20081028

Method READ Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_DATA_TAB	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE		Data table	20081027
2	Exporting	E_END_OF_FILE	Value transfer	☐	Type reference (TYPE)	AS4FLAG		Flag (X oder Blank)	20081027
3	Exporting	E_LINES_READ	Value transfer	☐	Type reference (TYPE)	I		Number of lines read	20081027
4	Importing	I_CLEAR_DATA_TAB	Value transfer	☐	Type reference (TYPE)	AS4FLAG	'X'	Clear c_data_tab before reading data into it?	20081027
5	Importing	I_LINES	Value transfer	☐	Type reference (TYPE)	I	1	Number of lines to read	20081027

#	Exception	Resumable	Description	Created on
1	CX_RS_FAILED	☐	Operation gescheitert	20081028

Method _GET_RANGE Signature

Method _GET_RANGE on class CL_RSAN_UT_EXCEL_FILE_READER has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_RS_FAILED	☐	Operation gescheitert	20081030

History

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