SAP ABAP Class /UI2/CL_SERIALIZE (Generic compressed serialization class)

Hierarchy

☛ SAP_UI (Software Component) User Interface Technology
   ⤷ CA-UI2-INT-BE (Application Component) Backend Enablement
     ⤷ /UI2/NWBC_CORE (Package) NetWeaver Business Client - Core Functionality

Properties

Class	/UI2/CL_SERIALIZE
Short Description	Generic compressed serialization class
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	/UI2/NWBC_CORE	NetWeaver Business Client - Core Functionality
Created	20130522	SAP
Last change	20141120
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 /UI2/CL_SERIALIZE has no interface implemented.

Friends

Class /UI2/CL_SERIALIZE has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_STOP_WORDS_DE	Static Attribute	Public	☑	Type reference (TYPE)	STRING		German stop word list separated by '|'	20130613
2	GC_STOP_WORDS_EN	Static Attribute	Public	☑	Type reference (TYPE)	STRING		English stop word list separated by '|'	20130613
3	GC_STOP_WORDS_ES	Static Attribute	Public	☑	Type reference (TYPE)	STRING		Spanish stop word list separated by '|'	20130613
4	GC_STOP_WORDS_FR	Static Attribute	Public	☑	Type reference (TYPE)	STRING		French stop word list separated by '|'	20130613
5	GC_STOP_WORDS_PL	Static Attribute	Public	☑	Type reference (TYPE)	STRING		Polish stop word list separated by '|'	20130613
6	GC_S_ENCODING	Constant	Public	☐	See coding				20130522
7	MO_ICU_TRANSFORMATION	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_ICU_TRANSFORMATION		Transliteration helper	20130625
8	MT_PARAM_TABLE	Instance attribute	Protected	☐	Type reference (TYPE)	STRING_TABLE			20130522
9	MV_CLIENT	Instance attribute	Protected	☐	Type reference (TYPE)	MANDT		Client	20140519
10	MV_GUID	Instance attribute	Protected	☐	Type reference (TYPE)	STRING			20131129

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_ENTRIES	Instance method	Public	Method	Adds multiple entries for serialization	20130617
2	ADD_ENTRY	Instance method	Public	Method	Add an entry to serialize	20130522
3	BASE_CONVERTER	Static method	Public	Method	Convert number from one base to another	20130522
4	CLASS_CONSTRUCTOR	Static method	Public	Constructor	CLASS_CONSTRUCTOR	20130613
5	CLEAR	Instance method	Public	Method	Delete all entries	20130522
6	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20130611
7	FROM_STRING	Instance method	Public	Method	Serialize entries to string	20130522
8	GET_COUNT	Instance method	Public	Method	Get entry count	20130522
9	GET_ENTRIES	Instance method	Public	Method	Returns entries table	20130617
10	GET_ENTRY	Instance method	Public	Method	Get entry by index	20130522
11	GET_STOP_WORDS	Static method	Public	Method	Get stop word list for language	20130613
12	GET_TRANSLIT	Static method	Protected	Method	Lazy creation of transliteration object	20130625
13	PRETTY_TEXT	Static method	Public	Method	Compress and pretty print the text	20130613
14	SET_GUID	Instance method	Public	Method	Guid for mock-data construction (resolver)	20131129
15	TO_STRING	Instance method	Public	Method	Deserialize entries from string	20130522

Events

Class /UI2/CL_SERIALIZE has no event.

Types

Class /UI2/CL_SERIALIZE has no local type.

Method Signatures

Method ADD_ENTRIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_ENTRIES	Call by reference	☐	Type reference (TYPE)	STRING_TABLE		Entries table	20130617

Method ADD_ENTRIES on class /UI2/CL_SERIALIZE has no exception.

Method ADD_ENTRY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CONDENSE	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Truncate spaces	20130522
2	Importing	IV_VALUE	Call by reference	☐	Type reference (TYPE)	ANY		Value to serialize	20130522

Method ADD_ENTRY on class /UI2/CL_SERIALIZE has no exception.

Method BASE_CONVERTER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_FROM_BASE	Call by reference	☑	Type reference (TYPE)	I	10	From Base	20130522
2	Importing	IV_NUMBER	Call by reference	☐	Type reference (TYPE)	ANY		Number to convert	20130522
3	Importing	IV_TO_BASE	Call by reference	☑	Type reference (TYPE)	I	62	To Base	20130522
4	Returning	RV_VALUE	Value transfer	☐	Type reference (TYPE)	STRING		Converted	20130522

