SAP ABAP Class CL_ESH_ADAPT_KM (KM Adapter for Searching in KM)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
     ⤷ S_ESH_CONTENT_FED_ADAPTERS (Package) Adapters for Federated Search

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_ESH_FED_ADAPTER_FEATURES	Federation Search - Adapter Features	20080811
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_ESH_FED_FEDERATION_SEARCH	Federation Search Interface	20080811

Properties

Class	CL_ESH_ADAPT_KM
Short Description	KM Adapter for Searching in KM
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	S_ESH_CONTENT_FED_ADAPTERS	Adapters for Federated Search
Created	20080811	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

#	Interface	Abstract	Final	Description	Created on
1	IF_ESH_FED_ADAPTER_FEATURES	☐	☐	Federation Search - Adapter Features	20080811
2	IF_ESH_FED_FEDERATION_SEARCH	☐	☐	Federation Search Interface	20080811

Friends

Class CL_ESH_ADAPT_KM has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	ADAPTER_TYPE	Constant	Private	☐	Type reference (TYPE)	STRING	'KM'	Adapter type	20081031
2	GC_DISPLAYNAME_FIELD	Constant	Private	☐	Type reference (TYPE)	ESH_E_IF_ATTRIBUTE_NAME	'DISPLAYNAME'	Attribute name	20081112
3	GC_EXTERNAL_KEY	Constant	Private	☐	Type reference (TYPE)	STRING	'{}displayname'	Attribute name of the external key	20080916
4	GC_FILENAME	Constant	Private	☐	Type reference (TYPE)	STRING	'FILENAME'	Attribute	20081114
5	GC_KM_REGEX	Constant	Private	☐	Type reference (TYPE)	STRING	'{[A-Za-z0-9:/._]*}'	Needed to build the name	20081112
6	GC_PREVIEW_FIELD	Constant	Private	☐	Type reference (TYPE)	ESH_E_IF_ATTRIBUTE_NAME	'PREVIEW'	Attribute name	20081022
7	GC_QUOTE	Constant	Public	☐	Type reference (TYPE)	C	'"'	Quotation marks	20080815
8	GC_SORT_ASCENDING	Constant	Public	☐	Type reference (TYPE)	CHAR1	'1'	Boolean variable (X=True, -=False, Space=Unknown)	20080815
9	GC_SPACE	Constant	Public	☐	Type reference (TYPE)	BOOLEAN	' '	false	20081118
10	GC_TYPE_STRING	Constant	Public	☐	Type reference (TYPE)	CHAR1	'S'	Type string	20080916
11	GC_URL_FIELD	Constant	Private	☐	Type reference (TYPE)	ESH_E_IF_ATTRIBUTE_NAME	'URL'	Attribute name	20081022
12	GC_X	Constant	Public	☐	Type reference (TYPE)	BOOLEAN	'X'	'X'	20080815
13	GV_CHUNK_SIZE	Constant	Private	☐	Type reference (TYPE)	I	10	Size of KM search result chunks	20080910
14	TYPE_BOOLEAN	Constant	Public	☐	Type reference (TYPE)	INT4	1	Boolean type	20080813
15	TYPE_DATE	Constant	Public	☐	Type reference (TYPE)	INT4	2	Date type	20080813
16	TYPE_INTEGER	Constant	Public	☐	Type reference (TYPE)	INT4	3	Integer type	20080813
17	TYPE_LONG	Constant	Public	☐	Type reference (TYPE)	INT4	4	Long type	20080813
18	TYPE_STRING	Constant	Public	☐	Type reference (TYPE)	INT4	5	String type	20080813
19	TYPE_XML	Constant	Public	☐	Type reference (TYPE)	INT4	6	XML type	20080813

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	BUILD_FETCH_GROUP	Instance method	Private	Method	Build the complex type FetchGroup und make the settings	20080910
2	CONVERT_ATTR_TYPE_TO_KM	Instance method	Private	Method	Convert the TREX attribute type to KM attribute type	20080813
3	CONVERT_DATE_TO_KM	Instance method	Private	Method	Convert date in KM format ( string )	20080815
4	CONVERT_KM_DATE_TO_ES	Instance method	Public	Method	Convert the KM date format to ES	20080916
5	CONVERT_KM_TYPE_TO_ES	Instance method	Public	Method	Convert KM attribute type to ES/TREX attribute type format	20080916
6	CONVERT_MATCHES	Instance method	Private	Method	Convert KM matches to Enterprise Search results	20080916
7	CONVERT_TO_KM_QUERY	Instance method	Private	Method	Convert the TREX-format query to KM-format query	20080813
8	CONVERT_TREX_RESP_TO_ESH_RESP	Instance method	Private	Method	Convert the TREX response to ESH response	20080916
9	EXTEND_INP_QUERY_DISPLAYNAME	Instance method	Private	Method	Extend the input query with the display name	20090615
10	GET_ATTRIBUTE_PROPERTY	Static method	Private	Method	Get attribute property	20100812
11	GET_CONNECTOR_INDEX	Static method	Private	Method	Get connector index	20100812
12	GET_IQ_LEFT_BRACKET	Instance method	Protected	Method	Get a query line with bracket	20100920
13	GET_IQ_OPERATOR	Instance method	Protected	Method	Get a query line with bracket	20100920
14	GET_IQ_RIGHT_BRACKET	Instance method	Protected	Method	Get a query line with bracket	20100920
15	GET_IQ_SIMPLE_ATTR_CONDITION	Instance method	Protected	Method	Get simple attribute condition in internal format	20100920
16	GET_SEARCH_ATTRS_TYPE_FOR_CONN	Instance method	Private	Method	Get the internal type of the search attribute of a connector	20080815
17	MAP_FILE_TYPE_TO_ICON	Static method	Private	Method	Map file type to icon	20100407
18	SEARCH_FOR_QUERY	Instance method	Private	Method	Search for the given query	20080909
19	SET_ERROR_IN_RESPONSE_BUILDER	Instance method	Private	Method	Set the error message in the corresponding response_builder	20081205
20	SPLIT_INPUT_QUERY	Instance method	Private	Method	Split query if the search term contains more than one word	20080813

