SAP ABAP Class CL_ESH_IF_INA_JSON_WRITER (JSON-renderer (flexble, easy, fast))

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
     ⤷ S_ESH_ENG_INTERFACE_INA (Package) Enterprise Search: InA-Interface

Properties

Class	CL_ESH_IF_INA_JSON_WRITER
Short Description	JSON-renderer (flexble, easy, fast)
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class	ESH_IF_INA_JSON
Program status
Category	0
Package	S_ESH_ENG_INTERFACE_INA	Enterprise Search: InA-Interface
Created	20121112	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)

Interfaces

Class CL_ESH_IF_INA_JSON_WRITER has no interface implemented.

Friends

Class CL_ESH_IF_INA_JSON_WRITER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MV_ACCEPT_ABAP_BOOL	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL			20130821
2	MV_CHECKS_ACTIVE	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL			20130213
3	MV_JSON_STRING	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20121112
4	MV_OPEN_ARRAYS	Instance attribute	Private	☐	Type reference (TYPE)	INT4		Natural number	20121112
5	MV_OPEN_OBJECTS	Instance attribute	Private	☐	Type reference (TYPE)	INT4		Natural number	20121112
6	MV_PREV_ELEMENT	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20121112
7	MV_PREV_TYPE	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20130213
8	MV_STRUCTURE_LOG	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20130213
9	MV_STRUCTURE_LOG_ACTIVE	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL			20130213
10	SC_ARR	Constant	Public	☐	Type reference (TYPE)	STRING	'array'		20130212
11	SC_ARR_CLOSE	Constant	Private	☐	Type reference (TYPE)	STRING	'arr.close'		20121112
12	SC_BOL	Constant	Public	☐	Type reference (TYPE)	STRING	'bool'		20130212
13	SC_FALSE	Constant	Public	☐	Type reference (TYPE)	ESH_E_IF_INA_SSTRING	'false'	short string	20130212
14	SC_NUM	Constant	Public	☐	Type reference (TYPE)	STRING	'num'		20130212
15	SC_OBJ	Constant	Public	☐	Type reference (TYPE)	STRING	'object'		20130212
16	SC_OBJ_CLOSE	Constant	Private	☐	Type reference (TYPE)	STRING	'obj.close'		20121112
17	SC_STR	Constant	Public	☐	Type reference (TYPE)	STRING	'str'		20130212
18	SC_TRUE	Constant	Public	☐	Type reference (TYPE)	ESH_E_IF_INA_SSTRING	'true'	short string	20130212

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CLOSE_ELEMENT	Instance method	Public	Method	Close Object or Array	20121112
2	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20130213
3	DISCARD_JSON_STREAM	Instance method	Public	Method	Discard document	20130208
4	GET_JSON_STREAM	Instance method	Public	Method	Get document as (x)string	20121112
5	GET_STRUCTURE_LOG	Instance method	Public	Method	Get logged document structure	20130213
6	INSERT_JSON	Instance method	Public	Method	Insert closed document into current document	20130208
7	WRITE_ELEMENT	Instance method	Public	Method	Write Object, Array, String, Boolean, Number	20121112

Events

Class CL_ESH_IF_INA_JSON_WRITER has no event.

Types

Class CL_ESH_IF_INA_JSON_WRITER has no local type.

Method Signatures

Method CLOSE_ELEMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_IS_ARRAY	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Close array (otherwise object is closed)	20121112

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_INA	☐	ES-InA-Adapter: Errors	20121112

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ACCEPT_ABAP_BOOL	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Accept X/ ' ' instead of true/ false	20130821
2	Importing	IV_CHECKS_ON	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Early exception instead of invalid JSON	20130213
3	Importing	IV_STRUCTURE_LOG_ON	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Document structure can be used e.g. for error analysis	20130213

Method CONSTRUCTOR on class CL_ESH_IF_INA_JSON_WRITER has no exception.

Method DISCARD_JSON_STREAM Signature

Method DISCARD_JSON_STREAM on class CL_ESH_IF_INA_JSON_WRITER has no parameter.
Method DISCARD_JSON_STREAM on class CL_ESH_IF_INA_JSON_WRITER has no exception.

Method GET_JSON_STREAM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_STRING	Call by reference	☐	Type reference (TYPE)	STRING			20121113
2	Exporting	EV_XSTRING	Call by reference	☐	Type reference (TYPE)	XSTRING			20121113
3	Importing	IV_CHECK_CLOSURE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Return only closed JSON document	20130208

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_INA	☐	ES-InA-Adapter: Errors	20121112

Method GET_STRUCTURE_LOG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_OPEN_ARRAYS	Call by reference	☐	Type reference (TYPE)	INT4		Number of open arrays	20130213
2	Exporting	EV_OPEN_OBJECTS	Call by reference	☐	Type reference (TYPE)	INT4		Number of open objects	20130213
3	Exporting	EV_STRUCTURE_LOG	Call by reference	☐	Type reference (TYPE)	STRING		Structure (objects and arrrays)	20130213
4	Importing	IV_COLLAPSE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Collapse structure: remove all closed sections	20130213

Method GET_STRUCTURE_LOG on class CL_ESH_IF_INA_JSON_WRITER has no exception.

Method INSERT_JSON Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_JSON_WRITER	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_IF_INA_JSON_WRITER		Instance with closed JSON document	20130208

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_INA	☐	ES-InA-Adapter: Errors	20130208

Method WRITE_ELEMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NAME	Call by reference	☑	Type reference (TYPE)	STRING		Free tag name	20121112
2	Importing	STRING_IS_NUMBER	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	String contains a plain number	20130226
3	Importing	TYPE	Call by reference	☐	Type reference (TYPE)	STRING		[sc_arr; sc_bol; sc_num; sc_obj; sc_str]	20121112
4	Importing	VALUE	Call by reference	☑	Type reference (TYPE)	STRING		Tag value; sc_bol: [sc_true; sc_false]; sc_arr/sc_obj: empty	20121112

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_INA	☐	ES-InA-Adapter: Errors	20121112

History

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