SAP ABAP Class CL_HCSKW_ANALYZER (Analysis of Static KW Library)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-HLP-ABA (Application Component) Help Infrastructure for ABAP
     ⤷ SHCS_FILE_STATIC_KW (Package) Help Center Search: File Access Functions for Static KW

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_HCSKW_C	Constants for Analysis of Static KW Libraries	20090903

Properties

Class	CL_HCSKW_ANALYZER
Short Description	Analysis of Static KW Library
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class
Program status
Category	0
Package	SHCS_FILE_STATIC_KW	Help Center Search: File Access Functions for Static KW
Created	20090730	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)
2	IF_HCSKW_C	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_HCSKW_C	☐	☐	Constants for Analysis of Static KW Libraries	20090903

Friends

Class CL_HCSKW_ANALYZER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	C_ENQ_PAR	Constant	Private	☐	See coding				20090903
2	C_ENQ_RESULT	Constant	Private	☐	See coding				20090903

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ANALYSIS	Static method	Private	Method	Analysis	20090903
2	ANALYZE_LIBRARY	Static method	Public	Method	Analyzes a KW library	20090903
3	CHECK_INPUT_PARAMETER	Static method	Private	Method	Check Input Parameters	20090903
4	CREATE_LIBRARY_ENTRY	Static method	Public	Method	Generates an entry for analysis of KW library	20090903
5	DELETE_LIBRARY_ENTRY	Static method	Public	Method	Deletes the entry for a KW library	20090903
6	DEQUEUE	Static method	Private	Method	Unlock KW Library	20090903
7	ENQUEUE	Static method	Private	Method	Lock Library	20090903
8	GET_DOC_STAT	Static method	Private	Method	Gets statistics on documents and texts	20090903
9	GET_EXTERNAL_STATUS	Static method	Private	Method	Gets status for external use	20090903
10	GET_LIBRARY_ENTRY	Static method	Public	Method	Gets entry for a library	20090903
11	GET_STATISTIC_DATA	Static method	Public	Method	Gets statistical data on analysis	20090903
12	GET_STATUS_TEXT	Static method	Private	Method	Gets long text for a status	20090903
13	GET_STAT_FOR_LOIO	Static method	Private	Method	Gets statistic records for LOIOs	20090903
14	GET_STAT_FOR_TEXT	Static method	Private	Method	Gets statistic records for texts for each language	20090903
15	GET_TAB_STAT	Static method	Private	Method	Gets statistic records on table entries	20090903
16	READ_LIBRARY_ENTRY	Static method	Private	Method	Gets entry for a library	20090903
17	RESET_LIBRARY_ANALYSIS	Static method	Public	Method	Resets analysis for a KW library	20090903
18	WAIT_FOR_NEXT_TRY	Static method	Private	Method	Wait Until New Lock Attempt	20090903

Events

Class CL_HCSKW_ANALYZER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_ENQ_RESULT	Private	Type reference (TYPE)	I	Result of Lock Attempt	20090903

Method Signatures

Method ANALYSIS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_GLOSSAR_ONLY	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20090903
2	Importing	I_LIBRARY	Call by reference	☐	Type reference (TYPE)	HCSKW_LIBRARY		Name einer KW Bibliothek (statisch)	20090903
3	Importing	I_PROTOCOL_LEVEL	Call by reference	☐	Type reference (TYPE)	I			20090903

Method ANALYSIS on class CL_HCSKW_ANALYZER has no exception.

Method ANALYZE_LIBRARY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_STATUS	Call by reference	☐	Type reference (TYPE)	HCSKW_PSTATUS		Status der Vorbereitung einer Indizierung	20090903
2	Importing	I_GLOSSAR_ONLY	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20090903
3	Importing	I_LIBRARY	Call by reference	☐	Type reference (TYPE)	HCSKW_LIBRARY		Name einer KW Bibliothek (statisch)	20090903
4	Importing	I_PROTOCOL_LEVEL	Call by reference	☐	Type reference (TYPE)	I	0	ausführlich (0) oder kurz (1)	20090903

Method ANALYZE_LIBRARY on class CL_HCSKW_ANALYZER has no exception.

Method CHECK_INPUT_PARAMETER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ASS_CLASS	Call by reference	☐	Type reference (TYPE)	SEOCLNAME		Klassenname	20090903
2	Importing	I_LANGUAGE_VECTOR	Call by reference	☐	Type reference (TYPE)	SCPLANGSS		Liste von Sprachen (als STRING)	20090903
3	Importing	I_LIBRARY	Call by reference	☐	Type reference (TYPE)	HCSKW_LIBRARY		Name einer KW Bibliothek (statisch)	20090903
4	Importing	I_LOGPATH	Call by reference	☐	Type reference (TYPE)	PATHINTERN		Logischer Pfadname	20090903
5	Importing	I_RFCDEST	Call by reference	☐	Type reference (TYPE)	HCSKW_HTTP_DEST		RFC Destination	20100419
6	Importing	I_STORAGE_TYPE	Call by reference	☐	Type reference (TYPE)	HCSKW_STORAGE_TYPE		Ablagetyp	20100419
7	Importing	I_USE_ALLOWED_LANGUAGES	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20090903
8	Importing	I_USE_ALL_LANGUAGES	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20090903

