SAP ABAP Class CL_ESH_HANA_FULLTEXTINDEX (Fulltext Index Compiler)

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_HANA_FULLTEXTINDEX
Short Description	Fulltext Index Compiler
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	20130528	SAP
Last change	20141121
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_ESH_HANA_FULLTEXTINDEX has no forward declaration.

Interfaces

Class CL_ESH_HANA_FULLTEXTINDEX has no interface implemented.

Friends

Class CL_ESH_HANA_FULLTEXTINDEX has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MR_APPLICATION_LOG	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_ESH_OM_APPLOG		Application Log	20130611
2	MR_HANA_PROXY	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_ESH_TREX_PROXY_ADMIN		HANA Proxy (-Admin-)	20130611
3	MT_FULLTEXTINDEX_ADD	Instance attribute	Private	☐	Type reference (TYPE)	ESH_T_HDB_FTX		Fulltext Indices: Add	20130528
4	MT_FULLTEXTINDEX_DROP	Instance attribute	Private	☐	Type reference (TYPE)	ESH_T_HDB_FTX		Fulltext Indices: Drop	20130528
5	SV_FUZZY_SEARCH_ON	Static Attribute	Private	☐	Type reference (TYPE)	TREX_RFC-BOOLEAN		Boolean (ON = '1')	20130718
6	SV_SEARCH_ONLY_OFF	Static Attribute	Private	☐	Type reference (TYPE)	TREX_RFC-BOOLEAN		Boolean (OFF = '0')	20130701

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADJUST_FULLTEXT_INDICES	Instance method	Public	Method	Adjust Fulltext Indices	20130528
2	CHECK_FULLTEXT_INDEX_BY_DDIC	Instance method	Private	Method	Check whether fulltext index is owned by DDIC	20130612
3	CHECK_FULLTEXT_INDEX_BY_ESH	Instance method	Private	Method	Check whether fulltext index is owned/created by ESH	20130612
4	CHECK_FULLTEXT_INDEX_CROSSCLNT	Instance method	Private	Method	Check whether fulltext index has cross-client usages	20130612
5	CHECK_FULLTEXT_INDEX_CROSSOBJ	Instance method	Private	Method	Check whether fulltext index has cross-object usages	20130613
6	CLASS_CONSTRUCTOR	Static method	Public	Constructor	Class Constructor	20130701
7	GENERATE_FULLTEXT_INDEX_NAME	Static method	Public	Method	Generate Fullltext Index Name	20130612
8	GET_DDIC_FULLTEXTINDEX	Static method	Public	Method	Get Fulltext Index from DDIC	20130528
9	GET_ESH_HDB_FTX	Static method	Public	Method	Get ESH_HDB_FTX Data	20130617
10	GET_INSTANCE	Static method	Public	Method	Get Instance	20130528
11	HAS_DDIC_FULLTEXTINDEX	Static method	Public	Method	Check Node Field Has Fulltext Index from DDIC	20130528
12	REGISTER_TASK_CREATE	Instance method	Public	Method	Register Task: Create Fulltext Index	20130528
13	REGISTER_TASK_DROP	Instance method	Public	Method	Register Task: Drop Fulltext Index	20130528

Events

Class CL_ESH_HANA_FULLTEXTINDEX has no event.

Types

Class CL_ESH_HANA_FULLTEXTINDEX has no local type.

Method Signatures

Method ADJUST_FULLTEXT_INDICES Signature

Method ADJUST_FULLTEXT_INDICES on class CL_ESH_HANA_FULLTEXTINDEX has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_ESH_TREX_PROXY	☐	General ESH TREX Exception	20130611

Method CHECK_FULLTEXT_INDEX_BY_DDIC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_FIELD_NAME	Call by reference	☐	Type reference (TYPE)	FIELDNAME		Field Name	20130612
2	Importing	IV_FULLTEXT_INDEX_NAME	Call by reference	☐	Type reference (TYPE)	ESH_E_HDB_FULLTEXT_INDEX		Fulltext Index	20130612
3	Importing	IV_SCHEMA_NAME	Call by reference	☐	Type reference (TYPE)	ESH_E_HDB_DBSCHEMA		Database Schema	20130612
4	Importing	IV_TABLE_NAME	Call by reference	☐	Type reference (TYPE)	TREXD_INDEX_ID		Table Name	20130612
5	Returning	RV_OWNED_BY_DDIC	Value transfer	☐	Type reference (TYPE)	CHAR01		Owned by DDIC	20130612

Method CHECK_FULLTEXT_INDEX_BY_DDIC on class CL_ESH_HANA_FULLTEXTINDEX has no exception.

