SAP ABAP Class CL_DOC_CLASS_HIERARCHY (Document Class Hierarchy)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SRV-KPR-RET (Application Component) Text Retrieval and Information Extraction
     ⤷ SRET_DEMO (Package) Retrieval Demonstration

Properties

Class	CL_DOC_CLASS_HIERARCHY
Short Description	Document Class Hierarchy
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SRET_DEMO	Retrieval Demonstration
Created	20000425	SAP
Last change	00000000	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_DOC_CLASS_HIERARCHY has no forward declaration.

Interfaces

Class CL_DOC_CLASS_HIERARCHY has no interface implemented.

Friends

Class CL_DOC_CLASS_HIERARCHY has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	APPLICATION	Instance attribute	Private	☐	Type reference (TYPE)	SRET_ATRVL		Key: Application	20000425
2	INDEX_OF_CURRENT_CLASS	Instance attribute	Private	☐	Type reference (TYPE)	SRET_DBCNT		Index of Current Class	20000425
3	SEARCH_INDEX	Instance attribute	Private	☐	Type reference (TYPE)	SRET_CATID		Search Index	20000425
4	SRETCLASS_TAB	Instance attribute	Private	☐	Type reference (TYPE)	SRETCLASS_TAB		Classes as List	20000425
5	SRETINPOI_TAB	Instance attribute	Private	☐	Type reference (TYPE)	SRETINPOI_TAB		Relationship Between Index and Document Classes	20000425
6	USER	Instance attribute	Private	☐	Type reference (TYPE)	SYUNAME		Key: User	20000425

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	BUILD_HIERARCHY	Instance method	Private	Method	Build Hierarchy	20000425
2	CLEAR	Instance method	Public	Method	Delete Hierarchy and Documents	20000919
3	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20000425
4	CREATE_NEW_CLASS	Instance method	Public	Method	Create New Class	20000914
5	DELETE_CLASS	Instance method	Public	Method	Delete Class	20000914
6	DELETE_DOCUMENTS_FROM_INDEX	Instance method	Public	Method	Delete Documents from Index	20000919
7	DEQUEUE	Instance method	Private	Method	Set Unlock on Hierarchy	20000914
8	ENQUEUE	Instance method	Private	Method	Set Lock on Hierarchy	20000914
9	GET_ALL_CLASSES	Instance method	Public	Method	Get All Classes	20000710
10	GET_BEST_CATCHWORDS	Instance method	Public	Method	Extract Best Keywords	20000630
11	GET_BEST_DOC_CLASSES	Instance method	Public	Method	Classifies Document and Returns Best Classes	20000629
12	GET_CURRENT_CLASS	Instance method	Public	Method	Get Current Class	20000425
13	GET_CURRENT_PATH	Instance method	Public	Method	Get Current Path (Top Class to Current Class)	20000529
14	GET_KEY	Instance method	Public	Method	Get Hierarchy Key	20000425
15	GET_NEXT_FREE_COUNTER	Instance method	Public	Method	Get Free Index for New Class	20000621
16	GET_PATH	Instance method	Public	Method	Get Path from Top to Current Class	20000907
17	GET_PATH_UPTO_CURRENT_CLASS	Instance method	Public	Method	Get Path from Top to Current Class	20000616
18	GET_SEARCH_INDEX	Instance method	Private	Method	Get Search Index	20000425
19	GET_SIMILAR_TERMS	Instance method	Public	Method	Get Synonyms	20000731
20	GET_SUBCLASSES	Instance method	Public	Method	Get Subclasses	20000425
21	GET_TOP_LEVEL_INDEX	Instance method	Public	Method	Return Top Hierarchy Class as Index	20000620
22	READ_CLASSES_FROM_DB	Instance method	Private	Method	Read Classes from Database	20000425
23	SEARCH	Instance method	Public	Method	Find	20000425
24	SEE_ALSO	Instance method	Public	Method	Find Similar Documents	20000531
25	SET_CURRENT_CLASS	Instance method	Public	Method	Set Current Class	20000425

Events

Class CL_DOC_CLASS_HIERARCHY has no event.

Types

Class CL_DOC_CLASS_HIERARCHY has no local type.

Method Signatures

Method BUILD_HIERARCHY Signature

Method BUILD_HIERARCHY on class CL_DOC_CLASS_HIERARCHY has no parameter.

#	Exception	Resumable	Description	Created on
1	INTERNAL_ERROR	☐	Interner Fehler	20000425

Method CLEAR Signature

Method CLEAR on class CL_DOC_CLASS_HIERARCHY has no parameter.

#	Exception	Resumable	Description	Created on
1	ENQUEUE_ERROR	☐		20000919
2	INTERNAL_ERROR	☐		20000919

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_APPLICATION	Call by reference	☐	Type reference (TYPE)	SRET_APPL		Applikation	20000425
2	Importing	I_USER	Call by reference	☐	Type reference (TYPE)	SYUNAME		User	20000425

