SAP ABAP Class CL_ESH_IF_GENERIC_DB_ITERATOR (Extract Data from any DB Table)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
     ⤷ S_ESH_ENG_INTERFACE (Package) Interface

Properties

Class	CL_ESH_IF_GENERIC_DB_ITERATOR
Short Description	Extract Data from any DB Table
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class
Program status
Category	0
Package	S_ESH_ENG_INTERFACE	Interface
Created	20080117	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	ABAP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_ESH_IF_GENERIC_DB_ITERATOR has no interface implemented.

Friends

Class CL_ESH_IF_GENERIC_DB_ITERATOR has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_DEFAULT_PACKAGE_SIZE	Constant	Private	☐	Type reference (TYPE)	I	10000	Default package size	20080117
2	GC_MESSAGE_ID	Constant	Private	☐	Type reference (TYPE)	SYMSGID	'ESH_SEARCH'	Message class	20080218
3	GC_REPLACE_PATTERN	Constant	Public	☐	Type reference (TYPE)	STRING	'/_'	Replace pattern	20080319
4	GC_SPECIAL_CHARS	Constant	Public	☐	Type reference (TYPE)	STRING	'/'	String of special characters in field names	20080319
5	GR_S_KEY	Instance attribute	Private	☐	Object reference (TYPE REF TO)	DATA		Structure of key fields	20080117
6	GR_T_DATA	Instance attribute	Private	☐	Object reference (TYPE REF TO)	DATA		Data package	20080117
7	GR_T_KEY	Instance attribute	Private	☐	Object reference (TYPE REF TO)	DATA		Table of key fields	20080117
8	GT_DB_FIELDS	Instance attribute	Private	☐	Type reference (TYPE)	DDFIELDS		List of fields of the DB table	20080304
9	GT_FIELDLIST	Instance attribute	Private	☐	Type reference (TYPE)	DCBTFIELDS		List of field names	20080117
10	GT_INSTANCES	Static Attribute	Private	☐	Type reference (TYPE)	LTY_T_INSTANCE_TYPE		Table of all class instances	20080117
11	GT_KEYFIELDS	Instance attribute	Private	☐	Type reference (TYPE)	DDFIELDS		List of key fields	20080117
12	GT_KEYFIELDS_WORK	Instance attribute	Private	☐	Type reference (TYPE)	DDFIELDS		List of key fields used in selection	20080117
13	GT_SEL_OPTIONS	Instance attribute	Private	☐	Type reference (TYPE)	ESH_T_IF_EXTRACT_SEL_OPT		List of select options	20080117
14	GV_IS_DBVIEW	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL		Flag: Table is a DB view	20130112
15	GV_START	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL		Flag: Method START_EXTRACTION was called	20080117
16	GV_TABLENAME	Instance attribute	Private	☐	Type reference (TYPE)	TABNAME		Table name for selection	20080117

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Private	Constructor	Private constructor	20080117
2	CREATE_DATA_STRUCTURE	Static method	Public	Method	Create a dynamic data structure for the specified fields	20080117
3	GET_DATA	Instance method	Public	Method	Get object data by list of object IDs	20080117
4	GET_FIELDNAME	Static method	Public	Method	Get the field name (node field or back-end name)	20090220
5	GET_INSTANCE	Static method	Public	Method	Get instance method	20080117
6	NEXT	Instance method	Public	Method	Get next data package by last object ID	20080117
7	REPLACE_SPECIAL_CHARS_IN_FIELD	Static method	Public	Method	Replace special characters in the specified field	20080723
8	REPLACE_SPECIAL_CHARS_IN_TABLE	Static method	Public	Method	Replace special characters in one field of a table	20080326
9	START_DATA_EXTRACTION	Instance method	Public	Method	Start the data extraction	20080117

Events

Class CL_ESH_IF_GENERIC_DB_ITERATOR has no event.

Types

Class CL_ESH_IF_GENERIC_DB_ITERATOR has no local type.

Method Signatures

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TABLENAME	Call by reference	☐	Type reference (TYPE)	TABNAME		Table name	20080117

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_PROVIDER_ERROR	☐	General error in provider	20080117

