SAP ABAP Class CL_ESH_QL_SEARCHTERM_STAT (Search Term Statistics Handler)
Hierarchy
SAP_BASIS (Software Component) SAP Basis Component
   BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
     S_ESH_ENG_QUERY_LOGGING (Package) Query Logging
Properties
Class CL_ESH_QL_SEARCHTERM_STAT  
Short Description Search Term Statistics Handler    
Super Class    
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status     
Category 0   
Package S_ESH_ENG_QUERY_LOGGING   Query Logging 
Created 20100127   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)
Interfaces
Class CL_ESH_QL_SEARCHTERM_STAT has no interface implemented.
Friends
# Friend Modeled only Created on Description
1 CL_ESH_CM_TERM_SUGGESTIONS 20100331 Public API for Search Term Suggestions
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 GC_DEFAULT_RANKVALUE_THRESHOLD Constant Public Type reference (TYPE) INT4 500 Default rank value threshold for extraction 20100413
2 MR_QT_PROCESSOR Instance attribute Private Object reference (TYPE REF TO) CL_ESH_QT_QLOG_PROCESSOR Evaluate query log queries 20100331
3 MR_REGEX_HANDLER Instance attribute Private Object reference (TYPE REF TO) CL_ESH_QL_SEARCHTERM_REGEX Regex handler for search terms/exclusions 20100420
4 MV_CURR_BLOCKNO Instance attribute Private Type reference (TYPE) INT4 Block number (for SAVE) 20100401
5 MV_EXEC_TSP Instance attribute Private Type reference (TYPE) TIMESTAMPL Execution timestamp 20100408
6 MV_RANKVALUE_THRESHOLD Instance attribute Private Type reference (TYPE) INT4 Rank value threshold 20100413
Methods
# Method Level Visibility Method type Description Created on
1 AGGREGATE_TERMS_BY_WEIGHT Instance method Private Method Aggregate terms by weight 20100413
2 DB_UPDATE_EXCL_DEL Instance method Private Method Del exclusions (DB) 20100407
3 DB_UPDATE_EXCL_DEL_ALL Instance method Private Method Del exclusions (DB) all 20100407
4 DB_UPDATE_EXCL_SET Instance method Private Method Set exclusions (DB) 20100407
5 DB_UPDATE_TERMS_DEL Instance method Private Method Del terms (DB) 20100407
6 DB_UPDATE_TERMS_DEL_ALL Instance method Private Method Del terms (DB) all 20100407
7 DB_UPDATE_TERMS_DEL_EXCLUDED Instance method Private Method Del terms (DB) on exclusion analysis 20100412
8 DB_UPDATE_TERMS_SET Instance method Private Method Set terms (DB) 20100407
9 EXCLUSIONS_DEL_AFFECTED_TERMS Instance method Private Method Exclusions: Delete affected terms 20100412
10 EXCLUSIONS_GET_AFFECTED_TERMS Instance method Private Method Exclusions: Get affected terms 20100412
11 EXCLUSIONS_VALIDATE Instance method Private Method Validate exclusions 20100412
12 EXCLUSION_DELETIONS_VALIDATE Instance method Private Method Validate exclusion deletions 20100412
13 GET_EXEC_TIMESTAMP Instance method Protected Method Get exec timestamp 20100408
14 GET_INSTANCE Static method Public Method Get instance 20100127
15 GET_NEXT_BLOCKNO Instance method Private Method Get next block number for DB update 20100401
16 PROCESS_NEXT Instance method Public Method Process next 20100127
17 PROCESS_NEXT_BY_TIME Instance method Public Method Process next (timed) 20100127
18 PROVIDE_DATA_BY_ID Instance method Public Method Provide data by ID 20100127
19 SET_EXCLUSIONS Instance method Protected Method Set exclusions 20100331
20 SET_TERMS Instance method Protected Method Content management: Set terms 20100331
21 TERMS_CHECK_EXCLUSIONS Instance method Private Method Check exclusions 20100406
22 TERMS_SET_WEIGHTED_RANK Instance method Private Method Normalize rank values 20100406
23 TERMS_VALIDATE Instance method Private Method Validate terms 20100406
24 TERM_DELETIONS_VALIDATE Instance method Private Method Validate term deletions 20100407
25 UPDATE_BLOCK_GET_TIMESTAMP Instance method Private Method Update block: Set timestamp 20100412
Events
Class CL_ESH_QL_SEARCHTERM_STAT has no event.
Types
Class CL_ESH_QL_SEARCHTERM_STAT has no local type.
Method Signatures