Events

Class CL_ESH_ADAPT_KM has no event.

Types

Class CL_ESH_ADAPT_KM has no local type.

Method Signatures

Method BUILD_FETCH_GROUP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ER_FETCH_GROUP	Call by reference	☐	Object reference (TYPE REF TO)	IF_KMC_FETCH_GROUP		Complex type FetchGroup	20080910
2	Exporting	ET_SELECT_PROPERTIES	Call by reference	☐	Type reference (TYPE)	KMCWS_STRING_TAB		Proxy Table Type (Generated)	20080910
3	Importing	IR_KM_INDEX_MGR	Call by reference	☐	Object reference (TYPE REF TO)	IF_KMC_INDEX_MGR		Manager for aspect Index	20081021
4	Importing	IT_INDEXES	Call by reference	☐	Type reference (TYPE)	KMCWS_STRING_TAB		Table of indexes to be search	20081021

#	Exception	Resumable	Description	Created on
1	CX_ESH_ADAPT_EXCEPTION	☐	Exception in the Adapter	20080925

Method CONVERT_ATTR_TYPE_TO_KM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	EV_KM_TYPE	Value transfer	☐	Type reference (TYPE)	I			20080813
2	Importing	IV_TREX_TYPE	Value transfer	☐	Type reference (TYPE)	TREXD_ATTR_TYPE		Attribute type	20080813

Method CONVERT_ATTR_TYPE_TO_KM on class CL_ESH_ADAPT_KM has no exception.

Method CONVERT_DATE_TO_KM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_KM_DATE	Call by reference	☐	Type reference (TYPE)	STRING			20080815
2	Importing	IV_DATE	Call by reference	☐	Type reference (TYPE)	STRING			20080815

#	Exception	Resumable	Description	Created on
1	CX_ESH_ADAPT_EXCEPTION	☐	Exception in the Adapter	20080925

Method CONVERT_KM_DATE_TO_ES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_ES_DATE	Call by reference	☐	Type reference (TYPE)	STRING		date in TREX format	20080916
2	Importing	IV_KM_DATE	Call by reference	☐	Type reference (TYPE)	STRING		Date in KM format	20080916

#	Exception	Resumable	Description	Created on
1	CX_ESH_ADAPT_EXCEPTION	☐	Exception in the Adapter	20080925

Method CONVERT_KM_TYPE_TO_ES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	EV_ES_TYPE	Value transfer	☐	Type reference (TYPE)	TREXD_ATTR_TYPE		Attribute type	20080916
2	Importing	IV_KM_TYPE	Call by reference	☐	Type reference (TYPE)	I		KM type	20080916

Method CONVERT_KM_TYPE_TO_ES on class CL_ESH_ADAPT_KM has no exception.

