SAP ABAP Class CL_TREX_BC_BASE (Basisklasse für TREX-Basis-Client)
Hierarchy
SAP_BASIS (Software Component) SAP Basis Component
   BC-TRX-API (Application Component) TREX ABAP + JAVA API
     STREX (Package) TREX ABAP client
Meta Relationship - Used By
# Relationship type Used by Short Description Created on
1 Inheritance (c INHERITING FROM c_ref)  CL_TREX_BC_UTILITY1 Set of methods for indexing, aggregation. 20050603
Properties
Class CL_TREX_BC_BASE  
Short Description Basisklasse für TREX-Basis-Client    
Super Class    
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status P  SAP Standard Production Program 
Category 0   
Package STREX   TREX ABAP client 
Created 20050603   SAP 
Last change 20060207   SAP 
Shared Memory-enabled    
Fixed point arithmetic    
Unicode checks active    
Forward declarations
Class CL_TREX_BC_BASE has no forward declaration.
Interfaces
Class CL_TREX_BC_BASE has no interface implemented.
Friends
Class CL_TREX_BC_BASE has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 BINARY_DATA_FLAG Instance attribute Protected Type reference (TYPE) CHAR1 ' ' X: Binary data is included in the serialized string. 20050603
2 BINARY_DATA_STRING Instance attribute Protected Type reference (TYPE) XSTRING 20050603
3 COMPRESS_FLAG Instance attribute Private Type reference (TYPE) CHAR1 ' ' X: Compress data over the network. 20050623
4 C_ATTR_DATE_TYPE Constant Protected Type reference (TYPE) I 3 Attribute type: DATE 20050603
5 C_ATTR_FIXED_TYPE Constant Protected Type reference (TYPE) I 6 Attribute type: FIXED 20050603
6 C_ATTR_FLOAT_TYPE Constant Protected Type reference (TYPE) I 5 Attribute type: FLOAT 20050603
7 C_ATTR_INT_TYPE Constant Protected Type reference (TYPE) I 1 Attribute type: INT 20050603
8 C_ATTR_STRING_TYPE Constant Protected Type reference (TYPE) I 2 Attribute type: STRING 20050603
9 C_ATTR_TEXT_TYPE Constant Protected Type reference (TYPE) I 7 Attribute type: TEXT 20050603
10 C_ATTR_TIME_TYPE Constant Protected Type reference (TYPE) I 4 Attribute type: TIME 20050603
11 C_BOOL_FALSE Constant Protected Type reference (TYPE) CHAR1 '0' BOOL value: FALSE 20050603
12 C_BOOL_TRUE Constant Protected Type reference (TYPE) CHAR1 '1' BOOL value: TRUE 20050603
13 C_BYTE_ORDER_FOR_BE Constant Protected Type reference (TYPE) STRING '3830282018100800' Byte order for Big endian system. 20050603
14 C_BYTE_ORDER_FOR_LE Constant Protected Type reference (TYPE) STRING '0008101820283038' Byte order for Little endian system. 20050603
15 C_DELIMITER1 Constant Protected Type reference (TYPE) CHAR2 '[)' Dynamic delimiter 1 20050603
16 C_DELIMITER2 Constant Protected Type reference (TYPE) CHAR2 '~<' Dynamic delimiter 2 20050603
17 C_DELIMITER3 Constant Protected Type reference (TYPE) CHAR2 '[>' Dynamic delimiter 3 20050603
18 C_DELIMITER_LONG Constant Protected Type reference (TYPE) CHAR3 '[)<' Static delimiter 20050603
19 C_EMPTY_SERIALIZED_STRING Constant Protected Type reference (TYPE) STRING 'g[)<[)<' Serialized string of empty string value 20050603
20 C_FIELD_DELIMITER Constant Protected Type reference (TYPE) CHAR3 '>:)' Delimiter inserted by TrexNet 20050603
21 C_HTTP_BCD_TYPE Constant Protected Type reference (TYPE) CHAR1 'P' ABAP data type P 20050603
22 C_HTTP_BOOL_TYPE Constant Protected Type reference (TYPE) CHAR1 'B' ABAP character flag 20050603
23 C_HTTP_BYTE_TYPE Constant Protected Type reference (TYPE) CHAR1 'b' ABAP data type INT1 (b) 20050603
24 C_HTTP_CHAR_TYPE Constant Protected Type reference (TYPE) CHAR1 'C' ABAP data type C (only for length1) 20050603
25 C_HTTP_DATE_TYPE Constant Protected Type reference (TYPE) CHAR1 'D' ABAP data type D 20050603
26 C_HTTP_FLOAT_TYPE Constant Protected Type reference (TYPE) CHAR1 'F' ABAP data type F 20050603
27 C_HTTP_HEX_TYPE Constant Protected Type reference (TYPE) CHAR1 'X' ABAP data type X 20050603
28 C_HTTP_INT_TYPE Constant Protected Type reference (TYPE) CHAR1 'I' ABAP data type I (INT4) 20050603
29 C_HTTP_NUM_TYPE Constant Protected Type reference (TYPE) CHAR1 'N' ABAP data type N 20050603
30 C_HTTP_SHORT_TYPE Constant Protected Type reference (TYPE) CHAR1 's' ABAP data type INT2 (s) 20050603
31 C_HTTP_STRING_TYPE Constant Protected Type reference (TYPE) CHAR1 'g' ABAP data type string 20050603
32 C_HTTP_TIME_TYPE Constant Protected Type reference (TYPE) CHAR1 'T' ABAP data type T 20050603
33 C_HTTP_XSTRING_TYPE Constant Protected Type reference (TYPE) CHAR1 'y' ABAP data type xstring 20050603
34 C_INT_HEX_ZERO Constant Protected Type reference (TYPE) STRING 'I00000000' '0' with hex. 20050707
35 C_LOGICAL_DELIMITER Constant Protected Type reference (TYPE) CHAR3 '>-[' Delimiter inserted by BasisClient funcs. 20050603
36 C_NO_ERROR_TEXT Constant Protected Type reference (TYPE) STRING 'No error' Return message for no error. 20050603
37 C_SEARCH_ENGINE Constant Protected Type reference (TYPE) STRING 'drfuzzy' Search engine name 20050603
38 DATA_TYPE_LIST Instance attribute Protected Type reference (TYPE) TREXT_BC_DATATYPE_LIST Table type of data type list. 20050603
39 INDEX_ID Instance attribute Protected Type reference (TYPE) TREX_RFC-INDEX_ID Index Id 20050808
40 INDEX_LANGUAGE Instance attribute Protected Type reference (TYPE) TREX_RFC-LANGUAGE 'EN' Language 20050808
41 MEASUREMENT_INFO Instance attribute Protected Type reference (TYPE) TREX_BC_MEASURE Performance measurement information. 20050603
42 NO_DEL_CHECK_FLAG Instance attribute Protected Type reference (TYPE) CHAR1 'X' X: 3-byte delimiter is used. 20050603
43 R3_VERSION_INFO Static Attribute Protected Type reference (TYPE) STRING R/3 basis release & SP info. 20050603
44 RFC_DESTINATION Instance attribute Private Type reference (TYPE) TREX_RFC-RFC_DESTINATION RFC destination to TREX engine 20050808
45 SE_STRING_C Instance attribute Protected Type reference (TYPE) STRING Char based serialized string. 20050603
46 SE_STRING_X Instance attribute Protected Type reference (TYPE) XSTRING Bin based serialized string. 20050603
Methods
# Method Level Visibility Method type Description Created on
1 CHECK_DELIMITER_OK Static method Protected Method SE: Provide an appropriate delimiter for each char string. 20050603
2 CLASS_CONSTRUCTOR Static method Public Constructor 20050603
3 COMMUNICATE_VIA_ICM Instance method Private Method Create ICM obj, set/send/receive/get/close. 20050603
4 CONCATENATE_EMPTY_STRING Instance method Protected Method SE: Concatenate an empty string value (with delimiters). 20050603
5 CONSTRUCTOR Instance method Public Constructor 20050603
6 CONVERT_FROM_TEXT Static method Public Method DE: Convert string based value to a proper data type. 20050603
7 CONVERT_FROM_UTF8 Static method Public Method DE: Codepage conversion from UTF-8 to system codepage. 20050603
8 CONVERT_FROM_UTF8_DIRECT Instance method Protected Method DE: Convert SE_STRING_X to SCP and copy to SE_STRING_C. 20050603
9 CONVERT_TO_TEXT Static method Public Method SE: Convert any data to text basis. 20050603
10 CONVERT_TO_UTF8 Static method Public Method SE: Codepage conversion from SCP to UTF-8. 20050603
11 CONVERT_TO_UTF8_DIRECT Instance method Protected Method SE: Convert SE_STRING_C to UTF-8 and copy to SE_STRING_X. 20050603
12 FINALIZE_SERIALIZED_STRING Instance method Protected Method SE: Add meta info, Conv to UTF-8 20050603
13 GET_INDEX_SERVER_INFO Static method Private Method SE: Get host name and port number of proper Index Server. 20050603
14 GET_INITIAL_VALUE_AS_TEXT Static method Protected Method SE: Get an initial value as text for each ABAP format. 20050624
15 GET_PERFORMANCE_RESULT Static method Protected Method SE/DE: (TEST) Return performance measurement result. 20050603
16 GET_SERIALIZED_C_STRING Instance method Public Method SE: Return serialized character based string. 20050603
17 GET_SERIALIZED_X_STRING Instance method Public Method SE: Return serialized binary string (UTF-8 format). 20050603
18 REMOVE_LEADING_ZERO Static method Protected Method SE: Remove leading '0's from numeric character values. 20050603
19 REMOVE_TRAILING_ZERO Static method Protected Method SE: Remove trailing '0's from numeric character values. 20050603
20 RUN_COMMUNICATOR Instance method Public Method Data transferring between ABAP and TREX via ICM and TrexNet. 20050603
21 SERIALIZE_BOOL_VALUE Instance method Protected Method SE: Serialize bools ('1' , 'X' = TRUE; '0' , ' ' = FALSE). 20050603
22 SET_PERFORMANCE_RESULT Instance method Protected Method SE/DE: (TEST) Set performance measurement result. 20050603
23 SET_SERIALIZED_C_STRING Instance method Public Method SE: (TEST) Set a test string. 20050603
24 SET_SERIALIZED_X_STRING Instance method Protected Method SE: (TEST) Set a binary string (should be UTF-8 format). 20050603
Events
Class CL_TREX_BC_BASE has no event.
Types
Class CL_TREX_BC_BASE has no local type.
Method Signatures

