SAP ABAP Class CL_ESH_FED_QUERY_TRANSFORMATOR (Query Transformator)

Hierarchy

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

Properties

Class	CL_ESH_FED_QUERY_TRANSFORMATOR
Short Description	Query Transformator
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	S_ESH_ENG_FEDERATION	Federation
Created	20090810	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_FED_QUERY_TRANSFORMATOR has no interface implemented.

Friends

Class CL_ESH_FED_QUERY_TRANSFORMATOR has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MR_QUERY_PARSER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_ESH_QP_CH_PARSER		SearchTerms query parser	20090810
2	MR_REQUEST_DATA	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_ESH_FED_REQUEST_DATA		Search request data	20090810
3	MT_FQUERY_INTERNAL_QUERY	Instance attribute	Private	☐	Type reference (TYPE)	ESH_T_FED_QUERY_ENTRY		Query	20090810
4	MT_FQUERY_SEARCH_STRING	Instance attribute	Private	☐	Type reference (TYPE)	ESH_T_FED_QUERY_ENTRY		Query	20090810
5	MT_QUERY_ATTRIBUTE_CONDITIONS	Instance attribute	Private	☐	Type reference (TYPE)	ESH_T_FED_QUERY_ENTRY		Query	20090810
6	MT_QUERY_INTERNAL_QUERY	Instance attribute	Private	☐	Type reference (TYPE)	ESH_T_FED_QUERY_ENTRY		Query	20090810
7	MT_QUERY_QUERY_PARTS	Instance attribute	Private	☐	Type reference (TYPE)	ESH_T_FED_QUERY_ENTRY		Query	20090810
8	MT_QUERY_SEARCH_STRING	Instance attribute	Private	☐	Type reference (TYPE)	ESH_T_FED_QUERY_ENTRY		Query	20090810
9	MT_VALUE_HELP_CONDITIONS	Instance attribute	Private	☐	Type reference (TYPE)	ESH_T_FED_QUERY_ENTRY		Query	20100802
10	MV_DO_QUERY_PARSING	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL		Do query parsing	20100823
11	MV_PARSE_SCOPE	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL		Parse and adapt the scope from the search string	20110614
12	MX_EXCEPTION	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CX_ESH_IF_ENGINE		ESH interface exception	20090810

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20090810
2	CONVERT_ATTRIBUTE_CONDITIONS	Instance method	Private	Method	Process input: Attribute conditions	20090814
3	CONVERT_COMPLEX_ATTR_CONDITION	Instance method	Protected	Method	Convert complex attribute condition	20090810
4	CONVERT_SEARCH_TEXT	Instance method	Protected	Method	Get a query entry for text search	20100407
5	FINALIZE_INTERNAL_QUERY	Instance method	Private	Method	Process output: Internal query	20090810
6	GET_IQ_COMPLEX_ATTR_CONDITION	Instance method	Protected	Method	Get a complex attribute condition in internal format	20090810
7	GET_IQ_LEFT_BRACKET	Instance method	Protected	Method	Get a query line with bracket	20090810
8	GET_IQ_OPERATOR	Instance method	Protected	Method	Get a query line with bracket	20090810
9	GET_IQ_PARSED_ATTR_CONDITION	Instance method	Protected	Method	Deprecated	20090810
10	GET_IQ_PARSED_SEARCH_TEXT	Instance method	Protected	Method	Get a query entry for text search	20090810
11	GET_IQ_RIGHT_BRACKET	Instance method	Protected	Method	Get a query line with bracket	20090810
12	GET_IQ_SEARCH_TEXT_ENTRY	Instance method	Protected	Method	Get a query entry for text search	20090810
13	GET_IQ_SIMPLE_ATTR_CONDITION	Instance method	Protected	Method	Get simple attribute condition in internal format	20090810
14	GET_QUERY_PARSER	Instance method	Public	Method	Get query parser	20100906
15	PROCESS_ATTRIBUTE_CONDITIONS	Instance method	Private	Method	Process input: Attribute conditions	20090810
16	PROCESS_INTERNAL_QUERY	Instance method	Private	Method	Process input: Internal query	20090810
17	PROCESS_QUERY_PARTS	Instance method	Private	Method	Process input: Query parts	20090810
18	PROCESS_SEARCH_STRING	Instance method	Private	Method	Process input: Search string	20090810
19	SET_FUZZY_IN_QUERY	Instance method	Private	Method	Set fuzzy in internal query	20100802
20	SET_PART_IN_QUERY	Instance method	Private	Method	Set query part in internal query	20090903
21	SET_RANK_WEIGHT_IN_QUERY	Instance method	Private	Method	Set rank weight in internal query	20090817
22	TRANSFORM_QUERY_TO_INTERNAL	Instance method	Public	Method	Transform to internal query	20090810