Method CONVERT_MATCHES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_RESULTS	Call by reference	☐	Type reference (TYPE)	ESH_T_ADPT_KM_SEARCH_RESULT		Result table of one search service provider	20080916
2	Importing	IT_MATCHES	Call by reference	☐	Type reference (TYPE)	KMC_SEARCH_MATCH_TAB		KMC_SEARCH_MATCH_TAB	20080916
3	Importing	IT_SELECT_PROPERTIES	Call by reference	☐	Type reference (TYPE)	KMCWS_STRING_TAB		Proxy Table Type (Generated)	20080916
4	Importing	IV_FROM	Call by reference	☐	Type reference (TYPE)	I			20080916
5	Importing	IV_TO	Call by reference	☐	Type reference (TYPE)	I			20080916

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_ENGINE	☐	Exception in the Adapter	20100806

Method CONVERT_TO_KM_QUERY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_KM_QUERY	Call by reference	☐	Type reference (TYPE)	KMC_QUERY_ENTRY_TAB		KMC_QUERY_ENTRY_TAB	20080813
2	Importing	IT_TREX_QUERY	Call by reference	☐	Type reference (TYPE)	ESH_T_ADPT_KM_QUERY		Query	20080813
3	Importing	IV_CONNECTOR_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_SEARCH_CONNECTOR_ID		Search Connector ID	20100810

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_ENGINE	☐	Exception in the Adapter class	20100806

Method CONVERT_TREX_RESP_TO_ESH_RESP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ER_RESP_BUILDER	Value transfer	☐	Object reference (TYPE REF TO)	CL_ESH_FED_GRP_RESP_BUILDER		Grouped Response Builder	20080916
2	Importing	IT_ATTR_KM_TEMPLATE	Call by reference	☐	Type reference (TYPE)	ESH_T_ADPT_KM_ATTR_TYPE		Table of search attributes with internal type	20081021
3	Importing	IT_RESULT	Call by reference	☐	Type reference (TYPE)	ESH_T_ADPT_KM_SEARCH_RESULT		Link field for view query	20080916
4	Importing	IV_NO_OF_ALL_HITS	Call by reference	☐	Type reference (TYPE)	I		Number of all hits in index	20080916
5	Importing	IV_NO_OF_HITS	Call by reference	☐	Type reference (TYPE)	I		Number of hits in (iv_from, iv_to)	20080916
6	Importing	IV_SEARCH_CONNECTOR_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_SEARCH_CONNECTOR_ID		Search Connector ID	20080916

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_ENGINE	☐	Exception in the Adapter	20100806

Method EXTEND_INP_QUERY_DISPLAYNAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	IT_INPUT_QUERY	Call by reference	☐	Type reference (TYPE)	ESH_T_FED_QUERY_ENTRY		Query	20090615

Method EXTEND_INP_QUERY_DISPLAYNAME on class CL_ESH_ADAPT_KM has no exception.

Method GET_ATTRIBUTE_PROPERTY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ATTRIBUTE_NAME	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_ATTRIBUTE_NAME		Attribute ID	20100812
2	Importing	IV_CONNECTOR_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_SEARCH_CONNECTOR_ID		Search Connector ID	20100812
3	Returning	RV_PROPERTY_NAME	Value transfer	☐	Type reference (TYPE)	STRING		Property Name	20100812

Method GET_ATTRIBUTE_PROPERTY on class CL_ESH_ADAPT_KM has no exception.

Method GET_CONNECTOR_INDEX 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)	ESH_E_IF_SEARCH_CONNECTOR_ID		Search Connector ID	20100812
2	Importing	IV_FROM_BUFFER	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20100812
3	Returning	RV_INDEX_ID	Value transfer	☐	Type reference (TYPE)	STRING		Index ID	20100812

Method GET_CONNECTOR_INDEX on class CL_ESH_ADAPT_KM 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_ADPT_KM_QUERY		Query Entry	20100920
2	Importing	IV_QUERY_PART	Call by reference	☑	Type reference (TYPE)	INT4		Natural number	20100920

Method GET_IQ_LEFT_BRACKET on class CL_ESH_ADAPT_KM 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_ADPT_KM_QUERY		Query Entry	20100920
2	Importing	IV_OPERATOR	Call by reference	☐	Type reference (TYPE)	STRING		Operator (AND, OR)	20100920
3	Importing	IV_QUERY_PART	Call by reference	☑	Type reference (TYPE)	INT4		Natural number	20100920

Method GET_IQ_OPERATOR on class CL_ESH_ADAPT_KM 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_ADPT_KM_QUERY		Query Entry	20100920
2	Importing	IV_QUERY_PART	Call by reference	☑	Type reference (TYPE)	INT4		Natural number	20100920

