Class: Nokogiri::XML::Schematron::Schema

Inherits:

Base

• Object
• Base
• Nokogiri::XML::Schematron::Schema

Defined in:

lib/nokogiri/xml/schematron/schema.rb

Overview

The internal representation of the <sch:schema> XML element.

For example:

schema = Nokogiri::XML::Schematron::Schema.new(id: "schema1", title: "Example schema")
# => #<Nokogiri::XML::Schematron::Schema:0x00007fa1fb9e3b68 @parent=nil, @children=[], @options={:id=>"schema1", :title=>"Example schema"}>
schema.to_builder.to_xml
# => "<?xml version=\"1.0\"?>\n<sch:schema xmlns:sch=\"http://purl.oclc.org/dsdl/schematron\" id=\"schema1\">\n  <sch:title>Example schema</sch:title>\n</sch:schema>\n"

Instance Attribute Summary

• #id ⇒ String

  The value of the @id XML attribute.

• #title ⇒ String

  The value of the @title XML element.

Attributes inherited from Base

#children, #options, #parent

Instance Method Summary

• #initialize(**options) {|schema| ... } ⇒ Schema constructor

  Create a new Schema object.

• #ns(**options) {|ns| ... } ⇒ Nokogiri::XML::Schematron::Namespace

  Create a new Namespace object.

• #p(**options) {|p| ... } ⇒ Nokogiri::XML::Schematron::Paragraph

  Create a new Paragraph object.

• #pattern(**options) {|pattern| ... } ⇒ Nokogiri::XML::Schematron::Pattern

  Create a new Pattern object.

Methods inherited from Base

attribute, element, #to_builder

Constructor Details

#initialize(**options) {|schema| ... } ⇒ Schema

Create a new Schema object.

Parameters:

• options (Hash<Symbol, Object>) —

  the options.

Options Hash (**options):

• :id (#to_s) —

  the value of the @id XML attribute.

• :title (#to_s) —

  the value of the @title XML element.

Yield Parameters:

• schema (Nokogiri::XML::Schematron::Schema) —

  the internal representation of the <sch:schema> XML element.

Yield Returns:

• (void)

# File 'lib/nokogiri/xml/schematron/schema.rb', line 63

def initialize(**options, &block)
  super(nil, **options, &block)
end

Instance Attribute Details

#id ⇒ String

Returns the value of the @id XML attribute.

Returns:

• (String) —

  the value of the @id XML attribute.

# File 'lib/nokogiri/xml/schematron/schema.rb', line 21

attribute :id

#title ⇒ String

Returns the value of the @title XML element.

Returns:

• (String) —

  the value of the @title XML element.

# File 'lib/nokogiri/xml/schematron/schema.rb', line 25

attribute :title

Instance Method Details

#ns(**options) {|ns| ... } ⇒ Nokogiri::XML::Schematron::Namespace

Create a new Namespace object.

Parameters:

• options (Hash<Symbol, Object>) —

  the options.

Options Hash (**options):

• :prefix (String) —

  the value of the @prefix XML attribute.

• :uri (String) —

  the value of the @uri XML attribute.

Yield Parameters:

• ns (Nokogiri::XML::Schematron::Namespace) —

  the internal representation of the <sch:ns> XML element.

Yield Returns:

• (void)

Returns:

• (Nokogiri::XML::Schematron::Namespace) —

  the Namespace object.

# File 'lib/nokogiri/xml/schematron/schema.rb', line 35

element :ns, Nokogiri::XML::Schematron::Namespace

#p(**options) {|p| ... } ⇒ Nokogiri::XML::Schematron::Paragraph

Create a new Paragraph object.

Parameters:

• options (Hash<Symbol, Object>) —

  the options.

Options Hash (**options):

• :message (String) —

  the text content of the <sch:p> XML element.

Yield Parameters:

• p (Nokogiri::XML::Schematron::Paragraph) —

  the internal representation of the <sch:p> XML element.

Yield Returns:

• (void)

Returns:

• (Nokogiri::XML::Schematron::Paragraph) —

  the Paragraph object.

# File 'lib/nokogiri/xml/schematron/schema.rb', line 44

element :p, Nokogiri::XML::Schematron::Paragraph

#pattern(**options) {|pattern| ... } ⇒ Nokogiri::XML::Schematron::Pattern

Create a new Pattern object.

Parameters:

• options (Hash<Symbol, Object>) —

  the options.

Options Hash (**options):

• :id (String) —

  the value of the @id XML attribute.

• :title (String) —

  the value of the @title XML element.

Yield Parameters:

• pattern (Nokogiri::XML::Schematron::Pattern) —

  the internal representation of the <sch:pattern> XML element.

Yield Returns:

• (void)

Returns:

• (Nokogiri::XML::Schematron::Pattern) —

  the Pattern object.

# File 'lib/nokogiri/xml/schematron/schema.rb', line 54

element :pattern, Nokogiri::XML::Schematron::Pattern