SAP ABAP Class CL_ESH_TREX_SEARCH (Execute an ESH Search on TREX)

Hierarchy

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

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_ESH_FED_ADAPTER_FEATURES	Federation Search - Adapter Features	20091217
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_ESH_FED_FEDERATION_SEARCH	Federation Search Interface	20091217

Properties

Class	CL_ESH_TREX_SEARCH
Short Description	Execute an ESH Search on TREX
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	20091110	SAP
Last change	20141121
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_ESH_TREX_SEARCH has no forward declaration.

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_ESH_FED_ADAPTER_FEATURES	☐	☐	Federation Search - Adapter Features	20091217
2	IF_ESH_FED_FEDERATION_SEARCH	☐	☐	Federation Search Interface	20091217

Friends

#	Friend	Modeled only	Created on	Description
1	CL_ESH_TREX_SEARCH_UTILS	☐	20100630	Tools, Utilities, and Helper for ESH Searches

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MR_QUERY_HANDLER	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_ESH_TREX_QUERY_HANDLER		Generate the TREX query	20091230
2	MR_SEARCH_UTILS	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_ESH_TREX_SEARCH_UTILS			20100629

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_TREX_RESPONSES	Instance method	Private	Method	Set TREX responses	20130819
2	BUILD_QUERY_TO_CALL_DUPL_PROC	Instance method	Private	Method	Build query to call the hana proc. EXECUTE_SEARCH_RULE_SET	20130227
3	CLASS_CONSTRUCTOR	Static method	Public	Constructor	Class Constructor	20100726
4	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20091110
5	DYNAMIC_WAIT	Instance method	Private	Method	Dynamic Wait	20130819
6	GET_TREX_RESPONSES	Instance method	Private	Method	Get TREX responses	20130819
7	RECREATE_JOIN	Instance method	Private	Method	Recreate join	20100825
8	REQUEST_GET_EXT_SYSTEM_ID	Instance method	Private	Method	Search Request: Get Extermal System ID	20130823
9	SEARCH	Instance method	Private	Method	Search	20100630
10	SEARCH_710_MULTIPLE	Instance method	Private	Method	Search Multiple (TREX 7.10)	20100805
11	SEARCH_710_SINGLE	Instance method	Private	Method	Search Single (TREX 7.10)	20100805
12	SEARCH_710_SINGLE_RANKING	Instance method	Private	Method	Search Multiple (TREX 7.10) with Ranking	20100806
13	SEARCH_DUPLICATES	Instance method	Private	Method	Search for duplicates (HANA)	20130225
14	SEARCH_MODUS_710	Instance method	Private	Method	Search (TREX 7.10)	20100726
15	SEARCH_MODUS_720	Instance method	Private	Method	Search (HANA/TREX 7.20)	20100805

Events

Class CL_ESH_TREX_SEARCH has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	MTY_S_TREX_INPUT_MAP	Private	See coding			20130819	BEGIN OF mty_s_trex_input_map, request_response_index TYPE i, request_domain_index TYPE i, trex_search_input_idx TYPE i, exception TYPE REF TO cx_esh_if_engine, END OF mty_s_trex_input_map
2	MTY_T_TREX_INPUT_MAP	Private	See coding			20130819	mty_t_trex_input_map TYPE SORTED TABLE OF mty_s_trex_input_map WITH UNIQUE KEY request_response_index request_domain_index

Method Signatures

Method ADD_TREX_RESPONSES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_TREX_RESPONSES	Call by reference	☐	Type reference (TYPE)	ESH_T_TREX_RESPONSES		Table for ESH_S_TREX_RESPONSE	20130819
2	Importing	IT_TREX_REQUESTS	Call by reference	☐	Type reference (TYPE)	ESH_T_TREX_REQUESTS		table for esH_S_TREX_request	20130819
3	Importing	IT_TREX_SCOPE	Call by reference	☐	Type reference (TYPE)	ESH_T_SE_TREX_SEARCH_SCOPE		Search Scope (as passed to TREX Interface)	20130819

Method ADD_TREX_RESPONSES on class CL_ESH_TREX_SEARCH has no exception.

Method BUILD_QUERY_TO_CALL_DUPL_PROC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_QUERY	Call by reference	☐	Type reference (TYPE)	ESH_T_FED_QUERY_ENTRY		Query	20130227
2	Importing	IT_RESPONSE_ATTR	Call by reference	☐	Type reference (TYPE)	IF_ESH_SE_RUNTIME_DATA=>S_SEARCH_EXEC_SORTED-RESPONSE_ATTRIBUTE_TYPES		response fields	20130227
3	Importing	IV_RULESET_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_RULESET_ID		Ruleset ID for duplicate search	20130227
4	Importing	IV_VIEW	Call by reference	☐	Type reference (TYPE)	TREXD_INDEX_ID		column view in hana for request	20130227
5	Returning	RT_RESULTS_KEYS	Value transfer	☐	Type reference (TYPE)	IF_ESH_SE_RUNTIME_DATA=>S_SEARCH_EXEC_SORTED-RESPONSE_ATTRIBUTE_TYPES		keys of results	20130227

Method BUILD_QUERY_TO_CALL_DUPL_PROC on class CL_ESH_TREX_SEARCH has no exception.

Method CLASS_CONSTRUCTOR Signature

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

Method CONSTRUCTOR Signature

Method CONSTRUCTOR on class CL_ESH_TREX_SEARCH has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_ENGINE	☐		20100726

Method DYNAMIC_WAIT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_WHILE_COUNT	Call by reference	☐	Type reference (TYPE)	INT4		While count	20130819

