SAP ABAP Class CL_ESH_TREX_QUERY_HANDLER (Handle Query Transformation)

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_TREX_QUERY_HANDLER
Short Description	Handle Query Transformation
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	S_ESH_ENG_SEARCH	Search (internal)
Created	20091230	SAP
Last change	20141121
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	IF_ESH_SE_RUNTIME_DATA	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

Class CL_ESH_TREX_QUERY_HANDLER has no interface implemented.

Friends

#	Friend	Modeled only	Created on	Description
1	CL_ESH_SE_SEARCH_REQUEST	☐	20100607	Search Request

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MC_FALSE	Constant	Private	☐	Type reference (TYPE)	CHAR5	'FALSE'	False	20131112
2	MC_TRUE	Constant	Private	☐	Type reference (TYPE)	CHAR5	'TRUE'	True	20131112
3	MR_SEARCH_DEBUGGER	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_ESH_SE_SEARCH_DEBUGGING		Search debugger	20100607
4	MT_TREX_HINTS	Static Attribute	Private	☐	Type reference (TYPE)	TREXT_HINTS		Hints for the optimizer	20091230

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	BUILD_AUTHORIZATION_QUERY	Instance method	Private	Method	Build the authorization query without using query parts	20131112
2	BUILD_AUTHORIZATION_QUERY_QP	Instance method	Private	Method	Build query parts for the query	20131112
3	BUILD_QUERY_PART	Static method	Private	Method	Build query part	20091230
4	CLASS_CONSTRUCTOR	Static method	Public	Constructor	CLASS_CONSTRUCTOR	20091230
5	CONVERT_FED_2_TREX_QUERY	Instance method	Private	Method	Convert the federation query to a common runtime one	20091230
6	GET_AUTHORIZATION_QUERY	Instance method	Public	Method	Get authorization query	20100908
7	GET_AUTH_QUERY_FOR_REQUEST	Instance method	Public	Method	Get the authorization query for the specified request	20131112
8	GET_BRACKET	Static method	Protected	Method	Get a query line with bracket	20100601
9	GET_LOCAL_TIME_TO_UTC_DIFF	Static method	Private	Method	Get difference from local time to UTC	20101115
10	GET_OPERATOR	Static method	Protected	Method	Get a query line with bracket	20100601
11	GET_QUERY	Instance method	Public	Method	Get the query to be passed to TREX	20091230
12	HANDLE_QUERY_QUERY_PARTS	Instance method	Private	Method	Build query parts for the query	20091230
13	PREPARE_QUERY	Instance method	Private	Method	Prepare the query	20110323
14	PROCESS_AUTH_OBJECT	Instance method	Private	Method	Process an authorization object	20131112
15	PROCESS_EXPRESSION_TOKENS	Instance method	Private	Method	Process expression tokens	20131112
16	PROCESS_FIX_VALUES	Instance method	Private	Method	Process authorization fix values	20131112
17	PROCESS_LOGICAL_EXPRESSION	Instance method	Private	Method	Process the logical expression	20131112
18	REDUCE_LOGICAL_EXPRESSION	Instance method	Private	Method	Reduce logical expression	20131112
19	SET_HINTS	Static method	Private	Method	Add the hints for TREX	20091230
20	SET_SEARCH_DEBUGGER	Instance method	Public	Method	Set object for search debugging	20100607

Events

Class CL_ESH_TREX_QUERY_HANDLER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	LTY_S_AUTH_QUERY_TYPE	Private	See coding			20131112	BEGIN OF lty_s_auth_query_type, auth_check TYPE esh_e_om_auth_check, query_entries TYPE hdbt_query_entries, END OF lty_s_auth_query_type
2	LTY_S_FULL_AUTH_TYPE	Private	See coding			20131112	BEGIN OF lty_s_full_auth_type, objct TYPE xuobject, auth TYPE xuauth, field TYPE xufield, full_auth TYPE abap_bool, END OF lty_s_full_auth_type
3	LTY_T_AUTH_QUERY_TYPE	Private	See coding			20131112	LTY_T_AUTH_QUERY_TYPE TYPE SORTED TABLE OF lty_s_auth_query_type WITH UNIQUE KEY auth_check
4	LTY_T_FULL_AUTH_TYPE	Private	See coding			20131112	LTY_T_FULL_AUTH_TYPE TYPE SORTED TABLE OF lty_s_full_auth_type WITH UNIQUE KEY objct auth field

Method Signatures

