Interface if_ixml_ostream
Interface if_ixml_ostream
The iXMLOStream interface has to be implemented by all XML output streams.
Creation of XML output streams is done indirectly by calling the factory method createOStream() of the client application's StreamFactory instance.
specializes
enumerations
methods
method get_escaped
This method returns whether escaping has been enabled for the next string written to the stream.
interface
if_ixml_ostream
return value
True, if the next string written will be escaped, false otherwise.
abap signature
method get_escaped
returning
value(rval) type boolean.
method get_ignore_escaping
This method returns the special characters for which escaping is ignored.
interface
if_ixml_ostream
abap signature
method get_ignore_escaping
returning
value(rval) type string.
method get_indent
This method returns the currently set indentation level (number of indentation character repetitions) set for this stream.
interface
if_ixml_ostream
return value
The current indentation level ((number of indentation character repetitions).
abap signature
method get_indent
returning
value(rval) type I.
method get_indent_char
This method returns the currently set indentation character (typically space or tab).
interface
if_ixml_ostream
return value
The current indentation character.
abap signature
method get_indent_char
returning
value(rval) type ixml_c1.
method get_num_written
This method returns the number of characters (UCS-2) written to this stream since it was last opened.
interface
if_ixml_ostream
return value
Returns the number of characters written to this stream.
abap signature
method get_num_written
returning
value(rval) type I.
method get_num_written_raw
This method returns the number of bytes written to this stream since it was last opened.
interface
if_ixml_ostream
return value
Returns the number of bytes written to this stream.
abap signature
method get_num_written_raw
returning
value(rval) type I.
method get_pretty_print
This method returns whether pretty printing has been enabled for this stream.
interface
if_ixml_ostream
return value
True, if pretty printing is enabled, false otherwise.
abap signature
method get_pretty_print
returning
value(rval) type boolean.
method get_quoted
This method returns whether quotation has been enabled for the next string written to the stream.
interface
if_ixml_ostream
return value
True, if the next string written will be quoted, false otherwise.
abap signature
method get_quoted
returning
value(rval) type boolean.
method set_escaped
This method specifies whether the next string written to the stream will be written with certain characters escaped as character references (depending on where the string is placed in the document context (DTD or content etc.).
interface
if_ixml_ostream
parameters
is_escaped
True, if the next string written should be escaped, false otherwise.
abap signature
method set_escaped
importing
is_escaped type boolean.
method set_ignore_escaping
This method overrides subsequent calls to setEscaped(), such that these characters will not be escaped in any case.
interface
if_ixml_ostream
parameters
ignore_escaping
The special characters which should not be escaped.
abap signature
method set_ignore_escaping
importing
ignore_escaping type string.
method set_indent
This method specifies how many repetitions of the character defined as indentation character (set iXMLOStream::setIndentChar()) should be inserted into the output after each new-line character written.
interface
if_ixml_ostream
parameters
indent
The number of indentation characters after each new-line character written.
abap signature
method set_indent
importing
indent type I.
method set_indent_char
This method specifies what character will be used as indentation character after each new-line character written (typically space or tab). Indentation characters will only be written, if pretty printing has been enabled for this stream (see iXMLOStream::setPrettyPrint()).
interface
if_ixml_ostream
parameters
indent_char
The indentation characters to be used after each new-line character written.
abap signature
method set_indent_char
importing
indent_char type ixml_c1.
method set_pretty_print
This method specifies whether the stream should suppress new-lines and indentation for the output.
interface
if_ixml_ostream
parameters
pretty_print
[ default 'X' ]False, if the new-lines and indentation should be suppressed, true otherwise.
abap signature
method set_pretty_print
importing
pretty_print type boolean default 'X'.
method set_quoted
This method specifies whether the next string written to the stream will be enclosed in quotes (either single or double quotes, depending on the content of the string).
interface
if_ixml_ostream
parameters
is_quoted
True, if the next string written should be quoted, false otherwise.
abap signature
method set_quoted
importing
is_quoted type boolean.
method write_string
This method writes the given string to the XML output stream after converting it with the currently set character encoding.
interface
if_ixml_ostream
parameters
string
The string to write.
return value
Returns the number of characters (not bytes!) written from the string argument (0..length(string)).
abap signature
method write_string
importing
string type string
returning
value(rval) type I.
method clone
This method returns a clone (copy) of this XML input stream.
interface
if_ixml_ostream
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_ostream
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_ostream
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_ostream
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_ostream
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_ostream
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_ostream
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_ostream
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_ostream
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_ostream
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_ostream
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_ostream
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.