SAP ABAP Class CL_SIC_SEARCH_TREX (TREX Implementation of SIC Search Interface)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-EIM-IQM-IC (Application Component) Information Consistency
     ⤷ S_IC_SEARCH_TREX (Package) Information Consolidation Search TREX

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SIC_INDEX_SEARCH_ENGINE	Interface for Search Engine	20060419
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SIC_SEARCH_BUILDER	Interface for Index and Search Engine	20051212

Properties

Class	CL_SIC_SEARCH_TREX
Short Description	TREX Implementation of SIC Search Interface
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	S_IC_SEARCH_TREX	Information Consolidation Search TREX
Created	20051212	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_SIC_SEARCH_TREX has no forward declaration.

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_SIC_INDEX_SEARCH_ENGINE	☐	☐	Interface for Search Engine	20060419
2	IF_SIC_SEARCH_BUILDER	☐	☐	Interface for Index and Search Engine	20051212

Friends

Class CL_SIC_SEARCH_TREX has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_TREX_EXACT	Constant	Private	☐	Type reference (TYPE)	SIC_SRC_TYPE	'E'	TREX exact search	20060208
2	GC_TREX_EXTENDED	Constant	Private	☐	Type reference (TYPE)	SIC_SRC_TYPE	'G'	TREX extended search	20060419
3	GC_TREX_FUZZINESS	Constant	Private	☐	Type reference (TYPE)	I	100	Adaptor from SIC to TREX	20060208
4	GC_TREX_FUZZY	Constant	Private	☐	Type reference (TYPE)	SIC_SRC_TYPE	'F'	TREX fuzzy search	20060208
5	GC_TREX_MSG_ID	Constant	Private	☐	Type reference (TYPE)	SYMSGID	'SIC_SRC_TREX'	Message Class	20060209
6	GT_ALLOWED_FIELDS	Instance attribute	Private	☐	Type reference (TYPE)	SIC_T_NODE_FIELDS_NORM_TYPE		Table type for structure SIC_S_NODE_FIELDS	20060802
7	GT_CONFIG_PROVIDERS	Instance attribute	Private	☐	Type reference (TYPE)	SIC_T_CONFIGURATION_PROVIDER		Table type for SIC_S_CONFIGURATION_PROVIDER	20060802

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_SYSTEM_MESSAGE	Instance method	Private	Method	Add message from system variables	20061006
2	BUILD_QUERY	Instance method	Private	Method	Create the query	20051220
3	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20060802
4	CREATE_RESULT	Instance method	Private	Method	Create result	20060713
5	CREATE_RESULT_FROM_TABLE	Instance method	Private	Method	Create result from a table of objects	20060713
6	CREATE_TEST_DATA	Instance method	Private	Method	Create test data in simulation case	20060818
7	EXPAND_VALUE	Instance method	Private	Method	Get the values of all normalization types of a field	20060413
8	GET_REQ_ATTR	Instance method	Private	Method	Get the list with fields to be returned	20060224
9	GET_TREX_DESTINATION	Instance method	Private	Method	Get the TREX destination for the search	20060309

Events

Class CL_SIC_SEARCH_TREX has no event.

Types

Class CL_SIC_SEARCH_TREX has no local type.

Method Signatures

Method ADD_SYSTEM_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ET_MESSAGES	Value transfer	☐	Type reference (TYPE)	BAPIRETTAB		Table with BAPI Return Information	20061006
2	Importing	IT_MESSAGES	Call by reference	☐	Type reference (TYPE)	BAPIRETTAB		Table with BAPI Return Information	20061006

Method ADD_SYSTEM_MESSAGE on class CL_SIC_SEARCH_TREX has no exception.

Method BUILD_QUERY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_QUERY	Call by reference	☐	Type reference (TYPE)	TREXT_QUERY_ENTRIES		Search query	20051220
2	Importing	IS_STRATEGY	Call by reference	☐	Type reference (TYPE)	SIC_SRC_STRATEGY		Search strategy	20060109
3	Importing	IT_NORMALIZED_DATA	Call by reference	☐	Type reference (TYPE)	SIC_T_NORMALIZED_FIELD		Table type for structure SIC_S_NORMALIZED_FIELD	20051221
4	Importing	IV_BULK	Call by reference	☑	Type reference (TYPE)	SIC_BULK_QUERY_NR		Number of the bulk query	20060227

#	Exception	Resumable	Description	Created on
1	NO_FORMULA	☐	Formula has no text	20060419
2	NO_FORMULA_ID	☐	Formula doesn't exist	20060419

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_CONFIG_PROVIDERS	Call by reference	☑	Type reference (TYPE)	SIC_T_CONFIGURATION_PROVIDER		Table type for SIC_S_CONFIGURATION_PROVIDER	20060802