Method CHECK_FULLTEXT_INDEX_BY_ESH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_FULLTEXT_INDEX_NAME	Call by reference	☐	Type reference (TYPE)	ESH_E_HDB_FULLTEXT_INDEX		Fulltext Index	20130612
2	Returning	RV_OWNED_BY_ESH	Value transfer	☐	Type reference (TYPE)	CHAR01		Owned/Generated by ESH	20130612

Method CHECK_FULLTEXT_INDEX_BY_ESH on class CL_ESH_HANA_FULLTEXTINDEX has no exception.

Method CHECK_FULLTEXT_INDEX_CROSSCLNT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_FIELD_NAME	Call by reference	☐	Type reference (TYPE)	FIELDNAME		Field Name	20130612
2	Importing	IV_FULLTEXT_INDEX_NAME	Call by reference	☐	Type reference (TYPE)	ESH_E_HDB_FULLTEXT_INDEX		Fulltext Index	20130612
3	Importing	IV_SCHEMA_NAME	Call by reference	☐	Type reference (TYPE)	ESH_E_HDB_DBSCHEMA		Database Schema	20130612
4	Importing	IV_TABLE_NAME	Call by reference	☐	Type reference (TYPE)	TREXD_INDEX_ID		Table Name	20130612
5	Returning	RV_USED_CROSSCLNT	Value transfer	☐	Type reference (TYPE)	CHAR01		Used Cross-Client	20130612

Method CHECK_FULLTEXT_INDEX_CROSSCLNT on class CL_ESH_HANA_FULLTEXTINDEX has no exception.

Method CHECK_FULLTEXT_INDEX_CROSSOBJ Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_CURR_FTX_DROP	Call by reference	☐	Type reference (TYPE)	ESH_T_HDB_FTX		Current list of dropped fulltext indexes	20130613
2	Importing	IV_CURR_NODE	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_NODE_NAME		Current Node	20130613
3	Importing	IV_CURR_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_OBJECT_TYPE		Current Object Type	20130613
4	Importing	IV_FIELD_NAME	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_NODE_FIELD		Field Name	20130613
5	Importing	IV_FULLTEXT_INDEX_NAME	Call by reference	☐	Type reference (TYPE)	ESH_E_HDB_FULLTEXT_INDEX		Fulltext Index	20130613
6	Importing	IV_SCHEMA_NAME	Call by reference	☐	Type reference (TYPE)	ESH_E_HDB_DBSCHEMA		Database Schema	20130613
7	Importing	IV_TABLE_NAME	Call by reference	☐	Type reference (TYPE)	ESH_E_HDB_DBTABNAME		Table Name	20130613
8	Returning	RV_USED_CROSSOBJ	Value transfer	☐	Type reference (TYPE)	CHAR01		Is Used (Different object type/node)	20130613

Method CHECK_FULLTEXT_INDEX_CROSSOBJ on class CL_ESH_HANA_FULLTEXTINDEX has no exception.

Method CLASS_CONSTRUCTOR Signature

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

Method GENERATE_FULLTEXT_INDEX_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_FIELD_NAME	Call by reference	☐	Type reference (TYPE)	FIELDNAME		Field Name	20130612
2	Importing	IV_SCHEMA_NAME	Call by reference	☐	Type reference (TYPE)	ESH_E_HDB_DBSCHEMA		Database Schema	20130612
3	Importing	IV_TABLE_NAME	Call by reference	☐	Type reference (TYPE)	TREXD_INDEX_ID		Table Name	20130612
4	Returning	RV_FULLTEXT_INDEX_NAME	Value transfer	☐	Type reference (TYPE)	ESH_E_HDB_FULLTEXT_INDEX		Fulltext Index Name	20130612

#	Exception	Resumable	Description	Created on
1	CX_ESH_TREX_PROXY	☐	General ESH TREX Exception	20130612

Method GET_DDIC_FULLTEXTINDEX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_DB_TABLE	Call by reference	☐	Type reference (TYPE)	DDOBJNAME		DDIC Table	20130528
2	Importing	IV_FIELD_TYPE_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_NODE_FIELD		Node Field	20130528
3	Returning	RV_DDIC_FULLTEXTINDEX	Value transfer	☐	Type reference (TYPE)	ESH_E_HDB_FULLTEXT_INDEX		DDIC Fulltext Index Name	20130528

Method GET_DDIC_FULLTEXTINDEX on class CL_ESH_HANA_FULLTEXTINDEX has no exception.

