C# Class DocumentReader, simplexml

Inheritance: ICloneable

Datei anzeigen Open project: ngallagher/simplexml Class Usage Examples

Public Methods

Method	Description
Convert ( Node, node ) : EventNode,	This is used to convert the provided node in to an event. The conversion process ensures the node can be digested by the core reader and used to provide an `InputNode` that can be used to represent the XML elements or attributes. If the provided node is not an element then it is considered text.
DocumentReader ( Document, document ) : System	Constructor for the `DocumentReader` object. This makes use of a DOM document to extract events and provide them to the core framework. All nodes will be extracted from the document and queued for extraction as they are requested. This will ignore any comment nodes as they should not be considered.
Next ( ) : EventNode,	This is used to take the next node from the document. This will scan through the document, ignoring any comments to find the next relevant XML event to acquire. Typically events will be the start and end of an element, as well as any text nodes.
Peek ( ) : EventNode,	This is used to peek at the node from the document. This will scan through the document, ignoring any comments to find the next relevant XML event to acquire. Typically events will be the start and end of an element, as well as any text nodes.
Read ( ) : EventNode,	This is used to read the next node from the document. This will scan through the document, ignoring any comments to find the next relevant XML event to acquire. Typically events will be the start and end of an element, as well as any text nodes.
Read ( Node, node ) : EventNode,	This is used to read the next node from the document. This will scan through the document, ignoring any comments to find the next relevant XML event to acquire. Typically events will be the start and end of an element, as well as any text nodes.
Start ( Node, node ) : Start,	This is used to convert the provided node to a start event. The conversion process ensures the node can be digested by the core reader and used to provide an `InputNode` that can be used to represent an XML elements within the source document.

Private Methods

Method	Description
Build ( ) : System
Start ( node, node ) : System
isEmpty ( ) : System

Method Details

Convert() public method

This is used to convert the provided node in to an event. The conversion process ensures the node can be digested by the core reader and used to provide an InputNode that can be used to represent the XML elements or attributes. If the provided node is not an element then it is considered text.

public Convert ( Node, node ) : EventNode,
node	Node,	/// the node that is to be converted to an event ///
return	EventNode,

DocumentReader() public method

Constructor for the DocumentReader object. This makes use of a DOM document to extract events and provide them to the core framework. All nodes will be extracted from the document and queued for extraction as they are requested. This will ignore any comment nodes as they should not be considered.

public DocumentReader ( Document, document ) : System
document	Document,	/// this is the document that is to be read ///
return	System

Next() public method

This is used to take the next node from the document. This will scan through the document, ignoring any comments to find the next relevant XML event to acquire. Typically events will be the start and end of an element, as well as any text nodes.

public Next ( ) : EventNode,
return	EventNode,

Peek() public method

This is used to peek at the node from the document. This will scan through the document, ignoring any comments to find the next relevant XML event to acquire. Typically events will be the start and end of an element, as well as any text nodes.

public Peek ( ) : EventNode,
return	EventNode,

Read() public method

This is used to read the next node from the document. This will scan through the document, ignoring any comments to find the next relevant XML event to acquire. Typically events will be the start and end of an element, as well as any text nodes.

public Read ( ) : EventNode,
return	EventNode,

Read() public method

public Read ( Node, node ) : EventNode,
node	Node,	/// this is the XML node that has been read ///
return	EventNode,

Start() public method

This is used to convert the provided node to a start event. The conversion process ensures the node can be digested by the core reader and used to provide an InputNode that can be used to represent an XML elements within the source document.

public Start ( Node, node ) : Start,
node	Node,	/// the node that is to be converted to a start event ///
return	Start,