SAP ABAP Class CL_ESH_QL_SEARCHTERM_REGEX (Regex Handler for Searchterms/Exclusions)

Hierarchy

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

Properties

Class	CL_ESH_QL_SEARCHTERM_REGEX
Short Description	Regex Handler for Searchterms/Exclusions
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	S_ESH_ENG_QUERY_LOGGING	Query Logging
Created	20100420	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)

Interfaces

Class CL_ESH_QL_SEARCHTERM_REGEX has no interface implemented.

Friends

Class CL_ESH_QL_SEARCHTERM_REGEX has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MT_EXCLUSION_REGEX	Instance attribute	Private	☐	Type reference (TYPE)	ESH_T_CM_EXCL_REGEX		Exclusion regex	20100420
2	PATTERN_WILDCARD	Constant	Public	☐	Type reference (TYPE)	CHAR1	'*'	Pattern: Wildcard	20100420
3	REGEX_ANY_STRING	Constant	Public	☐	Type reference (TYPE)	CHAR3	'w*'	Any string of wordlike characters	20100421
4	REGEX_OR	Constant	Public	☐	Type reference (TYPE)	CHAR1	'|'	Regex: OR	20100420
5	REGEX_WORD_BOUNDARY	Constant	Public	☐	Type reference (TYPE)	CHAR2	''	Regex: Term End Mark	20100421

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	EXCLUSIONS_READ	Instance method	Private	Method	Read Exclusions from DB	20100420
2	GET_EXCLUSION_REGEX	Instance method	Public	Method	Get Exclusion Regex	20100420
3	GET_INSTANCE	Static method	Public	Method	Get Instance	20100420
4	PATTERN_APPEND_TO_REGEX	Instance method	Public	Method	Append Pattern to Regex	20100421
5	PATTERN_CONVERT_TO_REGEX	Instance method	Public	Method	Convert Pattern to Regex	20100421
6	REGEX_ADJUST_BACKREFERENCES	Instance method	Public	Method	Adjust Backreferences in Regex (n -> n+offset)	20100420
7	REGEX_APPEND_WITH_OR	Instance method	Public	Method	Create combined regex |	20100420
8	REGEX_CHECK_VALIDITY	Instance method	Public	Method	Check syntactical validity of regex	20100420
9	REGEX_GET_BACKREFERENCE_COUNT	Instance method	Public	Method	Get Backreference Count (Count of patterns '(xy)' in regex)	20100420
10	TERM_APPEND_TO_REGEX	Instance method	Public	Method	Append Single Term to Regex	20100421
11	TERM_ESCAPE_ALL_SPECIALCHARS	Instance method	Public	Method	Escape all Special Characters in Term	20100421

Events

Class CL_ESH_QL_SEARCHTERM_REGEX has no event.

Types

Class CL_ESH_QL_SEARCHTERM_REGEX has no local type.

Method Signatures

Method EXCLUSIONS_READ Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_EXCL_BLOCK	Call by reference	☐	Type reference (TYPE)	ESH_T_QL_ST_EXCL		Exclusions	20100420
2	Exporting	EV_LAST_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_QL_HKY		Query Log Content Hashkey	20100420
3	Exporting	EV_NO_MORE_DATA	Call by reference	☐	Type reference (TYPE)	CHAR01		No More Data	20100420
4	Importing	IV_FROM_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_QL_HKY		Query Log Content Hashkey	20100420
5	Importing	IV_PACKAGESIZE	Call by reference	☐	Type reference (TYPE)	INT4	1000	Package Size	20100420

Method EXCLUSIONS_READ on class CL_ESH_QL_SEARCHTERM_REGEX has no exception.

Method GET_EXCLUSION_REGEX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_EXCLUSION_REGEX	Call by reference	☐	Type reference (TYPE)	ESH_T_CM_EXCL_REGEX		Exclusion regex	20100420

