Module REXML::SAX2Listener
In: lib/rexml/sax2listener.rb

A template for stream parser listeners. Note that the declarations (attlistdecl, elementdecl, etc) are trivially processed; REXML doesn‘t yet handle doctype entity declarations, so you have to parse them out yourself.

Missing methods from SAX2

 ignorable_whitespace

Methods extending SAX2

WARNING These methods are certainly going to change, until DTDs are fully supported. Be aware of this.

 start_document
 end_document
 doctype
 elementdecl
 attlistdecl
 entitydecl
 notationdecl
 cdata
 xmldecl
 comment

Methods

Public Instance methods

If a doctype includes an ATTLIST declaration, it will cause this method to be called. The content is the declaration itself, unparsed. EG, <!ATTLIST el attr CDATA REQUIRED> will come to this method as "el attr CDATA REQUIRED". This is the same for all of the .*decl methods.

[Source]

    # File lib/rexml/sax2listener.rb, line 52
52:                 def attlistdecl(element, pairs, contents)
53:                 end

Called when <![CDATA[ … ]]> is encountered in a document. @p content "…"

[Source]

    # File lib/rexml/sax2listener.rb, line 80
80:                 def cdata content
81:                 end

[Source]

    # File lib/rexml/sax2listener.rb, line 35
35:                 def characters text
36:                 end

Called when a comment is encountered. @p comment The content of the comment

[Source]

    # File lib/rexml/sax2listener.rb, line 92
92:                 def comment comment
93:                 end

Handles a doctype declaration. Any attributes of the doctype which are not supplied will be nil. # EG, <!DOCTYPE me PUBLIC "foo" "bar"> @p name the name of the doctype; EG, "me" @p pub_sys "PUBLIC", "SYSTEM", or nil. EG, "PUBLIC" @p long_name the supplied long name, or nil. EG, "foo" @p uri the uri of the doctype, or nil. EG, "bar"

[Source]

    # File lib/rexml/sax2listener.rb, line 45
45:                 def doctype name, pub_sys, long_name, uri
46:                 end

<!ELEMENT …>

[Source]

    # File lib/rexml/sax2listener.rb, line 55
55:                 def elementdecl content
56:                 end

[Source]

    # File lib/rexml/sax2listener.rb, line 25
25:                 def end_document
26:                 end

[Source]

    # File lib/rexml/sax2listener.rb, line 33
33:                 def end_element uri, localname, qname
34:                 end

[Source]

    # File lib/rexml/sax2listener.rb, line 29
29:                 def end_prefix_mapping prefix
30:                 end

<!ENTITY …> The argument passed to this method is an array of the entity declaration. It can be in a number of formats, but in general it returns (example, result):

 <!ENTITY % YN '"Yes"'>
 ["%", "YN", "'\"Yes\"'", "\""]
 <!ENTITY % YN 'Yes'>
 ["%", "YN", "'Yes'", "s"]
 <!ENTITY WhatHeSaid "He said %YN;">
 ["WhatHeSaid", "\"He said %YN;\"", "YN"]
 <!ENTITY open-hatch SYSTEM "http://www.textuality.com/boilerplate/OpenHatch.xml">
 ["open-hatch", "SYSTEM", "\"http://www.textuality.com/boilerplate/OpenHatch.xml\""]
 <!ENTITY open-hatch PUBLIC "-//Textuality//TEXT Standard open-hatch boilerplate//EN" "http://www.textuality.com/boilerplate/OpenHatch.xml">
 ["open-hatch", "PUBLIC", "\"-//Textuality//TEXT Standard open-hatch boilerplate//EN\"", "\"http://www.textuality.com/boilerplate/OpenHatch.xml\""]
 <!ENTITY hatch-pic SYSTEM "../grafix/OpenHatch.gif" NDATA gif>
 ["hatch-pic", "SYSTEM", "\"../grafix/OpenHatch.gif\"", "\n\t\t\t\t\t\t\tNDATA gif", "gif"]

[Source]

    # File lib/rexml/sax2listener.rb, line 73
73:                 def entitydecl name, decl
74:                 end

<!NOTATION …>

[Source]

    # File lib/rexml/sax2listener.rb, line 76
76:                 def notationdecl content
77:                 end

[Source]

    # File lib/rexml/sax2listener.rb, line 37
37:                 def processing_instruction target, data
38:                 end

[Source]

    # File lib/rexml/sax2listener.rb, line 94
94:     def progress position
95:     end

[Source]

    # File lib/rexml/sax2listener.rb, line 23
23:                 def start_document
24:                 end

[Source]

    # File lib/rexml/sax2listener.rb, line 31
31:                 def start_element uri, localname, qname, attributes
32:                 end

[Source]

    # File lib/rexml/sax2listener.rb, line 27
27:                 def start_prefix_mapping prefix, uri
28:                 end

Called when an XML PI is encountered in the document. EG: <?xml version="1.0" encoding="utf"?> @p version the version attribute value. EG, "1.0" @p encoding the encoding attribute value, or nil. EG, "utf" @p standalone the standalone attribute value, or nil. EG, nil @p spaced the declaration is followed by a line break

[Source]

    # File lib/rexml/sax2listener.rb, line 88
88:                 def xmldecl version, encoding, standalone
89:                 end

[Validate]