SAP ABAP Class CL_ESH_FED_COMMON_ATTR_MAPPER (Common Attribute Mapper)

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_COMMON_ATTR_MAPPER
Short Description	Common Attribute Mapper
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

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

Friends

Class CL_ESH_FED_COMMON_ATTR_MAPPER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_COMMON_ATTR_PREFIX	Constant	Public	☐	Type reference (TYPE)	CHAR1	'#'	Common attribute prefix	20100105
2	MT_ATTRIBUTE_MAPPING	Instance attribute	Private	☐	Type reference (TYPE)	T_COMMON_ATTRIBUTE_MAPPING			20091229
3	SO_MAPPER_SINGLETON	Static Attribute	Protected	☐	Object reference (TYPE REF TO)	CL_ESH_FED_COMMON_ATTR_MAPPER		Common attribute mapper	20091229

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	GET_CAS_FROM_REQUEST_ATTRIBUTE	Instance method	Private	Method	Get common attributes from request attribute	20091229
2	GET_INAV_COMMON_ATTRIBUTES	Instance method	Public	Method	Get common attributes for interactive navigation by scope	20091230
3	GET_INSTANCE	Static method	Public	Method	Get singleton instance	20091229
4	GET_IQ_LEFT_BRACKET	Instance method	Protected	Method	Get a query line with bracket	20091229
5	GET_IQ_OPERATOR	Instance method	Protected	Method	Get a query line with bracket	20091229
6	GET_IQ_RIGHT_BRACKET	Instance method	Protected	Method	Get a query line with bracket	20091229
7	GET_REQUEST_ATTRIBUTES_FROM_CA	Instance method	Private	Method	Get request attributes from common attribute	20091229
8	HAS_IMPLIZIT_COMMON_ATTRS	Instance method	Public	Method	Is common attribute mapping required	20100226
9	IS_MAPPING_REQUIRED	Instance method	Public	Method	Is common attribute mapping required	20091229
10	MAP_ATTRIBUTES_IN_REQUEST	Instance method	Public	Method	Map attributes in request	20091229
11	MAP_ATTRIBUTES_IN_RESPONSES	Instance method	Public	Method	Map attributes in responses	20100104
12	MAP_COMMON_ATTRIBUTES	Instance method	Public	Method	Map common attributes	20091230
13	MAP_QUERY_TABLE	Instance method	Private	Method	Map common attributes in a query table	20100105
14	MAP_REQUEST_INAV_ATTRIBUTES	Instance method	Private	Method	Map query attributes in request	20091230
15	MAP_REQUEST_QUERY_ATTRIBUTES	Instance method	Private	Method	Map query attributes in request	20091229
16	MAP_REQUEST_SORT_ATTRIBUTES	Instance method	Private	Method	Map query attributes in request	20100111
17	MAP_REQUEST_VALUE_LIST_ATTRS	Instance method	Private	Method	Map query attributes in request	20091230
18	MAP_RESPONSES_DISTRIBUTION	Instance method	Public	Method	Map distribution in responses	20100104
19	READ_CAS_OF_RESOLVED_SCOPE	Instance method	Private	Method	Read common attributes of the resolved search scope	20091229

Events

Class CL_ESH_FED_COMMON_ATTR_MAPPER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	S_COMMON_ATTRIBUTE_MAPPING	Private	See coding			20091229	BEGIN OF s_common_attribute_mapping, connector_id TYPE esh_e_if_search_connector_id, request_type_id TYPE esh_e_if_con_request_type_id, common_attribute_id TYPE esh_e_om_comm_attr, request_attribute_type_id TYPE char32, END OF s_common_attribute_mapping
2	T_ATTRIBUTE_IDS	Private	See coding			20091229	t_attribute_ids TYPE STANDARD TABLE OF char32
3	T_COMMON_ATTRIBUTE_IDS	Private	See coding			20091229	t_common_attribute_ids TYPE SORTED TABLE OF char32 WITH UNIQUE KEY table_line
4	T_COMMON_ATTRIBUTE_MAPPING	Private	See coding			20091229	t_common_attribute_mapping TYPE SORTED TABLE OF s_common_attribute_mapping WITH NON-UNIQUE KEY connector_id request_type_id common_attribute_id WITH NON-UNIQUE SORTED KEY attr COMPONENTS connector_id request_type_id request_attribute_type_id

Method Signatures

Method GET_CAS_FROM_REQUEST_ATTRIBUTE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_COMMON_ATTRIBUTES	Call by reference	☐	Type reference (TYPE)	T_COMMON_ATTRIBUTE_IDS		Common Attributes	20091229
2	Importing	IV_CONNECTOR_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_SEARCH_CONNECTOR_ID		Search Connector ID	20091229
3	Importing	IV_REQUEST_ATTRIBUTE	Call by reference	☐	Type reference (TYPE)	CHAR32		Request Attribute ID	20091229
4	Importing	IV_REQUEST_TYPE_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_CON_REQUEST_TYPE_ID		Request Type ID	20091229

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