#	Exception	Resumable	Description	Created on
1	INTERNAL_ERROR	☐	Interner Fehler	20000425

Method CREATE_NEW_CLASS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_INDEX_TOP_CLASS	Call by reference	☐	Type reference (TYPE)	SRETCLASS-COUNTER		Index der oberen Klasse	20000920
2	Importing	I_NAME	Call by reference	☐	Type reference (TYPE)	SRETCLASS-CLASS		Name der Klasse	20000914

#	Exception	Resumable	Description	Created on
1	ENQUEUE_ERROR	☐		20000914
2	INTERNAL_ERROR	☐		20000914

Method DELETE_CLASS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_NEW_INDEX	Call by reference	☐	Type reference (TYPE)	SRETCLASS-COUNTER		Neue Dokumentenklasse	20001113
2	Importing	I_INDEX	Call by reference	☐	Type reference (TYPE)	SRETCLASS-COUNTER		Dokumentenklasse	20000920

#	Exception	Resumable	Description	Created on
1	CLASS_CONTAINS_DOCS	☐		20000914
2	ENQUEUE_ERROR	☐		20000914
3	INTERNAL_ERROR	☐		20000914

Method DELETE_DOCUMENTS_FROM_INDEX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_DOCIDS	Call by reference	☐	Type reference (TYPE)	SRETDOCID_TAB		Dokumenten-Ids	20000919

#	Exception	Resumable	Description	Created on
1	INTERNAL_ERROR	☐		20000919

Method DEQUEUE Signature

Method DEQUEUE on class CL_DOC_CLASS_HIERARCHY has no parameter.
Method DEQUEUE on class CL_DOC_CLASS_HIERARCHY has no exception.

Method ENQUEUE Signature

Method ENQUEUE on class CL_DOC_CLASS_HIERARCHY has no parameter.

#	Exception	Resumable	Description	Created on
1	ENQUEUE_ERROR	☐		20000914

Method GET_ALL_CLASSES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_CLASSES	Call by reference	☐	Type reference (TYPE)	SRETCLASS_TAB			20000710

Method GET_ALL_CLASSES on class CL_DOC_CLASS_HIERARCHY has no exception.

Method GET_BEST_CATCHWORDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_CATCHWORDS	Call by reference	☐	Type reference (TYPE)	SRETSRES_TAB		Merkmale	20000630
2	Importing	I_DOC_URL	Call by reference	☐	Type reference (TYPE)	STRING			20000630

#	Exception	Resumable	Description	Created on
1	INTERNAL_ERROR	☐	Interner Fehler	20000630

Method GET_BEST_DOC_CLASSES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_RESULTS	Call by reference	☐	Type reference (TYPE)	SRETSRES_TAB		Die besten Klassen fuer das Dokument	20000630
2	Importing	I_DOC_URL	Call by reference	☐	Type reference (TYPE)	STRING		Klassen	20000629

#	Exception	Resumable	Description	Created on
1	INTERNAL_ERROR	☐	Interner Fehler	20000629

Method GET_CURRENT_CLASS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_DOC_CLASS	Call by reference	☐	Object reference (TYPE REF TO)	CL_DOC_CLASS		Dokumentenklasse	20000425

#	Exception	Resumable	Description	Created on
1	INTERNAL_ERROR	☐	Interner Fehler	20000425

Method GET_CURRENT_PATH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_CLASSES	Call by reference	☐	Type reference (TYPE)	SRETCLASS_TAB		Klassen	20000529

Method GET_CURRENT_PATH on class CL_DOC_CLASS_HIERARCHY has no exception.

Method GET_KEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_APPLICATION	Call by reference	☐	Type reference (TYPE)	SRET_APPL		Applikation	20000425
2	Exporting	E_USER	Call by reference	☐	Type reference (TYPE)	SYUNAME		User	20000425

Method GET_KEY on class CL_DOC_CLASS_HIERARCHY has no exception.

Method GET_NEXT_FREE_COUNTER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_FREE_COUNTER	Call by reference	☐	Type reference (TYPE)	SRETCLASS-COUNTER		Zähler	20000621

Method GET_NEXT_FREE_COUNTER on class CL_DOC_CLASS_HIERARCHY has no exception.

Method GET_PATH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_CLASSES	Call by reference	☐	Type reference (TYPE)	SRETCLASS_TAB		Alle Klassen	20000907
2	Importing	I_INDEX	Call by reference	☐	Type reference (TYPE)	SRET_DBCNT		Klasse	20000911

Method GET_PATH on class CL_DOC_CLASS_HIERARCHY has no exception.