Method CREATE_DATA_STRUCTURE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ER_DATA_STRUCTURE_REF	Call by reference	☐	Object reference (TYPE REF TO)	DATA		Reference to dynamic data structure	20080117
2	Exporting	ER_DATA_TABLE_REF	Call by reference	☐	Object reference (TYPE REF TO)	DATA		Reference to dynamic data table	20080117
3	Importing	IT_FIELDS	Call by reference	☐	Type reference (TYPE)	DDFIELDS		DD: Field List	20080117
4	Importing	IV_INCL_DATA_TABLE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Flag: Create a dynamic data table	20080117
5	Importing	IV_KEY_FIELDS_ONLY	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Flag: Consider key fields only	20080117
6	Importing	IV_REPLACE_SPECIAL_CHARS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Flag: Replace special character in fieldnames	20080319

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_ENGINE	☐	ESH Interface Exception	20080218
2	CX_SY_CREATE_DATA_ERROR	☐	System-Exception Creating Data	20080117
3	CX_SY_STRUCT_CREATION	☐	Exception when Creating a Structure Type	20080117
4	CX_SY_TABLE_CREATION	☐	Exception when Creating a Table Type	20080117

Method GET_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_OBJECT_EXTRACTION	Call by reference	☐	Type reference (TYPE)	ESH_S_IF_EXTRACT_NODE			20080117
2	Importing	IT_OBJECT_IDS	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_CHANGED_OBJECTS		Changed Objects	20080117

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_PROVIDER_ERROR	☐	General error in provider	20080117

Method GET_FIELDNAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_FIELDS	Call by reference	☐	Type reference (TYPE)	DDFIELDS		DD: Field List	20090220
2	Importing	IV_BACKEND_NAME	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_BACKEND_NAME		Backend Name	20090220
3	Importing	IV_NODE_FIELD	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_NODE_FIELD		Node Field	20090220
4	Returning	RV_FIELDNAME	Value transfer	☐	Type reference (TYPE)	FIELDNAME		Field Name	20090220

Method GET_FIELDNAME on class CL_ESH_IF_GENERIC_DB_ITERATOR has no exception.

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TABLENAME	Call by reference	☐	Type reference (TYPE)	TABNAME		Table Name	20080117
2	Returning	RR_INSTANCE	Value transfer	☐	Object reference (TYPE REF TO)	CL_ESH_IF_GENERIC_DB_ITERATOR		Extract data from any DB table	20080117

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_PROVIDER_ERROR	☐	General error in provider	20080117

Method NEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_LAST_OBJECT_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_GENERAL_ID		General ID	20080117
2	Exporting	EV_NO_MORE_DATA	Call by reference	☐	Type reference (TYPE)	XFELD		Flag: No more data to extract	20080117
3	Importing	IS_OBJECT_EXTRACTION	Call by reference	☐	Type reference (TYPE)	ESH_S_IF_EXTRACT_NODE		Extraction of one node	20080117
4	Importing	IV_LAST_OBJECT_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_GENERAL_ID	SPACE	General ID	20080117
5	Importing	IV_PACKAGE_SIZE	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_PACKAGE_SIZE		Package size	20080117

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_PROVIDER_ERROR	☐	General error in provider	20080117

Method REPLACE_SPECIAL_CHARS_IN_FIELD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CV_FIELD	Call by reference	☐	Type reference (TYPE)	ANY			20080723

Method REPLACE_SPECIAL_CHARS_IN_FIELD on class CL_ESH_IF_GENERIC_DB_ITERATOR has no exception.

Method REPLACE_SPECIAL_CHARS_IN_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_TABLE	Call by reference	☐	Type reference (TYPE)	TABLE		Table	20080326
2	Importing	IV_FIELDNAME	Call by reference	☑	Type reference (TYPE)	FIELDNAME		Field Name	20080326
3	Importing	IV_FIELDNAME_STRING	Call by reference	☑	Type reference (TYPE)	STRING		String of fieldnames separated by space	20080327

Method REPLACE_SPECIAL_CHARS_IN_TABLE on class CL_ESH_IF_GENERIC_DB_ITERATOR has no exception.

Method START_DATA_EXTRACTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_LAST_OBJECT_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_GENERAL_ID		General ID	20080117
2	Exporting	EV_NO_MORE_DATA	Call by reference	☐	Type reference (TYPE)	XFELD		Flag: No more data to extract	20080117
3	Importing	IS_OBJECT_EXTRACTION	Call by reference	☐	Type reference (TYPE)	ESH_S_IF_EXTRACT_NODE		Extraction of one node	20080117
4	Importing	IT_SELECT_OPTIONS	Call by reference	☑	Type reference (TYPE)	ESH_T_IF_EXTRACT_SEL_OPT		Select options	20080117
5	Importing	IV_PACKAGE_SIZE	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_PACKAGE_SIZE		Package size	20080117

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_PROVIDER_ERROR	☐	General error in provider	20080117

History

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