Method BUILD_AUTHORIZATION_QUERY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_QUERY_ENTRIES	Call by reference	☐	Type reference (TYPE)	HDBT_QUERY_ENTRIES		Search query	20131112
2	Importing	IT_QUERY_ENTRIES	Call by reference	☐	Type reference (TYPE)	LTY_T_AUTH_QUERY_TYPE		Query entries per attribute	20131112
3	Importing	IV_LOGICAL_EXPRESSION	Call by reference	☐	Type reference (TYPE)	STRING		Logical expression	20131112

Method BUILD_AUTHORIZATION_QUERY on class CL_ESH_TREX_QUERY_HANDLER has no exception.

Method BUILD_AUTHORIZATION_QUERY_QP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_HINTS	Call by reference	☐	Type reference (TYPE)	TREXT_HINTS		Hints for the optimizer	20131112
2	Changing	CT_QUERY_ENTRIES	Call by reference	☐	Type reference (TYPE)	HDBT_QUERY_ENTRIES		Search query	20131112
3	Importing	IT_QUERY_ENTRIES	Call by reference	☐	Type reference (TYPE)	LTY_T_AUTH_QUERY_TYPE		Query entries per attribute	20131112
4	Importing	IV_LOGICAL_EXPRESSION	Call by reference	☐	Type reference (TYPE)	STRING		Logical expression	20131112

Method BUILD_AUTHORIZATION_QUERY_QP on class CL_ESH_TREX_QUERY_HANDLER has no exception.

Method BUILD_QUERY_PART Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_EXTENDED_QUERY	Call by reference	☐	Type reference (TYPE)	HDBT_QUERY_ENTRIES		HANA: Search query	20091230
2	Exporting	ET_HINTS	Call by reference	☐	Type reference (TYPE)	TREXT_HINTS			20091230
3	Exporting	EV_QUERY_PART	Call by reference	☐	Type reference (TYPE)	INT2			20091230
4	Exporting	EV_QUERY_PART_STRING	Call by reference	☐	Type reference (TYPE)	STRING			20091230
5	Importing	IT_QUERY	Call by reference	☐	Type reference (TYPE)	HDBT_QUERY_ENTRIES		HANA: Search query	20091230
6	Importing	IT_TOKENS	Call by reference	☐	Type reference (TYPE)	LTY_T_TOKEN_TYPE			20091230
7	Importing	IV_AND_AS_QUERY_PART	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20091230
8	Importing	IV_EXPRESSION_COUNTER	Call by reference	☑	Type reference (TYPE)	NUMC4			20091230
9	Importing	IV_NODE_HASH	Call by reference	☐	Type reference (TYPE)	CHAR24			20091230
10	Importing	IV_QUERY_PART	Call by reference	☐	Type reference (TYPE)	INT2	1000		20091230
11	Importing	IV_USER_NAME	Call by reference	☐	Type reference (TYPE)	SYUNAME	SYST-UNAME		20091230

#	Exception	Resumable	Description	Created on
1	CX_ESH_TREX_SEARCH_DYNAMIC	☐		20091230
2	CX_ESH_TREX_SEARCH_STATIC	☐		20091230

Method CLASS_CONSTRUCTOR Signature

Method CLASS_CONSTRUCTOR on class CL_ESH_TREX_QUERY_HANDLER has no parameter.
Method CLASS_CONSTRUCTOR on class CL_ESH_TREX_QUERY_HANDLER has no exception.

Method CONVERT_FED_2_TREX_QUERY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_QUERY	Call by reference	☐	Type reference (TYPE)	HDBT_QUERY_ENTRIES		HANA: Search query	20131205
2	Importing	IT_FEDERATION_QUERY	Call by reference	☐	Type reference (TYPE)	ESH_T_FED_QUERY_ENTRY		Query	20091230

Method CONVERT_FED_2_TREX_QUERY on class CL_ESH_TREX_QUERY_HANDLER has no exception.

Method GET_AUTHORIZATION_QUERY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_CONSTRAINTS	Call by reference	☐	Type reference (TYPE)	TREXT_PLACEHOLDERS			20100908
2	Exporting	ET_HINTS	Call by reference	☐	Type reference (TYPE)	TREXT_HINTS			20100908
3	Exporting	ET_INCLUDE_QUERY	Call by reference	☐	Type reference (TYPE)	HDBT_QUERY_ENTRIES		HANA: Search query	20100908
4	Importing	IS_CONNECTOR_X	Call by reference	☑	Type reference (TYPE)	IF_ESH_SE_RUNTIME_DATA=>S_SEARCH_EXEC_SORTED			20100908
5	Importing	IT_QUERY	Call by reference	☑	Type reference (TYPE)	HDBT_QUERY_ENTRIES		HANA: Search query	20100908
6	Importing	IV_BUILD_BUFFER	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20100908
7	Importing	IV_CONNECTOR_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_SEARCH_CONNECTOR_ID			20100908
8	Importing	IV_REQUEST_TYPE_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_REQUEST			20100908

