Eiffeldoc: XML_TREE

+

Point of view

All features

class XML_TREE

Summary

DOM-like representation of an XML document

See also XML_PARSER

Direct parents: Inherit list: XML_CALLBACKS

Overview

Creation features

make (url: URL)

read the xml tree at the given url
with_error_handler (url: URL, a_error_handler: PROCEDURE[TUPLE 3[INTEGER_32, INTEGER_32, STRING]])

Features

root: XML_COMPOSITE_NODE

The root of the tree
attribute_at (a_attribute_name: UNICODE_STRING): UNICODE_STRING

Usually to recover the "version" or "encoding" attributes
set_processing_instruction (target: UNICODE_STRING, processor: PROCEDURE[TUPLE 1[UNICODE_STRING]])

{}

with_attribute (attribute_name: UNICODE_STRING, attribute_value: UNICODE_STRING, line: INTEGER_32, column: INTEGER_32)

Called by the parser to add an attribute of a node BEFORE calling open_node
open_node (node_name: UNICODE_STRING, line: INTEGER_32, column: INTEGER_32)

When the parser reads an opening node
close_node (node_name: UNICODE_STRING, line: INTEGER_32, column: INTEGER_32)

When the parser reads a closing node
open_close_node (node_name: UNICODE_STRING, line: INTEGER_32, column: INTEGER_32)

When the parser reads a node that opens and closes immediately (syntax "<node/>")
xml_header (line: INTEGER_32, column: INTEGER_32)

Called by the parser if a "<?xml ... ?>"
processing_instruction (a_target: UNICODE_STRING, a_data: UNICODE_STRING)

Called by the parser if a "<?...?>"
current_node: UNICODE_STRING

The current node
entity (a_entity: UNICODE_STRING, line: INTEGER_32, column: INTEGER_32): UNICODE_STRING

Called by the parser when an &entity; is found.
open_entity_url (a_entity: UNICODE_STRING, a_url: URL)

Called by the parser when the entity triggers the reading of another stream (i.e. a SYSTEM or PUBLIC entity)
close_entity_url (a_entity: UNICODE_STRING, a_url: URL)

Called by the parser when the stream triggered by open_entity_url is disconnected
data (a_data: UNICODE_STRING, line: INTEGER_32, column: INTEGER_32)

Called by the parser when the node contains raw data
parse_error (line: INTEGER_32, column: INTEGER_32, message: STRING)

Called by the parser if there is an error
at_error: BOOLEAN

True if there was at least an error

{}

error_handler: PROCEDURE[TUPLE 3[INTEGER_32, INTEGER_32, STRING]]
make (url: URL)

read the xml tree at the given url
with_error_handler (url: URL, a_error_handler: PROCEDURE[TUPLE 3[INTEGER_32, INTEGER_32, STRING]])
new_node (node_name: UNICODE_STRING, line: INTEGER_32, column: INTEGER_32): XML_COMPOSITE_NODE
parser: XML_PARSER

set_validator (a_validator: XML_VALIDATOR)

Sets a validator for this XML file.
validator: XML_VALIDATOR

The XML validator for this file (DTD, XML Schema...)

root: XML_COMPOSITE_NODE

writable attribute

The root of the tree

attribute_at (a_attribute_name: UNICODE_STRING): UNICODE_STRING

effective function

Usually to recover the "version" or "encoding" attributes

set_processing_instruction (target: UNICODE_STRING, processor: PROCEDURE[TUPLE 1[UNICODE_STRING]])

effective procedure

attributes: HASHED_DICTIONARY[UNICODE_STRING, UNICODE_STRING]

writable attribute

{}

tree_attributes: HASHED_DICTIONARY[UNICODE_STRING, UNICODE_STRING]

writable attribute

{}

open_nodes: STACK[XML_COMPOSITE_NODE]

writable attribute

{}

processing_instructions: HASHED_DICTIONARY[FAST_ARRAY[PROCEDURE[TUPLE 1[UNICODE_STRING]]], UNICODE_STRING]

once function

{}

with_attribute (attribute_name: UNICODE_STRING, attribute_value: UNICODE_STRING, line: INTEGER_32, column: INTEGER_32)

effective procedure

Called by the parser to add an attribute of a node BEFORE calling open_node

open_node (node_name: UNICODE_STRING, line: INTEGER_32, column: INTEGER_32)

effective procedure

When the parser reads an opening node

close_node (node_name: UNICODE_STRING, line: INTEGER_32, column: INTEGER_32)

effective procedure

When the parser reads a closing node

open_close_node (node_name: UNICODE_STRING, line: INTEGER_32, column: INTEGER_32)

effective procedure

When the parser reads a node that opens and closes immediately (syntax "<node/>")

xml_header (line: INTEGER_32, column: INTEGER_32)

effective procedure

Called by the parser if a "<?xml ... ?>"

processing_instruction (a_target: UNICODE_STRING, a_data: UNICODE_STRING)

effective procedure

Called by the parser if a "<?...?>"

current_node: UNICODE_STRING

effective function

The current node

entity (a_entity: UNICODE_STRING, line: INTEGER_32, column: INTEGER_32): UNICODE_STRING

effective function

Called by the parser when an &entity; is found.

open_entity_url (a_entity: UNICODE_STRING, a_url: URL)

effective procedure

Called by the parser when the entity triggers the reading of another stream (i.e. a SYSTEM or PUBLIC entity)

close_entity_url (a_entity: UNICODE_STRING, a_url: URL)

effective procedure

Called by the parser when the stream triggered by open_entity_url is disconnected

data (a_data: UNICODE_STRING, line: INTEGER_32, column: INTEGER_32)

effective procedure

Called by the parser when the node contains raw data

parse_error (line: INTEGER_32, column: INTEGER_32, message: STRING)

effective procedure

Called by the parser if there is an error

at_error: BOOLEAN

writable attribute

True if there was at least an error

error_handler: PROCEDURE[TUPLE 3[INTEGER_32, INTEGER_32, STRING]]

writable attribute

{}

make (url: URL)

effective procedure

{}

read the xml tree at the given url

with_error_handler (url: URL, a_error_handler: PROCEDURE[TUPLE 3[INTEGER_32, INTEGER_32, STRING]])

effective procedure

{}

new_node (node_name: UNICODE_STRING, line: INTEGER_32, column: INTEGER_32): XML_COMPOSITE_NODE

effective function

{}

parser: XML_PARSER

once function

{}

set_validator (a_validator: XML_VALIDATOR)

effective procedure

Sets a validator for this XML file.

validator: XML_VALIDATOR

writable attribute

The XML validator for this file (DTD, XML Schema...)