load serializer.xmlstream

This module provides the Serializer.XmlStream class which allow to read and write XML documents.

• Serializer

This enum describe the behaviour of the readElementText method when a child element is encountred.

This enum describe the current state of the parser. The values of this enum will be used to check how to handle the next character.

This class is the representation of an XML attribute.

This class is the representation of an element's XML attributes.

This class class provides a way to read and write XML documents.

• Serializer.DocumentStream

This class provides a parser to convert an XML stream to tokens.

This class describe an attribute.

This class describe a namespace declaration.

This class describe an element tag.

This class provides a writer to convert events to formated XML into a stream.

def (const self, const other)

Returns false if other is the same attribute than self; otherwise returns true.

def (const self, const other)

Returns true if other is the same attribute than self; otherwise returns false.

def (const self)

Returns the local name of the attribute.

def (const self)

Returns the namespace URI of the attribute.

def (const self)

Returns the prefix (namespace) of the attribute.

def (const self)

Returns the qualified name of the attribute (prefix + name).

def (const self)

Returns the value of the attribute.

''

Internal attribute name.

''

Internal attribute namespace URI.

def (self)

Creates a new empty attribute.

def (self, qualifiedName, value)

Creates a new attribute with the given qualifiedName and value.

def (self, namespaceUri, qualifiedName, value)

Creates a new attribute with the given namespaceUri, qualifiedName and value.

''

Internal attribute qualified name.

def (const self, const value)

Sets the value of the attribute to value.

def (const self)

Returns the string representation of the attribute.

''

Internal attribute value.

def (const self, const other)

Returns true if other is not equal to this list of attributes; otherwise returns false.

Two lists are considered equal if they contain the same attributes in the same order.

def (self, other)

Copies the attributes contained in other into self then returns self.

def (self, attr)

Inserts attr at the end of the list.

def (const self, const other)

Returns true if other is equal to this list of attributes; otherwise returns false.

Two lists are considered equal if they contain the same attributes in the same order.

def (const self, const index)

Returns the attribute at the given index.

def (self, const qualifiedName, const value)

Sets the value of the first attribute with the given qualifiedName to value. If no element matched, a new attribute is created at the end of the list.

[]

Internal attributes.

def (self)

Removes all the attributes of the list.

def (const self, const qualifiedName)

Returns true if the list contains an attribute with the given qualifiedName; otherwise returns false.

def (const self, const namespaceUri, const localName)

Returns true if the list contains an attribute with the givens namespaceUri and localName; otherwise returns false.

def (const self, const qualifiedName)

Returns the first attribute with the given qualifiedName.

def (const self, const namespaceUri, const localName)

Returns the first attribute with the givens namespaceUri and localName.

def (const self, const qualifiedName)

Returns true if the list contains an attribute with the given qualifiedName; otherwise returns false.

def (const self)

Returns an iterator on each attribute of the list.

def (const self, const qualifiedName)

Returns the index position of the first attribute with the given qualifiedName. Returns none if no element matched.

def (const self, const namespaceUri, const localName)

Returns the index position of the first attribute with the givens namespaceUri and localName. Returns none if no element matched.

def (self, index, qualifiedName, value)

Creates a new attribute with the given qualifiedName and value at the given index.

def (self, index, namespaceUri, qualifiedName, value)

Creates a new attribute with the given namespaceUri, qualifiedName and value at the given index.

def (const self)

Returns true if the list is empty; otherwise returns false.

def (self, const qualifiedName)

Removes the first attribute with the given qualifiedName.

def (self, const namespaceUri, const localName)

Removes the first attribute with the givens namespaceUri and localName.

def (const self)

Returns the number of attributes in the list.

def (const self)

Returns the string representation of the attribute list.

def (const self, const qualifiedName)

Returns the value of the first attribute with the given qualifiedName. Returns none if no element matched.

def (const self, const namespaceUri, const localName)

Returns the value of the first attribute with the givens namespaceUri and localName. Returns none if no element matched.

def (self, data)

Writes the content of data to the stream using the write function, then returns a reference to the stream.

0

The children elements makes the stream raises an instance of Serializer.DocumentStream.InvalidDocument.

1

The children elements are included in the element text.

2

The children elements are ignored.

''

''

''

''

''

15

Reading a tag attribute name (<... ... )

16

Reading a tag attribute value (<... ...="..." )

4