Method GET_PATH_UPTO_CURRENT_CLASS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_CLASSES	Call by reference	☐	Type reference (TYPE)	SRETCLASS_TAB		Alle Klassen	20000620
2	Importing	IT_TOP_CLASS	Call by reference	☐	Type reference (TYPE)	SRET_DBCNT		Klasse, von der die Suche angefangen wird	20000620

Method GET_PATH_UPTO_CURRENT_CLASS on class CL_DOC_CLASS_HIERARCHY has no exception.

Method GET_SEARCH_INDEX Signature

Method GET_SEARCH_INDEX on class CL_DOC_CLASS_HIERARCHY has no parameter.

#	Exception	Resumable	Description	Created on
1	INTERNAL_ERROR	☐	Interner Fehler	20000425

Method GET_SIMILAR_TERMS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_TERMS	Call by reference	☐	Type reference (TYPE)	SRETSIMRES_TAB		Ähnliche Begriffe: Ergebnisse	20000731
2	Importing	I_SEARCHSTRING	Call by reference	☐	Type reference (TYPE)	STRING		Suchstring	20000731

#	Exception	Resumable	Description	Created on
1	INTERNAL_ERROR	☐	Interner Fehler	20000731

Method GET_SUBCLASSES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_SUBCLASSES	Call by reference	☐	Type reference (TYPE)	SRETDOCCL_TAB		Subklassen	20000425
2	Importing	I_INDEX	Call by reference	☐	Type reference (TYPE)	SRET_DBCNT		Index der Klasse	20000425

#	Exception	Resumable	Description	Created on
1	INTERNAL_ERROR	☐	Interner Fehler	20000425

Method GET_TOP_LEVEL_INDEX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_INDEX	Call by reference	☐	Type reference (TYPE)	SRET_DBCNT		Index der obersten Klasse	20000620

#	Exception	Resumable	Description	Created on
1	INTERNAL_ERROR	☐	Interner Fehler	20000620

Method READ_CLASSES_FROM_DB Signature

Method READ_CLASSES_FROM_DB on class CL_DOC_CLASS_HIERARCHY has no parameter.

#	Exception	Resumable	Description	Created on
1	INTERNAL_ERROR	☐	Interner Fehler	20000425

Method SEARCH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_NUMBER_OF_RESULTS	Call by reference	☐	Type reference (TYPE)	I		Anzahl Ergebnisse	20000830
2	Exporting	E_SEARCH_RESULTS	Call by reference	☐	Type reference (TYPE)	SRETSRES_TAB		Ergebnisse Suchanfrage	20000518
3	Importing	I_BEGIN	Call by reference	☐	Type reference (TYPE)	I	1	Treffer von...	20000428
4	Importing	I_END	Call by reference	☐	Type reference (TYPE)	I	20	Treffer bis...	20000428
5	Importing	I_QUERY_TYPE	Call by reference	☐	Type reference (TYPE)	C	'PHRASE'	Verknüpfung der Terme: AND, OR, PHRASE	20000905
6	Importing	I_SEARCH_MODE	Call by reference	☐	Type reference (TYPE)	CHAR01	'E'	Suchtyp: F(uzzy), E(xact), L(inguistic)	20000905
7	Importing	I_SEARCH_STRING	Call by reference	☐	Type reference (TYPE)	C		Suchstring	20000428
8	Importing	I_SYNONYMS	Call by reference	☑	Type reference (TYPE)	SRETSIMRES_TAB		Ähnliche Begriffe: Ergebnisse	20000809
9	Importing	I_WITH_ADDITIONAL_INFO	Call by reference	☐	Type reference (TYPE)	CHAR01	' '	Features zum Dokument liefern	20000915

#	Exception	Resumable	Description	Created on
1	INTERNAL_ERROR	☐	Interner Fehler	20000428

Method SEE_ALSO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_NUMBER_OF_RESULTS	Call by reference	☐	Type reference (TYPE)	I		Anzahl Ergebnisse	20000830
2	Exporting	E_SEE_ALSO_RESULTS	Call by reference	☐	Type reference (TYPE)	SRETSRES_TAB		Ähnliche Dokumente	20000619
3	Importing	I_URLS	Call by reference	☐	Type reference (TYPE)	SRETURL_TAB		Dokumente	20000531
4	Importing	I_WITH_ADDITIONAL_INFO	Value transfer	☐	Type reference (TYPE)	CHAR01	' '	Mit zusätzlicher Info	20000918

#	Exception	Resumable	Description	Created on
1	INTERNAL_ERROR	☐	Interner Fehler	20000531

Method SET_CURRENT_CLASS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_INDEX	Call by reference	☐	Type reference (TYPE)	SRET_DBCNT		Index	20000425

#	Exception	Resumable	Description	Created on
1	INTERNAL_ERROR	☐	Interner Fehler	20000425

History

Last changed by/on	SAP	00000000
SAP Release Created in	50A