Method AGGREGATE_TERMS_BY_WEIGHT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CT_SEARCHTERM_STAT Call by reference Type reference (TYPE) ESH_T_QL_ST_STAT Searchterm Statistics Table for Indexing of Statistics Data 20100413

Method AGGREGATE_TERMS_BY_WEIGHT on class CL_ESH_QL_SEARCHTERM_STAT has no exception.

Method DB_UPDATE_EXCL_DEL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_EXCLUSIONS_DEL Call by reference Type reference (TYPE) ESH_T_QL_ST_EXCL 20100412
2 Importing IV_CONTENT_MANAGER Call by reference Type reference (TYPE) ESH_E_CM_CONTENT_MGR_APPL Content Manager Application (Classname) 20100412

Method DB_UPDATE_EXCL_DEL on class CL_ESH_QL_SEARCHTERM_STAT has no exception.

Method DB_UPDATE_EXCL_DEL_ALL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_CONTENT_MANAGER Call by reference Type reference (TYPE) ESH_E_CM_CONTENT_MGR_APPL Content Manager Application (Classname) 20100412
2 Importing IV_TO_TIMESTAMP Call by reference Type reference (TYPE) TIMESTAMPL 20100412

Method DB_UPDATE_EXCL_DEL_ALL on class CL_ESH_QL_SEARCHTERM_STAT has no exception.

Method DB_UPDATE_EXCL_SET Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_EXCLUSIONS_ADDED Call by reference Type reference (TYPE) ESH_T_QL_ST_EXCL Searchterm Exclusions (Added) 20100412
2 Importing IT_EXCLUSIONS Call by reference Type reference (TYPE) ESH_T_QL_ST_EXCL Searchterm Exclusions 20100412
3 Importing IV_CONTENT_MANAGER Call by reference Type reference (TYPE) ESH_E_CM_CONTENT_MGR_APPL Content Manager Application (Classname) 20100412
4 Importing IV_EXEC_TSP Call by reference Type reference (TYPE) TIMESTAMPL Execution Timestamp 20100412
5 Importing IV_OVERWRITE Call by reference Type reference (TYPE) ESH_E_CM_OVERWRITE_MODE Overwrite vs. Delta (Add/Del) Mode 20100412

Method DB_UPDATE_EXCL_SET on class CL_ESH_QL_SEARCHTERM_STAT has no exception.

Method DB_UPDATE_TERMS_DEL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_TERMS_DEL Call by reference Type reference (TYPE) ESH_T_QL_ST_STAT 20100412
2 Importing IV_COMMIT_WORK Call by reference Type reference (TYPE) CHAR01 ABAP_TRUE Commit Work 20100422
3 Importing IV_CONTENT_MANAGER Call by reference Type reference (TYPE) ESH_E_CM_CONTENT_MGR_APPL Content Manager Application (Classname) 20100407
4 Importing IV_CREATE_CHANGEPOINTERS Call by reference Type reference (TYPE) CHAR01 ABAP_TRUE Create Changepointers 20100412
5 Importing IV_MANUAL Call by reference Type reference (TYPE) ESH_E_CM_MANUAL_ENTRY Manual Entry 20100407

Method DB_UPDATE_TERMS_DEL on class CL_ESH_QL_SEARCHTERM_STAT has no exception.

Method DB_UPDATE_TERMS_DEL_ALL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_COMMIT_WORK Call by reference Type reference (TYPE) CHAR01 ABAP_TRUE Commit Work 20100422
2 Importing IV_CONTENT_MANAGER Call by reference Type reference (TYPE) ESH_E_CM_CONTENT_MGR_APPL Content Manager Application (Classname) 20100407
3 Importing IV_CREATE_CHANGEPOINTERS Call by reference Type reference (TYPE) CHAR01 ABAP_TRUE Create Changepointers 20100412
4 Importing IV_TO_TIMESTAMP Call by reference Type reference (TYPE) TIMESTAMPL Execution Timestamp 20100412

Method DB_UPDATE_TERMS_DEL_ALL on class CL_ESH_QL_SEARCHTERM_STAT has no exception.