Reading a CDATA open token (<![CDATA[ )

5

Reading the content of a CDATA (<![CDATA[...]]> )

3

Reading character inside a markup (<tag>...</tag> )

2

Reading a comment (<!-- ... --> )

6

Reading a DTD open token (<!DOCTYPE )

7

Reading the content of a DTD (<!DOCTYPE ... [ ... ]> )

0

Waiting for a new element

1

Reading an opening token (< )

10

Reading a processing instruction attribute name (<?... ... )

11

Reading a processing instruction attribute value (<?... ...="..." )

8

Reading a processing instruction close token (?> )

9

Reading a processing instruction tag name (<?... )

12

Reading a tag close token (</...> )

13

Reading an empty tag close token (<.../> )

14

Reading a tag name (<... )

none

''

''

null

def (self, c)

Returns the next non white space character.

[]

'UTF-8'

def (self, isEmptyTag)

Handles a end element token.

def (self)

Handles a start element token.

def (self, qualifiedName, value)

Handles an XML attribute.

false

[]

def (self, prefix)

Returns the namespace URI for the given prefix.

''

[]

def (self, stream)

Creates a new parser on the stream given by stream.

def (self)

Reads the XML document and parses it until the next token. Returns true if the parsing is completed successfully; otherwise returns false, indicating that an event has not been correctly handled by the handler.

An instance of Serializer.DocumentStream.InvalidDocument is raised on error.

def (self)

Returns the content of the next attribute value of the stream.

An instance of Serializer.DocumentStream.InvalidDocument is raised on error.

def (self, c)

Returns the value corresponding to the next escape sequence of the stream.

An instance of Serializer.DocumentStream.InvalidDocument is raised on error.

''

def (self)

Resolve all namepaces for the current element

false

null

null

Internal stream object.

''

''

null

'1.0'

8

6

7

9

3

5

0

1

2

4

false

Internal automatic closing state.

[]

Internal element stack.

0

Internal current indentation level.

false

Internal indentation format state.

def (self, stream)

Creates a new writer on the stream given by stream.

def (self, content)

Writes a CDATA section to the output stream. Returns true to continue input stream parsing.

def (self, content)

Writes a character section to the output stream. Returns true to continue input stream parsing.

def (self, content)

Writes a comment section to the output stream. Returns true to continue input stream parsing.

def (self, content)

Writes a DTD section to the output stream. Returns true to continue input stream parsing.

def (self)

Ends the data writing to the output stream. Returns true to continue input stream parsing.

def (self, namespaceUri, localName, qualifiedName)

Writes a closing element to the output stream. If the element tag name does not match the previously opened element, the function returns false to interput the parsing; otherwise returns true.

def (self)

Writes a closing element to the output stream matching the last opened element. If no element is open, the function returns false to interput the parsing; otherwise returns true.

def (self, localName, attributes)

Writes a processing instruction to the output stream. Returns true to continue input stream parsing.

def (self)

Begins the data writing to the output stream. Returns true to continue input stream parsing.

def (self, namespaceUri, localName, qualifiedName, attributes)

Writes an opening element to the output stream. Returns true to continue input stream parsing.

false

Internal element state.

null

Internal stream object.

def (str)

Returns the content of str with special characters escaped to be inserted in an XML document.

def (const self)

Returns current element's attributs as instances of Serializer.XmlAttributes.

def (const self)

Returns the name of the encoding used by the document.

def (const self)

Returns the version of the XML standard used by the document.

def (const self)

Returns the name of the current element.

def (const self)

Returns the namespace URI of the current element.

def (const self)

Returns the prefix (namespace) of the current element.

def (const self)

Returns the current processing instruction's data as instances of Serializer.XmlAttributes.

def (const self)

Returns the current processing instructions's target.

def (const self)

Returns the qualified name of the current element (prefix + name).

def (const self)

Returns the current texte.

def (const self)

Returns the last read token's text as a string.

def (const self)

Returns the last read token's type as a value of Serializer.XmlSaxStream.TokenType.

def (const self)

Returns true if the stream automaticaly close the markups when writing; otherwise returns false.

def (const self)

Returns true if the last read token's type is Serializer.XmlStream.TokenType.CDATA; otherwise returns false.

def (const self)

Returns true if the last read token's type is Serializer.XmlStream.TokenType.Characters; otherwise returns false.

def (const self)

Returns true if the last read token's type is Serializer.XmlStream.TokenType.Comment; otherwise returns false.

def (const self)

Returns true if the last read token's type is Serializer.XmlStream.TokenType.DTD; otherwise returns false.

def (const self)

Returns true if the last read token's type is Serializer.XmlStream.TokenType.EndDocument; otherwise returns false.

def (const self)

Returns true if the last read token's type is Serializer.XmlStream.TokenType.EndElement; otherwise returns false.

def (const self)

Returns true if the stream indent the XML when writing; otherwise returns false.

def (const self)

Returns true if the last read token's type is Serializer.XmlStream.TokenType.ProcessingInstruction; otherwise returns false.

def (const self)

Returns true if the standalone attribute of the document is set; otherwise returns false.

def (const self)

Returns true if the last read token's type is Serializer.XmlStream.TokenType.StartDocument; otherwise returns false.

def (const self)

Returns true if the last read token's type is Serializer.XmlStream.TokenType.StartElement; otherwise returns false.

def (self, stream)

Creates a new stream for reading and writing data using stream.

def (self)

Reads the next token of the stream and returns its type. The stream context is the updated with the token informations.

def (self, behaviour = Serializer.XmlStream.ReadElementTextBehaviour.ErrorOnUnexpectedElement)

Returns the whole text contained in the current element. The behaviour must be a value from ReadElementTextBehaviour that describe the behaviour of this method when a child element is encountred. If the stream is not on an Serializer.XmlStream.TokenType.StartElement token, none is returned.

def (self)

Reads the stream until the next Serializer.XmlStream.TokenType.StartElement token. Returns true if a token was found; otherwise returns false.

null

Internal reader context.

def (self, enabled)

Enables the automatic closing of the markups writed to the stream. If enabled is true, the markups will be automaticaly closed; otherwise the unclosed markups will be keeped to be slosed later.

Closed markups example:

<?xml version="1.0" encoding="UTF-8"?>
<document attr="value">
    <tag attr="value"/>
</document>

Unclosed markups example:

<?xml version="1.0" encoding="UTF-8"?>
<document attr="value">
    <tag attr="value"/>

By default, the markups are not closed.

def (self, enabled)

Enables the indentation of the XML writed to the stream. If indented is true, the XML will be indented; otherwise the XML will be compact.

Indented example:

<?xml version="1.0" encoding="UTF-8"?>
<document attr="value">
    <tag attr="value"/>
</document>

Compact example:

<?xml version="1.0" encoding="UTF-8"?><document attr="value"><tag attr="value"/></document>

By default, the data is not indented.

def (self)

Reads the stream until the end of the current element.

def (qualifiedName)

Returns the local name corresponding to the given qualifiedName.

def (self, data)

Writes the XML described by data to the stream. The XML will be adapted to match the configuration sets by setIndented and setAutoClosing. Returns true if all the data have been correctly writed; otherwise returns false. If the content of the data is not a valid XML, an instance of Serializer.DocumentStream.InvalidDocument is raised.

def (self, content)

Writes a CDATA section to the output stream. Returns true on success; otherwise returns false.

def (self, content)

Writes a character section to the output stream. Returns true on success; otherwise returns false.

def (self, content)

Writes a comment section to the output stream. Returns true on success; otherwise returns false.

def (self, content)

Writes a DTD section to the output stream. Returns true on success; otherwise returns false.

def (self, qualifiedName, attributes = Serializer.XmlAttributes ())

Writes an opening element to the output stream. Returns true on success; otherwise returns false.

def (self, namespaceUri, localName, qualifiedName, attributes = Serializer.XmlAttributes ())

Writes an opening element to the output stream. Returns true on success; otherwise returns false.

def (self)

Ends the data writing to the output stream. Returns true on success; otherwise returns false.

def (self, qualifiedName)

Writes a closing element to the output stream. If the element tag name does not match the previously opened element, the function returns false; otherwise returns true.

def (self)

Writes a closing element to the output stream.

def (self, namespaceUri, localName, qualifiedName)

Writes a closing element to the output stream. If the element tag name does not match the previously opened element, the function returns false; otherwise returns true.

def (self, localName, attributes)

Writes a processing instruction to the output stream. Returns true on success; otherwise returns false.

def (self)

Begins the data writing to the output stream. Returns true on success; otherwise returns false.

def (self, qualifiedName, attributes = Serializer.XmlAttributes ())

Writes an opening element to the output stream. Returns true on success; otherwise returns false.

def (self, namespaceUri, localName, qualifiedName, attributes = Serializer.XmlAttributes ())

Writes an opening element to the output stream. Returns true on success; otherwise returns false.

null

Internal writer context.