SAP ABAP Class CL_ESH_QP_CH_PARSER (SearchTerms Query Parser)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
     ⤷ S_ESH_ENG_QUERY_PARSER (Package) Query Parser

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_ESH_TAU_CHK_TEST	Public Tests of a Class	20100223

Properties

Class	CL_ESH_QP_CH_PARSER
Short Description	SearchTerms Query Parser
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	S_ESH_ENG_QUERY_PARSER	Query Parser
Created	20090917	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)
2	CL_ESH_QP_GRAMMAR_CONTAINER	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_ESH_TAU_CHK_TEST	☐	☐	Public Tests of a Class	20100223

Friends

#	Friend	Modeled only	Created on	Description
1	CL_ESH_QP_TRANSLATOR	☐	20091005	Query Translator

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GV_ERROR_SYMBOL	Constant	Public	☐	Type reference (TYPE)	CHAR32	'ERROR'	Error start symbol	20100712
2	GV_START_SYMBOL	Constant	Public	☐	Type reference (TYPE)	CHAR32	'QUERY'	Grammar start symbol	20090917
3	GV_VALUE_START_SYMBOL	Constant	Public	☐	Type reference (TYPE)	CHAR32	'BEXPRESSION'	Attribute value start symbol	20091104
4	MO_LEXER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_ESH_QP_CH_LEXER		Text tokenizer	20090917
5	MO_REGEX_BOOLEAN	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_ABAP_REGEX		Regex describing SearchTerms syntax	20091104
6	MO_REGEX_OPERATOR	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_ABAP_REGEX		Regex describing search scope	20110809
7	MO_REGEX_SCOPE	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_ABAP_REGEX		Regex describing search scope	20110809
8	MO_REGEX_SEARCHTERMS	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_ABAP_REGEX		SearchTerms expression	20100322
9	MO_TRANSLATOR	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_ESH_QP_TRANSLATOR		Query translator	20090924
10	MT_CHART	Instance attribute	Private	☐	Type reference (TYPE)	ESH_T_QP_CHART		Query recognition table	20090917
11	MT_GRAMMAR	Static Attribute	Private	☐	Type reference (TYPE)	ESH_T_QP_GRAMMAR_PRODUCTION		Query grammar	20090917
12	MT_TOKENS	Instance attribute	Private	☐	Type reference (TYPE)	ESH_T_QP_CH_TOKENS		Tokens	20090917
13	MV_EXTENDED_FLAG	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL		True if extended SearchTerms syntax is used	20091105
14	MV_LENGTH	Instance attribute	Private	☐	Type reference (TYPE)	I		Token count	20090917

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_GRAMMAR	Static method	Public	Method	Check query grammar	20100729
2	CONCATENATE_TERMS	Instance method	Private	Method	Concatenate terms	20101206
3	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20090917
4	CREATE_QUERY_ENTRY	Instance method	Private	Method	Create trivial query entry	20090923
5	GET_LEXEMS	Instance method	Public	Method	Get token sequence under a parse node	20090917
6	PARSE	Instance method	Private	Method	Parse query	20091104
7	PARSE_EXTENDED	Instance method	Private	Method	Parse query	20100823
8	PARSE_QUERY	Instance method	Private	Method	Parse query	20090917
9	PARSE_QUERY_ATTRIBUTE	Instance method	Public	Method	Parse query attribute value	20091104
10	PARSE_QUERY_STRING	Instance method	Public	Method	Parse query string	20090923
11	PARSE_SCOPE	Instance method	Public	Method	Parse search scope	20110809
12	READ_GRAMMAR	Instance method	Private	Method	Read query grammar	20091130
13	SERIALIZE_ATTR_VALUE	Static method	Private	Method	Serialize attribute value	20091104
14	SERIALIZE_QUERY	Static method	Public	Method	Build a SearchTerms query	20091104
15	TRANSLATE_QUERY	Instance method	Private	Method	Translate parsed query to request data	20091028
16	TRANSLATE_QUERY_ATTRIBUTE	Instance method	Private	Method	Translate attribute value	20091104

