Class REXML::Document
In: lib/rexml/document.rb
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|.

Methods

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

Attributes

entity_expansion_count  [R] 

Public Class methods

Get the entity expansion limit. By default the limit is set to 10000.

[Source]

     # File lib/rexml/document.rb, line 212
212:     def Document::entity_expansion_limit
213:       return @@entity_expansion_limit
214:     end

Set the entity expansion limit. By default the limit is set to 10000.

[Source]

     # File lib/rexml/document.rb, line 207
207:     def Document::entity_expansion_limit=( val )
208:       @@entity_expansion_limit = val
209:     end

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.

[Source]

    # File lib/rexml/document.rb, line 34
34:                 def initialize( source = nil, context = {} )
35:       @entity_expansion_count = 0
36:                         super()
37:                         @context = context
38:                         return if source.nil?
39:                         if source.kind_of? Document
40:                                 @context = source.context
41:                                 super source
42:                         else
43:                                 build(  source )
44:                         end
45:                 end

[Source]

     # File lib/rexml/document.rb, line 200
200:                 def Document::parse_stream( source, listener )
201:                         Parsers::StreamParser.new( source, listener ).parse
202:                 end

Public Instance methods

<<( child )

Alias for add

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

[Source]

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

[Source]

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

Should be obvious

[Source]

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

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

[Source]

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

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

[Source]

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

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

[Source]

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

Alias for expanded_name

[Source]

    # File lib/rexml/document.rb, line 47
47:     def node_type
48:       :document
49:     end

[Source]

     # File lib/rexml/document.rb, line 218
218:     def record_entity_expansion
219:       @entity_expansion_count += 1
220:       if @entity_expansion_count > @@entity_expansion_limit
221:         raise "number of entity expansions exceeded, processing aborted."
222:       end
223:     end

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

[Source]

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

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

[Source]

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

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

[Source]

     # File lib/rexml/document.rb, line 128
128:                 def version
129:                         xml_decl().version
130:                 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 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 unnecessary bandwidth to applications such as XML-RPC.

See also the classes in the rexml/formatters package for the proper way to change the default formatting of XML output

Examples

  Document.new("<a><b/></a>").serialize

  output_string = ""
  tr = Transitive.new( output_string )
  Document.new("<a><b/></a>").serialize( tr )
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 twice this number of spaces, and children will be indented an additional amount. For a value of 3, every item will be indented 3 more levels, or 6 more spaces (2 * 3). Defaults to -1
trans: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

[Source]

     # File lib/rexml/document.rb, line 183
183:                 def write( output=$stdout, indent=-1, trans=false, ie_hack=false )
184:       if xml_decl.encoding != "UTF-8" && !output.kind_of?(Output)
185:         output = Output.new( output, xml_decl.encoding )
186:       end
187:       formatter = if indent > -1
188:           if trans
189:             REXML::Formatters::Transitive.new( indent, ie_hack )
190:           else
191:             REXML::Formatters::Pretty.new( indent, ie_hack )
192:           end
193:         else
194:           REXML::Formatters::Default.new( ie_hack )
195:         end
196:       formatter.write( self, output )
197:                 end

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

[Source]

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

Private Instance methods

[Source]

     # File lib/rexml/document.rb, line 226
226:                 def build( source )
227:       Parsers::TreeParser.new( source, self ).parse
228:                 end

[Validate]