adiwg-mdtranslator 2.18.2 → 2.18.4

data/lib/adiwg/mdtranslator/writers/simple_html/readme.md

@@ -0,0 +1,19 @@
+
+## html
+
+### Supported versions
+
+> Supports mdTranslator version 2.x
+
+### Writer for HTML 'human-readable' output of metadata
+
+The HTML Metadata Record output from the mdTranslator is intended to 
+be a human readable version of the metadata content read in by the 
+translator.  The HTML output does not attempt mimic any established 
+metadata standard but remains agnostic in its presentation. 
+The HTML metadata output will display the full content of the 
+metadata record ingested by the mdTranslator while translation to 
+established standards may not support all fields.
+
+The HTML output can be conveniently embedded in a users web page to 
+present metadata content to visitors.

data/lib/adiwg/mdtranslator/writers/simple_html/sections/html_additionalDocumentation.rb

@@ -0,0 +1,49 @@
+# HTML writer
+# additional documentation
+
+# History:
+#  Stan Smith 2017-04-04 refactored for mdTranslator 2.0
+# 	Stan Smith 2015-08-21 original script
+
+require_relative 'html_resourceType'
+require_relative 'html_citation'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Simple_html
+
+            class Html_AdditionalDocumentation
+
+               def initialize(html)
+                  @html = html
+               end
+
+               def writeHtml(hAddDoc)
+
+                  # classes used
+                  typeClass = Html_ResourceType.new(@html)
+                  citationClass = Html_Citation.new(@html)
+
+                  # additional documentation - resource type [] {resourceType}
+                  hAddDoc[:resourceTypes].each do |hType|
+                     typeClass.writeHtml(hType)
+                  end
+
+                  # additional documentation - citation [] {citation}
+                  hAddDoc[:citation].each do |hCitation|
+                     @html.div do
+                        @html.div(hCitation[:title], {'class' => 'h5'})
+                        @html.div(:class => 'block') do
+                           citationClass.writeHtml(hCitation)
+                        end
+                     end
+                  end
+
+               end # writeHtml
+            end # Html_AdditionalDocumentation
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/writers/simple_html/sections/html_algorithm.rb

@@ -0,0 +1,48 @@
+# HTML writer
+# algorithm
+
+# History:
+#  Stan Smith 2019-09-24 original script
+
+require_relative 'html_citation'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Simple_html
+
+            class Html_Algorithm
+
+               def initialize(html)
+                  @html = html
+               end
+
+               def writeHtml(hAlgorithm)
+
+                  # classes used
+                  citationClass = Html_Citation.new(@html)
+
+                  # algorithm - description
+                  unless hAlgorithm[:description].nil?
+                     @html.em('Description: ')
+                     @html.text!(hAlgorithm[:description])
+                     @html.br
+                  end
+
+                  # algorithm - citation {citation}
+                  unless hAlgorithm[:citation].empty?
+                     @html.div do
+                        @html.div('Algorithm citation', {'class' => 'h5'})
+                        @html.div(:class => 'block') do
+                           citationClass.writeHtml(hAlgorithm[:citation])
+                        end
+                     end
+                  end
+
+               end # writeHtml
+            end # Html_Algorithm
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/writers/simple_html/sections/html_allocation.rb