Method GET_AUTHORIZATION_QUERY on class CL_ESH_TREX_QUERY_HANDLER has no exception.

Method GET_AUTH_QUERY_FOR_REQUEST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_HINTS	Call by reference	☐	Type reference (TYPE)	TREXT_HINTS		Hints for the optimizer	20131112
2	Changing	CT_QUERY_ENTRIES	Call by reference	☐	Type reference (TYPE)	HDBT_QUERY_ENTRIES		Search query	20131112
3	Exporting	EV_FULL_AUTH	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		User has full authorization	20131112
4	Exporting	EV_NO_AUTH	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		User is not authorized	20131112
5	Importing	IS_REQUEST_TYPE	Call by reference	☐	Type reference (TYPE)	IF_ESH_SE_RUNTIME_DATA=>S_SEARCH_EXEC_REQU_TYPE		Request data	20131128
6	Importing	IV_NODE_NAME	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_NODE_NAME		Node Name	20131112
7	Importing	IV_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_OBJECT_TYPE		Object Type	20131112
8	Importing	IV_REQUEST	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_REQUEST		Request	20131112

Method GET_AUTH_QUERY_FOR_REQUEST on class CL_ESH_TREX_QUERY_HANDLER has no exception.

Method GET_BRACKET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ES_SEARCH	Value transfer	☐	Type reference (TYPE)	HDBS_QUERY_ENTRY		Query Entry	20100601
2	Importing	IV_ROWTYPE	Call by reference	☐	Type reference (TYPE)	TREXD_ROWTYPE		Rowtype (TERM, OPERATOR, ATTRIBUTE,FREESTYLE,...)	20100601

Method GET_BRACKET on class CL_ESH_TREX_QUERY_HANDLER has no exception.

Method GET_LOCAL_TIME_TO_UTC_DIFF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_UTCDIFF	Call by reference	☐	Type reference (TYPE)	TZNUTCDIFF		Difference of time zone from UTC (w/o Summer time)	20101115
2	Exporting	EV_UTCSIGN	Call by reference	☐	Type reference (TYPE)	TZNUTCSIGN		Sign of the Difference from UTC (+ or -)	20101115

Method GET_LOCAL_TIME_TO_UTC_DIFF on class CL_ESH_TREX_QUERY_HANDLER has no exception.

Method GET_OPERATOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ES_SEARCH	Value transfer	☐	Type reference (TYPE)	HDBS_QUERY_ENTRY		Query Entry	20100601
2	Importing	IV_OPERATOR	Call by reference	☐	Type reference (TYPE)	STRING		Operator (AND, OR)	20100601

Method GET_OPERATOR on class CL_ESH_TREX_QUERY_HANDLER has no exception.

Method GET_QUERY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_TREX_AUTH_QUERY	Call by reference	☐	Type reference (TYPE)	HDBT_QUERY_ENTRIES		HANA: Search query	20091230
2	Changing	CT_TREX_CONSTRAINTS	Call by reference	☐	Type reference (TYPE)	TREXT_PLACEHOLDERS			20091230
3	Changing	CT_TREX_HINTS	Call by reference	☐	Type reference (TYPE)	TREXT_HINTS			20091230
4	Exporting	EV_NO_AUTHORITY	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Not authorized	20131115
5	Importing	IR_PROXY	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_TREX_PROXY_RUNTIME		Search Proxy	20130823
6	Importing	IS_CONNECTOR_EXECUTION	Call by reference	☐	Type reference (TYPE)	IF_ESH_SE_RUNTIME_DATA=>S_SEARCH_EXEC_SORTED			20091230
7	Importing	IT_FEDERATION_QUERY	Call by reference	☐	Type reference (TYPE)	ESH_T_FED_QUERY_ENTRY		Query	20091230
8	Importing	IV_CONNECTOR_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_SEARCH_CONNECTOR_ID		Search Connector ID	20091230
9	Importing	IV_NO_AUTH_QUERY	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20101006
10	Importing	IV_REQUEST_TYPE_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_REQUEST		Request Type ID	20091230

Method GET_QUERY on class CL_ESH_TREX_QUERY_HANDLER has no exception.

Method HANDLE_QUERY_QUERY_PARTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_HINTS	Call by reference	☐	Type reference (TYPE)	TREXT_HINTS			20091230
2	Changing	CT_INCLUDE_QUERY	Call by reference	☐	Type reference (TYPE)	HDBT_QUERY_ENTRIES		HANA: Search query	20091230
3	Importing	IT_QUERY	Call by reference	☐	Type reference (TYPE)	HDBT_QUERY_ENTRIES		HANA: Search query	20091230