Events

Class CL_ESH_FED_QUERY_TRANSFORMATOR has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	S_PROCESS_LIST	Private	See coding			20100217	BEGIN OF s_process_list, id TYPE int4, obj TYPE REF TO cl_esh_if_query_part, END OF s_process_list
2	S_VISITED_PART	Private	See coding			20100217	BEGIN OF s_visited_part, id TYPE int4, query TYPE esh_t_fed_query_entry, done TYPE abap_bool, END OF s_visited_part
3	T_PROCESS_LIST	Private	See coding			20100217	t_process_list TYPE TABLE OF s_process_list
4	T_VISITED_PART	Private	See coding			20100217	t_visited_part TYPE SORTED TABLE OF s_visited_part WITH UNIQUE KEY id

Method Signatures

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_PARSE_SCOPE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Parse scope from search string	20110614
2	Importing	IV_WITH_QUERY_PARSING	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Do Query Parsing	20100823

Method CONSTRUCTOR on class CL_ESH_FED_QUERY_TRANSFORMATOR has no exception.

Method CONVERT_ATTRIBUTE_CONDITIONS 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)	ESH_T_FED_QUERY_ENTRY		Query	20090814
2	Importing	IT_ATTRIBUTE_CONDITIONS	Call by reference	☐	Type reference (TYPE)	ESH_T_FED_ATTR_CONDITION		Attribute conditions for search	20090814

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

Method CONVERT_COMPLEX_ATTR_CONDITION 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)	ESH_T_FED_QUERY_ENTRY		Query	20090810
2	Importing	IS_ATTR_CONDITION	Call by reference	☐	Type reference (TYPE)	ESH_S_FED_ATTR_CONDITION		Attribute condition for search	20090810

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

Method CONVERT_SEARCH_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_QUERY_ENTRY	Call by reference	☐	Type reference (TYPE)	ESH_T_FED_QUERY_ENTRY		Query Entries	20100407
2	Exporting	ET_QUERY_ENTRY_FREESTYLE	Call by reference	☐	Type reference (TYPE)	ESH_T_FED_QUERY_ENTRY		Query Entries	20100407
3	Importing	IV_SEARCH_STRING	Call by reference	☐	Type reference (TYPE)	STRING		Search string	20100407

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

Method FINALIZE_INTERNAL_QUERY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_COLLECTION_FOUND	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20100122
2	Importing	IV_NUMBER_OF_COND_PARTS	Call by reference	☐	Type reference (TYPE)	INT4		Natural number	20100831

Method FINALIZE_INTERNAL_QUERY on class CL_ESH_FED_QUERY_TRANSFORMATOR has no exception.