@@ -0,0 +1,114 @@
+# HTML writer
+# allocation
+
+# History:
+#  Stan Smith 2017-08-31 refactored for mdJson 2.3 schema update
+#  Stan Smith 2017-04-04 original script
+
+require_relative 'html_responsibility'
+require_relative 'html_onlineResource'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Simple_html
+
+            class Html_Allocation
+
+               def initialize(html)
+                  @html = html
+               end
+
+               def writeHtml(hAllocation)
+
+                  # classes used
+                  responsibilityClass = Html_Responsibility.new(@html)
+                  onlineClass = Html_OnlineResource.new(@html)
+
+                  # allocation - id
+                  unless hAllocation[:id].nil?
+                     @html.em('Source Allocation ID: ')
+                     @html.text!(hAllocation[:id])
+                     @html.br
+                  end
+
+                  # allocation - amount
+                  unless hAllocation[:amount].nil?
+                     @html.em('Amount: ')
+                     @html.text!(hAllocation[:amount].to_s)
+                     @html.br
+                  end
+
+                  # allocation - currency
+                  unless hAllocation[:currency].nil?
+                     @html.em('Currency: ')
+                     @html.text!(hAllocation[:currency])
+                     @html.br
+                  end
+
+                  # allocation - sourceId
+                  unless hAllocation[:sourceId].nil?
+                     hContact = Html_Document.getContact(hAllocation[:sourceId])
+                     @html.em('Source Contact: ')
+                     if hContact.empty?
+                        @html.text!("Contact #{hAllocation[:sourceId]} not found!")
+                     else
+                        @html.a(hContact[:contactId], 'href' => '#CID_'+hContact[:contactId])
+                     end
+                     @html.br
+                  end
+
+                  # allocation - recipientId
+                  unless hAllocation[:recipientId].nil?
+                     hContact = Html_Document.getContact(hAllocation[:recipientId])
+                     @html.em('Recipient Contact: ')
+                     if hContact.empty?
+                        @html.text!("Contact #{hAllocation[:recipientId]} not found!")
+                     else
+                        @html.a(hContact[:contactId], 'href' => '#CID_'+hContact[:contactId])
+                     end
+                     @html.br
+                  end
+
+                  # allocation - matching {Boolean}
+                  unless hAllocation[:matching].nil?
+                     @html.em('Matching Funds Provided: ')
+                     @html.text!(hAllocation[:matching].to_s)
+                     @html.br
+                  end
+
+                  # allocation - responsible parties [] {responsibleParty}
+                  hAllocation[:responsibleParties].each do |hResponsibility|
+                     @html.div do
+                        @html.div(hResponsibility[:roleName], 'class' => 'h5')
+                        @html.div(:class => 'block') do
+                           responsibilityClass.writeHtml(hResponsibility)
+                        end
+                     end
+                  end
+
+                  # allocation - online resource [] {onlineResource}
+                  hAllocation[:onlineResources].each do |hOnline|
+                     @html.div do
+                        @html.div('Online Resource', {'class' => 'h5'})
+                        @html.div(:class => 'block') do
+                           onlineClass.writeHtml(hOnline)
+                        end
+                     end
+                  end
+
+                  # allocation - comment
+                  unless hAllocation[:comment].nil?
+                     @html.em('Comment: ')
+                     @html.div(:class => 'block') do
+                        @html.text!(hAllocation[:comment])
+                     end
+                  end
+
+               end # writeHtml
+            end # Html_Allocation
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/writers/simple_html/sections/html_associatedResource.rb

@@ -0,0 +1,73 @@
+# HTML writer
+# associated resource
+
+# History:
+#  Stan Smith 2017-04-04 refactored for mdTranslator 2.0
+# 	Stan Smith 2015-08-21 original script
+
+require_relative 'html_resourceType'
+require_relative 'html_citation'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Simple_html
+
+            class Html_AssociatedResource
+
+               def initialize(html)
+                  @html = html
+               end
+
+               def writeHtml(hResource)
+
+                  # classes used
+                  typeClass = Html_ResourceType.new(@html)
+                  citationClass = Html_Citation.new(@html)
+
+                  # associated resource - resource type
+                  hResource[:resourceTypes].each do |hType|
+                     typeClass.writeHtml(hType)
+                  end
+
+                  # associated resource - association type {associationTypeCode}
+                  unless hResource[:associationType].nil?
+                     @html.em('Association type: ')
+                     @html.text!(hResource[:associationType])
+                     @html.br
+                  end
+
+                  # associated resource - initiative type {initiativeTypeCode}
+                  unless hResource[:initiativeType].nil?
+                     @html.em('Initiative type: ')
+                     @html.text!(hResource[:initiativeType])
+                     @html.br
+                  end
+
+                  # associated resource - resource citation {citation}
+                  unless hResource[:resourceCitation].empty?
+                     @html.div do
+                        @html.div('Resource citation', {'class' => 'h5'})
+                        @html.div(:class => 'block') do
+                           citationClass.writeHtml(hResource[:resourceCitation])
+                        end
+                     end
+                  end
+
+                  # associated resource - metadata citation
+                  unless hResource[:metadataCitation].empty?
+                     @html.div do
+                        @html.div('Metadata citation', {'class' => 'h5'})
+                        @html.div(:class => 'block') do
+                           citationClass.writeHtml(hResource[:metadataCitation])
+                        end
+                     end
+                  end
+
+               end # writeHtml
+            end # Html_AssociatedResource
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/writers/simple_html/sections/html_attribute.rb