Method DB_UPDATE_TERMS_DEL_EXCLUDED Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_EXCLUDED_TERMS_SRTD Call by reference Type reference (TYPE) ESH_T_QL_ST_STAT_SRTD Term Deletions 20100412
2 Importing IV_CREATE_CHANGEPOINTERS Call by reference Type reference (TYPE) CHAR01 ABAP_TRUE Create Changepointers 20100412

Method DB_UPDATE_TERMS_DEL_EXCLUDED on class CL_ESH_QL_SEARCHTERM_STAT has no exception.

Method DB_UPDATE_TERMS_SET Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_TERMS Call by reference Type reference (TYPE) ESH_T_QL_ST_STAT Searchterm Statistics Table for Indexing of Statistics Data 20100412
2 Importing IV_COMMIT_WORK Call by reference Type reference (TYPE) CHAR01 ABAP_TRUE Commit Work 20100422
3 Importing IV_CONTENT_MANAGER Call by reference Type reference (TYPE) ESH_E_CM_CONTENT_MGR_APPL Content Manager Application (Classname) 20100407
4 Importing IV_CREATE_CHANGEPOINTERS Call by reference Type reference (TYPE) CHAR01 ABAP_TRUE Create Changepointers 20100412
5 Importing IV_EXEC_TSP Call by reference Type reference (TYPE) TIMESTAMPL Execution Timestamp 20100408
6 Importing IV_MANUAL Call by reference Type reference (TYPE) ESH_E_CM_MANUAL_ENTRY Manual Entry 20100407
7 Importing IV_OVERWRITE Call by reference Type reference (TYPE) ESH_E_CM_OVERWRITE_MODE Overwrite vs. Delta (Add/Del) Mode 20100412

Method DB_UPDATE_TERMS_SET on class CL_ESH_QL_SEARCHTERM_STAT has no exception.

Method EXCLUSIONS_DEL_AFFECTED_TERMS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_EXCLUSIONS_ADDED Call by reference Type reference (TYPE) ESH_T_QL_ST_EXCL Term Exclusions 20100412
2 Importing IV_CREATE_CHANGEPOINTERS Call by reference Type reference (TYPE) CHAR01 ABAP_TRUE Create Changepointers 20100412

Method EXCLUSIONS_DEL_AFFECTED_TERMS on class CL_ESH_QL_SEARCHTERM_STAT has no exception.

Method EXCLUSIONS_GET_AFFECTED_TERMS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_EXCLUDED_TERMS Call by reference Type reference (TYPE) ESH_T_QL_ST_STAT_SRTD Search Terms (Sorted) 20100412
2 Importing IT_EXCLUSIONS_ADDED Call by reference Type reference (TYPE) ESH_T_QL_ST_EXCL Term Exclusions 20100412

Method EXCLUSIONS_GET_AFFECTED_TERMS on class CL_ESH_QL_SEARCHTERM_STAT has no exception.

Method EXCLUSIONS_VALIDATE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_ST_EXCL Call by reference Type reference (TYPE) ESH_T_QL_ST_EXCL Term Exclusions (DB Structure) 20100412
2 Importing IT_EXCLUSIONS Call by reference Type reference (TYPE) ESH_T_CM_EXCLUSIONS Term Exclusions (CM Interface Structure) 20100412
3 Importing IV_CONTENT_MANAGER Call by reference Type reference (TYPE) ESH_E_CM_CONTENT_MGR_APPL Content Manager Application (Classname) 20100412

Method EXCLUSIONS_VALIDATE on class CL_ESH_QL_SEARCHTERM_STAT has no exception.

Method EXCLUSION_DELETIONS_VALIDATE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_EXCLUSIONS_DEL Call by reference Type reference (TYPE) ESH_T_QL_ST_EXCL Term Exclusions (DB Structure) 20100412
2 Importing IT_EXCLUSION_DELETIONS Call by reference Type reference (TYPE) ESH_T_CM_EXCLUSION_DELETIONS Term Exclusions (CM Interface Structure) 20100412
3 Importing IV_CONTENT_MANAGER Call by reference Type reference (TYPE) ESH_E_CM_CONTENT_MGR_APPL Content Manager Application (Classname) 20100412

Method EXCLUSION_DELETIONS_VALIDATE on class CL_ESH_QL_SEARCHTERM_STAT has no exception.

