Class: Yori::Schema::V3::XML

Inherits:

Yori::SchemaBase

• Object
• Hash
• Yori::SchemaBase
• Yori::Schema::V3::XML

Defined in:

lib/yori/schema/v3/xml.rb

Overview

Xml

A metadata object that allows for more fine-tuned XML model definitions.
When using arrays, XML element names are not inferred (for singular/plural forms) and the name property SHOULD be used to add that information.

Instance Attribute Summary

Attributes inherited from Yori::SchemaBase

#id

Instance Method Summary

• #attribute ⇒ Object

  Declares whether the property definition translates to an attribute instead of an element.

• #name ⇒ Object

  Replaces the name of the element/attribute used for the described schema property.

• #namespace ⇒ Object

  The URI of the namespace definition.

• #prefix ⇒ Object

  The prefix to be used for the name.

• #wrapped ⇒ Object

  MAY be used only for an array definition.

Methods inherited from Yori::SchemaBase

eval_class!, eval_hash!, eval_input!, #ref, #validate!, #validator

Instance Method Details

#attribute ⇒ Object

Declares whether the property definition translates to an attribute instead of an element. Default value is false.

# File 'lib/yori/schema/v3/xml.rb', line 24

fields :name, :namespace, :prefix, :attribute, :wrapped

#name ⇒ Object

Replaces the name of the element/attribute used for the described schema property. When defined within items, it will affect the name of the individual XML elements within the list. When defined alongside type being array (outside the items), it will affect the wrapping element and only if wrapped is true. If wrapped is false, it will be ignored.

# File 'lib/yori/schema/v3/xml.rb', line 24

fields :name, :namespace, :prefix, :attribute, :wrapped

#namespace ⇒ Object

The URI of the namespace definition. Value MUST be in the form of an absolute URI.

# File 'lib/yori/schema/v3/xml.rb', line 24

fields :name, :namespace, :prefix, :attribute, :wrapped

#prefix ⇒ Object

The prefix to be used for the name.

# File 'lib/yori/schema/v3/xml.rb', line 24

fields :name, :namespace, :prefix, :attribute, :wrapped

#wrapped ⇒ Object

MAY be used only for an array definition. Signifies whether the array is wrapped (for example, <books><book/><book/></books>) or unwrapped (<book/><book/>). Default value is false. The definition takes effect only when defined alongside type being array (outside the items).

# File 'lib/yori/schema/v3/xml.rb', line 24

fields :name, :namespace, :prefix, :attribute, :wrapped