SAP ABAP Class CL_DEMO_OUTPUT_STREAM (Demo for XML Output Stream for ABAP Data)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-ABA-LA (Application Component) Syntax, Compiler, Runtime
     ⤷ SABAP_DEMOS_OUTPUT_STREAM (Package) Non-UI-Specific Output Stream for Demo Programs

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_DEMO_OUTPUT_FORMATS	Constants for Demo Output Stream	20121212

Properties

Class	CL_DEMO_OUTPUT_STREAM
Short Description	Demo for XML Output Stream for ABAP Data
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class
Program status
Category	0
Package	SABAP_DEMOS_OUTPUT_STREAM	Non-UI-Specific Output Stream for Demo Programs
Created	20120504	SAP
Last change	20140121	SAP
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

#	Interface	Abstract	Final	Description	Created on
1	IF_DEMO_OUTPUT_FORMATS	☐	☐	Constants for Demo Output Stream	20121212

Friends

Class CL_DEMO_OUTPUT_STREAM has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_HEADING	Instance attribute	Public	☐	Attribute reference (LIKE)				20120504
2	GC_HTML	Constant	Private	☐	Type reference (TYPE)	STRING	`html`	Name for HTML	20120511
3	GC_INITIAL_NAME	Constant	Private	☐	Type reference (TYPE)	STRING	`initial_name`	Initial name of data object	20120504
4	GC_JSON	Constant	Private	☐	Type reference (TYPE)	STRING	`json`	Name for JSON	20120902
5	GC_NONPROP	Instance attribute	Public	☐	Attribute reference (LIKE)				20120510
6	GC_REFERENCE	Constant	Private	☐	Type reference (TYPE)	STRING	`reference`	Placeholder for Reference Variables	20131009
7	GC_TEXT	Instance attribute	Public	☐	Attribute reference (LIKE)				20120504
8	GC_XML	Constant	Private	☐	Type reference (TYPE)	STRING	`xml`	Name for XML	20120508
9	MT_STREAM	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_TRANS_SRCBIND_TAB		Internal table for output stream	20120504
10	MV_CLOSED	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	abap_true, if stream closed	20120820
11	MV_NAME	Instance attribute	Private	☐	Type reference (TYPE)	STRING		Name of Data Object	20120504

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_ELEMENTARY_OBJECT	Instance method	Private	Method	Attaches elementary data object	20120504
2	ADD_STRUCTURED_OBJECT	Instance method	Private	Method	Attaches structured data object	20120504
3	ADD_TABULAR_OBJECT	Instance method	Private	Method	Attaches table-like data object	20120504
4	CHECK_STRUCTURE	Instance method	Private	Method	Checks for elementary elements and resolves includes	20120504
5	CLOSE	Instance method	Public	Method	Closes output stream and triggers eventq	20120504
6	CREATE_VALUE	Instance method	Private	Method	Creates segment of output stream	20120507
7	ELEMENTARY2STRUCTURED	Instance method	Private	Method	Converts elementary data object to structured data object	20120504
8	FINALIZE_STREAM	Instance method	Private	Method	Finish stream in internal table	20120504
9	FINALIZE_XML	Instance method	Private	Method	Finish stream in XML stream	20120504
10	OPEN	Static method	Public	Method	Opens an output stream	20120504
11	STRUCTURED2TABULAR	Instance method	Private	Method	Converts structured data object to table-like data object	20120504
12	WRITE_DATA	Instance method	Public	Method	Writes data object to stream	20120504
13	WRITE_HTML	Instance method	Public	Method	Writes formatted HTML text to stream	20120511
14	WRITE_JSON	Instance method	Public	Method	Writes formatted JSON text to the stream	20120902
15	WRITE_TEXT	Instance method	Public	Method	Writes text to stream	20120504
16	WRITE_XML	Instance method	Public	Method	Writes formatted XML text to stream	20120508

Events

#	Event	Type	Visibility	Description	Created on
1	COMPLETED	Instance Event (0)	Public (2)	Output stream closed	20120504

Types

Class CL_DEMO_OUTPUT_STREAM has no local type.

Method Signatures