Method GET_IQ_RIGHT_BRACKET on class CL_ESH_ADAPT_KM 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_ADPT_KM_QUERY		Query Entry	20100920
2	Importing	IV_ATTRIBUTE_NAME	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_ATTRIBUTE_NAME			20100920
3	Importing	IV_VALUE	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_ATTRIBUTE_VALUE		Attribute Value	20100920

Method GET_IQ_SIMPLE_ATTR_CONDITION on class CL_ESH_ADAPT_KM has no exception.

Method GET_SEARCH_ATTRS_TYPE_FOR_CONN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_RESP_ATTRIBUTES_TYPES	Call by reference	☐	Type reference (TYPE)	ESH_T_ADPT_KM_ATTR_TYPE		Table of search attributes with internal type	20080815
2	Importing	IV_CONNECTOR_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_SEARCH_CONNECTOR_ID		Search Connector ID	20080815

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_ENGINE	☐	Exception in the Adapter	20100806

Method MAP_FILE_TYPE_TO_ICON Signature

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

Method MAP_FILE_TYPE_TO_ICON on class CL_ESH_ADAPT_KM has no exception.

Method SEARCH_FOR_QUERY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_RESULTS	Call by reference	☐	Type reference (TYPE)	ESH_T_ADPT_KM_SEARCH_RESULT		Result table of one search service provider	20080916
2	Exporting	EV_NO_OF_ALL_HITS	Call by reference	☐	Type reference (TYPE)	I		Number of all hits in Index	20080912
3	Exporting	EV_NO_OF_HITS	Call by reference	☐	Type reference (TYPE)	I		Number of hits in interval from-to	20080916
4	Importing	IR_COLLATOR_ENTRY	Value transfer	☐	Object reference (TYPE REF TO)	IF_KMC_COLLATOR_ENTRY		Complex type CollatorEntry	20080909
5	Importing	IR_FETCH_GROUP	Value transfer	☐	Object reference (TYPE REF TO)	IF_KMC_FETCH_GROUP		Complex type FetchGroup	20080909
6	Importing	IR_KM_INDEX_MGR	Value transfer	☐	Object reference (TYPE REF TO)	IF_KMC_INDEX_MGR		Manager for aspect Index	20080910
7	Importing	IT_INDEXES	Call by reference	☐	Type reference (TYPE)	KMCWS_STRING_TAB		Proxy Table Type (Generated)	20080912
8	Importing	IT_KM_QUERY	Call by reference	☐	Type reference (TYPE)	KMC_QUERY_ENTRY_TAB		KMC_QUERY_ENTRY_TAB	20080909
9	Importing	IT_LANGUAGES	Call by reference	☑	Type reference (TYPE)	KMCWS_STRING_TAB		Proxy Table Type (Generated)	20080909
10	Importing	IT_SELECT_PROPERTIES	Call by reference	☐	Type reference (TYPE)	KMCWS_STRING_TAB		Proxy Table Type (Generated)	20080916
11	Importing	IV_CHUNK_SIZE	Value transfer	☑	Type reference (TYPE)	I		Size of KM search result chunks	20080909
12	Importing	IV_FROM	Value transfer	☐	Type reference (TYPE)	I		begin search with result iv_from	20080910
13	Importing	IV_TO	Value transfer	☐	Type reference (TYPE)	I		end the search with result iv_to	20080910

#	Exception	Resumable	Description	Created on
1	CX_AI_SYSTEM_FAULT	☐	Application Integration: Technical Error	20100806
2	CX_ESH_IF_ENGINE	☐	ESH Interface Exception	20100812

Method SET_ERROR_IN_RESPONSE_BUILDER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ER_RESP_BUILDER	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_FED_GRP_RESP_BUILDER		Responses Builder	20081205
2	Importing	IV_CONNECTOR_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_SEARCH_CONNECTOR_ID		Search Connector ID	20081205
3	Importing	IV_ERROR_MESSAGE	Call by reference	☐	Type reference (TYPE)	STRING		Error message	20081205

Method SET_ERROR_IN_RESPONSE_BUILDER on class CL_ESH_ADAPT_KM has no exception.

Method SPLIT_INPUT_QUERY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_QUERY_PART	Call by reference	☐	Type reference (TYPE)	ESH_T_ADPT_KM_QUERY		Query	20080813
2	Importing	IV_CONNECTOR_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_SEARCH_CONNECTOR_ID		Search Connector ID	20130322
3	Importing	IV_INPUT_QUERY	Call by reference	☐	Type reference (TYPE)	ESH_S_ADPT_KM_QUERY		Query Entry	20080813

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

History

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