SAP ABAP Class CL_ABAP_DOCU_INDEX_SEARCH (Index Search of the ABAP Documentation)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-ABA-LA (Application Component) Syntax, Compiler, Runtime
     ⤷ SABAPDOCU (Package) ABAP Documentation Objects in ABAP Workbench

Properties

Class	CL_ABAP_DOCU_INDEX_SEARCH
Short Description	Index Search of the ABAP Documentation
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SABAPDOCU	ABAP Documentation Objects in ABAP Workbench
Created	20080129	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_ABAP_DOCU	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)

Interfaces

Class CL_ABAP_DOCU_INDEX_SEARCH has no interface implemented.

Friends

Class CL_ABAP_DOCU_INDEX_SEARCH has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	ASTERISK_EXCEPTIONS	Constant	Private	☐	Type reference (TYPE)	STRING	'* ** ->*'		20080129
2	C_LANGU	Static Attribute	Private	☐	Type reference (TYPE)	SY-LANGU			20080129
3	INDEX_CHECK	Static Attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL			20080129
4	RESULTS	Static Attribute	Private	☐	See coding				20080129
5	SIMILAR_FLAG	Static Attribute	Private	☐	See coding				20080129

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_EXAMPLE_LIST	Static method	Private	Method	Search in Examples List	20080129
2	ADD_GLOSSARY	Static method	Private	Method	Search in Glossary	20080129
3	ADD_SUBJECT_LIST	Static method	Private	Method	Search in Keyword List	20080129
4	AUTO_INDEX	Static method	Private	Method	Search in Automatic Index	20080129
5	CHECK_ELEMENT	Static method	Private	Method	Search by Language Element	20080129
6	CHECK_ENVIRON	Static method	Private	Method	Search by Environment	20080129
7	CHECK_FORMAT_OPT	Static method	Private	Method	Search by Formatting Option of Embedded Expressions	20080129
8	CHECK_FUNCTION	Static method	Private	Method	Search for Predefined Function	20080129
9	CHECK_KEYWORD	Static method	Private	Method	Search by Keyword	20080129
10	CHECK_SIMILAR	Static method	Private	Method	Check Similar	20080129
11	CHECK_STRING_TEMPL	Static method	Private	Method	Handle Character String Templates	20080129
12	CHECK_SYFIELD	Static method	Private	Method		20120710
13	CHECK_TABLE_EXPR	Static method	Private	Method	Handles table expressions	20121129
14	CHECK_TOKENS	Static method	Private	Method	Find Token Table	20080129
15	CHECK_TWO_WORDS	Static method	Private	Method	Find Two Words	20080129
16	CHECK_WORD	Static method	Private	Method	Find a Word	20080129
17	CONDENSE_TOKENS	Static method	Private	Method	Tokens	20080129
18	HANDLE_CONSTR_EXPR	Static method	Private	Method	Handles constructor expressions with #	20121206
19	HANDLE_PRAGMAS	Static method	Private	Method	Handle Pragmas	20080129
20	INTERSECT	Static method	Private	Method	Intersection from Different Searches	20080129
21	MAIN	Static method	Public	Method	Entry into Different Searches	20080129
22	SEARCH_SIMILAR	Static method	Private	Method	Similarity Search	20080129
23	SORT_EXAMPLES	Static method	Private	Method	Arrange Examples in Results List	20080129
24	SORT_GLOSRY	Static method	Private	Method	Arrange Glossary Entries in Results List	20080129
25	SORT_INTERNALS	Static method	Private	Method	Arrange Internal in Results List	20080129
26	SORT_OBSOLETES	Static method	Private	Method	Arrange Obsolete in Results List	20080129
27	SORT_OTHERS	Static method	Private	Method	Arrange Remaining in Results List	20080129
28	SORT_SPECIALS	Static method	Private	Method	Specifically Arrange in Results List	20080430
29	SORT_SUBJECTS	Static method	Private	Method	Arrange Keywords in Results List	20080129
30	STRUCTURE_RESULT_TAB	Static method	Private	Method		20100802

Events

Class CL_ABAP_DOCU_INDEX_SEARCH has no event.

Types

Class CL_ABAP_DOCU_INDEX_SEARCH has no local type.

Method Signatures

Method ADD_EXAMPLE_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	RESULT_TAB	Call by reference	☐	Attribute reference (LIKE)	RESULTS		RESULT_TAB	20080129
2	Importing	WORD	Call by reference	☐	Type reference (TYPE)	CSEQUENCE		WORD	20080129

Method ADD_EXAMPLE_LIST on class CL_ABAP_DOCU_INDEX_SEARCH has no exception.

