SAP ABAP Class CL_ESH_TREX_JOININDEX_COMPILER (Join Index Creation in TREX for NWES)
Hierarchy
SAP_BASIS (Software Component) SAP Basis Component
   BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
     S_ESH_ENG_TREX (Package) TREX handling for Enterprise Search
Properties
Class CL_ESH_TREX_JOININDEX_COMPILER  
Short Description Join Index Creation in TREX for NWES    
Super Class    
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status     
Category 0   
Package S_ESH_ENG_TREX   TREX handling for Enterprise Search 
Created 20090826   SAP 
Last change 20141121    
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_ESH_SE_RUNTIME_DATA Forward declaration interface (INTERFACE i DEFINITION DEF...  Forward declaration interface (INTERFACE i DEFINITION DEF...
Interfaces
Class CL_ESH_TREX_JOININDEX_COMPILER has no interface implemented.
Friends
Class CL_ESH_TREX_JOININDEX_COMPILER has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 GC_INLIST_IDENTIFIER Constant Public Type reference (TYPE) CHAR12 '%ESH_INLIST%' Inlist identifier 20100720
2 GC_INLIST_SEPARATOR Constant Public Type reference (TYPE) CHAR4 '%;$%' Inlist separator 20100720
3 GC_MSG_CLASS Constant Private Type reference (TYPE) ARBGB 'ESH_BOS_INDEX_CTRL' Default message class: 'ESH_BOS_INDEX_CTRL' 20090826
4 MR_APPLICATION_LOG Instance attribute Private Object reference (TYPE REF TO) IF_ESH_OM_APPLOG Application log 20091207
5 MR_AUTHC Instance attribute Private Object reference (TYPE REF TO) CL_ESH_OM_AUTHC AUTHC reference 20090826
6 MR_AUTHNW Instance attribute Private Object reference (TYPE REF TO) CL_ESH_OM_AUTHNW AUTHNW reference 20090826
7 MR_AUTHPB Instance attribute Private Object reference (TYPE REF TO) CL_ESH_OM_AUTHPB AUTHPB reference 20090826
8 MR_DPRVD Instance attribute Private Object reference (TYPE REF TO) CL_ESH_OM_DPRVD Data Providers 20120511
9 MR_INDEX_CHECKER Instance attribute Private Object reference (TYPE REF TO) CL_ESH_TREX_INDEX_CHECKER Index Checker 20120727
10 MR_MODEL_METADATA Instance attribute Private Object reference (TYPE REF TO) CL_ESH_TREX_MODEL_METADATA Model metadata 20120614
11 MR_OTYP Instance attribute Private Object reference (TYPE REF TO) CL_ESH_OM_OTYP OTYP reference 20090826
12 MR_SCENARIO_ANALYZER Instance attribute Private Object reference (TYPE REF TO) CL_ESH_HANA_SCENARIO_ANALYZER ESH-on-HANA Scenario Analyzer 20120525
13 MR_TREX_PROXY Instance attribute Private Object reference (TYPE REF TO) CL_ESH_TREX_PROXY_ADMIN TREX/HANA Proxy 20130823
14 MT_MSG Instance attribute Private Type reference (TYPE) ESH_T_ADM_BAL_S_MSG Messages 20090826
15 MV_EXT_SYS_ID Instance attribute Private Type reference (TYPE) ESH_E_ADM_EXTERNAL_SYSTEM_ID External system ID 20090826
16 MV_JOIN_COUNTER Instance attribute Private Type reference (TYPE) NUMC3 Join counter 20090826
17 MV_LOGSYS Instance attribute Private Type reference (TYPE) LOGSYS Logical system 20090826
18 MV_MESSAGE Instance attribute Private Type reference (TYPE) STRING Message 20090826
19 MV_OBJTYPE Instance attribute Private Type reference (TYPE) ESH_E_OM_OBJECT_TYPE Object type 20090826
20 MV_TEMPLATE_TYPE Instance attribute Private Type reference (TYPE) ESH_E_OM_TEMPLATE_TYPE Template type 20120727
Methods
# Method Level Visibility Method type Description Created on
1 ADD_TO_LIST Static method Private Method Add to list 20090826
2 ADJUST_PATH Instance method Private Method Adjust the path by inserting table ESH_HDB_MAP 20130505
3 CLASS_CONSTRUCTOR Static method Public Constructor Class constructor 20130424
4 COLLECT_INDEX_ID Instance method Private Method Collect all index IDs 20120620
5 CONSTRUCTOR Instance method Public Constructor Constructor 20090826
6 CREATE_JOIN_DATAMINING Instance method Public Method Create data mining join index 20090908
7 CREATE_JOIN_INDEX Instance method Public Method Create join index 20090826
8 CREATE_JOIN_PROPERTY Instance method Private Method Create property join index 20090826
9 DETERMINE_INDEX_NAME Instance method Private Method Determine index name 20090826
10 FILL_PATH_FROM_PPS Instance method Private Method Fill path from path steps 20090826
11 GET_CONSTRAINT_TOKENS Static method Private Method Get constraint tokens 20090826
12 GET_CURRENT_OBJECT_TYPE Instance method Public Method Gert object type for which Join Index Compiler has been inst 20131213
13 GET_INITIAL_VALUE_FOR_TYPE Static method Public Method Get the initial value for the specified field type 20130423
14 GET_INVOLVED_ATTRIBUTES Instance method Public Method Get involved attributes 20090826
15 GET_MESSAGES Instance method Public Method Get messages 20100219
16 GET_NEXT_CONSTRAINT Instance method Private Method Get next constraint 20090826
17 GET_NEXT_JOIN_CONDITION Instance method Private Method Get next join condition 20090826
18 GET_ROOT_NODE Instance method Public Method Get root node 20100219
Events
Class CL_ESH_TREX_JOININDEX_COMPILER has no event.
Types
# Type Visibility Typing Associated Type Description Created on Type Source
1 GTY_S_HDB_DBMAP_TYPE Private See coding Object Node to DB Table / DB Schema Mapping extended 20121214 BEGIN OF GTY_S_HDB_DBMAP_TYPE. INCLUDE TYPE esh_s_hdb_dbmap. TYPES: counter(2) TYPE n, hdb_dbtabfull(128) TYPE c, END OF GTY_S_HDB_DBMAP_TYPE
2 GTY_S_HDB_INDEX_MAP_TYPE Private See coding Mapping of index names 20121217 BEGIN OF GTY_S_HDB_INDEX_MAP_TYPE, index_src TYPE trexd_index_id, index_trg TYPE trexd_index_id, END OF GTY_S_HDB_INDEX_MAP_TYPE
3 GTY_S_INDEX_TYPE Public See coding Object type, node name and index IDs 20120620 begin of GTY_S_INDEX_TYPE, object_type TYPE esh_e_om_object_type, node_name TYPE esh_e_om_node_name, index_ids TYPE STANDARD TABLE OF trexd_index_id WITH NON-UNIQUE DEFAULT KEY, end of GTY_S_INDEX_TYPE
4 GTY_T_HDB_DBMAP_TYPE Private See coding Table type for GTY_S_HDB_DBMAP_TYPE 20121214 GTY_T_HDB_DBMAP_TYPE TYPE STANDARD TABLE OF GTY_S_HDB_DBMAP_TYPE
5 GTY_T_HDB_INDEX_MAP_TYPE Private See coding Table type for GTY_S_HDB_INDEX_MAP_TYPE 20121217 GTY_T_HDB_INDEX_MAP_TYPE TYPE STANDARD TABLE OF GTY_S_HDB_INDEX_MAP_TYPE
6 GTY_T_INDEX_TYPE Public See coding Table type for GTY_S_INDEX_TYPE 20120620 GTY_T_INDEX_TYPE TYPE SORTED TABLE OF gty_s_index_type WITH UNIQUE KEY object_type node_name
Method Signatures

Method ADD_TO_LIST Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning EV_LIST Value transfer Type reference (TYPE) STRING 20090826
2 Importing IV_KEY Call by reference Type reference (TYPE) STRING 20090826
3 Importing IV_LIST Call by reference Type reference (TYPE) STRING 20090826

Method ADD_TO_LIST on class CL_ESH_TREX_JOININDEX_COMPILER has no exception.

Method ADJUST_PATH Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CT_PATH Call by reference Type reference (TYPE) ESH_T_JOIN_PATH_STEP Table type for ESH_S_JOIN_PATH_STEP 20130505

Method ADJUST_PATH on class CL_ESH_TREX_JOININDEX_COMPILER has no exception.

Method CLASS_CONSTRUCTOR Signature

Method CLASS_CONSTRUCTOR on class CL_ESH_TREX_JOININDEX_COMPILER has no parameter.
Method CLASS_CONSTRUCTOR on class CL_ESH_TREX_JOININDEX_COMPILER has no exception.

Method COLLECT_INDEX_ID Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CT_ALL_INDICES Call by reference Type reference (TYPE) GTY_T_INDEX_TYPE Index collection 20120620
2 Changing CT_HDB_DBMAP Call by reference Type reference (TYPE) GTY_T_HDB_DBMAP_TYPE Object Node to DB Table / DB Schema Mapping extended 20121208
3 Changing CT_HDB_INDEX_MAP Call by reference Type reference (TYPE) GTY_T_HDB_INDEX_MAP_TYPE Mapping of HDB index names 20121217
4 Changing CV_INDEX_ID Call by reference Type reference (TYPE) TREXD_INDEX_ID Index Id 20121214
5 Importing IV_IS_AUTH_INDEX Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE Indicator: is authorization index 20130415
6 Importing IV_MODE_SNAPSHOT Call by reference Type reference (TYPE) ABAP_BOOL Indicator: snapshot mode 20131124
7 Importing IV_NODE_NAME Call by reference Type reference (TYPE) ESH_E_OM_NODE_NAME Node Name 20120620
8 Importing IV_OBJECT_TYPE Call by reference Type reference (TYPE) ESH_E_OM_OBJECT_TYPE Object Type 20120620

Method COLLECT_INDEX_ID on class CL_ESH_TREX_JOININDEX_COMPILER has no exception.

Method CONSTRUCTOR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IR_APPLICATION_LOG Call by reference Object reference (TYPE REF TO) IF_ESH_OM_APPLOG Application Log 20091207
2 Importing IR_INDEX_CHECKER Call by reference Object reference (TYPE REF TO) CL_ESH_TREX_INDEX_CHECKER Index Checker 20120727
3 Importing IR_INDEX_METAMODEL Call by reference Object reference (TYPE REF TO) CL_ESH_TREX_MODEL_METADATA Data object holding model references 20090918
4 Importing IR_SCENARIO_ANALYZER Call by reference Object reference (TYPE REF TO) CL_ESH_HANA_SCENARIO_ANALYZER ESH-on-HANA Scenario Analyzer 20120525
5 Importing IV_EXT_SYS_ID Call by reference Type reference (TYPE) ESH_E_ADM_EXTERNAL_SYSTEM_ID External system ID 20090826
6 Importing IV_LOGSYS Call by reference Type reference (TYPE) LOGSYS Logical system 20090826
7 Importing IV_OBJTYPE Call by reference Type reference (TYPE) ESH_E_OM_OBJECT_TYPE Object type 20090826
8 Importing IV_TEMPLATE_TYPE Call by reference Type reference (TYPE) ESH_E_OM_TEMPLATE_TYPE Template Type 20120727
9 Importing IV_WRITE_MSG Call by reference Type reference (TYPE) FLAG Set "write messages" mode 20090826
# Exception Resumable Description Created on
1 CX_ESH_TREX_PROXY Static exception superclass for ESH-TREX 20130823

Method CREATE_JOIN_DATAMINING Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IS_AUTH_INDEX_METADATA Call by reference Type reference (TYPE) ESH_S_TREX_INDEX_METADATA Authorization Index Metadata 20101122
2 Importing IV_ADD_NODEKEY_ATTRIBUTES Call by reference Type reference (TYPE) CHAR01 Add Node Key Attributes 20130426
3 Importing IV_REDUCE_PATHS Call by reference Type reference (TYPE) CHAR01 ABAP_TRUE Reduce Paths in case "Auth via External Obj" 20131028
# Exception Resumable Description Created on
1 CX_ESH_TREX_STATIC Static exception superclass for ESH-TREX 20130426

Method CREATE_JOIN_INDEX Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EV_JOIN_INDEX Call by reference Type reference (TYPE) TREXD_INDEX_ID Join Index 20090826
2 Importing IV_MODE_SNAPSHOT Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE Indicator: snapshot mode 20131124
3 Importing IV_REQUEST Call by reference Type reference (TYPE) ESH_E_OM_REQUEST Request 20090826
4 Importing IV_REQ_NODE Call by reference Type reference (TYPE) ESH_E_OM_NODE_NAME Request Node 20090826
# Exception Resumable Description Created on
1 CX_ESH_TREX_DYNAMIC Dynamic superclass for NWES-TREX-API 20091203
2 CX_ESH_TREX_STATIC Static exception superclass for ESH-TREX 20091203

Method CREATE_JOIN_PROPERTY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CT_ALL_INDICES Call by reference Type reference (TYPE) GTY_T_INDEX_TYPE Index collection 20120621
2 Changing CT_HDB_DBMAP Call by reference Type reference (TYPE) GTY_T_HDB_DBMAP_TYPE Object Node to DB Table / DB Schema Mapping extended 20121208
3 Changing CT_HDB_INDEX_MAP Call by reference Type reference (TYPE) GTY_T_HDB_INDEX_MAP_TYPE Mapping of HDB index names 20121217
4 Importing IT_OBJ_CLASS_KEYS Call by reference Type reference (TYPE) TREXT_ATTRIBUTES Attributes 20091116
5 Importing IV_JOIN_INDEX Call by reference Type reference (TYPE) TREXD_INDEX_ID Index ID 20090826
6 Importing IV_MODE_SNAPSHOT Call by reference Type reference (TYPE) ABAP_BOOL Indicator: snapshot mode 20131124
7 Importing IV_OBJTYPE Call by reference Type reference (TYPE) ESH_E_OM_OBJECT_TYPE Object Type 20090826
8 Importing IV_PROP_VAL_NODE Call by reference Type reference (TYPE) ESH_E_OM_NODE_NAME Node Name 20090826
9 Importing IV_REQUEST Call by reference Type reference (TYPE) ESH_E_OM_REQUEST '$PV' Request 20090826
# Exception Resumable Description Created on
1 CX_ESH_TREX_DYNAMIC Dynamic superclass for NWES-TREX-API 20091203
2 CX_ESH_TREX_STATIC Static exception superclass for ESH-TREX 20091203

Method DETERMINE_INDEX_NAME Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CT_ALL_INDICES Call by reference Type reference (TYPE) GTY_T_INDEX_TYPE Index collection 20120621
2 Changing CT_HDB_DBMAP Call by reference Type reference (TYPE) GTY_T_HDB_DBMAP_TYPE Object Node to DB Table / DB Schema Mapping extended 20121208
3 Changing CT_HDB_INDEX_MAP Call by reference Type reference (TYPE) GTY_T_HDB_INDEX_MAP_TYPE Mapping of HDB index names 20121217
4 Changing CV_FROM_INDEX Call by reference Type reference (TYPE) TREXD_INDEX_ID Index Id 20090826
5 Changing CV_TO_INDEX Call by reference Type reference (TYPE) TREXD_INDEX_ID Index Id 20090826
6 Importing IS_PATH_STEP Call by reference Type reference (TYPE) ESH_S_JOIN_PATH_STEP List with path steps 20090826
7 Importing IV_MODE_SNAPSHOT Call by reference Type reference (TYPE) ABAP_BOOL Indicator: snapshot mode 20131124
# Exception Resumable Description Created on
1 ERROR 20090826

Method FILL_PATH_FROM_PPS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IS_AOTYPPS_EXT Call by reference Type reference (TYPE) ESH_S_OM_AOTYPPS_EXT 20090826
2 Importing IV_REVERSED_PATH Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE Flag: Path is reversed 20100114
3 Returning RS_PATH_STEP Value transfer Type reference (TYPE) ESH_S_JOIN_PATH_STEP 20090826

Method FILL_PATH_FROM_PPS on class CL_ESH_TREX_JOININDEX_COMPILER has no exception.

Method GET_CONSTRAINT_TOKENS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_CONSTRAINT_TOKENS Call by reference Type reference (TYPE) TREXT_STRING 20090826
2 Exporting EV_NON_CONSTRAINT_EXPRESSION Call by reference Type reference (TYPE) STRING 20090826
3 Importing IT_TOKENS Call by reference Type reference (TYPE) TREXT_STRING 20090826
4 Importing IV_LOGICAL_EXPRESSION Call by reference Type reference (TYPE) STRING 20090826

Method GET_CONSTRAINT_TOKENS on class CL_ESH_TREX_JOININDEX_COMPILER has no exception.

Method GET_CURRENT_OBJECT_TYPE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_OBJECT_TYPE Value transfer Type reference (TYPE) ESH_E_OM_OBJECT_TYPE Object Type 20131213

Method GET_CURRENT_OBJECT_TYPE on class CL_ESH_TREX_JOININDEX_COMPILER has no exception.

Method GET_INITIAL_VALUE_FOR_TYPE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_DECIMALS Call by reference Type reference (TYPE) DECIMALS Number of Decimal Places 20130423
2 Importing IV_INTTYPE Call by reference Type reference (TYPE) INTTYPE ABAP data type (C,D,N,...) 20130423
3 Importing IV_LENG Call by reference Type reference (TYPE) DDLENG Length (No. of Characters) 20130423
4 Returning RV_INITIAL_VALUE Value transfer Type reference (TYPE) STRING Initial value in string format 20130423

Method GET_INITIAL_VALUE_FOR_TYPE on class CL_ESH_TREX_JOININDEX_COMPILER has no exception.

Method GET_INVOLVED_ATTRIBUTES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_ATTR_LIST Call by reference Type reference (TYPE) ESH_T_JOIN_ATTRIBUTES_LIST Attribute list 20090826
2 Exporting ET_AUTH_OBJ Call by reference Type reference (TYPE) IF_ESH_SE_RUNTIME_DATA=>S_SEARCH_EXEC_REQU_TYPE-AUTHORIZATION_OBJECTS Authorization objects 20131113
3 Exporting ET_AUTH_PATH Call by reference Type reference (TYPE) IF_ESH_SE_RUNTIME_DATA=>S_SEARCH_EXEC_REQU_TYPE-AUTHORIZATION_PATHS Authorization paths 20131113
4 Exporting ET_NODE_LIST Call by reference Type reference (TYPE) ESH_T_NODE_AUTHORIZATION_LIST Node list 20090826
5 Exporting EV_LOGICAL_EXPRESSION Call by reference Type reference (TYPE) IF_ESH_SE_RUNTIME_DATA=>S_SEARCH_EXEC_REQU_TYPE-LOGICAL_EXPRESSION Logical expressions for authorization 20131128
6 Importing IV_REQUESTED_NODE Call by reference Type reference (TYPE) ESH_E_OM_NODE_NAME Node Name 20090826
7 Importing IV_REQUEST_TYPE_ID Call by reference Type reference (TYPE) ESH_E_OM_REQUEST Request 20090826
# Exception Resumable Description Created on
1 CX_ESH_TREX_DYNAMIC Dynamic superclass for NWES-TREX-API 20091203
2 CX_ESH_TREX_STATIC Static exception superclass for ESH-TREX 20091203

Method GET_MESSAGES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_MSG Call by reference Type reference (TYPE) ESH_T_ADM_BAL_S_MSG Error messages 20100219

Method GET_MESSAGES on class CL_ESH_TREX_JOININDEX_COMPILER has no exception.

Method GET_NEXT_CONSTRAINT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning EV_CONSTRAINT Value transfer Type reference (TYPE) ESH_E_TREX_ELEMENT 20090826

Method GET_NEXT_CONSTRAINT on class CL_ESH_TREX_JOININDEX_COMPILER has no exception.

Method GET_NEXT_JOIN_CONDITION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning EV_JOIN_CONDITION Value transfer Type reference (TYPE) TREXD_JOIN_PATH 20090826

Method GET_NEXT_JOIN_CONDITION on class CL_ESH_TREX_JOININDEX_COMPILER has no exception.

Method GET_ROOT_NODE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_ROOT_NODE Value transfer Type reference (TYPE) ESH_E_OM_NODE_NAME Name of the root node 20100219

Method GET_ROOT_NODE on class CL_ESH_TREX_JOININDEX_COMPILER has no exception.
History
Last changed by/on SAP  20141121 
SAP Release Created in 730