Method GET_IQ_COMPLEX_ATTR_CONDITION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ET_QUERY_ENTRY	Value transfer	☐	Type reference (TYPE)	ESH_T_FED_QUERY_ENTRY		Query Entries	20090810
2	Importing	IS_SELECT_OPTION	Call by reference	☐	Type reference (TYPE)	ESH_S_IF_SELECT_OPTIONS		Structure for select options	20090810
3	Importing	IV_ATTRIBUTE_NAME	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_ATTRIBUTE_NAME		Attribute Name	20090810
4	Importing	IV_CONTENT_TYPE	Call by reference	☑	Type reference (TYPE)	ESH_E_IF_CONTENT_TYPE		Content Type	20110420
5	Importing	IV_FUZZY_SIMILARITY	Call by reference	☑	Type reference (TYPE)	ESH_E_FED_FUZZY_SIMILARITY		Fuzzy Similarity 0..10000	20131205
6	Importing	IV_SEARCH_MODE	Call by reference	☑	Type reference (TYPE)	ESH_E_IF_SEARCH_MODE		Search Mode	20110420
7	Importing	IV_SEARCH_OPTIONS	Call by reference	☑	Type reference (TYPE)	ESH_E_FED_SEARCH_OPTIONS		Search Options	20131205

Method GET_IQ_COMPLEX_ATTR_CONDITION on class CL_ESH_FED_QUERY_TRANSFORMATOR has no exception.

Method GET_IQ_LEFT_BRACKET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ES_QUERY_ENTRY	Value transfer	☐	Type reference (TYPE)	ESH_S_FED_QUERY_ENTRY		Query Entry	20090810
2	Importing	IV_QUERY_PART	Call by reference	☑	Type reference (TYPE)	INT4		Natural number	20100113

Method GET_IQ_LEFT_BRACKET on class CL_ESH_FED_QUERY_TRANSFORMATOR has no exception.

Method GET_IQ_OPERATOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ES_QUERY_ENTRY	Value transfer	☐	Type reference (TYPE)	ESH_S_FED_QUERY_ENTRY		Query Entry	20090810
2	Importing	IV_OPERATOR	Call by reference	☐	Type reference (TYPE)	STRING		Operator (AND, OR)	20090810
3	Importing	IV_QUERY_PART	Call by reference	☑	Type reference (TYPE)	INT4		Natural number	20100113

Method GET_IQ_OPERATOR on class CL_ESH_FED_QUERY_TRANSFORMATOR has no exception.

Method GET_IQ_PARSED_ATTR_CONDITION 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)	ESH_T_FED_QUERY_ENTRY		Query	20090810
2	Importing	IS_QUERY_ENTRY	Call by reference	☐	Type reference (TYPE)	ESH_S_FED_QUERY_ENTRY		Query Entry	20090810

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

Method GET_IQ_PARSED_SEARCH_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_QUERY_ENTRY	Call by reference	☐	Type reference (TYPE)	ESH_T_FED_QUERY_ENTRY		Query Entries	20090810
2	Exporting	ET_QUERY_ENTRY_FREESTYLE	Call by reference	☐	Type reference (TYPE)	ESH_T_FED_QUERY_ENTRY		Query Entries	20090810
3	Importing	IV_SEARCH_STRING	Call by reference	☐	Type reference (TYPE)	STRING		Search string	20090810

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

Method GET_IQ_RIGHT_BRACKET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ES_QUERY_ENTRY	Value transfer	☐	Type reference (TYPE)	ESH_S_FED_QUERY_ENTRY		Query Entry	20090810
2	Importing	IV_QUERY_PART	Call by reference	☑	Type reference (TYPE)	INT4		Natural number	20100113

Method GET_IQ_RIGHT_BRACKET on class CL_ESH_FED_QUERY_TRANSFORMATOR has no exception.

Method GET_IQ_SEARCH_TEXT_ENTRY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ES_QUERY_ENTRY	Value transfer	☐	Type reference (TYPE)	ESH_S_FED_QUERY_ENTRY		Query Entry	20090810
2	Importing	IV_FOR_FREESTYLE	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL			20090810
3	Importing	IV_SEARCH_MODE	Call by reference	☑	Type reference (TYPE)	TREXD_TERM_ACTION		Term action (Exact, fuzzy, linquistic search)	20090810
4	Importing	IV_SEARCH_STRING	Call by reference	☐	Type reference (TYPE)	STRING		Search string	20090810