Method GET_EXEC_TIMESTAMP Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning EV_EXEC_TSP Value transfer Type reference (TYPE) TIMESTAMPL Exec timestamp (to msecs) 20100408

Method GET_EXEC_TIMESTAMP on class CL_ESH_QL_SEARCHTERM_STAT has no exception.

Method GET_INSTANCE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RR_SEARCHTERM_STAT Value transfer Object reference (TYPE REF TO) CL_ESH_QL_SEARCHTERM_STAT Searchterm Statistics Handler 20100127

Method GET_INSTANCE on class CL_ESH_QL_SEARCHTERM_STAT has no exception.

Method GET_NEXT_BLOCKNO Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_BLOCKNO Value transfer Type reference (TYPE) I Block number 20100401

Method GET_NEXT_BLOCKNO on class CL_ESH_QL_SEARCHTERM_STAT has no exception.

Method PROCESS_NEXT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_SEARCHTERM_STAT Call by reference Type reference (TYPE) ESH_T_QL_ST_STAT Searchterm Statistics Block 20100127
2 Exporting EV_LAST_KEY Call by reference Type reference (TYPE) ESH_E_QL_HKY Last Key Processed 20100127
3 Exporting EV_NO_MORE_DATA Call by reference Type reference (TYPE) CHAR01 No More Data 20100127
4 Importing IV_FROM_KEY Call by reference Type reference (TYPE) ESH_E_QL_HKY From Key 20100127
5 Importing IV_PACKAGE_SIZE Call by reference Type reference (TYPE) ESH_E_IF_PACKAGE_SIZE Package size 20100127

Method PROCESS_NEXT on class CL_ESH_QL_SEARCHTERM_STAT has no exception.

Method PROCESS_NEXT_BY_TIME Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_SEARCHTERM_STAT_D Call by reference Type reference (TYPE) ESH_T_QL_ST_STAT Searchterm Statistics Block (Delete) 20100127
2 Exporting ET_SEARCHTERM_STAT_N Call by reference Type reference (TYPE) ESH_T_QL_ST_STAT Searchterm Statistics Block (Insert) 20100127
3 Exporting EV_LAST_TIMESTAMP Call by reference Type reference (TYPE) TIMESTAMPL Last Timestamp 20100127
4 Exporting EV_NO_MORE_DATA Call by reference Type reference (TYPE) CHAR01 No More Data 20100127
5 Importing IV_FROM_TIMESTAMP Call by reference Type reference (TYPE) TIMESTAMPL From Timestamp 20100127
6 Importing IV_PACKAGE_SIZE Call by reference Type reference (TYPE) ESH_E_IF_PACKAGE_SIZE Package size 20100127
# Exception Resumable Description Created on
1 CX_ESH_QL_ENGINE ESH Query Logging Engine Exception 20100804

Method PROVIDE_DATA_BY_ID Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_SEARCHTERM_STAT Call by reference Type reference (TYPE) ESH_T_QL_ST_STAT Searchterm Statistics 20100127
2 Importing IT_CONTENT_KEYS Call by reference Type reference (TYPE) ESH_T_QL_HKY Query Log Content Hashkey 20100127

Method PROVIDE_DATA_BY_ID on class CL_ESH_QL_SEARCHTERM_STAT has no exception.

Method SET_EXCLUSIONS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_EXCLUSIONS Call by reference Type reference (TYPE) ESH_T_CM_EXCLUSIONS Excluded Terms 20100412
2 Importing IT_EXCLUSION_DELETIONS Call by reference Type reference (TYPE) ESH_T_CM_EXCLUSION_DELETIONS Exclusion Deletions 20100412
3 Importing IV_CONTENT_MANAGER Call by reference Type reference (TYPE) ESH_E_CM_CONTENT_MGR_APPL Content Manager Application (Classname) 20100412
4 Importing IV_LAST_BLOCK Call by reference Type reference (TYPE) CHAR01 Is last block 20100412
5 Importing IV_OVERWRITE Call by reference Type reference (TYPE) ESH_E_CM_OVERWRITE_MODE Overwrite vs. Delta (Add/Del) Mode 20100412

Method SET_EXCLUSIONS on class CL_ESH_QL_SEARCHTERM_STAT has no exception.

