SAP ABAP Class CL_ESH_SE_SEARCH_DEBUGGING (Search Debugger)

Hierarchy

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

Properties

Class	CL_ESH_SE_SEARCH_DEBUGGING
Short Description	Search Debugger
Super Class
Instantiability of a Class	1	Protected
Final	☑

General Data

Message Class
Program status
Category	0
Package	S_ESH_ENG_SEARCH	Search (internal)
Created	20080704	SAP
Last change	20110908	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)
2	CL_ESH_SE_SEARCH_DEBUGGING	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)

Interfaces

Class CL_ESH_SE_SEARCH_DEBUGGING has no interface implemented.

Friends

#	Friend	Modeled only	Created on	Description
1	CL_ESH_SE_SEARCH_REQUEST	☐	20081013	Search Request
2	CL_ESH_TREX_QUERY_HANDLER	☐	20100607	Handle Query Transformation

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MO_SEARCH_REQUEST	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_ESH_SE_SEARCH_REQUEST		Search request	20080704
2	MO_SEARCH_REQUEST_FRONT	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_ESH_IF_SEARCH_REQUEST		Search request	20090204
3	MR_CURRENT_DEBUGGER_STEP	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	LST_DEBUGGER_RESULT		Current debugger result	20080705
4	MR_FIRST_DEBUGGER_STEP	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	LST_DEBUGGER_RESULT		First debugger result	20080705
5	MT_DEBUGGER_STEPS	Instance attribute	Protected	☐	Type reference (TYPE)	LTT_DEBUGGER_RESULTS		Debugger results	20080705
6	MV_AUTH_QUERY_DEBUGGER_ACTIVE	Instance attribute	Public	☑	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Debugger active	20080705
7	MV_CURRENT_DEBUGGER_STEP_NO	Instance attribute	Protected	☐	Type reference (TYPE)	I		Tabix	20080705
8	MV_LOG_CONJ_SPLITTER	Instance attribute	Protected	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Logical conjunction splitter active	20080704
9	MV_PARALLELIZATION	Instance attribute	Protected	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_UNDEFINED		20090204
10	MV_PROGRESS_INDICATOR	Instance attribute	Protected	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Progress indicator active	20080704
11	MV_REPLACED_LOG_CONJ	Instance attribute	Protected	☐	Type reference (TYPE)	STRING		Replaced logical conjunctions	20080705
12	MV_REPLACE_LOG_CONJ	Instance attribute	Protected	☐	Type reference (TYPE)	ABAP_BOOL			20080705
13	MV_USER_NAME	Instance attribute	Protected	☐	Type reference (TYPE)	SYUNAME		User name	20080704
14	SC_AND	Constant	Public	☐	Type reference (TYPE)	LVT_CHAR1	'&'	And	20080706
15	SC_CLOSE	Constant	Public	☐	Type reference (TYPE)	LVT_CHAR1	')'	Close	20080706
16	SC_DOUBLE_SEMICOLON	Constant	Public	☐	Type reference (TYPE)	LVT_CHAR2	';;'	Double semicolon	20080706
17	SC_NOT	Constant	Public	☐	Type reference (TYPE)	LVT_CHAR1	'-'	Not	20080706
18	SC_NO_LOGICAL_CONJUNCTION	Constant	Protected	☐	Type reference (TYPE)	CHAR32	''	No logical conjunction	20080705
19	SC_OPEN	Constant	Public	☐	Type reference (TYPE)	LVT_CHAR1	'('	Open	20080706
20	SC_OR	Constant	Public	☐	Type reference (TYPE)	LVT_CHAR1	'|'	Or	20080706
21	SC_REPLACE_PATTERN	Constant	Public	☐	Type reference (TYPE)	LVT_CHAR4	';$1;'	Replacement pattern	20080706
22	SC_SEMICOLON	Constant	Public	☐	Type reference (TYPE)	LVT_CHAR1	';'	Semicolon	20080706
23	SC_STATE_AFTER_SEARCH	Constant	Protected	☐	Type reference (TYPE)	CHAR1	'A'	After search	20080705
24	SC_STATE_DURING_SEARCH	Constant	Protected	☐	Type reference (TYPE)	CHAR1	'D'	During search	20080705
25	SC_TOKEN_SEPARATORS	Constant	Public	☐	Type reference (TYPE)	LVT_CHAR9	'([()|&-])'	Token separators	20080706

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_DEBUGGER_STEP	Instance method	Protected	Method	Add an empty step	20080705
2	ADD_DEBUGGER_SUB_STEPS	Instance method	Protected	Method	Split logical conjunction and add substeps	20080705
3	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20080704
4	DEBUG_AUTHORIZATION_QUERY	Instance method	Protected	Method	Debug	20080705
5	EXECUTE_AUTH_QUERY_DEBUGGER	Instance method	Public	Method	Execute debugger	20080705
6	EXECUTE_SEARCHES	Instance method	Protected	Method	Execute searches	20080705
7	GET_INSTANCE	Static method	Public	Method	Get instance	20080704
8	GET_TOKENS_OF_LOG_CONJ	Static method	Public	Method	Get tokens of logical conjunction	20080706
9	GET_USER	Instance method	Public	Method	Get user name	20080706
10	IS_LOG_CONJ_SYNTAX_OK	Static method	Public	Method	Is logical conjunction syntax OK	20080706
11	PREPARE_DEBUGGER_STEPS	Instance method	Protected	Method	Prepare logical conjunctions	20080705
12	REPLACE_LOGICAL_CONJUNCTION	Instance method	Public	Method	Add a logical conjunction	20080705
13	SET_LOGICAL_CONJUNCT_SPLITTER	Instance method	Public	Method	Set logical conjunction splitter	20080704
14	SET_PARALLELIZATION	Instance method	Public	Method	Set parallelization	20080718
15	SET_PROGRESS_INDICATOR	Instance method	Public	Method	Set progress indicator	20080704
16	SET_USER	Instance method	Public	Method	Set user	20080704
17	UPDATE_PROGRESS_INDICATOR	Instance method	Protected	Method	Update progress indicator	20080705