Method CHECK_DELIMITER_OK Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EX_DELIMITER Call by reference Type reference (TYPE) CHAR2 2-Byte-Begrenzer verfügbar für Import-String 20050603
2 Importing IM_CHAR_STRING Call by reference Type reference (TYPE) ANY String-Daten 20050603
# Exception Resumable Description Created on
1 CX_TREX_BC_ERROR_OCCURED Fehler gefunden und Nachricht erzeugt 20050603

Method CLASS_CONSTRUCTOR Signature

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

Method COMMUNICATE_VIA_ICM Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_HOST Call by reference Type reference (TYPE) STRING Hostname des TREX-Indexservers 20050603
2 Importing IM_METHOD Call by reference Type reference (TYPE) STRING Methodenname (ID) 20050603
3 Importing IM_SERVICE Call by reference Type reference (TYPE) STRING Postnummer des TREX-Indexservers 20050603
4 Importing IM_TREXNET_VERSION Call by reference Type reference (TYPE) STRING '1.0.0' TrexNet-Version 20050603
# Exception Resumable Description Created on
1 CX_TREX_BC_ERROR_OCCURED Fehler gefunden und Nachricht erzeugt 20050603
2 CX_TREX_BC_TRANSFER_ERR_MSG Übergabe einer Ausnahmefehlernachricht an Aufrufer 20050603