Method DYNAMIC_WAIT on class CL_ESH_TREX_SEARCH has no exception.

Method GET_TREX_RESPONSES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_HANDLES	Call by reference	☐	Type reference (TYPE)	TREXT_HANDLES		TREX Handles	20130819
2	Changing	CT_TREX_SCOPE	Call by reference	☐	Type reference (TYPE)	ESH_T_SE_TREX_SEARCH_SCOPE		Search Scope (as passed to TREX Interface)	20130819
3	Importing	IR_PROXY	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_TREX_PROXY_RUNTIME		Runtime Proxy for NW ES - TREX	20131015
4	Importing	IT_TREX_REQUESTS	Call by reference	☐	Type reference (TYPE)	ESH_T_TREX_REQUESTS		table for esH_S_TREX_request	20130819
5	Importing	IV_CALCULATE_ALL_HITS	Call by reference	☑	Type reference (TYPE)	XFELD		Calculate number of all hits	20130819
6	Importing	IV_RANKING_WEIGHT	Call by reference	☑	Type reference (TYPE)	ESH_E_OM_RANKING_WEIGHT		Ranking Weight	20130819

#	Exception	Resumable	Description	Created on
1	CX_ESH_TREX_PROXY	☐	General ESH TREX Exception	20130819

Method RECREATE_JOIN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_ESH_REQUEST_N_RESPONSE	Call by reference	☐	Type reference (TYPE)	ESH_T_FED_BULK_CONTAINER		Request/Responses Container	20100825
2	Importing	IR_RUNTIME_PROXY	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_TREX_PROXY_RUNTIME		Proxy (Runtime)	20130823
3	Importing	IV_VIA_EXCEPTION	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Exception has occurred	20100825

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_ENGINE	☐		20100825

Method REQUEST_GET_EXT_SYSTEM_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_REQUEST_CONTAINER	Call by reference	☐	Type reference (TYPE)	ESH_T_FED_BULK_CONTAINER		Request Data Containers for Bulk Search	20130823
2	Returning	RV_EXT_SYS_ID	Value transfer	☐	Type reference (TYPE)	ESH_E_ADM_EXTERNAL_SYSTEM_ID		External System ID	20130823

#	Exception	Resumable	Description	Created on
1	CX_ESH_TREX_SEARCH_STATIC	☐	Search Runtime Exception	20130823

Method SEARCH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_ESH_REQUEST_N_RESPONSE	Call by reference	☐	Type reference (TYPE)	ESH_T_FED_BULK_CONTAINER		ESH representation of request and response data	20100701

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_ENGINE	☐	ESH Interface Exception	20100630

Method SEARCH_710_MULTIPLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_TREX_REQUESTS	Call by reference	☐	Type reference (TYPE)	ESH_T_TREX_REQUESTS		Requests	20100805
2	Changing	CT_TREX_RESPONSES	Call by reference	☐	Type reference (TYPE)	ESH_T_TREX_RESPONSES		Responses	20100805
3	Importing	IR_PROXY	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_TREX_PROXY_RUNTIME		Search Proxy	20130823

#	Exception	Resumable	Description	Created on
1	CX_ESH_TREX_PROXY	☐	General ESH TREX Exception	20130819

Method SEARCH_710_SINGLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CS_TREX_REQUEST	Call by reference	☐	Type reference (TYPE)	ESH_S_TREX_REQUEST		Request	20100806
2	Changing	CS_TREX_RESPONSE	Call by reference	☐	Type reference (TYPE)	ESH_S_TREX_RESPONSE		Response	20100806
3	Importing	IR_PROXY	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_TREX_PROXY_RUNTIME		Search Proxy	20130823

#	Exception	Resumable	Description	Created on
1	CX_ESH_TREX_PROXY	☐		20100806

Method SEARCH_710_SINGLE_RANKING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CS_TREX_REQUEST	Call by reference	☐	Type reference (TYPE)	ESH_S_TREX_REQUEST			20100806
2	Changing	CS_TREX_RESPONSE	Call by reference	☐	Type reference (TYPE)	ESH_S_TREX_RESPONSE			20100806
3	Importing	IV_RANKING_VALUE	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_RANKING_WEIGHT			20100824

#	Exception	Resumable	Description	Created on
1	CX_ESH_TREX_PROXY	☐		20100806

Method SEARCH_DUPLICATES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_ESH_REQUEST_N_RESPONSE	Call by reference	☐	Type reference (TYPE)	ESH_T_FED_BULK_CONTAINER		Request Data Containers for Bulk Search	20130225
2	Importing	IR_PROXY	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_TREX_PROXY_RUNTIME		Search Proxy	20130823

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_ENGINE	☐	ESH Interface Exception	20130225

Method SEARCH_MODUS_710 Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_ESH_REQUEST_N_RESPONSE	Call by reference	☐	Type reference (TYPE)	ESH_T_FED_BULK_CONTAINER		Search Request Container	20100726
2	Importing	IR_PROXY	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_TREX_PROXY_RUNTIME		Search Proxy	20130823

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_ENGINE	☐		20100824
2	CX_ESH_TREX_PROXY	☐		20100726

Method SEARCH_MODUS_720 Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_ESH_REQUEST_N_RESPONSE	Call by reference	☐	Type reference (TYPE)	ESH_T_FED_BULK_CONTAINER		Search Request Container	20100805
2	Importing	IR_PROXY	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_TREX_PROXY_RUNTIME		Search Proxy	20130823

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_ENGINE	☐		20100806
2	CX_ESH_TREX_PROXY	☐		20100805
3	CX_ESH_TREX_SEARCH_STATIC	☐		20100805

History

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