Method ADD_GLOSSARY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	RESULT_TAB	Call by reference	☐	Attribute reference (LIKE)	RESULTS		RESULT_TAB	20080129
2	Importing	WORD	Call by reference	☐	Type reference (TYPE)	CSEQUENCE		WORD	20080129

Method ADD_GLOSSARY on class CL_ABAP_DOCU_INDEX_SEARCH has no exception.

Method ADD_SUBJECT_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	RESULT_TAB	Call by reference	☐	Attribute reference (LIKE)	RESULTS		RESULT_TAB	20080129
2	Importing	WORD	Call by reference	☐	Type reference (TYPE)	CSEQUENCE		WORD	20080129

Method ADD_SUBJECT_LIST on class CL_ABAP_DOCU_INDEX_SEARCH has no exception.

Method AUTO_INDEX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FIRST_WORD	Call by reference	☐	Type reference (TYPE)	CSEQUENCE		FIRST_WORD	20080129
2	Changing	RESULT_TAB	Call by reference	☐	Attribute reference (LIKE)	RESULTS		RESULT_TAB	20080129
3	Importing	WORD	Value transfer	☐	Type reference (TYPE)	CSEQUENCE		WORD	20080129

Method AUTO_INDEX on class CL_ABAP_DOCU_INDEX_SEARCH has no exception.

Method CHECK_ELEMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	RESULT_TAB	Call by reference	☐	Attribute reference (LIKE)	RESULTS		RESULT_TAB	20080129
2	Importing	WORD	Call by reference	☐	Type reference (TYPE)	CSEQUENCE		WORD	20080129

Method CHECK_ELEMENT on class CL_ABAP_DOCU_INDEX_SEARCH has no exception.

Method CHECK_ENVIRON Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	RESULT_TAB	Call by reference	☐	Attribute reference (LIKE)	RESULTS		RESULT_TAB	20080129
2	Importing	WORD	Call by reference	☐	Type reference (TYPE)	CSEQUENCE		WORD	20080129

Method CHECK_ENVIRON on class CL_ABAP_DOCU_INDEX_SEARCH has no exception.

Method CHECK_FORMAT_OPT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	RESULT_TAB	Call by reference	☐	Attribute reference (LIKE)	RESULTS		RESULT_TAB	20080129
2	Importing	WORD	Call by reference	☐	Type reference (TYPE)	CSEQUENCE		WORD	20080129

Method CHECK_FORMAT_OPT on class CL_ABAP_DOCU_INDEX_SEARCH has no exception.

Method CHECK_FUNCTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	RESULT_TAB	Call by reference	☐	Attribute reference (LIKE)	RESULTS		RESULT_TAB	20080129
2	Importing	WORD	Call by reference	☐	Type reference (TYPE)	CSEQUENCE		WORD	20080129

Method CHECK_FUNCTION on class CL_ABAP_DOCU_INDEX_SEARCH has no exception.

Method CHECK_KEYWORD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	FOUND_FLAG	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		FOUND_FLAG	20080129
2	Changing	MODE	Call by reference	☑	Type reference (TYPE)	CSEQUENCE		MODE	20080129
3	Changing	RESULT_TAB	Call by reference	☑	Attribute reference (LIKE)	RESULTS		RESULT_TAB	20080129
4	Importing	TOKENS	Call by reference	☑	Type reference (TYPE)	ABAPDOCU_TOKENS		TOKENS	20080129
5	Importing	WORD	Call by reference	☐	Type reference (TYPE)	CSEQUENCE		WORD	20080129

Method CHECK_KEYWORD on class CL_ABAP_DOCU_INDEX_SEARCH has no exception.

Method CHECK_SIMILAR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	RESULT_TAB	Call by reference	☐	Attribute reference (LIKE)	RESULTS		RESULT_TAB	20080129
2	Importing	WORD	Call by reference	☐	Type reference (TYPE)	CSEQUENCE		WORD	20080129

Method CHECK_SIMILAR on class CL_ABAP_DOCU_INDEX_SEARCH has no exception.

Method CHECK_STRING_TEMPL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	RESULT_TAB	Call by reference	☐	Attribute reference (LIKE)	RESULTS		RESULT_TAB	20080129
2	Importing	TOKENS	Call by reference	☐	Type reference (TYPE)	ABAPDOCU_TOKENS		TOKENS	20080129

Method CHECK_STRING_TEMPL on class CL_ABAP_DOCU_INDEX_SEARCH has no exception.

