SAP ABAP Class CL_TREX_TEST_INDEX (Index)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-TRX-API (Application Component) TREX ABAP + JAVA API
     ⤷ STREX (Package) TREX ABAP client

Properties

Class	CL_TREX_TEST_INDEX
Short Description	Index
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	STREX	TREX ABAP client
Created	20051117	SAP
Last change	20130531	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)
2	CL_TREX_TEST_INDEX	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)

Interfaces

Class CL_TREX_TEST_INDEX has no interface implemented.

Friends

Class CL_TREX_TEST_INDEX has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	C_DOC_ACTION_DEINDEX	Constant	Public	☐	Type reference (TYPE)	TREXD_INDEX_ACTION	'D'	Document action for indexing.	20080506
2	C_DOC_ACTION_INDEX	Constant	Public	☐	Type reference (TYPE)	TREXD_INDEX_ACTION	'I'	Document action for indexing.	20080506
3	C_DOC_ACTION_UPDATE	Constant	Public	☐	Type reference (TYPE)	TREXD_INDEX_ACTION	'U'	Document action for indexing.	20080506
4	FACADE	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_TREX_TEST_FACADE		Facade to TREX for Testing	20070920
5	ID	Instance attribute	Public	☑	Type reference (TYPE)	TREXD_INDEX_ID		Index Id	20070920
6	LANG	Instance attribute	Public	☑	Type reference (TYPE)	ISOLA		SAP Language Key (2-letter code)	20070920

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	AGGREGATE	Instance method	Public	Method		20061218
2	BULK_SEARCH	Instance method	Public	Method		20100505
3	CLEAR	Instance method	Public	Method		20051124
4	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20051117
5	CREATE_FOR_RFCDEST	Static method	Public	Method		20070112
6	DEINDEX_CELL_TABLE	Instance method	Public	Method		20051207
7	DEINDEX_CELL_TABLE_V2	Instance method	Public	Method		20070221
8	DEINDEX_TABLE_RFC	Instance method	Public	Method		20060405
9	DELETE	Instance method	Public	Method		20051117
10	GENERATE_DOCUMENT_TABLE	Static method	Public	Method		20110404
11	GET_DATA_MATRIX	Instance method	Public	Method		20061109
12	INDEX_CELL_TABLE	Instance method	Public	Method		20051121
13	INDEX_CELL_TABLE_V2	Instance method	Public	Method		20070221
14	INDEX_DOC_FROM_TABLE	Instance method	Public	Method		20110404
15	INDEX_TABLE_RFC	Instance method	Public	Method		20060405
16	OPTIMIZE	Instance method	Public	Method		20051117
17	SEARCH_DOCUMENTS	Instance method	Public	Method		20060213
18	SEARCH_TABLE	Instance method	Public	Method		20061214
19	SHOW_INDEX_INFO	Instance method	Public	Method		20070426
20	SIMPLE_SEARCH_TABLE	Instance method	Public	Method		20070215

Events

Class CL_TREX_TEST_INDEX has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	SEARCH_TABLE_REQ_TAB	Public	See coding			20100506	search_table_req_tab TYPE STANDARD TABLE OF REF TO cl_trex_search_cell_table_req
2	SEARCH_TABLE_RES_TAB	Public	See coding			20100506	search_table_res_tab TYPE STANDARD TABLE OF REF TO cl_trex_search_cell_table_res

Method Signatures

Method AGGREGATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	REQUEST	Call by reference	☐	Object reference (TYPE REF TO)	CL_TREX_AGGREGATE_REQ		Basis Client: Request for Aggregation	20061218
2	Importing	RESPONSE	Call by reference	☐	Object reference (TYPE REF TO)	CL_TREX_AGGREGATE_RES		Basis Client: Response for Aggregation	20061218

#	Exception	Resumable	Description	Created on
1	CX_TREX_NO_SERVER	☐		20061218
2	CX_TREX_REMOTE_COMMUNICATION	☐		20061218
3	CX_TREX_SERVER	☐		20061218