Method HANDLE_QUERY_QUERY_PARTS on class CL_ESH_TREX_QUERY_HANDLER has no exception.

Method PREPARE_QUERY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_TREX_QUERY	Call by reference	☐	Type reference (TYPE)	HDBT_QUERY_ENTRIES		Search Query	20110323
2	Importing	IR_PROXY	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_TREX_PROXY_RUNTIME		Search Proxy	20130823

Method PREPARE_QUERY on class CL_ESH_TREX_QUERY_HANDLER has no exception.

Method PROCESS_AUTH_OBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_QUERY_ENTRIES	Call by reference	☐	Type reference (TYPE)	HDBT_QUERY_ENTRIES		Search query	20131112
2	Exporting	EV_FULLY_AUTHORIZED	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Fully authorized	20131112
3	Exporting	EV_NOT_AUTHORIZED	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Not authorized	20131112
4	Importing	IT_AUTH_DATA	Call by reference	☐	Type reference (TYPE)	IF_ESH_SE_RUNTIME_DATA=>T_EXEC_REQU_TYPE_AUTHOBJS		Data for Authorization Object	20131112
5	Importing	IV_AUTH_OBJECT	Call by reference	☐	Type reference (TYPE)	XUOBJECT		Authorization Object	20131112
6	Importing	IV_UNAME	Call by reference	☐	Type reference (TYPE)	XUBNAME	SYST-UNAME	User Name in User Master Record	20131112

Method PROCESS_AUTH_OBJECT on class CL_ESH_TREX_QUERY_HANDLER has no exception.

Method PROCESS_EXPRESSION_TOKENS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CV_LOGICAL_EXPRESSION	Call by reference	☐	Type reference (TYPE)	STRING		Logical expression	20131112
2	Importing	IT_TOKENS	Call by reference	☐	Type reference (TYPE)	LTY_T_TOKEN_TYPE		Expression tokens	20131112
3	Importing	IV_AUTH_CHECK	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_AUTH_CHECK		Authorization Check	20131112
4	Importing	IV_VALUE	Call by reference	☐	Type reference (TYPE)	CHAR5		Value for authorization check	20131112

Method PROCESS_EXPRESSION_TOKENS on class CL_ESH_TREX_QUERY_HANDLER has no exception.

Method PROCESS_FIX_VALUES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_NOT_AUTHORIZED	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Not authorized	20131112
2	Importing	IT_AUTH_VALUES	Call by reference	☐	Type reference (TYPE)	SUSR_T_USVALUES		Transfer Table for Authorization Values for Object	20131112
3	Importing	IT_FIX_VALUES	Call by reference	☐	Type reference (TYPE)	ESH_T_SE_FIX_VALUE		Table Type for Fix Values	20131112

Method PROCESS_FIX_VALUES on class CL_ESH_TREX_QUERY_HANDLER has no exception.

Method PROCESS_LOGICAL_EXPRESSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CV_LOGICAL_EXPRESSION	Call by reference	☐	Type reference (TYPE)	STRING		Logical expression	20131112
2	Exporting	EV_FULLY_AUTHORIZED	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Fully authorized	20131112
3	Exporting	EV_NOT_AUTHORIZED	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Not authorized	20131112
4	Importing	IV_AUTH_CHECK	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_AUTH_CHECK		Authorization Check	20131112
5	Importing	IV_VALUE	Call by reference	☐	Type reference (TYPE)	CHAR5		Value for authorization check	20131112

Method PROCESS_LOGICAL_EXPRESSION on class CL_ESH_TREX_QUERY_HANDLER has no exception.

Method REDUCE_LOGICAL_EXPRESSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CV_LOGICAL_EXPRESSION	Call by reference	☐	Type reference (TYPE)	STRING		Logical expression	20131112
2	Importing	IV_AUTH_CHECK	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_AUTH_CHECK		Authorization Check	20131112
3	Importing	IV_VALUE	Call by reference	☐	Type reference (TYPE)	CHAR5		Value for authorization check	20131112

Method REDUCE_LOGICAL_EXPRESSION on class CL_ESH_TREX_QUERY_HANDLER has no exception.

Method SET_HINTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_HINTS	Call by reference	☐	Type reference (TYPE)	TREXT_HINTS		Hints for the optimizer	20091230

Method SET_HINTS on class CL_ESH_TREX_QUERY_HANDLER has no exception.

Method SET_SEARCH_DEBUGGER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_SEARCH_DEBUGGER	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_SE_SEARCH_DEBUGGING		Search Debugger	20100607

Method SET_SEARCH_DEBUGGER on class CL_ESH_TREX_QUERY_HANDLER has no exception.

History

Last changed by/on	SAP	20141121
SAP Release Created in	730