Method SET_TERMS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IS_RANK_VALUE_RANGE Call by reference Type reference (TYPE) ESH_S_CM_RANK_VALUE_RANGE Rank Value Normalization Range (Low/Top Values) 20100331
2 Importing IT_SUGGESTIONS Call by reference Type reference (TYPE) ESH_T_CM_SUGGESTIONS Suggested Terms 20100331
3 Importing IT_SUGGESTION_DELETIONS Call by reference Type reference (TYPE) ESH_T_CM_SUGGESTION_DELETIONS Suggested Terms to Delete 20100331
4 Importing IV_CONTENT_MANAGER Call by reference Type reference (TYPE) ESH_E_CM_CONTENT_MGR_APPL Content Manager Application (Classname) 20100331
5 Importing IV_LAST_BLOCK Call by reference Type reference (TYPE) CHAR01 Is last block 20100408
6 Importing IV_MANUAL_ENTRIES Call by reference Type reference (TYPE) ESH_E_CM_MANUAL_ENTRY Manual Entry 20100331
7 Importing IV_OVERWRITE Call by reference Type reference (TYPE) ESH_E_CM_OVERWRITE_MODE Overwrite vs. Delta (Add/Del) Mode 20100331

Method SET_TERMS on class CL_ESH_QL_SEARCHTERM_STAT has no exception.

Method TERMS_CHECK_EXCLUSIONS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CT_TERMS Call by reference Type reference (TYPE) ESH_T_QL_ST_STAT Searchterm Statistics Table for Indexing of Statistics Data 20100412

Method TERMS_CHECK_EXCLUSIONS on class CL_ESH_QL_SEARCHTERM_STAT has no exception.

Method TERMS_SET_WEIGHTED_RANK Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CT_TERMS Call by reference Type reference (TYPE) ESH_T_QL_ST_STAT Terms 20100412
2 Importing IS_RANK_VALUE_RANGE Call by reference Type reference (TYPE) ESH_S_CM_RANK_VALUE_RANGE Rank Value Normalization Range (Low/Top Values) 20100406

Method TERMS_SET_WEIGHTED_RANK on class CL_ESH_QL_SEARCHTERM_STAT has no exception.

Method TERMS_VALIDATE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_TERMS_VALIDATED Call by reference Type reference (TYPE) ESH_T_QL_ST_STAT Suggested Terms (Validated, DB Structure) 20100412
2 Importing IT_SUGGESTIONS Call by reference Type reference (TYPE) ESH_T_CM_SUGGESTIONS Suggested Terms 20100406
3 Importing IV_CONTENT_MANAGER Call by reference Type reference (TYPE) ESH_E_CM_CONTENT_MGR_APPL Content Manager Application (Classname) 20100407
4 Importing IV_MANUAL Call by reference Type reference (TYPE) ESH_E_CM_MANUAL_ENTRY Manual Entry 20100407

Method TERMS_VALIDATE on class CL_ESH_QL_SEARCHTERM_STAT has no exception.

Method TERM_DELETIONS_VALIDATE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_TERMS_DEL Call by reference Type reference (TYPE) ESH_T_QL_ST_STAT Terms to Delete 20100412
2 Importing IT_SUGGESTION_DELETIONS Call by reference Type reference (TYPE) ESH_T_CM_SUGGESTION_DELETIONS Suggested Terms to Delete 20100407
3 Importing IV_CONTENT_MANAGER Call by reference Type reference (TYPE) ESH_E_CM_CONTENT_MGR_APPL Content Manager Application (Classname) 20100407
4 Importing IV_MANUAL Call by reference Type reference (TYPE) ESH_E_CM_MANUAL_ENTRY Manual Entry 20100407

Method TERM_DELETIONS_VALIDATE on class CL_ESH_QL_SEARCHTERM_STAT has no exception.

Method UPDATE_BLOCK_GET_TIMESTAMP Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_TIMESTAMP Call by reference Type reference (TYPE) TIMESTAMPL Timestamp 20100412
2 Returning RV_BLOCK_TIMESTAMP Value transfer Type reference (TYPE) TIMESTAMPL Timestamp with Block Counter 20100412

Method UPDATE_BLOCK_GET_TIMESTAMP on class CL_ESH_QL_SEARCHTERM_STAT has no exception.
History
Last changed by/on SAP  20110908 
SAP Release Created in 730