Method CONCATENATE_EMPTY_STRING Signature

Method CONCATENATE_EMPTY_STRING on class CL_TREX_BC_BASE has no parameter.
Method CONCATENATE_EMPTY_STRING on class CL_TREX_BC_BASE has no exception.

Method CONSTRUCTOR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_COMPRESS_FLAG Call by reference Type reference (TYPE) FLAG ' ' X: Daten übers Netzwerk komprimieren 20050808
2 Importing IM_INDEX_ID Call by reference Type reference (TYPE) TREX_RFC-INDEX_ID Index-ID 20050808
3 Importing IM_LANGUAGE Call by reference Type reference (TYPE) TREX_RFC-LANGUAGE Sprache 20050808
4 Importing IM_NO_DELIMITER_CHECK Call by reference Type reference (TYPE) FLAG 'X' X: Begrenzerprüfung deaktiviert 20050603
5 Importing IM_RFC_DESTINATION Call by reference Type reference (TYPE) TREX_RFC-RFC_DESTINATION RFC-Destination zur TREX-Engine 20050808

Method CONSTRUCTOR on class CL_TREX_BC_BASE has no exception.

Method CONVERT_FROM_TEXT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EX_ACTUAL_VALUE Call by reference Type reference (TYPE) ANY Konvertierter Wert 20050603
2 Importing IM_ABAP_DATA_TYPE Call by reference Type reference (TYPE) CHAR1 ABAP-Datentyp 20050603
3 Importing IM_STRING_DATA Call by reference Type reference (TYPE) STRING Aktueller string-basierter Wert 20050603
# Exception Resumable Description Created on
1 CX_TREX_BC_ERROR_OCCURED Fehler gefunden und Nachricht erzeugt 20050603