Method GET_ESH_HDB_FTX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_ESH_HDB_FTX	Call by reference	☐	Type reference (TYPE)	ESH_T_HDB_FTX		Fulltext Indices	20130617
2	Importing	IV_FIELD_NAME	Call by reference	☑	Type reference (TYPE)	ESH_E_HDB_DBATTRIBUTE		Database Table Attribute Name	20130617
3	Importing	IV_FULLTEXT_INDEX	Call by reference	☑	Type reference (TYPE)	ESH_E_HDB_FULLTEXT_INDEX		Fulltext Index Name	20130617
4	Importing	IV_HDB_APPTABLE	Call by reference	☑	Type reference (TYPE)	ESH_E_HDB_DBTABNAME		Application Table	20130617
5	Importing	IV_HDB_DBSCHEMA	Call by reference	☑	Type reference (TYPE)	ESH_E_HDB_DBSCHEMA		Database Schema	20130617
6	Importing	IV_LOGSYS	Call by reference	☑	Type reference (TYPE)	LOGSYS		Logical system	20130617
7	Importing	IV_NODE_NAME	Call by reference	☑	Type reference (TYPE)	ESH_E_OM_NODE_NAME		Node Name	20130617
8	Importing	IV_OBJECT_TYPE	Call by reference	☑	Type reference (TYPE)	ESH_E_OM_OBJECT_TYPE		Object Type	20130617

Method GET_ESH_HDB_FTX on class CL_ESH_HANA_FULLTEXTINDEX has no exception.

Method GET_INSTANCE 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	20130611
2	Importing	IR_HANA_PROXY	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_TREX_PROXY_ADMIN		HANA Proxy (-Admin-)	20130611
3	Returning	RR_ESH_HANA_FULLTEXTINDEX	Value transfer	☐	Object reference (TYPE REF TO)	CL_ESH_HANA_FULLTEXTINDEX		Fulltext Index Compiler	20130528

#	Exception	Resumable	Description	Created on
1	CX_ESH_TREX_PROXY	☐	General ESH TREX Exception	20130613

Method HAS_DDIC_FULLTEXTINDEX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_DB_TABLE	Call by reference	☑	Type reference (TYPE)	DDOBJNAME		DD: Name of an ABAP Dictionary object	20130528
2	Importing	IV_FIELD_TYPE_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_NODE_FIELD		Node Field	20130528
3	Importing	IV_NODE_TYPE_ID	Call by reference	☑	Type reference (TYPE)	ESH_E_OM_NODE_NAME		Node Name	20130528
4	Importing	IV_OBJECT_TYPE_ID	Call by reference	☑	Type reference (TYPE)	ESH_E_OM_OBJECT_TYPE		Object Type	20130528
5	Importing	IV_SOFTWARE_COMPONENT	Call by reference	☑	Type reference (TYPE)	ESH_E_OM_SYSREL		Software Component	20130528
6	Returning	RV_DDIC_FULLTEXTINDEX	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20130528

Method HAS_DDIC_FULLTEXTINDEX on class CL_ESH_HANA_FULLTEXTINDEX has no exception.

Method REGISTER_TASK_CREATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_FULLTEXT_INDEX_ATTR	Call by reference	☐	Type reference (TYPE)	ESH_E_HDB_DBATTRIBUTE		Fulltext Index Attribute	20130617
2	Importing	IV_HDB_APPTABLE	Call by reference	☐	Type reference (TYPE)	ESH_E_HDB_DBTABNAME		Database Table	20130528
3	Importing	IV_HDB_DBSCHEMA	Call by reference	☑	Type reference (TYPE)	ESH_E_HDB_DBSCHEMA		Database Schema	20130528
4	Importing	IV_LOGSYS	Call by reference	☐	Type reference (TYPE)	LOGSYS		Logical System	20130528
5	Importing	IV_NODE	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_NODE_NAME		Node Name	20130617
6	Importing	IV_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_OBJECT_TYPE		Object Type	20130617

Method REGISTER_TASK_CREATE on class CL_ESH_HANA_FULLTEXTINDEX has no exception.

Method REGISTER_TASK_DROP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ALL_FULLTEXT_INDEXES	Call by reference	☑	Type reference (TYPE)	CHAR01		All ESH Fulltext Attributes of Node (Drop)	20130617
2	Importing	IV_FULLTEXT_INDEX_ATTR	Call by reference	☑	Type reference (TYPE)	ESH_E_HDB_DBATTRIBUTE		Fulltext Index Attribute (Drop)	20130617
3	Importing	IV_HDB_APPTABLE	Call by reference	☑	Type reference (TYPE)	ESH_E_HDB_DBTABNAME		Application Table	20130617
4	Importing	IV_HDB_DBSCHEMA	Call by reference	☑	Type reference (TYPE)	ESH_E_HDB_DBSCHEMA		Database Schema	20130617
5	Importing	IV_LOGSYS	Call by reference	☐	Type reference (TYPE)	LOGSYS		Logical System	20130528
6	Importing	IV_NODE	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_NODE_NAME		Node Name	20130617
7	Importing	IV_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_OBJECT_TYPE		Object Type	20130617

Method REGISTER_TASK_DROP on class CL_ESH_HANA_FULLTEXTINDEX has no exception.

History

Last changed by/on	SAP	20141121
SAP Release Created in	740