Interface if_ixml_stream
Interface if_ixml_stream
The iXMLStream interface has to be implemented by all XML streams.
Creation of XML input streams is done indirectly by calling the factory method createIStream...()/createOStream...() of the client application's StreamFactory instance or by cloning existing CiXMLIStream instances if appropriate.
specializes
enumerations
methods
method clone
This method returns a clone (copy) of this XML input stream.
interface
if_ixml_stream
return value
Returns a clone of itself or null if an error occured.
abap signature
method clone
returning
value(rval) type ref to if_ixml_stream.
method close
This method explicitely closes this stream (e.g. the associated file with a file iXMLIStream).
interface
if_ixml_stream
abap signature
method close.
method get_encoding
This method returns the currently set encoding which is used when converting raw data read or written from the stream.
interface
if_ixml_stream
return value
Returns the currently set character encoding for this stream.
abap signature
method get_encoding
returning
value(rval) type ref to if_ixml_encoding.
method get_public_id
This method returns the public ID of the source/target of this XML stream if defined.
interface
if_ixml_stream
return value
Returns the public ID of the source/target of this XML stream or null, if the ID is not defined.
abap signature
method get_public_id
returning
value(rval) type string.
method get_system_id
This method returns the system ID of the source/target of this XML stream.
interface
if_ixml_stream
return value
Returns the system ID of the source/target of this XML stream.
abap signature
method get_system_id
returning
value(rval) type string.
method is_capable
This method returns true, if this XML stream is capable of handling the given system ID and/or public ID.
interface
if_ixml_stream
parameters
system_id
The system ID (URL) to check.
public_id
The public ID to check (optional).
return value
Returns true if this XML stream is capable of handling the given system ID and/or public ID, false otherwise.
abap signature
method is_capable
importing
system_id type string
public_id type string
returning
value(rval) type boolean.
method make_absolute_id
This method creates an absolute ID (URL) for the given ID (currentId).
interface
if_ixml_stream
return value
Returns the absolute ID build from id and currentId.
abap signature
method make_absolute_id
importing
id type string
current_id type string
returning
value(rval) type string.
method open
This method explicitely opens this stream (e.g. the associated file with a file iXMLIStream).
interface
if_ixml_stream
abap signature
method open
returning
value(rval) type boolean.
method set_encoding
This method sets the character encoding to be used when converting from or to raw data when reading or writing to the stream.
interface
if_ixml_stream
parameters
encoding
The character encoding to use as specified in the XML 1.0 specification.
return value
Returns true if the encoding can be handled by the stream, false otherwise.
abap signature
method set_encoding
importing
encoding type ref to if_ixml_encoding
returning
value(rval) type boolean.
method set_public_id
This method sets the public ID of the source/target of this XML stream.
interface
if_ixml_stream
parameters
public_id
The public Id to set.
abap signature
method set_public_id
importing
public_id type string.
method set_system_id
This method sets the system ID of the source/target of this XML stream.
interface
if_ixml_stream
parameters
system_id
The system Id to set (URI, e.g. "http://..." or "file://...")
abap signature
method set_system_id
importing
system_id type string.
method query_interface
Queries the specified interface.
interface
if_ixml_stream
parameters
iid
The interface ID of the interface to query.
return value
Returns a reference to the queried interface or null if no such interface is supported.
abap signature
method query_interface
importing
iid type I
returning
value(rval) type I.