#	Exception	Resumable	Description	Created on
1	INVALID_BASE	☐	Invalid base. Max base can be 62. Min base can be 2.	20130522
2	INVALID_CHAR	☐	Invalid character in the input number.	20130522

Method CLASS_CONSTRUCTOR Signature

Method CLASS_CONSTRUCTOR on class /UI2/CL_SERIALIZE has no parameter.
Method CLASS_CONSTRUCTOR on class /UI2/CL_SERIALIZE has no exception.

Method CLEAR Signature

Method CLEAR on class /UI2/CL_SERIALIZE has no parameter.
Method CLEAR on class /UI2/CL_SERIALIZE has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CLIENT	Call by reference	☐	Type reference (TYPE)	MANDT	SY-MANDT	Client	20140519
2	Importing	IV_INPUT_STRING	Call by reference	☑	Type reference (TYPE)	STRING		Serialized fields	20130611

Method CONSTRUCTOR on class /UI2/CL_SERIALIZE has no exception.

Method FROM_STRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_INPUT_STRING	Call by reference	☐	Type reference (TYPE)	STRING		String to deserialize	20130522

Method FROM_STRING on class /UI2/CL_SERIALIZE has no exception.

Method GET_COUNT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_VALUE	Value transfer	☐	Type reference (TYPE)	SY-TABIX		Entries count	20130522

Method GET_COUNT on class /UI2/CL_SERIALIZE has no exception.

Method GET_ENTRIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_ENTRIES	Call by reference	☐	Type reference (TYPE)	STRING_TABLE		Entries table	20130617

Method GET_ENTRIES on class /UI2/CL_SERIALIZE has no exception.

Method GET_ENTRY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_INDEX	Call by reference	☐	Attribute reference (LIKE)	SY-TABIX		Index of entry	20130522
2	Returning	RV_VALUE	Value transfer	☐	Type reference (TYPE)	STRING		Entry value	20130522

Method GET_ENTRY on class /UI2/CL_SERIALIZE has no exception.

Method GET_STOP_WORDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_WORDS	Call by reference	☐	Type reference (TYPE)	STRING_TABLE		Table of Strings	20130613
2	Exporting	EV_WORDS_STRING	Call by reference	☐	Type reference (TYPE)	STRING		| separated list of words	20130613
3	Importing	IV_LANGU	Call by reference	☑	Attribute reference (LIKE)	SY-LANGU	SY-LANGU	Language Key of Current Text Environment	20130613
4	Importing	IV_NO_DEFAULT	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Do not return English list if nothing matches	20130613

Method GET_STOP_WORDS on class /UI2/CL_SERIALIZE has no exception.

Method GET_TRANSLIT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_TRANSLIT	Value transfer	☐	Object reference (TYPE REF TO)	CL_ICU_TRANSFORMATION		Transformations	20130625

Method GET_TRANSLIT on class /UI2/CL_SERIALIZE has no exception.

Method PRETTY_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_REMOVE_STOP_WORDS	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Remove stop words when condensing	20130613
2	Importing	IV_STRING	Call by reference	☐	Type reference (TYPE)	CSEQUENCE		Text to condese and pretty print	20130613
3	Importing	IV_TRANSLITERATE	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Transliterate text	20130621
4	Returning	RV_CONDESED	Value transfer	☐	Type reference (TYPE)	STRING		Condensed text	20130613

Method PRETTY_TEXT on class /UI2/CL_SERIALIZE has no exception.

Method SET_GUID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_GUID	Call by reference	☑	Type reference (TYPE)	STRING			20131129

Method SET_GUID on class /UI2/CL_SERIALIZE has no exception.

Method TO_STRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ENCODING_METHOD	Call by reference	☑	Type reference (TYPE)	C		Encoding method	20130522
2	Importing	IV_LEAD_STRING	Call by reference	☑	Type reference (TYPE)	STRING		Lead string	20130522
3	Returning	RV_OUTPUT_STRING	Value transfer	☐	Type reference (TYPE)	STRING		Serialized entries	20130522

Method TO_STRING on class /UI2/CL_SERIALIZE has no exception.

History

Last changed by/on	SAP	20141120
SAP Release Created in	100