SAP ABAP Interface IF_SXML_READER (XML Reader of sXML Library)
Hierarchy
☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-ABA-XML (Application Component) ABAP XML Processing
     ⤷ SXML (Package) Streamed XML Reader/Writer
Meta Relationship - Used By
# Relationship type Used by Short Description Created on
1 Interface implementation (CLASS c. INTERFACES i_ref)  CL_SXML_READER XML Reader of sXML Library 20041209
Properties
Interface IF_SXML_READER  
Short Description XML Reader of sXML Library    
General Data
Package SXML   Streamed XML Reader/Writer 
Created 20041209   SAP 
Last changed 20130531   SAP 
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)
2 IF_SXML_NAMED Forward declaration interface (INTERFACE i DEFINITION DEF...  Forward declaration interface (INTERFACE i DEFINITION DEF...
3 IF_SXML_NODE Forward declaration interface (INTERFACE i DEFINITION DEF...  Forward declaration interface (INTERFACE i DEFINITION DEF...
4 IF_SXML_VALUE Forward declaration interface (INTERFACE i DEFINITION DEF...  Forward declaration interface (INTERFACE i DEFINITION DEF...
Interfaces
# Interface Abstract Final Description Created on
1 IF_SXML Supported Formats of sXML Library 20041215
2 IF_SXML_NSURI_HELPER Service Methods for Readers and Writers of sXML Library 20041215
Friends
Interface IF_SXML_READER has no friend.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 CO_OPT_ASXML Constant Public Type reference (TYPE) I 3 Option: JSON Data contains asXML Part 20111102
2 CO_OPT_KEEP_WHITESPACE Constant Public Type reference (TYPE) I 2 Option: Pure Whitespace Texts Remain 20081013
3 CO_OPT_NORMALIZING Constant Public Type reference (TYPE) I 1 Option: Line Breaks in Accordance with XML Specifications 20081013
4 CO_OPT_SEP_MEMBER Constant Public Type reference (TYPE) I 4 Option: Object value in JSON data is a separate element 20111102
5 NAME Instance attribute Public Type reference (TYPE) STRING Node Name 20041210
6 NODE_TYPE Instance attribute Public Type reference (TYPE) IF_SXML_NODE=>NODE_TYPE Node type according to IF_SXML_NODE=>CO_NT_... 20041210
7 NSURI Instance attribute Public Type reference (TYPE) STRING Namespace URI 20041210
8 PREFIX Instance attribute Public Type reference (TYPE) STRING Namespace prefix 20041210
9 VALUE Instance attribute Public Type reference (TYPE) STRING Value (Text Data) 20041210
10 VALUE_RAW Instance attribute Public Type reference (TYPE) XSTRING Value (Raw Data) 20041210
11 VALUE_TYPE Instance attribute Public Type reference (TYPE) IF_SXML_VALUE=>VALUE_TYPE Value Type in accordance with IF_SXML_VALUE=>CO_VT_... 20041210
12 XML_TYPE Instance attribute Public Attribute reference (LIKE) 20041215
Methods
# Method Level Visibility Method type Description Created on
1 CURRENT_NODE Instance method Public Method Sets parser when current node opened (Token-based) 20041214
2 GET_ATTRIBUTE_VALUE Instance method Public Method Uses specific attribute value (token-based parsing) 20041210
3 GET_BYTE_OFFSET Instance method Public Method Returns number of bytes rad up to now) 20080711
4 GET_NSBINDINGS Instance method Public Method Read Over Next Node 20041215
5 GET_NSURI_BY_PREFIX Instance method Public Method Read Over Next Node 20041215
6 GET_OPTION Instance method Public Method Indicates whether an option is set 20111108
7 GET_PATH Instance method Public Method Read Over Next Node 20041214
8 GET_PREFIX_BY_NSURI Instance method Public Method Read Over Next Node 20041215
9 GET_VSI Instance method Public Method Return the Set Virus Scanner 20110928
10 NEXT_ATTRIBUTE Instance method Public Method Reads next attribute (token-based parsing) 20041210
11 NEXT_ATTRIBUTE_VALUE Instance method Public Method Uses current attribute value (token-based parsing) 20041210
12 NEXT_NODE Instance method Public Method Sets parser to next node (token-based parsing) 20041209
13 PUSH_BACK Instance method Public Method Sets parser to opening element of direct parent node 20041209
14 READ_CURRENT_NODE Instance method Public Method Sets parser to opening element of current node (OO) 20041214
15 READ_NEXT_NODE Instance method Public Method Sets parser to next node (object-oriented parsing) 20041214
16 SET_OPTION Instance method Public Method Sets option to control the reader, see long text 20081013
17 SET_VSI Instance method Public Method Sets a Virus Scanner 20110928
18 SKIP_NODE Instance method Public Method Parses the subtree for closing element 20041209
Events
Interface IF_SXML_READER has no event.
Types
Interface IF_SXML_READER has no local type.
Method Signatures

Method CURRENT_NODE Signature

Method CURRENT_NODE on Interface IF_SXML_READER has no parameter.
Method CURRENT_NODE on Interface IF_SXML_READER has no exception.

Method GET_ATTRIBUTE_VALUE 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 Name des Attributs 20041210
2 Importing NSURI Call by reference Type reference (TYPE) STRING Namensraum-URI 20041210
3 Importing VALUE_TYPE Call by reference Type reference (TYPE) IF_SXML_VALUE=>VALUE_TYPE IF_SXML_VALUE=>CO_VT_TEXT Gewünschter Typ für Attributwert 20041210
# Exception Resumable Description Created on
1 CX_SXML_PARSE_ERROR 20050118
2 CX_SXML_STATE_ERROR SXML State error 20041215

Method GET_BYTE_OFFSET Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning OFFSET Value transfer Type reference (TYPE) I Byte-Offset der aktuellen Position des Parsers 20080711

Method GET_BYTE_OFFSET on Interface IF_SXML_READER has no exception.

Method GET_NSBINDINGS Signature

Method GET_NSBINDINGS on Interface IF_SXML_READER has no parameter.
Method GET_NSBINDINGS on Interface IF_SXML_READER has no exception.

Method GET_NSURI_BY_PREFIX Signature

Method GET_NSURI_BY_PREFIX on Interface IF_SXML_READER has no parameter.
Method GET_NSURI_BY_PREFIX on Interface IF_SXML_READER has no exception.

Method GET_OPTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing OPTION Call by reference Type reference (TYPE) I Von SET_OPTION setzbare Option 20111108
2 Returning VALUE Value transfer Type reference (TYPE) ABAP_BOOL abap_true falls gesetzt , abap false falls nicht gesetzt 20111108

Method GET_OPTION on Interface IF_SXML_READER has no exception.

Method GET_PATH Signature

Method GET_PATH on Interface IF_SXML_READER has no parameter.
Method GET_PATH on Interface IF_SXML_READER has no exception.

Method GET_PREFIX_BY_NSURI Signature

Method GET_PREFIX_BY_NSURI on Interface IF_SXML_READER has no parameter.
Method GET_PREFIX_BY_NSURI on Interface IF_SXML_READER has no exception.

Method GET_VSI Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning VSI Value transfer Object reference (TYPE REF TO) CL_VSI_KERNEL Referenz auf Viren-Scanner 20110928

Method GET_VSI on Interface IF_SXML_READER has no exception.

Method NEXT_ATTRIBUTE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing VALUE_TYPE Call by reference Type reference (TYPE) IF_SXML_VALUE=>VALUE_TYPE IF_SXML_VALUE=>CO_VT_TEXT Gewünschter Typ für Attributwert 20041210
# Exception Resumable Description Created on
1 CX_SXML_PARSE_ERROR 20050118
2 CX_SXML_STATE_ERROR SXML State error 20041215

Method NEXT_ATTRIBUTE_VALUE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing VALUE_TYPE Call by reference Type reference (TYPE) IF_SXML_VALUE=>VALUE_TYPE IF_SXML_VALUE=>CO_VT_TEXT Gewünschter Typ für Attributwert 20041210
# Exception Resumable Description Created on
1 CX_SXML_PARSE_ERROR 20050118
2 CX_SXML_STATE_ERROR SXML State error 20041215

Method NEXT_NODE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing VALUE_TYPE Call by reference Type reference (TYPE) IF_SXML_VALUE=>VALUE_TYPE IF_SXML_VALUE=>CO_VT_TEXT Gewünschter Typ für Wert-Knoten 20041210
# Exception Resumable Description Created on
1 CX_SXML_PARSE_ERROR 20050118

Method PUSH_BACK Signature

Method PUSH_BACK on Interface IF_SXML_READER has no parameter.
# Exception Resumable Description Created on
1 CX_SXML_STATE_ERROR SXML State error 20041215

Method READ_CURRENT_NODE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning NODE Value transfer Object reference (TYPE REF TO) IF_SXML_NODE Referenz auf Knotenobjekt für aktuellen Knoten 20041214

Method READ_CURRENT_NODE on Interface IF_SXML_READER has no exception.

Method READ_NEXT_NODE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning NODE Value transfer Object reference (TYPE REF TO) IF_SXML_NODE Referenz auf Knotenobjekt für aktuellen Knoten 20041214
# Exception Resumable Description Created on
1 CX_SXML_PARSE_ERROR 20050118

Method SET_OPTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing OPTION Call by reference Type reference (TYPE) I Zu setzende Option, siehe Langtext 20081013
2 Importing VALUE Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE abap_true setzt Option, abap false hebt gesetzte Option auf 20081013

Method SET_OPTION on Interface IF_SXML_READER has no exception.

Method SET_VSI Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing VSI Value transfer Object reference (TYPE REF TO) CL_VSI_KERNEL Referenz auf Viren-Scanner 20110928

Method SET_VSI on Interface IF_SXML_READER has no exception.

Method SKIP_NODE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing WRITER Call by reference Object reference (TYPE REF TO) IF_SXML_WRITER XML-Writer, in den der aktuelle Teilbaum geschrieben wird 20041210
# Exception Resumable Description Created on
1 CX_SXML_PARSE_ERROR 20050118
History
Last changed by/on SAP  20130531 
SAP Release Created in 700