SAP ABAP Class CL_ESH_DP_FILE_SPREADSHEET (External Data Source: Spreadsheet File (XLS, ...))

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
     ⤷ S_ESH_CNT_DATA_PROVIDER (Package) Data Provider

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_ESH_IF_DATA_PROVIDER_XSYS	Data provider with destination handling	20100817
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_ESH_IF_DATA_PROVIDER_XSYS_I	Instances of included interfaces of data provider (x-sys)	20100817
3	Interface implementation (CLASS c. INTERFACES i_ref)	IF_ESH_IF_NODE_DESCRIPTOR	Node type descriptor	20100706
4	Interface implementation (CLASS c. INTERFACES i_ref)	IF_ESH_IF_NODE_TYPES_FOLD_XSYS	Node type list of folder (cross-system)	20100817
5	Interface implementation (CLASS c. INTERFACES i_ref)	IF_ESH_IF_NODE_TYPES_LIST_XSYS	Node type list (cross-system)	20100817

Properties

Class	CL_ESH_DP_FILE_SPREADSHEET
Short Description	External Data Source: Spreadsheet File (XLS, ...)
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	S_ESH_CNT_DATA_PROVIDER	Data Provider
Created	20100706	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_ESH_DP_FILE_SPREADSHEET has no forward declaration.

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_ESH_IF_DATA_PROVIDER_XSYS	☐	☐	Data provider with destination handling	20100817
2	IF_ESH_IF_DATA_PROVIDER_XSYS_I	☐	☐	Instances of included interfaces of data provider (x-sys)	20100817
3	IF_ESH_IF_NODE_DESCRIPTOR	☐	☐	Node type descriptor	20100706
4	IF_ESH_IF_NODE_TYPES_FOLD_XSYS	☐	☐	Node type list of folder (cross-system)	20100817
5	IF_ESH_IF_NODE_TYPES_LIST_XSYS	☐	☐	Node type list (cross-system)	20100817

Friends

Class CL_ESH_DP_FILE_SPREADSHEET has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MV_NODE_TYPE_BACKEND_NAME	Instance attribute	Private	☐	Type reference (TYPE)	ESH_E_OM_BACKEND_NAME		Back-end name	20100817
2	MV_NODE_TYPE_ID	Instance attribute	Private	☐	Type reference (TYPE)	ESH_E_OM_NODE_NAME		Node name	20100817
3	MV_SW_COMP_ID	Instance attribute	Private	☐	Type reference (TYPE)	ESH_E_OM_BACKEND_NAME		Back-end name	20100817
4	SC_PROVIDER_ID	Constant	Public	☐	Type reference (TYPE)	ESH_E_IF_PROVIDER_ID	'CL_ESH_DP_FILE_SPREADSHEET'	Provider ID	20100709

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_TYPE	Instance method	Private	Method		20100818
2	CONVERT_STRING_TO_ID	Static method	Public	Method		20100818
3	CONVERT_TABLE_DATA_HTML	Static method	Private	Method		20100817
4	CONVERT_WB_TO_SPREADS_TEMPLATE	Static method	Private	Method		20100817
5	CONVERT_XSTRING	Static method	Private	Method		20100708
6	GET_TABLE_RAW_DATA	Static method	Private	Method		20100817
7	HAS_NO_DATA	Static method	Private	Method		20100817
8	REMOVE_WHITESPACE_ETC	Static method	Private	Method		20100817

Events