Method BULK_SEARCH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	REQUESTS	Call by reference	☐	Type reference (TYPE)	CL_TREX_TEST_INDEX=>SEARCH_TABLE_REQ_TAB		input parameters for bulk search	20100505
2	Exporting	RESPONSES	Call by reference	☐	Type reference (TYPE)	CL_TREX_TEST_INDEX=>SEARCH_TABLE_RES_TAB		ouput parameters for bulk search	20100505

Method BULK_SEARCH on class CL_TREX_TEST_INDEX has no exception.

Method CLEAR Signature

Method CLEAR on class CL_TREX_TEST_INDEX has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_TREX_REMOTE_COMMUNICATION	☐		20051124
2	CX_TREX_SERVER	☐		20051124

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FACADE	Call by reference	☐	Object reference (TYPE REF TO)	CL_TREX_TEST_FACADE			20051117
2	Importing	ID	Call by reference	☐	Type reference (TYPE)	TREXD_INDEX_ID			20051117
3	Importing	LANG	Call by reference	☑	Type reference (TYPE)	ISOLA		SAP Language Key (2-letter code)	20070920

Method CONSTRUCTOR on class CL_TREX_TEST_INDEX has no exception.

Method CREATE_FOR_RFCDEST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID	Call by reference	☐	Type reference (TYPE)	TREXD_INDEX_ID		Index Id	20070112
2	Importing	LANG	Call by reference	☑	Type reference (TYPE)	ISOLA		SAP Language Key (2-letter code)	20070112
3	Importing	RFCDEST	Call by reference	☐	Type reference (TYPE)	RFCDEST		Logical Destination (Specified in Function Call)	20070112
4	Returning	RVAL	Value transfer	☐	Object reference (TYPE REF TO)	CL_TREX_TEST_INDEX		Index	20070112

Method CREATE_FOR_RFCDEST on class CL_TREX_TEST_INDEX has no exception.

Method DEINDEX_CELL_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DOC_ACTION	Call by reference	☐	Type reference (TYPE)	TREXD_INDEX_ACTION	C_DOC_ACTION_DEINDEX	Document action for indexing.	20080506
2	Importing	IGNORE_CONV_ERROR	Call by reference	☐	Type reference (TYPE)	TREX_RFC-BOOLEAN	0	0: false, 1: true	20080825
3	Importing	IGNORE_LOGICAL_INDEX	Call by reference	☐	Type reference (TYPE)	NUM1	'0'	Numeric 1-character	20090205
4	Importing	IS_AUTO_OPTIMIZE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20060130
5	Importing	TABLE	Call by reference	☐	Object reference (TYPE REF TO)	CL_TREX_TABLE			20051207

#	Exception	Resumable	Description	Created on
1	CX_TREX_REMOTE_COMMUNICATION	☐		20051207
2	CX_TREX_SERVER	☐		20051207

Method DEINDEX_CELL_TABLE_V2 Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DOC_ACTION	Call by reference	☐	Type reference (TYPE)	TREXD_INDEX_ACTION	C_DOC_ACTION_DEINDEX	Document action for indexing.	20080506
2	Importing	IGNORE_CONV_ERROR	Call by reference	☐	Type reference (TYPE)	TREX_RFC-BOOLEAN	0	0: false, 1: true	20080825
3	Importing	IGNORE_LOGICAL_INDEX	Call by reference	☐	Type reference (TYPE)	NUM1	'0'	Numeric 1-character	20090205
4	Importing	IS_AUTO_OPTIMIZE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20070221
5	Importing	TABLE	Call by reference	☐	Object reference (TYPE REF TO)	CL_TREX_TABLE		Internal Table Abstraction	20070221

#	Exception	Resumable	Description	Created on
1	CX_TREX_REMOTE_COMMUNICATION	☐	Remote Communication Exception	20070221
2	CX_TREX_SERVER	☐	Error returned from Server	20070221

Method DEINDEX_TABLE_RFC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_AUTO_OPTIMIZE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20060405
2	Importing	TABLE	Call by reference	☐	Object reference (TYPE REF TO)	CL_TREX_TEST_TABLE		Generic Table for Testing	20060405

#	Exception	Resumable	Description	Created on
1	CX_TREX_REMOTE_COMMUNICATION	☐		20060405
2	CX_TREX_SERVER	☐		20060405

Method DELETE Signature