Method CHECK_INPUT_PARAMETER on class CL_HCSKW_ANALYZER has no exception.

Method CREATE_LIBRARY_ENTRY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ADDPATH	Call by reference	☑	Type reference (TYPE)	HCSKW_ADDPATH		Pfadangabe für KW Bibliothek (statisch)	20090903
2	Importing	I_ASS_CLASS	Call by reference	☐	Type reference (TYPE)	SEOCLNAME	SPACE	Name der Klasse zur Ermittlung der Anwendungszuordnungen	20090903
3	Importing	I_LANGUAGE_VECTOR	Call by reference	☑	Type reference (TYPE)	SCPLANGSS		Liste von Sprachen (als STRING)	20090903
4	Importing	I_LIBRARY	Call by reference	☐	Type reference (TYPE)	HCSKW_LIBRARY		Name einer KW Bibliothek (statisch)	20090903
5	Importing	I_LOGPATH	Call by reference	☑	Type reference (TYPE)	PATHINTERN		Logischer Pfadname	20090903
6	Importing	I_RFCDEST	Call by reference	☑	Type reference (TYPE)	HCSKW_HTTP_DEST		RFC Destination	20100419
7	Importing	I_STORAGE_TYPE	Call by reference	☐	Type reference (TYPE)	HCSKW_STORAGE_TYPE	IF_HCSKW_C=>STORAGE_TYPE-FILE_SHARE	Ablagetyp	20100419
8	Importing	I_USE_ALLOWED_LANGUAGES	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20090903
9	Importing	I_USE_ALL_LANGUAGES	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20090903
10	Returning	R_SUCCESS	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20090903

Method CREATE_LIBRARY_ENTRY on class CL_HCSKW_ANALYZER has no exception.

Method DELETE_LIBRARY_ENTRY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_LIBRARY	Call by reference	☐	Type reference (TYPE)	HCSKW_LIBRARY		Name einer KW Bibliothek (statisch)	20090903
2	Returning	R_SUCCESS	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20090903

Method DELETE_LIBRARY_ENTRY on class CL_HCSKW_ANALYZER has no exception.

Method DEQUEUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_LIBRARY	Call by reference	☐	Type reference (TYPE)	HCSKW_LIBRARY		Name einer KW Bibliothek (statisch)	20090903

Method DEQUEUE on class CL_HCSKW_ANALYZER has no exception.

Method ENQUEUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_LIBRARY	Call by reference	☐	Type reference (TYPE)	HCSKW_LIBRARY		Name einer KW Bibliothek (statisch)	20090903
2	Returning	R_ENQ_RESULT	Value transfer	☐	Type reference (TYPE)	TY_ENQ_RESULT		Resultat eines Sperrversuches	20090903

Method ENQUEUE on class CL_HCSKW_ANALYZER has no exception.

Method GET_DOC_STAT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_KWDIR	Call by reference	☐	Type reference (TYPE)	HCSKW_DIR		Verzeichnis für statische KW Hilfe	20090903
2	Returning	RT_DOC_STAT	Value transfer	☐	Type reference (TYPE)	THCSKW_DOC_STAT		Statistiksatz für Dokumente	20090903

Method GET_DOC_STAT on class CL_HCSKW_ANALYZER has no exception.

Method GET_EXTERNAL_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_GLOSSAR_ONLY	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20090903
2	Importing	I_STATUS	Call by reference	☐	Type reference (TYPE)	HCSKW_PSTATUS		Status der Vorbereitung einer Indizierung	20090903
3	Returning	R_STATUS	Value transfer	☐	Type reference (TYPE)	HCSKW_PSTATUS		Status der Vorbereitung einer Indizierung	20090903

Method GET_EXTERNAL_STATUS on class CL_HCSKW_ANALYZER has no exception.

Method GET_LIBRARY_ENTRY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_ADDPATH	Call by reference	☐	Type reference (TYPE)	HCSKW_ADDPATH		Pfadangabe für KW Bibliothek (statisch)	20090903
2	Exporting	E_ALLLANG	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		alle sprachen der Bibliothek analysieren	20090903
3	Exporting	E_ALLOWLANG	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		erlaubte Sprachen im System analysieren	20090903
4	Exporting	E_LANGVECT	Call by reference	☐	Type reference (TYPE)	SCPLANGSS		Liste von Sprachen (als STRING)	20090903
5	Exporting	E_LOGPATH	Call by reference	☐	Type reference (TYPE)	PATHINTERN		Logischer Pfadname	20090903
6	Exporting	E_RFCDEST	Call by reference	☐	Type reference (TYPE)	HCSKW_HTTP_DEST		RFC Destination	20100419
7	Exporting	E_STATUS	Call by reference	☐	Type reference (TYPE)	HCSKW_PSTATUS		Status der Vorbereitung einer Indizierung	20090903
8	Exporting	E_STORAGE_TYPE	Call by reference	☐	Type reference (TYPE)	HCSKW_STORAGE_TYPE		Ablagetyp	20100419
9	Importing	I_GLOSSAR_ONLY	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	nur Glossar bearbeiten	20090903
10	Importing	I_LIBRARY	Value transfer	☐	Type reference (TYPE)	HCSKW_LIBRARY		Name einer KW Bibliothek (statisch)	20090903

