Class: Bio::PhyloXML::Uri

Inherits:
Object
  • Object
show all
Defined in:
lib/bio-phyloxml/phyloxml_elements.rb

Overview

A uniform resource identifier. In general, this is expected to be an URL (for example, to link to an image on a website, in which case the ‘type’ attribute might be ‘image’ and ‘desc’ might be ‘image of a California sea hare’)

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#desc ⇒ Object

String. Description of the uri. For example, image of a California sea hare’



669
670
671
 
# File 'lib/bio-phyloxml/phyloxml_elements.rb', line 669

def desc
  @desc
end

#type ⇒ Object

String. For example, image.



671
672
673
 
# File 'lib/bio-phyloxml/phyloxml_elements.rb', line 671

def type
  @type
end

#uri ⇒ Object

String. URL of the resource.



673
674
675
 
# File 'lib/bio-phyloxml/phyloxml_elements.rb', line 673

def uri
  @uri
end

Instance Method Details

#to_xml ⇒ Object

Converts elements to xml representation. Called by PhyloXML::Writer class.



676
677
678
679
680
681
682
683
684
 
# File 'lib/bio-phyloxml/phyloxml_elements.rb', line 676

def to_xml        
  if @uri != nil
    xml_node = LibXML::XML::Node.new('uri', @uri)
    Writer.generate_xml(xml_node, self, [
      [:attr, 'desc'],
      [:attr, 'type']])
    return xml_node
  end
end