SAP ABAP Class CL_ESH_QP_METADATA_HELPER (Metadata Helper Class)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
     ⤷ S_ESH_ENG_QUERY_PARSER_RD (Package) Recursive descent query parser

Properties

Class	CL_ESH_QP_METADATA_HELPER
Short Description	Metadata Helper Class
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	S_ESH_ENG_QUERY_PARSER_RD	Recursive descent query parser
Created	20081217	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_QP_METADATA_HELPER has no interface implemented.

Friends

Class CL_ESH_QP_METADATA_HELPER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	LC_MAX_LEN	Constant	Private	☐	Type reference (TYPE)	I	255		20090115
2	MT_ATTRIBUTES	Static Attribute	Private	☐	Type reference (TYPE)	ESH_T_QP_ATTRIBUTES		Search attributes	20090112
3	MT_CATEGORIES	Static Attribute	Private	☐	Type reference (TYPE)	ESH_T_IF_MDATA_CATEGORIES		Metadata: Category	20090108
4	MT_CONNECTORS	Static Attribute	Private	☐	Type reference (TYPE)	ESH_T_IF_MDATA_CONNECTORS		Metadata: Connectors	20090108
5	MT_TEMPLATES	Static Attribute	Private	☐	Type reference (TYPE)	ESH_T_IF_MDATA_TEMPLATES		Metadata: Templates	20090108

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	COMPUTE_DISTANCE	Static method	Private	Method	Compute distance	20090108
2	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20081219
3	GET_SIMILAR_ATTRIBUTE	Static method	Public	Method	Get similar category ID	20090109
4	GET_SIMILAR_CATEGORY	Static method	Public	Method	Get similar category ID	20081217
5	GET_SIMILAR_CONNECTOR	Static method	Public	Method	Get similar category ID	20090108
6	GET_SIMILAR_TEMPLATE	Static method	Public	Method	Get similar category ID	20090108
7	IS_ATTRIBUTE	Static method	Public	Method	Check if input is a valid attribute ID for given scope	20090109
8	IS_CATEGORY	Static method	Public	Method	Check if input is a valid search category ID	20081217
9	IS_CONNECTOR	Static method	Public	Method	Check if input is a valid search connector ID	20081218
10	IS_CONNECTOR_ATTRIBUTE	Static method	Public	Method	Check if input is a valid attribute ID	20090305
11	IS_KEYWORD	Static method	Public	Method	Check if input is a valid search keyword	20081217
12	IS_REQUEST	Static method	Public	Method	Check if input is a valid request for given scope ID	20081218
13	IS_TEMPLATE	Static method	Public	Method	Check if input is a valid search template ID	20081218
14	IS_TEMPLATE_ATTRIBUTE	Static method	Public	Method	Check if input is a valid attribute ID	20090309

Events

Class CL_ESH_QP_METADATA_HELPER has no event.

Types

Class CL_ESH_QP_METADATA_HELPER has no local type.

Method Signatures

Method COMPUTE_DISTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_DISTANCE	Value transfer	☐	Type reference (TYPE)	I			20090108
2	Exporting	EV_MAX	Call by reference	☐	Type reference (TYPE)	I			20090108
3	Importing	IV_PERCENT	Call by reference	☐	Type reference (TYPE)	I			20090108
4	Importing	IV_STR1	Call by reference	☐	Type reference (TYPE)	STRING			20090108
5	Importing	IV_STR2	Call by reference	☐	Type reference (TYPE)	STRING			20090108

Method COMPUTE_DISTANCE on class CL_ESH_QP_METADATA_HELPER has no exception.

Method CONSTRUCTOR Signature

Method CONSTRUCTOR on class CL_ESH_QP_METADATA_HELPER has no parameter.
Method CONSTRUCTOR on class CL_ESH_QP_METADATA_HELPER has no exception.

Method GET_SIMILAR_ATTRIBUTE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ATTRIBUTE_ID	Call by reference	☐	Type reference (TYPE)	STRING			20090109
2	Importing	IV_PERCENT	Call by reference	☐	Type reference (TYPE)	I	70		20090109
3	Importing	IV_REQUEST_ID	Call by reference	☐	Type reference (TYPE)	STRING	'DEFAULT'	Query Parser Identifier	20090113
4	Importing	IV_SCOPE_ID	Call by reference	☐	Type reference (TYPE)	STRING		Query Parser Identifier	20090109
5	Importing	IV_SCOPE_TYPE	Call by reference	☐	Type reference (TYPE)	ESH_E_QP_TOKEN_TYPE		SearchTerms Token Type	20090109
6	Returning	RV_SIMILAR_ID	Value transfer	☐	Type reference (TYPE)	ESH_E_QP_IDENTIFIER		Query Parser Identifier	20090109

Method GET_SIMILAR_ATTRIBUTE on class CL_ESH_QP_METADATA_HELPER has no exception.