#	Exception	Resumable	Description	Created on
1	ERROR	☐	Internal error	20060822

Method CREATE_RESULT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ER_SINGLE_CONTAINER	Call by reference	☐	Object reference (TYPE REF TO)	CL_SIC_SINGLE_CONTAINER		Container for Instances of Class CL_SIC_OBJECT	20060713
2	Importing	IR_OBJECT_NODE	Call by reference	☐	Object reference (TYPE REF TO)	IF_SIC_OBJECT_NODE		Object Node	20060713
3	Importing	IT_QUERY	Call by reference	☐	Type reference (TYPE)	TREXT_QUERY_ENTRIES		Search query	20060713
4	Importing	IT_RESULT_OBJECTS	Call by reference	☐	Type reference (TYPE)	SIC_T_SEARCH_RESULT		Table type for structure SIC_S_SEARCH_RESULT	20060713
5	Importing	IV_MESSAGE	Call by reference	☑	Type reference (TYPE)	STRING		Text: Error message	20061006

Method CREATE_RESULT on class CL_SIC_SEARCH_TREX has no exception.

Method CREATE_RESULT_FROM_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_SINGLE_CONTAINER	Call by reference	☐	Type reference (TYPE)	SIC_T_SINGLE_CONTAINER		Table type for class CL_SIC_SINGLE_CONTAINER	20060713
2	Importing	IT_SRC_RESULTS	Call by reference	☐	Type reference (TYPE)	SIC_T_SRC_BUFFER		Table type for search; holds object and query	20060713
3	Importing	IV_MESSAGE	Call by reference	☑	Type reference (TYPE)	STRING		Text: Error message	20061006

Method CREATE_RESULT_FROM_TABLE on class CL_SIC_SEARCH_TREX has no exception.

Method CREATE_TEST_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ER_SINGLE_CONTAINER	Call by reference	☐	Object reference (TYPE REF TO)	CL_SIC_SINGLE_CONTAINER		Container for Instances of Class CL_SIC_OBJECT	20060818
2	Importing	IT_QUERY	Call by reference	☐	Type reference (TYPE)	TREXT_QUERY_ENTRIES		Search query	20060821
3	Importing	IT_RESULT_ITEM	Call by reference	☐	Type reference (TYPE)	TREXT_RESULT_DOCS		Result documents	20060818

Method CREATE_TEST_DATA on class CL_SIC_SEARCH_TREX has no exception.

Method EXPAND_VALUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_QUERY	Call by reference	☐	Type reference (TYPE)	TREXT_QUERY_ENTRIES		Search query	20060413
2	Importing	IS_QUERY	Call by reference	☐	Type reference (TYPE)	TREXS_QUERY_ENTRY		QueryEntry	20060413
3	Importing	IT_NORMALIZED_DATA	Call by reference	☐	Type reference (TYPE)	SIC_T_NORMALIZED_FIELD		Table type for structure SIC_S_NORMALIZED_FIELD	20060413
4	Importing	IV_BULK	Call by reference	☐	Type reference (TYPE)	SIC_BULK_QUERY_NR		Number of the bulk query	20060413
5	Importing	IV_FIELD	Call by reference	☐	Type reference (TYPE)	SIC_SRC_FORMULA		Field name	20060413

#	Exception	Resumable	Description	Created on
1	NOT_FILLED	☐	No value was found	20060413

Method GET_REQ_ATTR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_REQ_ATTR	Call by reference	☐	Type reference (TYPE)	TREXT_ATTRIBUTES		Attributes	20060224
2	Importing	IV_SERVICE_PROFILE	Call by reference	☐	Type reference (TYPE)	SIC_SERVICE_PROFILE		Service Profile	20060224

#	Exception	Resumable	Description	Created on
1	NOT_FOUND	☐	Fields not found	20060224

Method GET_TREX_DESTINATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_INDEX	Call by reference	☐	Type reference (TYPE)	TREXT_INDEXLIST		Indexes with language and rfc destination	20060309
2	Importing	IS_APPL	Call by reference	☐	Type reference (TYPE)	SIC_S_APPL_OBJECT_TYPE		Unique identification of application and object type	20060309
3	Importing	IV_SEARCH_ENGINE	Call by reference	☐	Type reference (TYPE)	SIC_INDEX_SEARCH_ENGINE		Define the index and search engine	20060309

#	Exception	Resumable	Description	Created on
1	ERROR	☐	Error transforming the SES index name	20060309
2	NO_DESTINATION	☐	There is no apropriate destination in customizing	20060309

History

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