Method CONVERT_FROM_UTF8 Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EX_C_STRING Call by reference Type reference (TYPE) STRING 20050603
2 Importing IM_X_STRING Call by reference Type reference (TYPE) XSTRING 20050603
# Exception Resumable Description Created on
1 CX_TREX_BC_ERROR_OCCURED Fehler gefunden und Nachricht erzeugt 20050603

Method CONVERT_FROM_UTF8_DIRECT Signature

Method CONVERT_FROM_UTF8_DIRECT on class CL_TREX_BC_BASE has no parameter.
# Exception Resumable Description Created on
1 CX_TREX_BC_ERROR_OCCURED Fehler gefunden und Nachricht erzeugt 20050603

Method CONVERT_TO_TEXT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EX_STRING_DATA Call by reference Type reference (TYPE) STRING Konvertierter Wert 20050603
2 Importing IM_ABAP_DATA_TYPE Call by reference Type reference (TYPE) CHAR1 ABAP-Datentyp 20050603
3 Importing IM_ACTUAL_VALUE Call by reference Type reference (TYPE) ANY Aktueller Wert 20050603
4 Importing IM_WITHOUT_DATATYPE_INFO Call by reference Type reference (TYPE) FLAG ' ' Datentypinfo ist nicht gesetzt in EX_STRING_DATA 20050610
# Exception Resumable Description Created on
1 CX_TREX_BC_ERROR_OCCURED Fehler gefunden und Nachricht erzeugt 20050603

Method CONVERT_TO_UTF8 Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EX_X_STRING Call by reference Type reference (TYPE) XSTRING 20050603
2 Importing IM_C_STRING Call by reference Type reference (TYPE) STRING 20050603
# Exception Resumable Description Created on
1 CX_TREX_BC_ERROR_OCCURED Fehler gefunden und Nachricht erzeugt 20050603

Method CONVERT_TO_UTF8_DIRECT Signature

Method CONVERT_TO_UTF8_DIRECT on class CL_TREX_BC_BASE has no parameter.
# Exception Resumable Description Created on
1 CX_TREX_BC_ERROR_OCCURED Fehler gefunden und Nachricht erzeugt 20050603

Method FINALIZE_SERIALIZED_STRING Signature

Method FINALIZE_SERIALIZED_STRING on class CL_TREX_BC_BASE has no parameter.
# Exception Resumable Description Created on
1 CX_TREX_BC_TRANSFER_ERR_MSG Fehler gefunden und Nachricht erzeugt 20050603

Method GET_INDEX_SERVER_INFO Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EX_HOST_INFO Call by reference Type reference (TYPE) STRING Hostname des TREX-Indexservers 20050603
2 Exporting EX_SERVICE_INFO Call by reference Type reference (TYPE) STRING Postnummer des TREX-Indexservers 20050603
3 Importing IM_INDEX_ID Call by reference Type reference (TYPE) TREX_RFC-INDEX_ID Index-ID 20050629
4 Importing IM_RFC_DESTINATION Call by reference Type reference (TYPE) TREX_RFC-RFC_DESTINATION RFC-Destination zur TREX-Engine 20050603
# Exception Resumable Description Created on
1 CX_TREX_BC_ERROR_OCCURED Fehler gefunden und Nachricht erzeugt 20050603