Method CHECK_SYFIELD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	RESULT_TAB	Call by reference	☐	Attribute reference (LIKE)	RESULTS			20120710
2	Importing	WORD	Call by reference	☐	Type reference (TYPE)	CSEQUENCE			20120710

Method CHECK_SYFIELD on class CL_ABAP_DOCU_INDEX_SEARCH has no exception.

Method CHECK_TABLE_EXPR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	RESULT_TAB	Call by reference	☐	Attribute reference (LIKE)	RESULTS			20121129
2	Importing	TOKENS	Call by reference	☐	Type reference (TYPE)	ABAPDOCU_TOKENS			20121129

Method CHECK_TABLE_EXPR on class CL_ABAP_DOCU_INDEX_SEARCH has no exception.

Method CHECK_TOKENS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FIRST_WORD	Call by reference	☐	Type reference (TYPE)	CSEQUENCE		FIRST_WORD	20080129
2	Importing	MODE	Call by reference	☐	Type reference (TYPE)	CSEQUENCE		MODE	20080129
3	Changing	RESULT_TAB	Call by reference	☐	Attribute reference (LIKE)	RESULTS		RESULT_TAB	20080129
4	Importing	TOKENS	Call by reference	☐	Type reference (TYPE)	ABAPDOCU_TOKENS		TOKENS	20080129
5	Importing	WORD	Call by reference	☐	Type reference (TYPE)	CSEQUENCE		WORD	20080129

Method CHECK_TOKENS on class CL_ABAP_DOCU_INDEX_SEARCH has no exception.

Method CHECK_TWO_WORDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FIRST_WORD	Call by reference	☐	Type reference (TYPE)	CSEQUENCE		FIRST_WORD	20080129
2	Importing	MODE	Call by reference	☐	Type reference (TYPE)	CSEQUENCE		MODE	20080129
3	Importing	NO_SIMILARS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	' '	NO_SIMILARS	20080129
4	Changing	RESULT_TAB	Call by reference	☐	Attribute reference (LIKE)	RESULTS		RESULT_TAB	20080129
5	Importing	WORD	Call by reference	☐	Type reference (TYPE)	CSEQUENCE		WORD	20080129

Method CHECK_TWO_WORDS on class CL_ABAP_DOCU_INDEX_SEARCH has no exception.

Method CHECK_WORD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	KEY_WORD	Value transfer	☑	Type reference (TYPE)	CSEQUENCE		KEY_WORD	20080129
2	Changing	RESULT_TAB	Call by reference	☐	Attribute reference (LIKE)	RESULTS		RESULT_TAB	20080129
3	Importing	WORD	Call by reference	☐	Type reference (TYPE)	CSEQUENCE		WORD	20080129

Method CHECK_WORD on class CL_ABAP_DOCU_INDEX_SEARCH has no exception.

Method CONDENSE_TOKENS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	TOKENS	Call by reference	☐	Type reference (TYPE)	ABAPDOCU_TOKENS		TOKENS	20080129

Method CONDENSE_TOKENS on class CL_ABAP_DOCU_INDEX_SEARCH has no exception.

Method HANDLE_CONSTR_EXPR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	RESULT_TAB	Call by reference	☐	Attribute reference (LIKE)	RESULTS			20121206
2	Importing	TOKENS	Call by reference	☐	Type reference (TYPE)	ABAPDOCU_TOKENS			20121206

Method HANDLE_CONSTR_EXPR on class CL_ABAP_DOCU_INDEX_SEARCH has no exception.

Method HANDLE_PRAGMAS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	RESULT_TAB	Call by reference	☐	Attribute reference (LIKE)	RESULTS		RESULT_TAB	20080129
2	Importing	WORD	Call by reference	☐	Type reference (TYPE)	CSEQUENCE		WORD	20080129

Method HANDLE_PRAGMAS on class CL_ABAP_DOCU_INDEX_SEARCH has no exception.

Method INTERSECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CHECK_TAB	Call by reference	☐	Attribute reference (LIKE)	RESULTS		CHECK_TAB	20080129
2	Changing	TAB	Call by reference	☐	Attribute reference (LIKE)	RESULTS		TAB	20080129

Method INTERSECT on class CL_ABAP_DOCU_INDEX_SEARCH has no exception.