Events

Class CL_ESH_QP_CH_PARSER has no event.

Types

Class CL_ESH_QP_CH_PARSER has no local type.

Method Signatures

Method CHECK_GRAMMAR Signature

Method CHECK_GRAMMAR on class CL_ESH_QP_CH_PARSER has no parameter.
Method CHECK_GRAMMAR on class CL_ESH_QP_CH_PARSER has no exception.

Method CONCATENATE_TERMS Signature

Method CONCATENATE_TERMS on class CL_ESH_QP_CH_PARSER has no parameter.
Method CONCATENATE_TERMS on class CL_ESH_QP_CH_PARSER has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_COUNTRY	Call by reference	☐	Type reference (TYPE)	STRING	'US'		20090917
2	Importing	IV_LANGUAGE	Call by reference	☐	Type reference (TYPE)	STRING	'en'		20090917

#	Exception	Resumable	Description	Created on
1	CX_ESH_QP_LEXER	☐	Lexer Exception	20090917
2	CX_ESH_QP_QUERY_PARSER	☐	Query Parser Exception	20100823
3	CX_ESH_QP_TRANSLATOR	☐	Query Translation Exception	20091012

Method CREATE_QUERY_ENTRY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_FREESTYLE_QUERY	Call by reference	☐	Type reference (TYPE)	ESH_T_FED_QUERY_ENTRY		Query	20090923
2	Exporting	ET_QUERY	Call by reference	☐	Type reference (TYPE)	ESH_T_FED_QUERY_ENTRY		Query	20090923
3	Importing	IV_QUERY_STRING	Call by reference	☐	Type reference (TYPE)	STRING			20090923

#	Exception	Resumable	Description	Created on
1	CX_ESH_QP_QUERY_PARSER	☐	Query Parser Exception	20100322

Method GET_LEXEMS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_LENGTH	Call by reference	☐	Type reference (TYPE)	I			20090917
2	Importing	IV_START	Call by reference	☐	Type reference (TYPE)	I			20090917
3	Returning	RV_LEXEMS	Value transfer	☐	Type reference (TYPE)	STRING			20090917

#	Exception	Resumable	Description	Created on
1	CX_ESH_QP_QUERY_PARSER	☐	Query Parser Exception	20091005

Method PARSE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_QUERY_STRING	Call by reference	☐	Type reference (TYPE)	STRING			20091104

#	Exception	Resumable	Description	Created on
1	CX_ESH_QP_LEXER	☐	Lexer Exception	20091104
2	CX_ESH_QP_QUERY_PARSER	☐	Query Parser Exception	20091104
3	CX_ESH_QP_TRANSLATOR	☐	Query Translation Exception	20091104

Method PARSE_EXTENDED Signature

Method PARSE_EXTENDED on class CL_ESH_QP_CH_PARSER has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_ESH_QP_LEXER	☐	Lexer Exception	20100823
2	CX_ESH_QP_QUERY_PARSER	☐	Query Parser Exception	20100823
3	CX_ESH_QP_TRANSLATOR	☐	Query Translation Exception	20100823

Method PARSE_QUERY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_CORE_QUERIES	Call by reference	☐	Type reference (TYPE)	ESH_T_QP_CORE_QUERY		Core Queries for Extended SearchTerms	20091029
2	Exporting	ET_FREESTYLE_QUERY_ENTRY	Call by reference	☐	Type reference (TYPE)	ESH_T_FED_QUERY_ENTRY		Freestyle Query	20090917
3	Exporting	ET_QUERY_ENTRY	Call by reference	☐	Type reference (TYPE)	ESH_T_FED_QUERY_ENTRY		Query	20090917
4	Exporting	ET_SCOPE	Call by reference	☐	Type reference (TYPE)	ESH_T_FED_SCOPE		Search Scope	20090917
5	Exporting	ET_SEARCH_TIPS	Call by reference	☐	Type reference (TYPE)	STRING_TABLE		Table of Strings	20090924
6	Exporting	ET_SORT	Call by reference	☐	Type reference (TYPE)	ESH_T_FED_SORT		Sort Settings	20090917
7	Exporting	EV_DYM_QUERY	Call by reference	☐	Type reference (TYPE)	STRING			20091119
8	Exporting	EV_STATUS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20100322
9	Exporting	EV_TIMEOUT	Call by reference	☐	Type reference (TYPE)	ESH_E_FED_TIMEOUT		Search Timeout (secs)	20090917
10	Importing	IS_SCOPE	Call by reference	☑	Type reference (TYPE)	ESH_S_FED_SCOPE		Scope set externally	20090917
11	Importing	IV_QUERY_STRING	Call by reference	☐	Type reference (TYPE)	STRING			20090917

