Class: REXML::Document

Class

REXML::Document

In:

lib/rexml/document.rb

Parent:

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|.

Methods

<< add add_element build clone doctype encoding expanded_name name new node_type parse_stream root stand_alone? version write xml_decl

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

new( source = nil, context = {} )

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.

    # File lib/rexml/document.rb, line 37
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

parse_stream( source, listener )

     # File lib/rexml/document.rb, line 184
184:                 def Document::parse_stream( source, listener )
185:                         Parsers::StreamParser.new( source, listener ).parse
186:                 end

Public Instance methods

<<( child )

Alias for add

We override this, because XMLDecls and DocTypes must go at the start of the document

    # File lib/rexml/document.rb, line 69
69:                 def add( child )
70:                         if child.kind_of? XMLDecl
71:                                 @children.unshift child
72:                         elsif child.kind_of? DocType
73:         # Find first Element or DocType node and insert the decl right 
74:         # before it.  If there is no such node, just insert the child at the
75:         # end.  If there is a child and it is an DocType, then replace it.
76:         insert_before_index = 0
77:         @children.find { |x| 
78:           insert_before_index += 1
79:           x.kind_of?(Element) || x.kind_of?(DocType)
80:         }
81:         if @children[ insert_before_index ] # Not null = not end of list
82:           if @children[ insert_before_index ].kind_of DocType
83:             @children[ insert_before_index ] = child
84:           else
85:             @children[ index_before_index-1, 0 ] = child
86:           end
87:         else  # Insert at end of list
88:           @children[insert_before_index] = child
89:         end
90:                                 child.parent = self
91:                         else
92:                                 rv = super
93:                                 raise "attempted adding second root element to document" if @elements.size > 1
94:                                 rv
95:                         end
96:                 end

add_element(arg=nil, arg2=nil)

     # File lib/rexml/document.rb, line 99
 99:                 def add_element(arg=nil, arg2=nil)
100:                         rv = super
101:                         raise "attempted adding second root element to document" if @elements.size > 1
102:                         rv
103:                 end

Should be obvious

    # File lib/rexml/document.rb, line 54
54:                 def clone
55:                         Document.new self
56:                 end

@return the DocType child of the document, if one exists, and nil otherwise.

     # File lib/rexml/document.rb, line 115
115:                 def doctype
116:                         @children.find { |item| item.kind_of? DocType }
117:                 end

@return the XMLDecl encoding of this document as a String. If no XMLDecl has been set, returns the default encoding.

     # File lib/rexml/document.rb, line 135
135:                 def encoding
136:                         xml_decl().encoding
137:                 end

expanded_name()

According to the XML spec, a root node has no expanded name

    # File lib/rexml/document.rb, line 59
59:                 def expanded_name
60:                         ''
61:                         #d = doc_type
62:                         #d ? d.name : "UNDEFINED"
63:                 end

name()

Alias for expanded_name

    # File lib/rexml/document.rb, line 49
49:     def node_type
50:       :document
51:     end

@return the root Element of the document, or nil if this document has no children.

     # File lib/rexml/document.rb, line 107
107:                 def root
108:       elements[1]
109:       #self
110:       #@children.find { |item| item.kind_of? Element }
111:                 end

@return the XMLDecl standalone value of this document as a String. If no XMLDecl has been set, returns the default setting.

     # File lib/rexml/document.rb, line 141
141:                 def stand_alone?
142:                         xml_decl().stand_alone?
143:                 end

@return the XMLDecl version of this document as a String. If no XMLDecl has been set, returns the default version.

     # File lib/rexml/document.rb, line 129
129:                 def version
130:                         xml_decl().version
131:                 end

write( output=$stdout, indent=-1, transitive=false, ie_hack=false )

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 XML declaration (<?xml version=‘1.0’?>) whether or not one is given by the user (or source document). 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

     # File lib/rexml/document.rb, line 173
173:                 def write( output=$stdout, indent=-1, transitive=false, ie_hack=false )
174:                         output = Output.new( output, xml_decl.encoding ) if xml_decl.encoding != "UTF-8" && !output.kind_of?(Output)
175:                         @children.each { |node|
176:                                 indent( output, indent ) if node.node_type == :element
177:                                 if node.write( output, indent, transitive, ie_hack )
178:           output << "\n" unless indent<0 or node == @children[-1]
179:         end
180:                         }
181:                 end

@return the XMLDecl of this document; if no XMLDecl has been set, the default declaration is returned.

     # File lib/rexml/document.rb, line 121
121:                 def xml_decl
122:                         rv = @children[0]
123:       return rv if rv.kind_of? XMLDecl
124:       rv = @children.unshift(XMLDecl.default)[0]
125:                 end

Private Instance methods

build( source )

     # File lib/rexml/document.rb, line 189
189:                 def build( source )
190:       Parsers::TreeParser.new( source, self ).parse
191:                 end