@@ -0,0 +1,201 @@
+# HTML writer
+# attribute
+
+# History:
+#  Stan Smith 2017-04-02 original script
+
+require_relative 'html_identifier'
+require_relative 'html_rangeElementDescription'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Simple_html
+
+            class Html_Attribute
+
+               def initialize(html)
+                  @html = html
+               end
+
+               def writeHtml(hAttribute)
+                  # classes used
+                  identifierClass = Html_Identifier.new(@html)
+                  rangeElementDescriptionClass = Html_RangeElementDescription.new(@html)
+
+                  # attribute - sequence identifier
+                  unless hAttribute[:sequenceIdentifier].nil?
+                     @html.em('Sequence Identifier: ')
+                     @html.text!(hAttribute[:sequenceIdentifier])
+                     @html.br
+                  end
+
+                  # attribute - sequence identifier type
+                  unless hAttribute[:sequenceIdentifierType].nil?
+                     @html.em('Sequence Identifier Type: ')
+                     @html.text!(hAttribute[:sequenceIdentifierType])
+                     @html.br
+                  end
+
+                  # attribute - attribute description
+                  unless hAttribute[:attributeDescription].nil?
+                     @html.em('Attribute Description:')
+                     @html.div(:class => 'block') do
+                        @html.text!(hAttribute[:attributeDescription])
+                     end
+                  end
+
+                  # attribute - attribute identifiers [] {identifier}
+                  hAttribute[:attributeIdentifiers].each do |hIdentifier|
+                     @html.div do
+                        @html.div('Identifier', 'class' => 'h5')
+                        @html.div(:class => 'block') do
+                           identifierClass.writeHtml(hIdentifier)
+                        end
+                     end
+                  end
+
+                  # attribute - minimum value
+                  unless hAttribute[:minValue].nil?
+                     @html.em('Minimum Value: ')
+                     @html.text!(hAttribute[:minValue].to_s)
+                     @html.br
+                  end
+
+                  # attribute - maximum value
+                  unless hAttribute[:maxValue].nil?
+                     @html.em('Maximum Value: ')
+                     @html.text!(hAttribute[:maxValue].to_s)
+                     @html.br
+                  end
+
+                  # attribute - units
+                  unless hAttribute[:units].nil?
+                     @html.em('Units: ')
+                     @html.text!(hAttribute[:units])
+                     @html.br
+                  end
+
+                  # attribute - scale factor
+                  unless hAttribute[:scaleFactor].nil?
+                     @html.em('Scale Factor: ')
+                     @html.text!(hAttribute[:scaleFactor].to_s)
+                     @html.br
+                  end
+
+                  # attribute - offset
+                  unless hAttribute[:offset].nil?
+                     @html.em('Offset: ')
+                     @html.text!(hAttribute[:offset].to_s)
+                     @html.br
+                  end
+
+                  # attribute - mean value
+                  unless hAttribute[:meanValue].nil?
+                     @html.em('Mean Value: ')
+                     @html.text!(hAttribute[:meanValue].to_s)
+                     @html.br
+                  end
+
+                  # attribute - number of values
+                  unless hAttribute[:numberOfValues].nil?
+                     @html.em('Number of Values: ')
+                     @html.text!(hAttribute[:numberOfValues].to_s)
+                     @html.br
+                  end
+
+                  # attribute - standard deviation
+                  unless hAttribute[:standardDeviation].nil?
+                     @html.em('Standard Deviation: ')
+                     @html.text!(hAttribute[:standardDeviation].to_s)
+                     @html.br
+                  end
+
+                  # attribute - bits per value
+                  unless hAttribute[:bitsPerValue].nil?
+                     @html.em('Bits Per Value: ')
+                     @html.text!(hAttribute[:bitsPerValue].to_s)
+                     @html.br
+                  end
+
+                  # attribute - range element description
+                  hAttribute[:rangeElementDescription].each do |red|
+                     @html.div do
+                        @html.div('Range Element Description', 'class' => 'h5')
+                        @html.div(:class => 'block') do
+                           rangeElementDescriptionClass.writeHtml(red)
+                        end
+                     end
+                  end
+
+                  # attribute - bound minimum
+                  unless hAttribute[:boundMinimum].nil?
+                     @html.em('Bound Minimum: ')
+                     @html.text!(hAttribute[:boundMinimum].to_s)
+                     @html.br
+                  end
+
+                  # attribute - bound maximum
+                  unless hAttribute[:boundMaximum].nil?
+                     @html.em('Bound Maximum: ')
+                     @html.text!(hAttribute[:boundMaximum].to_s)
+                     @html.br
+                  end
+
+                  # attribute - peak response
+                  unless hAttribute[:peakResponse].nil?
+                     @html.em('Peak Response: ')
+                     @html.text!(hAttribute[:peakResponse].to_s)
+                     @html.br
+                  end
+
+                  # attribute - tone gradations
+                  unless hAttribute[:toneGradations].nil?
+                     @html.em('Tone Gradations: ')
+                     @html.text!(hAttribute[:toneGradations].to_s)
+                     @html.br
+                  end
+
+                  # attribute - band boundary definitions
+                  unless hAttribute[:bandBoundaryDefinition].nil?
+                     @html.em('Band Boundary Definition:')
+                     @html.div(:class => 'block') do
+                        @html.text!(hAttribute[:bandBoundaryDefinition])
+                     end
+                  end
+
+                  # attribute - nominal spatial resolution
+                  unless hAttribute[:nominalSpatialResolution].nil?
+                     @html.em('Nominal Spatial Resolution: ')
+                     @html.text!(hAttribute[:nominalSpatialResolution].to_s)
+                     @html.br
+                  end
+
+                  # attribute - transfer function type
+                  unless hAttribute[:transferFunctionType].nil?
+                     @html.em('Transfer Function Type: ')
+                     @html.text!(hAttribute[:transferFunctionType])
+                     @html.br
+                  end
+
+                  # attribute - transmitted polarization
+                  unless hAttribute[:transmittedPolarization].nil?
+                     @html.em('Transmitted Polarization: ')
+                     @html.text!(hAttribute[:transmittedPolarization])
+                     @html.br
+                  end
+
+                  # attribute - detected polarization
+                  unless hAttribute[:detectedPolarization].nil?
+                     @html.em('Detected Polarization: ')
+                     @html.text!(hAttribute[:detectedPolarization])
+                     @html.br
+                  end
+
+               end # writeHtml
+            end # Html_Attribute
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/writers/simple_html/sections/html_attributeGroup.rb