#	Exception	Resumable	Description	Created on
1	CX_ESH_CM_INVALID_REGEX	☐	Invalid Regex	20100420

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RR_REGEX_HANDLER	Value transfer	☐	Object reference (TYPE REF TO)	CL_ESH_QL_SEARCHTERM_REGEX		Regex handler	20100420

Method GET_INSTANCE on class CL_ESH_QL_SEARCHTERM_REGEX has no exception.

Method PATTERN_APPEND_TO_REGEX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_PATTERN	Call by reference	☐	Type reference (TYPE)	STRING			20100421
2	Importing	IV_REGEX	Call by reference	☐	Type reference (TYPE)	STRING			20100421
3	Returning	RV_REGEX	Value transfer	☐	Type reference (TYPE)	STRING			20100421

#	Exception	Resumable	Description	Created on
1	CX_ESH_CM_INVALID_REGEX	☐		20100421

Method PATTERN_CONVERT_TO_REGEX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_PATTERN	Call by reference	☐	Type reference (TYPE)	STRING			20100421
2	Returning	RV_REGEX	Value transfer	☐	Type reference (TYPE)	STRING			20100421

Method PATTERN_CONVERT_TO_REGEX on class CL_ESH_QL_SEARCHTERM_REGEX has no exception.

Method REGEX_ADJUST_BACKREFERENCES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_BACKREF_COUNTER_OFFSET	Call by reference	☐	Type reference (TYPE)	INT4		Offset	20100420
2	Importing	IV_REGEX	Call by reference	☐	Type reference (TYPE)	STRING		Regex	20100420
3	Returning	RV_REGEX	Value transfer	☐	Type reference (TYPE)	STRING		Adjusted Regex	20100420

Method REGEX_ADJUST_BACKREFERENCES on class CL_ESH_QL_SEARCHTERM_REGEX has no exception.

Method REGEX_APPEND_WITH_OR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_REGEX_1	Call by reference	☐	Type reference (TYPE)	STRING			20100420
2	Importing	IV_REGEX_2	Call by reference	☐	Type reference (TYPE)	STRING			20100420
3	Returning	RV_REGEX	Value transfer	☐	Type reference (TYPE)	STRING			20100420

#	Exception	Resumable	Description	Created on
1	CX_ESH_CM_INVALID_REGEX	☐	Invalid Regex	20100420

Method REGEX_CHECK_VALIDITY Signature

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

#	Exception	Resumable	Description	Created on
1	CX_ESH_CM_INVALID_REGEX	☐	Invalid Regex	20100420

Method REGEX_GET_BACKREFERENCE_COUNT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_REGEX	Call by reference	☐	Type reference (TYPE)	STRING		Regex	20100420
2	Returning	RV_COUNT	Value transfer	☐	Type reference (TYPE)	INT4		Backref Groups	20100420

Method REGEX_GET_BACKREFERENCE_COUNT on class CL_ESH_QL_SEARCHTERM_REGEX has no exception.

Method TERM_APPEND_TO_REGEX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_REGEX	Call by reference	☐	Type reference (TYPE)	STRING			20100421
2	Importing	IV_TERM	Call by reference	☐	Type reference (TYPE)	STRING			20100421
3	Returning	RV_REGEX	Value transfer	☐	Type reference (TYPE)	STRING			20100421

#	Exception	Resumable	Description	Created on
1	CX_ESH_CM_INVALID_REGEX	☐		20100421

Method TERM_ESCAPE_ALL_SPECIALCHARS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_EXCLUDING_PATTERN_WILDCARD	Call by reference	☐	Type reference (TYPE)	CHAR01	ABAP_FALSE	Exclude pattern wildcard *	20100421
2	Importing	IV_TERM	Call by reference	☐	Type reference (TYPE)	STRING		Term (original)	20100421
3	Returning	RV_TERM	Value transfer	☐	Type reference (TYPE)	STRING		Term (all regex speciaal chars escaped)	20100421

Method TERM_ESCAPE_ALL_SPECIALCHARS on class CL_ESH_QL_SEARCHTERM_REGEX has no exception.

History

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