Method GET_INAV_COMMON_ATTRIBUTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_ATTRS	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_ATTR_NAMES		Table of Attribute Names	20091230
2	Exporting	ET_RANGE_ATTRS	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_ATTR_NAMES		Table of Attribute Names	20100922
3	Importing	IT_CONNECTORS	Call by reference	☐	Type reference (TYPE)	ESH_T_FED_SCOPE		Search Scope	20091230

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

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RR_MAPPER	Value transfer	☐	Object reference (TYPE REF TO)	CL_ESH_FED_COMMON_ATTR_MAPPER		Common Attribute Mapper	20091229

Method GET_INSTANCE on class CL_ESH_FED_COMMON_ATTR_MAPPER 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	20091229

Method GET_IQ_LEFT_BRACKET on class CL_ESH_FED_COMMON_ATTR_MAPPER 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	20091229
2	Importing	IV_OPERATOR	Call by reference	☐	Type reference (TYPE)	STRING		Operator (AND, OR)	20091229

Method GET_IQ_OPERATOR on class CL_ESH_FED_COMMON_ATTR_MAPPER has no exception.

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	20091229

Method GET_IQ_RIGHT_BRACKET on class CL_ESH_FED_COMMON_ATTR_MAPPER has no exception.

Method GET_REQUEST_ATTRIBUTES_FROM_CA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_REQUEST_ATTRIBUTES	Call by reference	☐	Type reference (TYPE)	T_ATTRIBUTE_IDS		Request Attribute IDs	20091229
2	Importing	IV_COMMON_ATTRIBUTE	Call by reference	☐	Type reference (TYPE)	CHAR32		Common Attribute	20091229
3	Importing	IV_CONNECTOR_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_SEARCH_CONNECTOR_ID		Search Connector ID	20091229
4	Importing	IV_REQUEST_TYPE_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_CON_REQUEST_TYPE_ID		Request Type ID	20091229

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

Method HAS_IMPLIZIT_COMMON_ATTRS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_CONNECTORS	Call by reference	☐	Type reference (TYPE)	ESH_T_FED_SCOPE		Search Scope	20100226
2	Returning	RV_FLAG	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20100226

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

Method IS_MAPPING_REQUIRED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_CONNECTORS	Call by reference	☐	Type reference (TYPE)	ESH_T_FED_SCOPE		Search Scope	20091229
2	Returning	RV_FLAG	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20091229

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

Method MAP_ATTRIBUTES_IN_REQUEST Signature

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

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

Method MAP_ATTRIBUTES_IN_RESPONSES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CR_RESPONSES	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_IF_SEARCH_RESPONSES		Search Responses	20100104

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

Method MAP_COMMON_ATTRIBUTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_MAPPINGS	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_COMMON_ATTR_MAPPINGS		Mappings	20091230
2	Importing	IT_ATTRIBUTES	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_ATTR_NAMES		Attributes	20091230
3	Importing	IV_REQUEST_TYPE_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_REQUEST_TYPE_ID		Request Type ID	20091230
4	Importing	IV_SEARCH_CONNECTOR_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_SEARCH_CONNECTOR_ID		Search Connector ID	20091230

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

Method MAP_QUERY_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_QUERY	Call by reference	☐	Type reference (TYPE)	ESH_T_FED_QUERY_ENTRY		Query	20100105
2	Exporting	EV_MAPPING_DONE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20100609
3	Importing	IS_SCOPE	Call by reference	☐	Type reference (TYPE)	ESH_S_FED_SCOPE		Search Scope	20100105
4	Importing	IT_COMMON_ATTRIBUTES	Call by reference	☐	Type reference (TYPE)	T_COMMON_ATTRIBUTE_IDS			20100105

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

Method MAP_REQUEST_INAV_ATTRIBUTES Signature

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

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

Method MAP_REQUEST_QUERY_ATTRIBUTES Signature

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

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

Method MAP_REQUEST_SORT_ATTRIBUTES Signature

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

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

Method MAP_REQUEST_VALUE_LIST_ATTRS Signature

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

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

Method MAP_RESPONSES_DISTRIBUTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_ATTR_DIST_RANGES	Call by reference	☐	Type reference (TYPE)	TREXT_ATTR_DIST_RANGES		Attribute distribution ranges	20100104
2	Changing	CT_ATTR_DIST_VALUES	Call by reference	☐	Type reference (TYPE)	TREXT_ATTR_DIST_VALUES		Attribute distribution values	20100104
3	Importing	IV_REQUEST_TYPE_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_REQUEST_TYPE_ID		Request Type ID	20100104
4	Importing	IV_SEARCH_CONNECTOR_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_SEARCH_CONNECTOR_ID		Search Connector ID	20100104

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

Method READ_CAS_OF_RESOLVED_SCOPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_COMMON_ATTRIBUTES	Call by reference	☐	Type reference (TYPE)	T_COMMON_ATTRIBUTE_IDS			20091229
2	Exporting	ET_IMPLIZIT_COMMON_ATTRIBUTES	Call by reference	☐	Type reference (TYPE)	T_COMMON_ATTRIBUTE_IDS			20100226
3	Exporting	ET_RANGE_ATTRIBUTES	Call by reference	☐	Type reference (TYPE)	T_COMMON_ATTRIBUTE_IDS			20100922
4	Importing	IT_CONNECTORS	Call by reference	☐	Type reference (TYPE)	ESH_T_FED_SCOPE		Resolved Search Scope	20091229

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

History

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