Method GET_IQ_SEARCH_TEXT_ENTRY on class CL_ESH_FED_QUERY_TRANSFORMATOR has no exception.

Method GET_IQ_SIMPLE_ATTR_CONDITION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ES_QUERY_ENTRY	Value transfer	☐	Type reference (TYPE)	ESH_S_FED_QUERY_ENTRY		Query Entry	20090810
2	Importing	IV_ATTRIBUTE_NAME	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_ATTRIBUTE_NAME			20090810
3	Importing	IV_CONTENT_TYPE	Call by reference	☑	Type reference (TYPE)	ESH_E_IF_CONTENT_TYPE		Content Type	20110420
4	Importing	IV_FUZZY_SIMILARITY	Call by reference	☑	Type reference (TYPE)	ESH_E_FED_FUZZY_SIMILARITY		Fuzzy Similarity 0..10000	20131205
5	Importing	IV_SEARCH_MODE	Call by reference	☑	Type reference (TYPE)	ESH_E_IF_SEARCH_MODE		Search Mode	20110420
6	Importing	IV_SEARCH_OPTIONS	Call by reference	☑	Type reference (TYPE)	ESH_E_FED_SEARCH_OPTIONS		Search Options	20131205
7	Importing	IV_VALUE	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_ATTRIBUTE_VALUE		Attribute Value	20090810

Method GET_IQ_SIMPLE_ATTR_CONDITION on class CL_ESH_FED_QUERY_TRANSFORMATOR has no exception.

Method GET_QUERY_PARSER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_QUERY_PARSER	Value transfer	☐	Object reference (TYPE REF TO)	CL_ESH_QP_CH_PARSER		SearchTerms Query Parser	20100906

Method GET_QUERY_PARSER on class CL_ESH_FED_QUERY_TRANSFORMATOR has no exception.

Method PROCESS_ATTRIBUTE_CONDITIONS Signature

Method PROCESS_ATTRIBUTE_CONDITIONS on class CL_ESH_FED_QUERY_TRANSFORMATOR has no parameter.

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

Method PROCESS_INTERNAL_QUERY Signature

Method PROCESS_INTERNAL_QUERY on class CL_ESH_FED_QUERY_TRANSFORMATOR has no parameter.
Method PROCESS_INTERNAL_QUERY on class CL_ESH_FED_QUERY_TRANSFORMATOR has no exception.

Method PROCESS_QUERY_PARTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_COLLECTIONS_FOUND	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20100122
2	Exporting	EV_NUMBER_OF_COND_PARTS	Call by reference	☐	Type reference (TYPE)	INT4		Natural number	20100831

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

Method PROCESS_SEARCH_STRING Signature

Method PROCESS_SEARCH_STRING on class CL_ESH_FED_QUERY_TRANSFORMATOR has no parameter.

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

Method SET_FUZZY_IN_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)	ESH_T_FED_QUERY_ENTRY		Query	20100802

Method SET_FUZZY_IN_QUERY on class CL_ESH_FED_QUERY_TRANSFORMATOR has no exception.

Method SET_PART_IN_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)	ESH_T_FED_QUERY_ENTRY		Query	20090903
2	Importing	IV_PART_NO	Call by reference	☐	Type reference (TYPE)	INT2		Part number	20090903

Method SET_PART_IN_QUERY on class CL_ESH_FED_QUERY_TRANSFORMATOR has no exception.

Method SET_RANK_WEIGHT_IN_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)	ESH_T_FED_QUERY_ENTRY		Query	20090817
2	Importing	IV_RANK_WEIGHT	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_RANK_WEIGHT		Weight for ranking (1..10)	20090817

Method SET_RANK_WEIGHT_IN_QUERY on class CL_ESH_FED_QUERY_TRANSFORMATOR has no exception.

Method TRANSFORM_QUERY_TO_INTERNAL Signature

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

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

History

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