Method ADD_ELEMENTARY_OBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IA_ELEMENTARY	Call by reference	☐	Type reference (TYPE)	DATA		Elementares Datenobjekt	20120504
2	Importing	IO_ELEM_TYPE	Call by reference	☐	Object reference (TYPE REF TO)	CL_ABAP_ELEMDESCR		Referenz auf Datentyp	20120504
3	Importing	IV_FORMAT	Call by reference	☑	Type reference (TYPE)	STRING		Initial (proportional) oder IF_DEMO_OUTPUT=>NONPROP	20120917

Method ADD_ELEMENTARY_OBJECT on class CL_DEMO_OUTPUT_STREAM has no exception.

Method ADD_STRUCTURED_OBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IA_STRUCTURED	Call by reference	☐	Type reference (TYPE)	DATA		Strukturiertes Datenobjekt	20120504
2	Importing	IO_STRUCT_TYPE	Call by reference	☐	Object reference (TYPE REF TO)	CL_ABAP_STRUCTDESCR		Referenz auf Datentyp	20120504
3	Importing	IV_FORMAT	Call by reference	☑	Type reference (TYPE)	STRING		Initial (proportional) oder IF_DEMO_OUTPUT=>NONPROP	20120917

#	Exception	Resumable	Description	Created on
1	CX_DEMO_OUTPUT_NOT_POSSIBLE	☐	Ausgabe nicht möglich	20120504

Method ADD_TABULAR_OBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IA_TABULAR	Call by reference	☐	Type reference (TYPE)	ANY TABLE		Tabellenartiges Datenobjekt	20120504
2	Importing	IO_TABLE_TYPE	Call by reference	☐	Object reference (TYPE REF TO)	CL_ABAP_TABLEDESCR		Referenz auf Datentyp	20120504
3	Importing	IV_FORMAT	Call by reference	☑	Type reference (TYPE)	STRING		Initial (proportional) oder IF_DEMO_OUTPUT=>NONPROP	20120917

#	Exception	Resumable	Description	Created on
1	CX_DEMO_OUTPUT_NOT_POSSIBLE	☐	Ausgabe nicht möglich	20120504

Method CHECK_STRUCTURE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_STRUCT_TYPE	Call by reference	☐	Object reference (TYPE REF TO)	CL_ABAP_STRUCTDESCR		Referenz auf strukturierten Datentyp	20120504
2	Returning	RO_STRUCT_TYPE	Value transfer	☐	Object reference (TYPE REF TO)	CL_ABAP_STRUCTDESCR		Referenz auf strukturierten Datentyp	20120918

#	Exception	Resumable	Description	Created on
1	CX_DEMO_OUTPUT_NOT_POSSIBLE	☐	Ausgabe nicht möglich	20120504

Method CLOSE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_OUTPUT	Value transfer	☐	Type reference (TYPE)	XSTRING		Ausgabestrom im XML-Format	20120504

Method CLOSE on class CL_DEMO_OUTPUT_STREAM has no exception.

Method CREATE_VALUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CS_SEGMENT	Call by reference	☐	Type reference (TYPE)	ABAP_TRANS_SRCBIND		Segment des Ausgabestroms	20120507
2	Importing	IR_TABULAR	Call by reference	☐	Object reference (TYPE REF TO)	DATA		Referenz auf tabellenartigen Datentyp	20120507

Method CREATE_VALUE on class CL_DEMO_OUTPUT_STREAM has no exception.

Method ELEMENTARY2STRUCTURED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EO_STRUCT_TYPE	Call by reference	☐	Object reference (TYPE REF TO)	CL_ABAP_STRUCTDESCR		Referenz auf Datentyp des strukturierten Datenobjekts	20120504
2	Exporting	ER_STRUCTURED	Value transfer	☐	Object reference (TYPE REF TO)	DATA		Strukturiertes Datenobjekt	20120504
3	Importing	IO_ELEM_TYPE	Call by reference	☐	Object reference (TYPE REF TO)	CL_ABAP_ELEMDESCR		Referenz auf Datentyp des elementaren Datenobjekts	20120504
4	Importing	IR_ELEMENTARY	Call by reference	☐	Object reference (TYPE REF TO)	DATA		Elementares Datenobjekt	20120504