Method DELETE on class CL_TREX_TEST_INDEX has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_TREX_REMOTE_COMMUNICATION	☐		20051117
2	CX_TREX_SERVER	☐	Fehler vom Server zurückgegeben	20051117

Method GENERATE_DOCUMENT_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	DOC_TABLE	Call by reference	☐	Type reference (TYPE)	TREXT_INDEX_DOCS		Documents for indexing	20110404
2	Importing	ITAB	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE			20110404

#	Exception	Resumable	Description	Created on
1	CX_TREX_BAD_REQUEST	☐	Unexpected data received from application.	20110404
2	CX_TREX_PROXY	☐	Proxy Exception	20110404

Method GET_DATA_MATRIX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	REQUEST	Call by reference	☐	Object reference (TYPE REF TO)	CL_TREX_AGGREGATE_REQ		Basis Client: Request for Aggregation	20061109
2	Importing	RESPONSE	Call by reference	☐	Object reference (TYPE REF TO)	CL_TREX_AGGREGATE_RES		Basis Client: Response for Aggregation	20061109

#	Exception	Resumable	Description	Created on
1	CX_TREX_NO_SERVER	☐		20061109
2	CX_TREX_REMOTE_COMMUNICATION	☐		20061109
3	CX_TREX_SERVER	☐		20061109

Method INDEX_CELL_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DOC_ACTION	Call by reference	☐	Type reference (TYPE)	TREXD_INDEX_ACTION	C_DOC_ACTION_INDEX	Document action for indexing.	20080506
2	Importing	IGNORE_CONV_ERROR	Call by reference	☐	Type reference (TYPE)	TREX_RFC-BOOLEAN	0	0: false, 1: true	20080825
3	Importing	IGNORE_LOGICAL_INDEX	Call by reference	☐	Type reference (TYPE)	NUM1	'0'	Numeric 1-character	20090205
4	Importing	IS_AUTO_OPTIMIZE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20060130
5	Importing	SET_DEFAULT_ATTR_NAME	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20060816
6	Importing	TABLE	Call by reference	☐	Object reference (TYPE REF TO)	CL_TREX_TABLE			20051121

#	Exception	Resumable	Description	Created on
1	CX_TREX_REMOTE_COMMUNICATION	☐		20051121
2	CX_TREX_SERVER	☐		20051121

Method INDEX_CELL_TABLE_V2 Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DOC_ACTION	Call by reference	☐	Type reference (TYPE)	TREXD_INDEX_ACTION	C_DOC_ACTION_INDEX	Document action for indexing.	20080506
2	Importing	IGNORE_CONV_ERROR	Call by reference	☐	Type reference (TYPE)	TREX_RFC-BOOLEAN	0		20080825
3	Importing	IGNORE_LOGICAL_INDEX	Call by reference	☐	Type reference (TYPE)	NUM1	'0'	Numeric 1-character	20090205
4	Importing	IS_AUTO_OPTIMIZE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20070221
5	Importing	SET_DEFAULT_ATTR_NAME	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20070221
6	Importing	TABLE	Call by reference	☐	Object reference (TYPE REF TO)	CL_TREX_TABLE		Internal Table Abstraction	20070221

#	Exception	Resumable	Description	Created on
1	CX_TREX_REMOTE_COMMUNICATION	☐	Remote Communication Exception	20070221
2	CX_TREX_SERVER	☐	Error returned from Server	20070221

Method INDEX_DOC_FROM_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	TABLE	Call by reference	☐	Object reference (TYPE REF TO)	CL_TREX_TABLE		Internal Table Abstraction	20110404

#	Exception	Resumable	Description	Created on
1	CX_TREX_BAD_REQUEST	☐	Unexpected data received from application.	20110404
2	CX_TREX_PROXY	☐	Proxy Exception	20110404
3	CX_TREX_REMOTE_COMMUNICATION	☐	Remote Communication Exception	20110404
4	CX_TREX_SERVER	☐	Error returned from Server	20110404

Method INDEX_TABLE_RFC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_AUTO_OPTIMIZE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20060405
2	Importing	TABLE	Call by reference	☐	Object reference (TYPE REF TO)	CL_TREX_TABLE			20060405

#	Exception	Resumable	Description	Created on
1	CX_TREX_REMOTE_COMMUNICATION	☐		20060405
2	CX_TREX_SERVER	☐		20060405