Method MAIN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	EXAMPLES_FLAG	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	'X'	Beispiele berücksichtigen	20080129
2	Importing	FIRST_WORD	Call by reference	☐	Type reference (TYPE)	CSEQUENCE		Schlüsselwort	20080129
3	Importing	GLOSSARY_FLAG	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	'X'	Glossar berücksichtigen	20080129
4	Importing	INDEX_FLAG	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	'X'	ABAP-Index berücksichtigen	20080129
5	Importing	MODE	Value transfer	☐	Type reference (TYPE)	CSEQUENCE		ABAP oder Dynpro	20080129
6	Importing	NO_SIMILARS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	' '	Keine Ähnlickeitssuche	20080129
7	Importing	P_LANGU	Call by reference	☐	Type reference (TYPE)	SY-LANGU		Sprache	20080129
8	Exporting	RESULT_TAB	Call by reference	☐	Type reference (TYPE)	CL_ABAP_DOCU=>SEARCH_RESULTS		Ergebnistabelle	20080129
9	Exporting	STRUCTURED_RESULT_TAB	Call by reference	☐	Type reference (TYPE)	CL_ABAP_DOCU=>SEARCH_RESULTS			20100802
10	Importing	SUBJECTS_FLAG	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	'X'	Schlagwortliste berücksichtigen	20080129
11	Importing	TOKENS	Call by reference	☑	Type reference (TYPE)	ABAPDOCU_TOKENS		Token-Tabelle	20080129
12	Importing	WORD	Call by reference	☐	Type reference (TYPE)	CSEQUENCE		Suchwort	20080129

Method MAIN on class CL_ABAP_DOCU_INDEX_SEARCH has no exception.

Method SEARCH_SIMILAR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	EXAMPLES_FLAG	Call by reference	☐	Type reference (TYPE)	C		EXAMPLES_FLAG	20080129
2	Importing	GLOSRY_FLAG	Call by reference	☐	Type reference (TYPE)	C		GLOSRY_FLAG	20080129
3	Importing	INDEX_FLAG	Call by reference	☐	Type reference (TYPE)	C		INDEX_FLAG	20080129
4	Changing	RESULT_TAB	Call by reference	☐	Attribute reference (LIKE)	RESULTS		RESULT_TAB	20080129
5	Importing	SUBJECTS_FLAG	Call by reference	☐	Type reference (TYPE)	C		SUBJECTS_FLAG	20080129
6	Importing	WORD	Call by reference	☐	Type reference (TYPE)	CSEQUENCE		WORD	20080129

Method SEARCH_SIMILAR on class CL_ABAP_DOCU_INDEX_SEARCH has no exception.

Method SORT_EXAMPLES Signature

Method SORT_EXAMPLES on class CL_ABAP_DOCU_INDEX_SEARCH has no parameter.
Method SORT_EXAMPLES on class CL_ABAP_DOCU_INDEX_SEARCH has no exception.

Method SORT_GLOSRY Signature

Method SORT_GLOSRY on class CL_ABAP_DOCU_INDEX_SEARCH has no parameter.
Method SORT_GLOSRY on class CL_ABAP_DOCU_INDEX_SEARCH has no exception.

Method SORT_INTERNALS Signature

Method SORT_INTERNALS on class CL_ABAP_DOCU_INDEX_SEARCH has no parameter.
Method SORT_INTERNALS on class CL_ABAP_DOCU_INDEX_SEARCH has no exception.

Method SORT_OBSOLETES Signature

Method SORT_OBSOLETES on class CL_ABAP_DOCU_INDEX_SEARCH has no parameter.
Method SORT_OBSOLETES on class CL_ABAP_DOCU_INDEX_SEARCH has no exception.

Method SORT_OTHERS Signature

Method SORT_OTHERS on class CL_ABAP_DOCU_INDEX_SEARCH has no parameter.
Method SORT_OTHERS on class CL_ABAP_DOCU_INDEX_SEARCH has no exception.

Method SORT_SPECIALS Signature

Method SORT_SPECIALS on class CL_ABAP_DOCU_INDEX_SEARCH has no parameter.
Method SORT_SPECIALS on class CL_ABAP_DOCU_INDEX_SEARCH has no exception.

Method SORT_SUBJECTS Signature

Method SORT_SUBJECTS on class CL_ABAP_DOCU_INDEX_SEARCH has no parameter.
Method SORT_SUBJECTS on class CL_ABAP_DOCU_INDEX_SEARCH has no exception.

Method STRUCTURE_RESULT_TAB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	RESULT_TAB	Call by reference	☐	Type reference (TYPE)	CL_ABAP_DOCU=>SEARCH_RESULTS			20100802
2	Exporting	STRUCTURED_RESULT_TAB	Call by reference	☐	Type reference (TYPE)	CL_ABAP_DOCU=>SEARCH_RESULTS			20100802

Method STRUCTURE_RESULT_TAB on class CL_ABAP_DOCU_INDEX_SEARCH has no exception.

History

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