File: C:/Ruby27-x64/share/doc/ruby/html/REXML/Validation/RelaxNG.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class REXML::Validation::RelaxNG - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../../";
var index_rel_prefix = "../../";
</script>
<script src="../../js/navigation.js" defer></script>
<script src="../../js/search.js" defer></script>
<script src="../../js/search_index.js" defer></script>
<script src="../../js/searcher.js" defer></script>
<script src="../../js/darkfish.js" defer></script>
<link href="../../css/fonts.css" rel="stylesheet">
<link href="../../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="class">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../../table_of_contents.html#pages">Pages</a>
<a href="../../table_of_contents.html#classes">Classes</a>
<a href="../../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link"><a href="../../Object.html">Object</a>
</div>
<div id="includes-section" class="nav-section">
<h3>Included Modules</h3>
<ul class="link-list">
<li><a class="include" href="Validator.html">REXML::Validation::Validator</a>
</ul>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-receive">#receive</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-REXML::Validation::RelaxNG">
<h1 id="class-REXML::Validation::RelaxNG" class="class">
class REXML::Validation::RelaxNG
</h1>
<section class="description">
<p>Implemented:</p>
<ul><li>
<p>empty</p>
</li><li>
<p>element</p>
</li><li>
<p>attribute</p>
</li><li>
<p>text</p>
</li><li>
<p>optional</p>
</li><li>
<p>choice</p>
</li><li>
<p>oneOrMore</p>
</li><li>
<p>zeroOrMore</p>
</li><li>
<p>group</p>
</li><li>
<p>value</p>
</li><li>
<p>interleave</p>
</li><li>
<p>mixed</p>
</li><li>
<p>ref</p>
</li><li>
<p>grammar</p>
</li><li>
<p>start</p>
</li><li>
<p>define</p>
</li></ul>
<p>Not implemented:</p>
<ul><li>
<p>data</p>
</li><li>
<p>param</p>
</li><li>
<p>include</p>
</li><li>
<p>externalRef</p>
</li><li>
<p>notAllowed</p>
</li><li>
<p>anyName</p>
</li><li>
<p>nsName</p>
</li><li>
<p>except</p>
</li><li>
<p>name</p>
</li></ul>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="constants-list">
<header>
<h3>Constants</h3>
</header>
<dl>
<dt id="EMPTY">EMPTY
<dd>
<dt id="INFINITY">INFINITY
<dd>
<dt id="TEXT">TEXT
<dd>
</dl>
</section>
<section class="attribute-method-details" class="method-section">
<header>
<h3>Attributes</h3>
</header>
<div id="attribute-i-count" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">count</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
</div>
</div>
<div id="attribute-i-current" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">current</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
</div>
</div>
<div id="attribute-i-references" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">references</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
</div>
</div>
</section>
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(source)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>FIXME: Namespaces</p>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/rexml/validation/relaxng.rb, line 46</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span> <span class="ruby-identifier">source</span>
<span class="ruby-identifier">parser</span> = <span class="ruby-constant">REXML</span><span class="ruby-operator">::</span><span class="ruby-constant">Parsers</span><span class="ruby-operator">::</span><span class="ruby-constant">BaseParser</span>.<span class="ruby-identifier">new</span>( <span class="ruby-identifier">source</span> )
<span class="ruby-ivar">@count</span> = <span class="ruby-value">0</span>
<span class="ruby-ivar">@references</span> = {}
<span class="ruby-ivar">@root</span> = <span class="ruby-ivar">@current</span> = <span class="ruby-constant">Sequence</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword">self</span>)
<span class="ruby-ivar">@root</span>.<span class="ruby-identifier">previous</span> = <span class="ruby-keyword">true</span>
<span class="ruby-identifier">states</span> = [ <span class="ruby-ivar">@current</span> ]
<span class="ruby-keyword">begin</span>
<span class="ruby-identifier">event</span> = <span class="ruby-identifier">parser</span>.<span class="ruby-identifier">pull</span>
<span class="ruby-keyword">case</span> <span class="ruby-identifier">event</span>[<span class="ruby-value">0</span>]
<span class="ruby-keyword">when</span> <span class="ruby-value">:start_element</span>
<span class="ruby-keyword">case</span> <span class="ruby-identifier">event</span>[<span class="ruby-value">1</span>]
<span class="ruby-keyword">when</span> <span class="ruby-string">"empty"</span>
<span class="ruby-keyword">when</span> <span class="ruby-string">"element"</span>, <span class="ruby-string">"attribute"</span>, <span class="ruby-string">"text"</span>, <span class="ruby-string">"value"</span>
<span class="ruby-identifier">states</span>[<span class="ruby-value">-1</span>] <span class="ruby-operator"><<</span> <span class="ruby-identifier">event</span>
<span class="ruby-keyword">when</span> <span class="ruby-string">"optional"</span>
<span class="ruby-identifier">states</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">Optional</span>.<span class="ruby-identifier">new</span>( <span class="ruby-keyword">self</span> )
<span class="ruby-identifier">states</span>[<span class="ruby-value">-2</span>] <span class="ruby-operator"><<</span> <span class="ruby-identifier">states</span>[<span class="ruby-value">-1</span>]
<span class="ruby-keyword">when</span> <span class="ruby-string">"choice"</span>
<span class="ruby-identifier">states</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">Choice</span>.<span class="ruby-identifier">new</span>( <span class="ruby-keyword">self</span> )
<span class="ruby-identifier">states</span>[<span class="ruby-value">-2</span>] <span class="ruby-operator"><<</span> <span class="ruby-identifier">states</span>[<span class="ruby-value">-1</span>]
<span class="ruby-keyword">when</span> <span class="ruby-string">"oneOrMore"</span>
<span class="ruby-identifier">states</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">OneOrMore</span>.<span class="ruby-identifier">new</span>( <span class="ruby-keyword">self</span> )
<span class="ruby-identifier">states</span>[<span class="ruby-value">-2</span>] <span class="ruby-operator"><<</span> <span class="ruby-identifier">states</span>[<span class="ruby-value">-1</span>]
<span class="ruby-keyword">when</span> <span class="ruby-string">"zeroOrMore"</span>
<span class="ruby-identifier">states</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">ZeroOrMore</span>.<span class="ruby-identifier">new</span>( <span class="ruby-keyword">self</span> )
<span class="ruby-identifier">states</span>[<span class="ruby-value">-2</span>] <span class="ruby-operator"><<</span> <span class="ruby-identifier">states</span>[<span class="ruby-value">-1</span>]
<span class="ruby-keyword">when</span> <span class="ruby-string">"group"</span>
<span class="ruby-identifier">states</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">Sequence</span>.<span class="ruby-identifier">new</span>( <span class="ruby-keyword">self</span> )
<span class="ruby-identifier">states</span>[<span class="ruby-value">-2</span>] <span class="ruby-operator"><<</span> <span class="ruby-identifier">states</span>[<span class="ruby-value">-1</span>]
<span class="ruby-keyword">when</span> <span class="ruby-string">"interleave"</span>
<span class="ruby-identifier">states</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">Interleave</span>.<span class="ruby-identifier">new</span>( <span class="ruby-keyword">self</span> )
<span class="ruby-identifier">states</span>[<span class="ruby-value">-2</span>] <span class="ruby-operator"><<</span> <span class="ruby-identifier">states</span>[<span class="ruby-value">-1</span>]
<span class="ruby-keyword">when</span> <span class="ruby-string">"mixed"</span>
<span class="ruby-identifier">states</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">Interleave</span>.<span class="ruby-identifier">new</span>( <span class="ruby-keyword">self</span> )
<span class="ruby-identifier">states</span>[<span class="ruby-value">-2</span>] <span class="ruby-operator"><<</span> <span class="ruby-identifier">states</span>[<span class="ruby-value">-1</span>]
<span class="ruby-identifier">states</span>[<span class="ruby-value">-1</span>] <span class="ruby-operator"><<</span> <span class="ruby-constant">TEXT</span>
<span class="ruby-keyword">when</span> <span class="ruby-string">"define"</span>
<span class="ruby-identifier">states</span> <span class="ruby-operator"><<</span> [ <span class="ruby-identifier">event</span>[<span class="ruby-value">2</span>][<span class="ruby-string">"name"</span>] ]
<span class="ruby-keyword">when</span> <span class="ruby-string">"ref"</span>
<span class="ruby-identifier">states</span>[<span class="ruby-value">-1</span>] <span class="ruby-operator"><<</span> <span class="ruby-constant">Ref</span>.<span class="ruby-identifier">new</span>( <span class="ruby-identifier">event</span>[<span class="ruby-value">2</span>][<span class="ruby-string">"name"</span>] )
<span class="ruby-keyword">when</span> <span class="ruby-string">"anyName"</span>
<span class="ruby-identifier">states</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">AnyName</span>.<span class="ruby-identifier">new</span>( <span class="ruby-keyword">self</span> )
<span class="ruby-identifier">states</span>[<span class="ruby-value">-2</span>] <span class="ruby-operator"><<</span> <span class="ruby-identifier">states</span>[<span class="ruby-value">-1</span>]
<span class="ruby-keyword">when</span> <span class="ruby-string">"nsName"</span>
<span class="ruby-keyword">when</span> <span class="ruby-string">"except"</span>
<span class="ruby-keyword">when</span> <span class="ruby-string">"name"</span>
<span class="ruby-keyword">when</span> <span class="ruby-string">"data"</span>
<span class="ruby-keyword">when</span> <span class="ruby-string">"param"</span>
<span class="ruby-keyword">when</span> <span class="ruby-string">"include"</span>
<span class="ruby-keyword">when</span> <span class="ruby-string">"grammar"</span>
<span class="ruby-keyword">when</span> <span class="ruby-string">"start"</span>
<span class="ruby-keyword">when</span> <span class="ruby-string">"externalRef"</span>
<span class="ruby-keyword">when</span> <span class="ruby-string">"notAllowed"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">when</span> <span class="ruby-value">:end_element</span>
<span class="ruby-keyword">case</span> <span class="ruby-identifier">event</span>[<span class="ruby-value">1</span>]
<span class="ruby-keyword">when</span> <span class="ruby-string">"element"</span>, <span class="ruby-string">"attribute"</span>
<span class="ruby-identifier">states</span>[<span class="ruby-value">-1</span>] <span class="ruby-operator"><<</span> <span class="ruby-identifier">event</span>
<span class="ruby-keyword">when</span> <span class="ruby-string">"zeroOrMore"</span>, <span class="ruby-string">"oneOrMore"</span>, <span class="ruby-string">"choice"</span>, <span class="ruby-string">"optional"</span>,
<span class="ruby-string">"interleave"</span>, <span class="ruby-string">"group"</span>, <span class="ruby-string">"mixed"</span>
<span class="ruby-identifier">states</span>.<span class="ruby-identifier">pop</span>
<span class="ruby-keyword">when</span> <span class="ruby-string">"define"</span>
<span class="ruby-identifier">ref</span> = <span class="ruby-identifier">states</span>.<span class="ruby-identifier">pop</span>
<span class="ruby-ivar">@references</span>[ <span class="ruby-identifier">ref</span>.<span class="ruby-identifier">shift</span> ] = <span class="ruby-identifier">ref</span>
<span class="ruby-comment">#when "empty"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">when</span> <span class="ruby-value">:end_document</span>
<span class="ruby-identifier">states</span>[<span class="ruby-value">-1</span>] <span class="ruby-operator"><<</span> <span class="ruby-identifier">event</span>
<span class="ruby-keyword">when</span> <span class="ruby-value">:text</span>
<span class="ruby-identifier">states</span>[<span class="ruby-value">-1</span>] <span class="ruby-operator"><<</span> <span class="ruby-identifier">event</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span> <span class="ruby-keyword">while</span> <span class="ruby-identifier">event</span>[<span class="ruby-value">0</span>] <span class="ruby-operator">!=</span> <span class="ruby-value">:end_document</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-receive" class="method-detail ">
<div class="method-heading">
<span class="method-name">receive</span><span
class="method-args">(event)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="receive-source">
<pre><span class="ruby-comment"># File lib/rexml/validation/relaxng.rb, line 122</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">receive</span> <span class="ruby-identifier">event</span>
<span class="ruby-identifier">validate</span>( <span class="ruby-identifier">event</span> )
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>