Method OPTIMIZE Signature

Method OPTIMIZE on class CL_TREX_TEST_INDEX has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_TREX_REMOTE_COMMUNICATION	☐		20051117
2	CX_TREX_SERVER	☐		20051117

Method SEARCH_DOCUMENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ADMINISTERED_RESULT_DOCS	Call by reference	☐	Type reference (TYPE)	TREXT_RESULT_DOCS		Result documents	20091214
2	Exporting	ATTR_DIST_OVERVIEWS	Call by reference	☐	Type reference (TYPE)	TREXT_ATTR_DIST_OVERVIEWS		Attribute distribution overviews	20091214
3	Importing	HIGHLIGHT_ATTRIBUTES	Call by reference	☑	Type reference (TYPE)	TREXT_ATTRIBUTES		Attributes	20091214
4	Importing	REQUEST	Call by reference	☐	Object reference (TYPE REF TO)	CL_TREX_SEARCH_CELL_TABLE_REQ			20091214
5	Exporting	RESPONSE	Call by reference	☐	Object reference (TYPE REF TO)	CL_TREX_SEARCH_CELL_TABLE_RES		Basis Client: Response for Search Cell Table	20091214
6	Exporting	RESULT_DOCS	Call by reference	☐	Type reference (TYPE)	TREXT_RESULT_DOCS		Result documents	20060213
7	Importing	SNIPPET_ATTRIBUTES	Call by reference	☑	Type reference (TYPE)	TREXT_ATTRIBUTES			20091214
8	Exporting	SUGGESTED_TERMS	Call by reference	☐	Type reference (TYPE)	TREXT_SUGGESTED_TERM		Suggested terms (did you mean)	20091214
9	Exporting	TERM_ATTR_INFOS	Call by reference	☐	Type reference (TYPE)	TREXT_TERM_ATTR_INFOS		term attr info	20091214
10	Exporting	TRACE	Call by reference	☐	Type reference (TYPE)	TREXT_TRACE_LINES		Trace	20091214

#	Exception	Resumable	Description	Created on
1	CX_TREX_REMOTE_COMMUNICATION	☐		20060213
2	CX_TREX_SERVER	☐		20060213

Method SEARCH_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	REQUEST	Call by reference	☐	Object reference (TYPE REF TO)	CL_TREX_SEARCH_CELL_TABLE_REQ		Basis Client: Request for Search Cell Table	20061214
2	Importing	RESPONSE	Call by reference	☐	Object reference (TYPE REF TO)	CL_TREX_SEARCH_CELL_TABLE_RES		Basis Client: Response for Search Cell Table	20061214

#	Exception	Resumable	Description	Created on
1	CX_TREX_NO_SERVER	☐		20061214
2	CX_TREX_REMOTE_COMMUNICATION	☐		20061214
3	CX_TREX_SERVER	☐		20061214

Method SHOW_INDEX_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	QUERY	Call by reference	☐	Type reference (TYPE)	STRING			20070426
2	Exporting	RESULT	Call by reference	☐	Type reference (TYPE)	TREXT_TOPOLOGY		Table containing the topology tree in flat format	20070426

#	Exception	Resumable	Description	Created on
1	CX_TREX_REMOTE_COMMUNICATION	☐	Remote Communication Exception	20070426
2	CX_TREX_SERVER	☐	Error returned from Server	20070426

Method SIMPLE_SEARCH_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	REQUEST	Call by reference	☐	Object reference (TYPE REF TO)	CL_TREX_SIMPL_SEARCH_TABLE_REQ		Basis Client: Request for Simple Search Table	20070215
2	Importing	RESPONSE	Call by reference	☐	Object reference (TYPE REF TO)	CL_TREX_SIMPL_SEARCH_TABLE_RES		Basis Client: Response for Simple Search Table	20070215

#	Exception	Resumable	Description	Created on
1	CX_TREX_BAD_REQUEST	☐	Unexpected data received from application.	20080826
2	CX_TREX_NO_SERVER	☐		20070215
3	CX_TREX_REMOTE_COMMUNICATION	☐		20070215
4	CX_TREX_SERVER	☐		20070215

History

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