Method GET_SIMILAR_CATEGORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CATEGORY_ID	Call by reference	☐	Type reference (TYPE)	STRING		Query Parser Identifier	20081217
2	Importing	IV_PERCENT	Call by reference	☐	Type reference (TYPE)	I	70		20090108
3	Returning	RV_SIMILAR_ID	Value transfer	☐	Type reference (TYPE)	ESH_E_QP_IDENTIFIER		Query Parser Identifier	20081217

Method GET_SIMILAR_CATEGORY on class CL_ESH_QP_METADATA_HELPER has no exception.

Method GET_SIMILAR_CONNECTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CONNECTOR_ID	Call by reference	☐	Type reference (TYPE)	STRING			20090108
2	Importing	IV_PERCENT	Call by reference	☐	Type reference (TYPE)	I	70		20090108
3	Returning	RV_SIMILAR_ID	Value transfer	☐	Type reference (TYPE)	ESH_E_QP_IDENTIFIER		Query Parser Identifier	20090108

Method GET_SIMILAR_CONNECTOR on class CL_ESH_QP_METADATA_HELPER has no exception.

Method GET_SIMILAR_TEMPLATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_PERCENT	Call by reference	☐	Type reference (TYPE)	I	70		20090108
2	Importing	IV_TEMPLATE_ID	Call by reference	☐	Type reference (TYPE)	STRING			20090108
3	Returning	RV_SIMILAR_ID	Value transfer	☐	Type reference (TYPE)	ESH_E_QP_IDENTIFIER		Query Parser Identifier	20090108

Method GET_SIMILAR_TEMPLATE on class CL_ESH_QP_METADATA_HELPER has no exception.

Method IS_ATTRIBUTE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ATTRIBUTE_ID	Call by reference	☐	Type reference (TYPE)	STRING			20090109
2	Importing	IV_REQUEST_ID	Call by reference	☐	Type reference (TYPE)	STRING	'DEFAULT'		20090112
3	Importing	IV_SCOPE_ID	Call by reference	☐	Type reference (TYPE)	STRING			20090109
4	Importing	IV_SCOPE_TYPE	Call by reference	☐	Type reference (TYPE)	ESH_E_QP_TOKEN_TYPE		SearchTerms Token Type	20090109
5	Returning	RV_STATUS	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20090109

Method IS_ATTRIBUTE on class CL_ESH_QP_METADATA_HELPER has no exception.

Method IS_CATEGORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ID	Call by reference	☐	Type reference (TYPE)	STRING		Query Parser Identifier	20081217
2	Returning	RV_STATUS	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20081217

Method IS_CATEGORY on class CL_ESH_QP_METADATA_HELPER has no exception.

Method IS_CONNECTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ID	Call by reference	☐	Type reference (TYPE)	STRING		Query Parser Identifier	20081218
2	Returning	RV_STATUS	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20081218

Method IS_CONNECTOR on class CL_ESH_QP_METADATA_HELPER has no exception.

Method IS_CONNECTOR_ATTRIBUTE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ATTRIBUTE_ID	Call by reference	☐	Type reference (TYPE)	STRING			20090305
2	Importing	IV_CONNECTOR_ID	Call by reference	☐	Type reference (TYPE)	STRING			20090305
3	Importing	IV_REQUEST_ID	Call by reference	☑	Type reference (TYPE)	STRING			20090305
4	Returning	RV_STATUS	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20090305

Method IS_CONNECTOR_ATTRIBUTE on class CL_ESH_QP_METADATA_HELPER has no exception.

Method IS_KEYWORD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ID	Call by reference	☐	Type reference (TYPE)	STRING			20081217
2	Returning	RV_STATUS	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20081217

Method IS_KEYWORD on class CL_ESH_QP_METADATA_HELPER has no exception.

Method IS_REQUEST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_REQUEST_ID	Call by reference	☐	Type reference (TYPE)	STRING			20081218
2	Importing	IV_SCOPE_ID	Call by reference	☐	Type reference (TYPE)	STRING			20081218
3	Importing	IV_SCOPE_TYPE	Call by reference	☐	Type reference (TYPE)	ESH_E_QP_TOKEN_TYPE		SearchTerms Token Type	20090108
4	Returning	RV_STATUS	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20081218

Method IS_REQUEST on class CL_ESH_QP_METADATA_HELPER has no exception.

Method IS_TEMPLATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ID	Call by reference	☐	Type reference (TYPE)	STRING			20081218
2	Returning	RV_STATUS	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20081218

Method IS_TEMPLATE on class CL_ESH_QP_METADATA_HELPER has no exception.

Method IS_TEMPLATE_ATTRIBUTE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ATTRIBUTE_ID	Call by reference	☐	Type reference (TYPE)	STRING			20090309
2	Importing	IV_REQUEST_ID	Call by reference	☑	Type reference (TYPE)	STRING			20090309
3	Importing	IV_TEMPLATE_ID	Call by reference	☐	Type reference (TYPE)	STRING			20090309
4	Returning	RV_STATUS	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20090309

Method IS_TEMPLATE_ATTRIBUTE on class CL_ESH_QP_METADATA_HELPER has no exception.

History

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