Method ELEMENTARY2STRUCTURED on class CL_DEMO_OUTPUT_STREAM has no exception.

Method FINALIZE_STREAM Signature

Method FINALIZE_STREAM on class CL_DEMO_OUTPUT_STREAM has no parameter.
Method FINALIZE_STREAM on class CL_DEMO_OUTPUT_STREAM has no exception.

Method FINALIZE_XML Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_XML	Value transfer	☐	Type reference (TYPE)	STRING		Zeichenartiger XML-Ausgabestrom	20120504
2	Returning	RV_XML	Value transfer	☐	Type reference (TYPE)	XSTRING		Byteartiger XML-Ausgabestrom	20120504

#	Exception	Resumable	Description	Created on
1	CX_SY_REGEX_TOO_COMPLEX	☐		20131028

Method OPEN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_STREAM	Value transfer	☐	Object reference (TYPE REF TO)	CL_DEMO_OUTPUT_STREAM		Referenz auf Stromobjekt	20120504

Method OPEN on class CL_DEMO_OUTPUT_STREAM has no exception.

Method STRUCTURED2TABULAR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_STRUCT_TYPE	Call by reference	☐	Object reference (TYPE REF TO)	CL_ABAP_STRUCTDESCR		Referenz auf Datentyp des strukturierten Datenobjekts	20120504
2	Importing	IR_STRUCTURED	Call by reference	☐	Object reference (TYPE REF TO)	DATA		Strukturiertes Datenobjekt	20120504
3	Returning	RR_TABULAR	Value transfer	☐	Object reference (TYPE REF TO)	DATA		Tabellenartiges Datenobjekt	20120504

Method STRUCTURED2TABULAR on class CL_DEMO_OUTPUT_STREAM has no exception.

Method WRITE_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IA_VALUE	Call by reference	☐	Type reference (TYPE)	DATA		Elementares Datenobjekt, Struktur, interne Tabelle	20120504
2	Importing	IV_FORMAT	Value transfer	☑	Type reference (TYPE)	STRING		Initial (proportional) oder IF_DEMO_OUTPUT=>NONPROP	20120917
3	Importing	IV_NAME	Value transfer	☑	Type reference (TYPE)	STRING		Name	20130422

Method WRITE_DATA on class CL_DEMO_OUTPUT_STREAM has no exception.

Method WRITE_HTML Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_HTML	Value transfer	☐	Type reference (TYPE)	STRING		Text mit HTML-Tags	20120511

Method WRITE_HTML on class CL_DEMO_OUTPUT_STREAM has no exception.

Method WRITE_JSON Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_JSON	Value transfer	☑	Type reference (TYPE)	STRING		Text in JSON-Format	20120902
2	Importing	IV_XJSON	Value transfer	☑	Type reference (TYPE)	XSTRING		Binärdarstellung von Text in JSON-Format	20120902

Method WRITE_JSON on class CL_DEMO_OUTPUT_STREAM has no exception.

Method WRITE_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_FORMAT	Value transfer	☐	Type reference (TYPE)	STRING	GC_TEXT	Format aus IF_DEMO_OUTPUT	20120504
2	Importing	IV_LEVEL	Value transfer	☐	Type reference (TYPE)	I	1	Überschriftenebene (1 bis 4)	20120504
3	Importing	IV_TEXT	Value transfer	☐	Type reference (TYPE)	STRING		Text	20120504

Method WRITE_TEXT on class CL_DEMO_OUTPUT_STREAM has no exception.

Method WRITE_XML Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_XML	Value transfer	☑	Type reference (TYPE)	STRING		Text mit XML-Tags	20120508
2	Importing	IV_XXML	Value transfer	☑	Type reference (TYPE)	XSTRING		Binärdarstellung von Text mit XML-Tags	20120510

Method WRITE_XML on class CL_DEMO_OUTPUT_STREAM has no exception.

Event Signatures

Event COMPLETED Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	EV_OUTPUT	Exporting	Value transfer	☐	Type reference (TYPE)	XSTRING		Ausgabestrom im XML-Format	20120504

History

Last changed by/on	SAP	20140121
SAP Release Created in	732