#	Exception	Resumable	Description	Created on
1	CX_ESH_QP_LEXER	☐	Lexer Exception	20090918
2	CX_ESH_QP_QUERY_PARSER	☐	Query Parser Exception	20090917
3	CX_ESH_QP_TRANSLATOR	☐	Query Translation Exception	20091012

Method PARSE_QUERY_ATTRIBUTE 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			20091104
2	Exporting	ET_SEARCH_TIPS	Call by reference	☐	Type reference (TYPE)	STRING_TABLE		Table of Strings	20091104
3	Importing	IS_QUERY_ENTRY	Call by reference	☐	Type reference (TYPE)	ESH_S_FED_QUERY_ENTRY		Query Entry	20091104

#	Exception	Resumable	Description	Created on
1	CX_ESH_QP_LEXER	☐	Lexer Exception	20091104
2	CX_ESH_QP_QUERY_PARSER	☐	Query Parser Exception	20091104
3	CX_ESH_QP_TRANSLATOR	☐	Query Translation Exception	20091104

Method PARSE_QUERY_STRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_CORE_QUERIES	Call by reference	☐	Type reference (TYPE)	ESH_T_QP_CORE_QUERY		Table of Extended Queries	20091105
2	Exporting	ET_FREESTYLE_QUERY_ENTRY	Call by reference	☐	Type reference (TYPE)	ESH_T_FED_QUERY_ENTRY		Freestyle Query Entry	20090923
3	Exporting	ET_QUERY_ENTRY	Call by reference	☐	Type reference (TYPE)	ESH_T_FED_QUERY_ENTRY		Query Entry	20090923
4	Exporting	ET_SCOPE	Call by reference	☐	Type reference (TYPE)	ESH_T_FED_SCOPE		Search Scope	20090923
5	Exporting	ET_SEARCH_TIPS	Call by reference	☐	Type reference (TYPE)	STRING_TABLE		Table of Strings	20090924
6	Exporting	ET_SORT	Call by reference	☐	Type reference (TYPE)	ESH_T_FED_SORT		Sort Information	20090923
7	Exporting	EV_DYM_QUERY	Call by reference	☐	Type reference (TYPE)	STRING		Did-you-mean query	20091119
8	Exporting	EV_TIMEOUT	Call by reference	☐	Type reference (TYPE)	ESH_E_FED_TIMEOUT		Search Timeout (sec)	20090923
9	Importing	IS_SCOPE	Call by reference	☑	Type reference (TYPE)	ESH_S_FED_SCOPE		Scope set externally	20090923
10	Importing	IV_DYM_FLAG	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20091119
11	Importing	IV_EXTENDED_FLAG	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	True if extended SearchTerms Syntax	20091105
12	Importing	IV_QUERY_STRING	Call by reference	☐	Type reference (TYPE)	STRING		Query String	20090923

#	Exception	Resumable	Description	Created on
1	CX_ESH_QP_LEXER	☐	Lexer Exception	20090923
2	CX_ESH_QP_QUERY_PARSER	☐	Query Parser Exception	20090923
3	CX_ESH_QP_TRANSLATOR	☐	Query Translation Exception	20091012

Method PARSE_SCOPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CV_QUERY_STRING	Call by reference	☐	Type reference (TYPE)	STRING		Query String	20110809
2	Exporting	ET_SCOPE	Call by reference	☐	Type reference (TYPE)	ESH_T_FED_SCOPE		Search Scope	20110809
3	Exporting	EV_SUCCESS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20110809