@@ -0,0 +1,51 @@
+# HTML writer
+# attribute group
+
+# History:
+#  Stan Smith 2017-04-02 refactored for mdTranslator 2.0
+# 	Stan Smith 2015-08-21 original script
+
+require_relative 'html_attribute'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Simple_html
+
+            class Html_AttributeGroup
+
+               def initialize(html)
+                  @html = html
+               end
+
+               def writeHtml(hGroup)
+
+                  # classes used
+                  attributeClass = Html_Attribute.new(@html)
+
+                  # attribute group - content type [] {CoverageContentTypeCode}
+                  hGroup[:attributeContentTypes].each do |type|
+                     @html.em('Content Type: ')
+                     @html.text!(type)
+                     @html.br
+                  end
+
+                  # attribute group - attribute [] {attribute}
+                  counter = 0
+                  hGroup[:attributes].each do |hAttribute|
+                     @html.div do
+                        counter += 1
+                        @html.div('Attribute '+counter.to_s, {'class' => 'h5'})
+                        @html.div(:class => 'block') do
+                           attributeClass.writeHtml(hAttribute)
+                        end
+                     end
+                  end
+
+               end # writeHtml
+            end # Html_AttributeGroup
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/writers/simple_html/sections/html_bearingDistanceResolution.rb

@@ -0,0 +1,68 @@
+# HTML writer
+# bearing distance resolution
+
+# History:
+#  Stan Smith 2017-10-20 original script
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Simple_html
+
+            class Html_BearingDistanceResolution
+
+               def initialize(html)
+                  @html = html
+               end
+
+               def writeHtml(hBearRes)
+
+                  # bearing distance resolution - distance resolution
+                  unless hBearRes[:distanceResolution].nil?
+                     @html.em('Distance Resolution: ')
+                     @html.text!(hBearRes[:distanceResolution].to_s)
+                     @html.br
+                  end
+
+                  # bearing distance resolution - distance unit of measure
+                  unless hBearRes[:distanceUnitOfMeasure].nil?
+                     @html.em('Distance Unit of Measure: ')
+                     @html.text!(hBearRes[:distanceUnitOfMeasure])
+                     @html.br
+                  end
+
+                  # bearing distance resolution - bearing resolution
+                  unless hBearRes[:bearingResolution].nil?
+                     @html.em('Bearing Resolution: ')
+                     @html.text!(hBearRes[:bearingResolution].to_s)
+                     @html.br
+                  end
+
+                  # bearing distance resolution - bearing unit of measure
+                  unless hBearRes[:bearingUnitOfMeasure].nil?
+                     @html.em('Bearing Unit of Measure: ')
+                     @html.text!(hBearRes[:bearingUnitOfMeasure])
+                     @html.br
+                  end
+
+                  # bearing distance resolution - bearing reference direction
+                  unless hBearRes[:bearingReferenceDirection].nil?
+                     @html.em('Bearing Reference Direction: ')
+                     @html.text!(hBearRes[:bearingReferenceDirection])
+                     @html.br
+                  end
+
+                  # bearing distance resolution - bearing reference meridian
+                  unless hBearRes[:bearingReferenceMeridian].nil?
+                     @html.em('Bearing Reference Meridian: ')
+                     @html.text!(hBearRes[:bearingReferenceMeridian])
+                     @html.br
+                  end
+
+               end # writeHtml
+            end # Html_BearingDistanceResolution
+
+         end
+      end
+   end
+end