Method GET_INITIAL_VALUE_AS_TEXT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EX_INITIAL_VALUE Call by reference Type reference (TYPE) STRING Initialwert als Text 20050624
2 Importing IM_ABAP_DATA_TYPE Call by reference Type reference (TYPE) CHAR1 ABAP-Datentyp 20050624
# Exception Resumable Description Created on
1 CX_TREX_BC_ERROR_OCCURED Fehler gefunden und Nachricht erzeugt 20050630
2 CX_TREX_BC_TRANSFER_ERR_MSG Übergabe einer Ausnahmefehlernachricht an Aufrufer 20050630

Method GET_PERFORMANCE_RESULT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EX_MEASUREMENT_VALUES Call by reference Type reference (TYPE) TREX_BC_MEASURE BasisClient: Leistungsmessunginformationen 20050603
2 Exporting EX_RETURN_CODE Call by reference Type reference (TYPE) INT4 0 = gefunden, 1 = Ergebnis nicht gefunden 20050603
3 Importing IM_OBJECT_ID Call by reference Type reference (TYPE) CHAR3 Objekt-(Funktions-)ID 20050603

Method GET_PERFORMANCE_RESULT on class CL_TREX_BC_BASE has no exception.

Method GET_SERIALIZED_C_STRING Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RT_STRING Value transfer Type reference (TYPE) STRING 20050603

Method GET_SERIALIZED_C_STRING on class CL_TREX_BC_BASE has no exception.

Method GET_SERIALIZED_X_STRING Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RT_X_STRING Value transfer Type reference (TYPE) XSTRING 20050603

Method GET_SERIALIZED_X_STRING on class CL_TREX_BC_BASE has no exception.

Method REMOVE_LEADING_ZERO Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EX_NUMERIC_STRING Call by reference Type reference (TYPE) STRING Zeichenbasierte Daten, deren führende 0 gelöscht wurde 20050603
2 Importing IM_NUMERIC_VALUE Call by reference Type reference (TYPE) ANY Beliebige Länge nummerischer Werte 20050603
# Exception Resumable Description Created on
1 CX_TREX_BC_ERROR_OCCURED Fehler gefunden und Nachricht erzeugt 20050603

Method REMOVE_TRAILING_ZERO Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CHG_NUMERIC_VALUE Call by reference Type reference (TYPE) STRING 20050603

Method REMOVE_TRAILING_ZERO on class CL_TREX_BC_BASE has no exception.

Method RUN_COMMUNICATOR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_METHOD_NAME Call by reference Type reference (TYPE) STRING Methodenname 20050603
# Exception Resumable Description Created on
1 CX_TREX_BC_TRANSFER_ERR_MSG Fehler gefunden und Nachricht erzeugt 20050603

Method SERIALIZE_BOOL_VALUE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_BOOL_VALUE Call by reference Type reference (TYPE) CHAR1 Einstelliges Kennzeichen 20050603
# Exception Resumable Description Created on
1 CX_TREX_BC_ERROR_OCCURED Fehler gefunden und Nachricht erzeugt 20050603

Method SET_PERFORMANCE_RESULT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_OBJECT_ID Call by reference Type reference (TYPE) CHAR3 Feld der Laenge 3 Bytes 20050603

Method SET_PERFORMANCE_RESULT on class CL_TREX_BC_BASE has no exception.

Method SET_SERIALIZED_C_STRING Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_TEST_STRING Call by reference Type reference (TYPE) STRING 20050603
# Exception Resumable Description Created on
1 CX_TREX_BC_TRANSFER_ERR_MSG Ausnahmefehlernachricht an Aufrufer übergeben 20050603

Method SET_SERIALIZED_X_STRING Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_X_STRING Call by reference Type reference (TYPE) XSTRING 20050603

Method SET_SERIALIZED_X_STRING on class CL_TREX_BC_BASE has no exception.
History
Last changed by/on SAP  20060207 
SAP Release Created in 710