Events

Class CL_ESH_SE_SEARCH_DEBUGGING has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	LOT_RESPONSE	Public	Object reference (TYPE REF TO)	CL_ESH_IF_SEARCH_RESPONSE		20080705
2	LST_DEBUGGER_RESULT	Public	See coding		Debugger result	20080704	BEGIN OF lst_debugger_result, logical_conjunction TYPE string, conjunction_operator TYPE char1, parent_logical_conjunction TYPE string, position TYPE i, parent_position TYPE i, responses TYPE REF TO cl_esh_if_search_responses, response_all TYPE ltt_response_all, exception TYPE REF TO cx_esh_if_engine, END OF lst_debugger_result
3	LTT_DEBUGGER_RESULTS	Public	See coding		Table of Debugger Results	20080704	ltt_debugger_results TYPE STANDARD TABLE OF lst_debugger_result
4	LTT_RESPONSE_ALL	Public	See coding			20080705	ltt_response_all TYPE STANDARD TABLE OF lot_response WITH DEFAULT KEY
5	LVT_CHAR1	Public	See coding			20080706	lvt_char1(1) TYPE c
6	LVT_CHAR2	Public	See coding			20080706	lvt_char2(2) TYPE c
7	LVT_CHAR4	Public	See coding			20080706	lvt_char4(4) TYPE c
8	LVT_CHAR9	Public	See coding			20080706	lvt_char9(9) TYPE c

Method Signatures

Method ADD_DEBUGGER_STEP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_PARENT_DEBUGGER_RESULT	Call by reference	☑	Type reference (TYPE)	LST_DEBUGGER_RESULT		Debugger result	20080705
2	Returning	RR_DEBUGGER_RESULT	Value transfer	☐	Object reference (TYPE REF TO)	LST_DEBUGGER_RESULT		Debugger result	20080705

Method ADD_DEBUGGER_STEP on class CL_ESH_SE_SEARCH_DEBUGGING has no exception.

Method ADD_DEBUGGER_SUB_STEPS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_PARENT_DEBUGGER_STEP	Call by reference	☐	Object reference (TYPE REF TO)	LST_DEBUGGER_RESULT		Debugger result	20080705

Method ADD_DEBUGGER_SUB_STEPS on class CL_ESH_SE_SEARCH_DEBUGGING has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_SEARCH_REQUEST	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_IF_SEARCH_REQUEST		Search Request	20080704

Method CONSTRUCTOR on class CL_ESH_SE_SEARCH_DEBUGGING has no exception.

Method DEBUG_AUTHORIZATION_QUERY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_ATTR_LIST	Call by reference	☐	Type reference (TYPE)	ESH_T_JOIN_ATTRIBUTES_LIST		Table type for ESH_S_JOIN_ATTRIBUTES_LIST	20080705
2	Changing	CT_NODE_LIST	Call by reference	☐	Type reference (TYPE)	ESH_T_NODE_AUTHORIZATION_LIST		Table type for ESH_S_NODE_AUTHORIZATION_LIST	20080705
3	Changing	CV_SY_UNAME	Call by reference	☐	Type reference (TYPE)	SYUNAME		User Name	20080705

