EVOLUTION-MANAGER

Edit File: SAXState-class.html

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><title>R: A virtual base class defining methods for SAX parsing</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<link rel="stylesheet" type="text/css" href="R.css" />
</head><body>

<table width="100%" summary="page for SAXState-class {XML}"><tr><td>SAXState-class {XML}</td><td style="text-align: right;">R Documentation</td></tr></table>

<h2>A virtual base class defining methods for SAX parsing</h2>

<h3>Description</h3>

<p>This is a degenerate virtual class which others are
expected to sub-class  when they want to
use S4 methods as handler functions for SAX-based XML parsing.
The idea is that one can pass both i)  a collection of handlers
to <code><a href="xmlEventParse.html">xmlEventParse</a></code> which are simply 
the generic functions for the different SAX actions,
and ii) a suitable object to maintain state across
the different SAX calls.
This is used to perform the method dispatching to get
the appropriate behavior for the action.
Each of these methods is expected to return the
updated state object and the SAX parser
will pass this in the next callback.
</p>
<p>We define this class here so that we can provide
default methods for each of the different handler
actions. This allows other programmers to define
new classes to maintain state that are sub-class
of <code>SAXState</code> and then they do not have to
implement methods for each of the
different handlers.
</p>

<h3>Objects from the Class</h3>

<p>A virtual Class: No objects may be created from it.</p>

<h3>Methods</h3>

<dl>
<dt>comment.SAX</dt><dd><p><code>signature(content = "ANY", .state = "SAXState")</code>: ... </p>
</dd>
<dt>endElement.SAX</dt><dd><p><code>signature(name = "ANY", .state = "SAXState")</code>: ... </p>
</dd>
<dt>entityDeclaration.SAX</dt><dd><p><code>signature(name = "ANY", base = "ANY", sysId = "ANY", publicId = "ANY", notationName = "ANY", .state = "SAXState")</code>: ... </p>
</dd>
<dt>processingInstruction.SAX</dt><dd><p><code>signature(target = "ANY", content = "ANY", .state = "SAXState")</code>: ... </p>
</dd>
<dt>startElement.SAX</dt><dd><p><code>signature(name = "ANY", atts = "ANY", .state = "SAXState")</code>: ... </p>
</dd>
<dt>text.SAX</dt><dd><p><code>signature(content = "ANY", .state = "SAXState")</code>: ... </p>
</dd>
</dl>

<h3>Author(s)</h3>

<p>Duncan Temple Lang</p>

<h3>References</h3>

<p><a href="http://www.w3.org/XML">http://www.w3.org/XML</a>, <a href="http://www.xmlsoft.org">http://www.xmlsoft.org</a></p>

<p><code><a href="xmlEventParse.html">xmlEventParse</a></code>
</p>

<h3>Examples</h3>

<pre>

# For each element in the document, grab the node name
# and increment the count in an vector for this name.

# We define an S4 class named ElementNameCounter which
# holds the vector of frequency counts for the node names.

setClass("ElementNameCounter",
             representation(elements = "integer"), contains = "SAXState")

# Define a method for handling the opening/start of any XML node
# in the SAX streams.

setMethod("startElement.SAX",  c(.state = "ElementNameCounter"),
           function(name, atts, .state = NULL) {

if(name %in% names(.state@elements))
                 .state@elements[name] = as.integer(.state@elements[name] + 1)
             else
                 .state@elements[name] = as.integer(1)
             .state
           })

filename = system.file("exampleData", "eurofxref-hist.xml.gz", package = "XML")

# Parse the file, arranging to have our startElement.SAX method invoked.
 z = xmlEventParse(filename, genericSAXHandlers(),
                   state = new("ElementNameCounter"), addContext = FALSE)

z@elements

# Get the contents of all the comments in a character vector.

setClass("MySAXState",
             representation(comments = "character"), contains = "SAXState")

setMethod("comment.SAX",  c(.state = "MySAXState"),
           function(content, .state = NULL) {
             cat("comment.SAX called for MySAXState\n")
             .state@comments &lt;- c(.state@comments, content)
             .state
           })

filename = system.file("exampleData", "charts.svg", package = "XML")
 st = new("MySAXState")
 z = xmlEventParse(filename, genericSAXHandlers(useDotNames = TRUE), state = st)
 z@comments

</pre>

<hr /><div style="text-align: center;">[Package <em>XML</em> version 3.99-0.3 <a href="00Index.html">Index</a>]</div>
</body></html>