#	Exception	Resumable	Description	Created on
1	CX_ESH_QP_QUERY_PARSER	☐	Query Parser Exception	20110809
2	CX_ESH_QP_TRANSLATOR	☐	Query Translation Exception	20110809

Method READ_GRAMMAR Signature

Method READ_GRAMMAR on class CL_ESH_QP_CH_PARSER has no parameter.
Method READ_GRAMMAR on class CL_ESH_QP_CH_PARSER has no exception.

Method SERIALIZE_ATTR_VALUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CONTENT_TYPE	Call by reference	☐	Type reference (TYPE)	TREXD_CONTENT_TYPE		Content type	20110324
2	Importing	IV_VALUE	Call by reference	☐	Type reference (TYPE)	STRING			20091104
3	Returning	RV_VALUE_STRING	Value transfer	☐	Type reference (TYPE)	STRING			20091104

Method SERIALIZE_ATTR_VALUE on class CL_ESH_QP_CH_PARSER has no exception.

Method SERIALIZE_QUERY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_REQUEST_DATA	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_FED_REQUEST_DATA		Search Request Data	20091104
2	Importing	IV_WITH_SCOPE_FLAG	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20091104
3	Returning	RV_ST_QUERY	Value transfer	☐	Type reference (TYPE)	STRING		Serialized SearchTerms Query	20091104

Method SERIALIZE_QUERY on class CL_ESH_QP_CH_PARSER has no exception.

Method TRANSLATE_QUERY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_CORE_QUERIES	Call by reference	☐	Type reference (TYPE)	ESH_T_QP_CORE_QUERY		Table of Strings	20091029
2	Exporting	ET_FREESTYLE_QUERY_ENTRY	Call by reference	☐	Type reference (TYPE)	ESH_T_FED_QUERY_ENTRY		Freestyle Query	20091028
3	Exporting	ET_QUERY_ENTRY	Call by reference	☐	Type reference (TYPE)	ESH_T_FED_QUERY_ENTRY		Query	20091028
4	Exporting	ET_SCOPE	Call by reference	☐	Type reference (TYPE)	ESH_T_FED_SCOPE		Search Scope	20091028
5	Exporting	ET_SEARCH_TIPS	Call by reference	☐	Type reference (TYPE)	STRING_TABLE		Table of Strings	20091028
6	Exporting	ET_SORT	Call by reference	☐	Type reference (TYPE)	ESH_T_FED_SORT		Sort Settings	20091028
7	Exporting	EV_DYM_QUERY	Call by reference	☐	Type reference (TYPE)	STRING		Did-you-mean query	20091119
8	Exporting	EV_STATUS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		True if translation of core query successful	20100318
9	Exporting	EV_TIMEOUT	Call by reference	☐	Type reference (TYPE)	ESH_E_FED_TIMEOUT		Search Timeout (secs)	20091028
10	Importing	IS_SCOPE	Call by reference	☑	Type reference (TYPE)	ESH_S_FED_SCOPE		Scope set externally	20091028
11	Importing	IV_DYM_FLAG	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20091119

#	Exception	Resumable	Description	Created on
1	CX_ESH_QP_LEXER	☐	Lexer Exception	20091028
2	CX_ESH_QP_QUERY_PARSER	☐	Query Parser Exception	20091028
3	CX_ESH_QP_TRANSLATOR	☐	Query Translation Exception	20091028

Method TRANSLATE_QUERY_ATTRIBUTE 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	20091104
2	Exporting	ET_SEARCH_TIPS	Call by reference	☐	Type reference (TYPE)	STRING_TABLE		Table of Strings	20091104

#	Exception	Resumable	Description	Created on
1	CX_ESH_QP_LEXER	☐	Lexer Exception	20091104
2	CX_ESH_QP_QUERY_PARSER	☐	Query Parser Exception	20091104
3	CX_ESH_QP_TRANSLATOR	☐	Query Translation Exception	20091104

History

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