Method DEBUG_AUTHORIZATION_QUERY on class CL_ESH_SE_SEARCH_DEBUGGING has no exception.

Method EXECUTE_AUTH_QUERY_DEBUGGER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_DEBUGGER_RESULTS	Call by reference	☐	Type reference (TYPE)	CL_ESH_SE_SEARCH_DEBUGGING=>LTT_DEBUGGER_RESULTS		Table of Debugger Results	20080705

Method EXECUTE_AUTH_QUERY_DEBUGGER on class CL_ESH_SE_SEARCH_DEBUGGING has no exception.

Method EXECUTE_SEARCHES Signature

Method EXECUTE_SEARCHES on class CL_ESH_SE_SEARCH_DEBUGGING has no parameter.
Method EXECUTE_SEARCHES on class CL_ESH_SE_SEARCH_DEBUGGING has no exception.

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_SEARCH_REQUEST	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_IF_SEARCH_REQUEST		Search Request	20080704
2	Returning	RO_INSTANCE	Value transfer	☐	Object reference (TYPE REF TO)	CL_ESH_SE_SEARCH_DEBUGGING		Search Debugger	20080704

Method GET_INSTANCE on class CL_ESH_SE_SEARCH_DEBUGGING has no exception.

Method GET_TOKENS_OF_LOG_CONJ Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_TOKENS	Call by reference	☐	Type reference (TYPE)	STRING_TABLE		Table of Strings	20080706
2	Importing	IV_INDENT	Call by reference	☐	Type reference (TYPE)	INT4	0	Indent level	20080706
3	Importing	IV_LOGICAL_CONJUNCTION	Call by reference	☐	Type reference (TYPE)	STRING			20080706

Method GET_TOKENS_OF_LOG_CONJ on class CL_ESH_SE_SEARCH_DEBUGGING has no exception.

Method GET_USER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_USER_NAME	Value transfer	☐	Type reference (TYPE)	SYUNAME		User Name	20080706

Method GET_USER on class CL_ESH_SE_SEARCH_DEBUGGING has no exception.

Method IS_LOG_CONJ_SYNTAX_OK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_LOGICAL_CONJUNCTION	Call by reference	☐	Type reference (TYPE)	STRING			20080706
2	Returning	RV_TRUE	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20080706

Method IS_LOG_CONJ_SYNTAX_OK on class CL_ESH_SE_SEARCH_DEBUGGING has no exception.

Method PREPARE_DEBUGGER_STEPS Signature

Method PREPARE_DEBUGGER_STEPS on class CL_ESH_SE_SEARCH_DEBUGGING has no parameter.
Method PREPARE_DEBUGGER_STEPS on class CL_ESH_SE_SEARCH_DEBUGGING has no exception.

Method REPLACE_LOGICAL_CONJUNCTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ACTIVE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20080705
2	Importing	IV_LOG_CONJ	Call by reference	☐	Type reference (TYPE)	STRING			20080705

#	Exception	Resumable	Description	Created on
1	CX_ESH_CO_INVALID_PARAMETER	☐	Invalid Parameter	20080706

Method SET_LOGICAL_CONJUNCT_SPLITTER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ACTIVE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20080704

Method SET_LOGICAL_CONJUNCT_SPLITTER on class CL_ESH_SE_SEARCH_DEBUGGING has no exception.

Method SET_PARALLELIZATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ACTIVE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Active	20080718

Method SET_PARALLELIZATION on class CL_ESH_SE_SEARCH_DEBUGGING has no exception.

Method SET_PROGRESS_INDICATOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ACTIVE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20080704

Method SET_PROGRESS_INDICATOR on class CL_ESH_SE_SEARCH_DEBUGGING has no exception.

Method SET_USER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_USER_NAME	Call by reference	☐	Type reference (TYPE)	SYUNAME	SY-UNAME	User Name	20080704

Method SET_USER on class CL_ESH_SE_SEARCH_DEBUGGING has no exception.

Method UPDATE_PROGRESS_INDICATOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_STATE	Call by reference	☐	Type reference (TYPE)	CHAR1		Single-Character Flag	20080705

Method UPDATE_PROGRESS_INDICATOR on class CL_ESH_SE_SEARCH_DEBUGGING has no exception.

History

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