| Class | REXML::Document |
| In: |
|
| Parent: | Element |
Represents a full XML document, including PIs, a doctype, etc. A Document has a single child that can be accessed by root(). Note that if you want to have an XML declaration written for a document you create, you must add one; REXML documents do not write a default declaration for you. See |DECLARATION| and |write|.
Constants
| DECLARATION | = | XMLDecl.default | A convenient default XML declaration. If you want an XML declaration, the easiest way to add one is mydoc << Document::DECLARATION DEPRECATED Use: mydoc << XMLDecl.default |
Public Class methods
Constructor @param source if supplied, must be a Document, String, or IO. Documents have their context and Element attributes cloned. Strings are expected to be valid XML documents. IOs are expected to be sources of valid XML documents. @param context if supplied, contains the context of the document; this should be a Hash. NOTE that I’m not sure what the context is for; I cloned it out of the Electric XML API (in which it also seems to do nothing), and it is now legacy. It may do something, someday… it may disappear.
37: def initialize( source = nil, context = {} ) 38: super() 39: @context = context 40: return if source.nil? 41: if source.kind_of? Document 42: @context = source.context 43: super source 44: else 45: build( source ) 46: end 47: end
172: def Document::parse_stream( source, listener ) 173: Parsers::StreamParser.new( source, listener ).parse 174: end
Public Instance methods
We override this, because XMLDecls and DocTypes must go at the start of the document
69: def add( child ) 70: if child.kind_of? XMLDecl 71: @children.unshift child 72: elsif child.kind_of? DocType 73: if @children[0].kind_of? XMLDecl 74: @children[1,0] = child 75: else 76: @children.unshift child 77: end 78: child.parent = self 79: else 80: rv = super 81: raise "attempted adding second root element to document" if @elements.size > 1 82: rv 83: end 84: end
87: def add_element(arg=nil, arg2=nil) 88: rv = super 89: raise "attempted adding second root element to document" if @elements.size > 1 90: rv 91: end
Write the XML tree out, optionally with indent. This writes out the entire XML document, including XML declarations, doctype declarations, and processing instructions (if any are given). A controversial point is whether Document should always write the REXML does not write one if one was not specified, because it adds unneccessary bandwidth to applications such as XML-RPC.
| output: | output an object which supports ’<< string’; this is where the |
document will be written.
| indent: | An integer. If -1, no indenting will be used; otherwise, the indentation will be this number of spaces, and children will be indented an additional amount. Defaults to -1 |
| transitive: | If transitive is true and indent is >= 0, then the output will be pretty-printed in such a way that the added whitespace does not affect the absolute value of the document — that is, it leaves the value and number of Text nodes in the document unchanged. |
| ie_hack: | Internet Explorer is the worst piece of crap to have ever been written, with the possible exception of Windows itself. Since IE is unable to parse proper XML, we have to provide a hack to generate XML that IE’s limited abilities can handle. This hack inserts a space before the /> on empty tags. Defaults to false |
161: def write( output=$stdout, indent=-1, transitive=false, ie_hack=false ) 163: @children.each { |node| 164: indent( output, indent ) if node.node_type == :element 165: if node.write( output, indent, transitive, ie_hack ) 166: output << "\n" unless indent<0 or node == @children[-1] 167: end 168: } 169: end