Class CL_ESH_DP_FILE_SPREADSHEET has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TS_ROW	Public	See coding			20100817	ts_row TYPE TABLE OF string WITH DEFAULT KEY
2	TS_SPREADSHEET_TEMPLATE	Public	See coding			20100817	BEGIN OF ts_spreadsheet_template, * pos 01 (col A) -> node name node_type_id TYPE esh_e_om_node_name, * pos 02 (col B) -> node description node_stext TYPE esh_e_om_description, * pos 03 (col C) -> parent node name parent_node_type_id TYPE esh_e_om_node_name, * pos 04 (col D) -> language language TYPE laiso, "iso, 2 characters * pos 05 (col E) -> root node root_node TYPE esh_e_om_root_node, * pos 06 (col F) -> field field_id TYPE esh_e_om_node_field, * pos 07 (col G) -> field description field_stext TYPE esh_e_om_description, * pos 08 (col H) -> key primary_key TYPE esh_e_om_flag_primary_id, * pos 09 (col I) -> foreign key alias foreign_key_alias TYPE string, * pos 10 (col J) -> relevant for text search text_search TYPE esh_e_om_text_srch_rel, * pos 11 (col K) -> data type xsd_data_type TYPE string, * pos 12 (col L) -> attribute group description attribute_group_stext TYPE esh_e_om_description, * pos 13 (col M) -> lock node lock_node TYPE abap_bool, * pos 14 (col N) -> import parent (parent is mandatory for node) mandatory_parent TYPE abap_bool, * pos 15 (col O) -> import together with parent (node/child is mandatory for parent) mandatory_child TYPE abap_bool, * pos 16 (col P) -> modification status of composition (to parent node) modification_status TYPE esh_e_om_mod_status_relat, END OF ts_spreadsheet_template
3	TS_WORKBOOK	Public	See coding			20100817	ts_workbook TYPE TABLE OF ts_worksheet WITH DEFAULT KEY
4	TS_WORKSHEET	Public	See coding			20100817	ts_worksheet TYPE TABLE OF ts_row WITH DEFAULT KEY
5	TT_SPREADSHEET_TEMPLATE	Public	See coding			20100817	tt_spreadsheet_template TYPE TABLE OF ts_spreadsheet_template WITH KEY node_type_id
6	TT_WORKBOOK	Public	See coding			20100817	tt_workbook TYPE TABLE OF ts_workbook WITH DEFAULT KEY

Method Signatures

Method ADD_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CS_DATA_ELEMENTS	Call by reference	☐	Type reference (TYPE)	ESH_S_IF_DCB_DATA_ELEMENT			20100818
2	Importing	IV_XSD_DATA_TYPE	Call by reference	☐	Type reference (TYPE)	STRING			20100818

Method ADD_TYPE on class CL_ESH_DP_FILE_SPREADSHEET has no exception.

Method CONVERT_STRING_TO_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_STRING	Call by reference	☐	Type reference (TYPE)	STRING			20100818
2	Returning	RV_STRING	Value transfer	☐	Type reference (TYPE)	STRING			20100818

Method CONVERT_STRING_TO_ID on class CL_ESH_DP_FILE_SPREADSHEET has no exception.

Method CONVERT_TABLE_DATA_HTML Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_FILE_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20100825
2	Importing	IV_HTML	Call by reference	☐	Type reference (TYPE)	STRING			20100817
3	Returning	RS_WORKBOOK	Value transfer	☐	Type reference (TYPE)	TS_WORKBOOK			20100817

#	Exception	Resumable	Description	Created on
1	CX_ESH_DP_EXCEPTION	☐	Generic Software Component Import	20100817

Method CONVERT_WB_TO_SPREADS_TEMPLATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_WORKBOOK	Call by reference	☐	Type reference (TYPE)	TT_WORKBOOK			20100817
2	Returning	RT_SPREADSHEET_TEMPLATE	Value transfer	☐	Type reference (TYPE)	TT_SPREADSHEET_TEMPLATE			20100817

Method CONVERT_WB_TO_SPREADS_TEMPLATE on class CL_ESH_DP_FILE_SPREADSHEET has no exception.

Method CONVERT_XSTRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_FILE_CONTENT_X	Call by reference	☐	Type reference (TYPE)	CL_ESH_IEF_FRAMEWORK=>TT_FILE_CONTENT_X			20100817
2	Returning	RT_WORKBOOK	Value transfer	☐	Type reference (TYPE)	TT_WORKBOOK			20100817

#	Exception	Resumable	Description	Created on
1	CX_ESH_DP_EXCEPTION	☐	Data Provider Exception	20100817

Method GET_TABLE_RAW_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_FILE_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20100817
2	Importing	IV_RAW_DATA	Call by reference	☐	Type reference (TYPE)	XSTRING			20100817
3	Returning	RS_WORKBOOK	Value transfer	☐	Type reference (TYPE)	TS_WORKBOOK			20100817

#	Exception	Resumable	Description	Created on
1	CX_ESH_DP_EXCEPTION	☐	Data Provider Exception	20100817

Method HAS_NO_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_ROW_VALUES	Call by reference	☐	Type reference (TYPE)	TS_ROW			20100817
2	Returning	RV_IS_INITIAL	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20100817

Method HAS_NO_DATA on class CL_ESH_DP_FILE_SPREADSHEET has no exception.

Method REMOVE_WHITESPACE_ETC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_VALUE	Call by reference	☐	Type reference (TYPE)	STRING			20100817
2	Returning	RV_VALUE	Value transfer	☐	Type reference (TYPE)	STRING			20100817

Method REMOVE_WHITESPACE_ETC on class CL_ESH_DP_FILE_SPREADSHEET has no exception.

History

Last changed by/on	SAP	20110908
SAP Release Created in	703