Method GET_LIBRARY_ENTRY on class CL_HCSKW_ANALYZER has no exception.

Method GET_STATISTIC_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_DOC_STAT	Call by reference	☐	Type reference (TYPE)	THCSKW_DOC_STAT		Statistiksatz für Dokumente	20090903
2	Exporting	ET_TAB_STAT	Call by reference	☐	Type reference (TYPE)	THCSKW_COUNT		Zähler für Statistiken	20090903
3	Exporting	E_EXT_STATUS	Call by reference	☐	Type reference (TYPE)	HCSKW_PSTATUS		Status der Vorbereitung einer Indizierung	20090903
4	Exporting	E_EXT_STATUS_TEXT	Call by reference	☐	Type reference (TYPE)	STRING		Langtext für Status	20090903
5	Exporting	E_KWDIR	Call by reference	☐	Type reference (TYPE)	HCSKW_DIR		Verzeichnis für statische KW Hilfe	20090903
6	Exporting	E_STATUS_TEXT	Call by reference	☐	Type reference (TYPE)	STRING			20090903
7	Importing	I_GLOSSAR_ONLY	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20090903
8	Importing	I_LIBRARY	Call by reference	☐	Type reference (TYPE)	HCSKW_LIBRARY		Name der Analyse einer KW Bibliothek (statisch)	20090903

Method GET_STATISTIC_DATA on class CL_HCSKW_ANALYZER has no exception.

Method GET_STATUS_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_STATUS	Call by reference	☐	Type reference (TYPE)	HCSKW_PSTATUS		Status der Vorbereitung einer Indizierung	20090903
2	Returning	R_TEXT	Value transfer	☐	Type reference (TYPE)	STRING			20090903

Method GET_STATUS_TEXT on class CL_HCSKW_ANALYZER has no exception.

Method GET_STAT_FOR_LOIO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_LIBID	Call by reference	☐	Type reference (TYPE)	HCSKW_LIBID		Id für eine KW Bibliothek	20090903
2	Returning	RT_DOC_STAT	Value transfer	☐	Type reference (TYPE)	THCSKW_DOC_STAT		Statistiksatz für Dokumente	20090903

Method GET_STAT_FOR_LOIO on class CL_HCSKW_ANALYZER has no exception.

Method GET_STAT_FOR_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_DOC_STAT	Call by reference	☐	Type reference (TYPE)	THCSKW_DOC_STAT		Statistiksatz für Dokumente	20090903
2	Importing	I_LANG	Call by reference	☐	Type reference (TYPE)	SPRAS		Sprachenschlüssel	20090903
3	Importing	I_LIBID	Call by reference	☐	Type reference (TYPE)	HCSKW_LIBID		Id für eine KW Bibliothek	20090903

Method GET_STAT_FOR_TEXT on class CL_HCSKW_ANALYZER has no exception.

Method GET_TAB_STAT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ET_TAB_STAT	Value transfer	☐	Type reference (TYPE)	THCSKW_COUNT		Zähler für Statistiken	20090903
2	Importing	I_LIBID	Call by reference	☐	Type reference (TYPE)	HCSKW_LIBID		Id für eine KW Bibliothek	20090903

Method GET_TAB_STAT on class CL_HCSKW_ANALYZER has no exception.

Method READ_LIBRARY_ENTRY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_LIBRARY	Value transfer	☐	Type reference (TYPE)	HCSKW_LIBRARY		Name einer KW Bibliothek (statisch)	20090903
2	Returning	R_KWDIR	Value transfer	☐	Type reference (TYPE)	HCSKW_DIR		Verzeichnis für statische KW Hilfe	20090903

Method READ_LIBRARY_ENTRY on class CL_HCSKW_ANALYZER has no exception.

Method RESET_LIBRARY_ANALYSIS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_LIBRARY	Call by reference	☐	Type reference (TYPE)	HCSKW_LIBRARY		Name einer KW Bibliothek (statisch)	20090903
2	Returning	R_SUCCESS	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20090903

Method RESET_LIBRARY_ANALYSIS on class CL_HCSKW_ANALYZER has no exception.

Method WAIT_FOR_NEXT_TRY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_GLOSSAR_ONLY	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20090903
2	Importing	I_LIBRARY	Call by reference	☐	Type reference (TYPE)	HCSKW_LIBRARY		Name einer KW Bibliothek (statisch)	20090903
3	Returning	R_STATUS	Value transfer	☐	Type reference (TYPE)	HCSKW_PSTATUS		Status der Vorbereitung einer Indizierung	20090903

Method WAIT_FOR_NEXT_TRY on class CL_HCSKW_ANALYZER has no exception.

History

Last changed by/on	SAP	20110908
SAP Release Created in