SAP ABAP Class CL_FX_READER (Obsolete, replaced by CL_SXML_READER)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-ABA-XML (Application Component) ABAP XML Processing
     ⤷ SXML (Package) Streamed XML Reader/Writer

Properties

Class	CL_FX_READER
Short Description	Obsolete, replaced by CL_SXML_READER
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	SXML	Streamed XML Reader/Writer
Created	20030805	SAP
Last change	20130531	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

Class CL_FX_READER has no interface implemented.

Friends

Class CL_FX_READER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	ATTNUM	Instance attribute	Public	☑	Type reference (TYPE)	I		Attribute Count	20030805
2	ATTRIB	Instance attribute	Public	☑	Type reference (TYPE)	ATTRIBUTES		Node Attributes	20050118
3	CFG_ENTITYREF_ERROR	Constant	Public	☐	Type reference (TYPE)	I	2	Mode: Error on Entry Ref (Else Copy)	20030805
4	CFG_RESOLVE_CHARREF	Constant	Public	☐	Type reference (TYPE)	I	1	Mode: Resolve Character and Build-in Refs	20030805
5	CFG_SKIP_WHITESPACE	Constant	Public	☐	Type reference (TYPE)	I	3	Mode: Skip Whitespace Only Text	20030805
6	CONSUMED	Instance attribute	Public	☑	Type reference (TYPE)	I		Bytes Consumed	20030805
7	DSIG_INFO	Instance attribute	Public	☐	Type reference (TYPE)	SEC_XML_DSIG_INFO_TAB		Signature Info	20041221
8	ERROR	Instance attribute	Public	☑	Type reference (TYPE)	STRING		Error Message	20030805
9	FILENAME	Instance attribute	Private	☐	Type reference (TYPE)	STRING		File Name	20060908
10	FLAGS	Instance attribute	Public	☑	Type reference (TYPE)	I		Node Flags	20030805
11	FL_CDATA_SECTION	Constant	Public	☐	Type reference (TYPE)	I	2	Flag: Cdata Section Node	20030805
12	FL_CHAR_DATA	Constant	Public	☐	Type reference (TYPE)	I	1	Flag: Char Data (Not Whitespace Only)	20030805
13	FL_CHAR_REF	Constant	Public	☐	Type reference (TYPE)	I	4	Flag:Cdata Contains Resolved Char Refs	20030805
14	FL_ENTITY_REF	Constant	Public	☐	Type reference (TYPE)	I	8	Flag: Cdata Contains Entity Refs	20030805
15	INPUT	Instance attribute	Private	☐	Type reference (TYPE)	XSTRING		Input Buffer	20030805
16	NAME	Instance attribute	Public	☑	Type reference (TYPE)	STRING		Local Name	20030805
17	NSDECL	Instance attribute	Public	☑	Type reference (TYPE)	I		Namespace nsdecl attributes	20030805
18	NSURI	Instance attribute	Public	☑	Type reference (TYPE)	STRING		Namespace URI	20030805
19	PREFIX	Instance attribute	Public	☑	Type reference (TYPE)	STRING		Namespace Prefix	20030805
20	PTR	Instance attribute	Private	☐	Type reference (TYPE)	%_C_POINTER		Xreader Pointer	20030805
21	TK_ATTRIBUTE	Constant	Public	☐	Type reference (TYPE)	I	32	Token: Attribute (Internal)	20030805
22	TK_CHAR_DATA	Constant	Public	☐	Type reference (TYPE)	I	4	Token: Character Data	20030805
23	TK_COMMENT	Constant	Public	☐	Type reference (TYPE)	I	8	Token: Comment Data	20030805
24	TK_END_OF_ENTITY	Constant	Public	☐	Type reference (TYPE)	I	0	Token: End of Stream Reached	20030805
25	TK_END_TAG	Constant	Public	☐	Type reference (TYPE)	I	2	Token: End Tag	20030805
26	TK_ERROR	Constant	Public	☐	Type reference (TYPE)	I	-2	Token: Invalid Token Found	20030805
27	TK_PARTIAL	Constant	Public	☐	Type reference (TYPE)	I	-1	Token: Partial Parsed Token	20030805
28	TK_PI	Constant	Public	☐	Type reference (TYPE)	I	16	Token: Processing Instruction	20030805
29	TK_START_TAG	Constant	Public	☐	Type reference (TYPE)	I	1	Token: Start Tag	20030805
30	TOKENS	Instance attribute	Public	☑	Type reference (TYPE)	I		Token Count	20030805
31	TYPE	Instance attribute	Public	☑	Type reference (TYPE)	I		Node Type	20030805
32	VALUE	Instance attribute	Public	☑	Type reference (TYPE)	STRING		Value	20030805
33	VALUE_RAW	Instance attribute	Public	☑	Type reference (TYPE)	XSTRING		Raw Value	20050118
34	VALUE_TYPE	Instance attribute	Public	☑	Type reference (TYPE)	I		Value Type	20050118
35	XENC_INFO	Instance attribute	Public	☐	Type reference (TYPE)	SEC_XML_XENC_INFO_TAB		Encryption Information	20041221

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CREATE	Static method	Public	Method	Create Reader Instance	20030805
2	DESTRUCTOR	Instance method	Public	Destructor	Destroy Kernel Reader (don't call manualy)	20030805
3	GET_ATTRIBUTE	Instance method	Public	Method	Access Attributes by Index	20030805
4	GET_FEATURE	Instance method	Public	Method	get reader option	20030805
5	GET_NSBINDINGS	Instance method	Public	Method	namespace bindings in scope	20050118
6	GET_PATH	Instance method	Public	Method	get path up to root node	20050118
7	INITIALIZE	Instance method	Public	Method	Initialize Kernel Reader	20030805
8	INITIALIZE_DATASET	Instance method	Private	Method	Initialize Kernel Dataset Reader	20060908
9	NEXT_NODE	Instance method	Public	Method	read next node from stream	20030805
10	NSURI_BY_PREFIX	Instance method	Public	Method	Resolve a namespace URI by a namespace prefix	20030805
11	PREFIX_BY_NSURI	Instance method	Public	Method	Resolve a namespace prefix by a namespace uri	20030805
12	PUSH_BACK	Instance method	Public	Method	push last node back into the stream	20030805
13	SET_FEATURE	Instance method	Public	Method	set reader option	20030805
14	SET_SECURITY	Instance method	Public	Method	Set XML Security	20050124
15	SKIP_NODE	Instance method	Public	Method	Skip current node or subtree	20030805

Events

Class CL_FX_READER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	ATTRIBUTE	Public	See coding			20050118	BEGIN OF attribute, name TYPE string, " localname prefix TYPE string, " namespace prefix nsuri TYPE string, " namespace uri value TYPE string, " attribute value rawval TYPE xstring, " bxml raw value END OF attribute
2	ATTRIBUTES	Public	See coding			20050118	attributes TYPE STANDARD TABLE OF attribute WITH DEFAULT KEY
3	NSBINDING	Public	See coding			20050118	BEGIN OF nsbinding, prefix TYPE string, " namespace prefix nsuri TYPE string, " namespace uri END OF nsbinding
4	NSBINDINGS	Public	See coding			20050118	nsbindings TYPE STANDARD TABLE OF nsbinding WITH DEFAULT KEY
5	PATH_NODE	Public	See coding			20050118	BEGIN OF path_node, name TYPE string, " localname prefix TYPE string, " namespace prefix nsuri TYPE string, " namespace uri pos TYPE i, " child position END OF path_node
6	PATH_NODES	Public	See coding			20050118	path_nodes TYPE STANDARD TABLE OF path_node WITH DEFAULT KEY

Method Signatures

Method CREATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FILENAME	Call by reference	☑	Type reference (TYPE)	STRING			20060908
2	Importing	INPUT	Call by reference	☑	Type reference (TYPE)	XSTRING			20030805
3	Returning	READER	Value transfer	☐	Object reference (TYPE REF TO)	CL_FX_READER			20030805

Method CREATE on class CL_FX_READER has no exception.

Method DESTRUCTOR Signature

Method DESTRUCTOR on class CL_FX_READER has no parameter.
Method DESTRUCTOR on class CL_FX_READER has no exception.

Method GET_ATTRIBUTE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	INDEX	Call by reference	☐	Type reference (TYPE)	I			20030805
2	Exporting	NAME	Call by reference	☐	Type reference (TYPE)	STRING			20030805
3	Exporting	NSURI	Call by reference	☐	Type reference (TYPE)	STRING			20030805
4	Exporting	PREFIX	Call by reference	☐	Type reference (TYPE)	STRING			20030805
5	Exporting	RETCODE	Call by reference	☐	Type reference (TYPE)	I			20030805
6	Exporting	VALUE	Call by reference	☐	Type reference (TYPE)	STRING			20030805

Method GET_ATTRIBUTE on class CL_FX_READER has no exception.

Method GET_FEATURE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FEATURE	Call by reference	☐	Type reference (TYPE)	I			20030805
2	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20030805

Method GET_FEATURE on class CL_FX_READER has no exception.

Method GET_NSBINDINGS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	NSBINDINGS	Value transfer	☐	Type reference (TYPE)	NSBINDINGS			20050118

Method GET_NSBINDINGS on class CL_FX_READER has no exception.

Method GET_PATH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	PATH_NODES	Value transfer	☐	Type reference (TYPE)	PATH_NODES			20050118

Method GET_PATH on class CL_FX_READER has no exception.

Method INITIALIZE Signature

Method INITIALIZE on class CL_FX_READER has no parameter.
Method INITIALIZE on class CL_FX_READER has no exception.

Method INITIALIZE_DATASET Signature

Method INITIALIZE_DATASET on class CL_FX_READER has no parameter.
Method INITIALIZE_DATASET on class CL_FX_READER has no exception.

Method NEXT_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RETCODE	Value transfer	☐	Type reference (TYPE)	I			20030805

Method NEXT_NODE on class CL_FX_READER has no exception.

Method NSURI_BY_PREFIX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	NSURI	Value transfer	☐	Type reference (TYPE)	STRING			20030805
2	Importing	PREFIX	Call by reference	☐	Type reference (TYPE)	STRING			20030805

Method NSURI_BY_PREFIX on class CL_FX_READER has no exception.

Method PREFIX_BY_NSURI Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NSURI	Call by reference	☐	Type reference (TYPE)	STRING			20030805
2	Returning	PREFIX	Value transfer	☐	Type reference (TYPE)	STRING			20030805

Method PREFIX_BY_NSURI on class CL_FX_READER has no exception.

Method PUSH_BACK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RETCODE	Value transfer	☐	Type reference (TYPE)	I			20030805

Method PUSH_BACK on class CL_FX_READER has no exception.

Method SET_FEATURE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ENABLED	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20030805
2	Importing	FEATURE	Call by reference	☐	Type reference (TYPE)	I			20030805
3	Returning	OLDVAL	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20030805

Method SET_FEATURE on class CL_FX_READER has no exception.

Method SET_SECURITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ENABLED	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20050124
2	Returning	OLDVAL	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20050124

Method SET_SECURITY on class CL_FX_READER has no exception.

Method SKIP_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RETCODE	Value transfer	☐	Type reference (TYPE)	I			20030805
2	Importing	WRITER	Call by reference	☑	Object reference (TYPE REF TO)	CL_FX_WRITER		fast streamed xml writer	20040923

Method SKIP_NODE on class CL_FX_READER has no exception.

History

Last changed by/on	SAP	20130531
SAP Release Created in	640