adiwg-mdtranslator 1.4.0 → 2.0.0rc2

data/lib/adiwg/mdtranslator/writers/html/sections/html_timePeriod.rb

@@ -2,59 +2,104 @@
 # time period
 
 # History:
+#  Stan Smith 2017-03-26 refactored for mdTranslator 2.0
+#  Stan Smith 2015-07-16 refactored to remove global namespace $HtmlNS
 # 	Stan Smith 2015-03-23 original script
-#   Stan Smith 2015-07-16 refactored to remove global namespace $HtmlNS
 
-require_relative 'html_dateTime'
+require_relative 'html_datetime'
+require_relative 'html_identifier'
+require_relative 'html_timeInterval'
+require_relative 'html_duration'
 
 module ADIWG
-    module Mdtranslator
-        module Writers
-            module Html
-
-                class MdHtmlTimePeriod
-                    def initialize(html)
-                        @html = html
-                    end
-
-                    def writeHtml(hTimePeriod)
-
-                        # classes used
-                        htmlDateTime = MdHtmlDateTime.new(@html)
-
-                        # timePeriod - id
-                        s = hTimePeriod[:timeId]
-                        if !s.nil?
-                            @html.em('ID: ')
-                            @html.text!(s)
-                            @html.br
-                        end
+   module Mdtranslator
+      module Writers
+         module Html
 
-                        # timePeriod - description
-                        s = hTimePeriod[:description]
-                        if !s.nil?
-                            @html.em('Description: ')
-                            @html.text!(s)
-                            @html.br
-                        end
+            class Html_TimePeriod
+
+               def initialize(html)
+                  @html = html
+               end
+
+               def writeHtml(hPeriod)
+
+                  # classes used
+                  datetimeClass = Html_Datetime.new(@html)
+                  identifierClass = Html_Identifier.new(@html)
+                  intervalClass = Html_TimeInterval.new(@html)
+                  durationClass = Html_Duration.new(@html)
+
+                  # time period - id
+                  unless hPeriod[:timeId].nil?
+                     @html.em('Period ID: ')
+                     @html.text!(hPeriod[:timeId])
+                     @html.br
+                  end
 
-                        # timePeriod - begin time
-                        if !hTimePeriod[:beginTime].empty?
-                            @html.em('Begin dateTime: ')
-                            htmlDateTime.writeHtml(hTimePeriod[:beginTime])
+                  # time period - name []
+                  hPeriod[:periodNames].each do |iName|
+                     @html.em('Period Name: ')
+                     @html.text!(iName)
+                     @html.br
+                  end
+
+                  # time period - start datetime
+                  unless hPeriod[:startDateTime].empty?
+                     @html.em('Start Datetime: ')
+                     @html.text!(datetimeClass.writeHtml(hPeriod[:startDateTime]))
+                     @html.br
+                  end
+
+                  # time period - end datetime
+                  unless hPeriod[:endDateTime].empty?
+                     @html.em('End Datetime: ')
+                     @html.text!(datetimeClass.writeHtml(hPeriod[:endDateTime]))
+                     @html.br
+                  end
+
+                  # time period - description
+                  unless hPeriod[:description].nil?
+                     @html.em('Description: ')
+                     @html.section(:class => 'block') do
+                        @html.text!(hPeriod[:description])
+                     end
+                  end
+
+                  # time period - identifier {identifier}
+                  unless hPeriod[:identifier].empty?
+                     @html.details do
+                        @html.summary('Identifier', 'class' => 'h5')
+                        @html.section(:class => 'block') do
+                           identifierClass.writeHtml(hPeriod[:identifier])
                         end
+                     end
+                  end
 
-                        # timePeriod - end time
-                        if !hTimePeriod[:endTime].empty?
-                            @html.em('End dateTime: ')
-                            htmlDateTime.writeHtml(hTimePeriod[:endTime])
+                  # time period - time interval
+                  unless hPeriod[:timeInterval].empty?
+                     @html.details do
+                        @html.summary('Time Interval', 'class' => 'h5')
+                        @html.section(:class => 'block') do
+                           intervalClass.writeHtml(hPeriod[:timeInterval])
                         end
+                     end
+                  end
 
-                    end # writeHtml
+                  # time period - duration
+                  unless hPeriod[:duration].empty?
+                     @html.details do
+                        @html.summary('Duration', 'class' => 'h5')
+                        @html.section(:class => 'block') do
+                           durationClass.writeHtml(hPeriod[:duration])
+                        end
+                     end
+                  end
 
-                end # class
+               end # writeHtml
+            end # Html_TimePeriod
 
-            end
-        end
-    end
+         end
+      end
+   end
 end

data/lib/adiwg/mdtranslator/writers/html/sections/html_transferOption.rb

@@ -2,75 +2,93 @@
 # transfer option
 
 # History:
+#  Stan Smith 2017-04-04 refactored for mdTranslator 2.0
+#  Stan Smith 2015-09-21 added transfer size elements
+#  Stan Smith 2015-07-16 refactored to remove global namespace $HtmlNS
 # 	Stan Smith 2015-03-27 original script
-#   Stan Smith 2015-07-16 refactored to remove global namespace $HtmlNS
-#   Stan Smith 2015-09-21 added transfer size elements
 
 require_relative 'html_onlineResource'
 require_relative 'html_medium'
+require_relative 'html_duration'
 require_relative 'html_format'
 
 module ADIWG
-    module Mdtranslator
-        module Writers
-            module Html
+   module Mdtranslator
+      module Writers
+         module Html
 
-                class MdHtmlTransferOption
-                    def initialize(html)
-                        @html = html
-                    end
+            class Html_TransferOption
 
-                    def writeHtml(hTransOption)
+               def initialize(html)
+                  @html = html
+               end
 
-                        # classes used
-                        htmlOlRes = MdHtmlOnlineResource.new(@html)
-                        htmlMedium = MdHtmlMedium.new(@html)
-                        htmlFormat = MdHtmlFormat.new(@html)
+               def writeHtml(hOption)
 
-                        # resource distribution - resource format
-                        hTransOption[:distFormats].each do |hFormat|
-                            htmlFormat.writeHtml(hFormat)
-                        end
+                  # classes used
+                  onlineClass = Html_OnlineResource.new(@html)
+                  mediumClass = Html_Medium.new(@html)
+                  durationClass = Html_Duration.new(@html)
+                  formatClass = Html_Format.new(@html)
 
-                        # transfer options - transfer size
-                        s = hTransOption[:transferSize]
-                        if !s.nil?
-                            @html.em('Transfer size: ')
-                            @html.text!(s.to_s)
-                            @html.br
-                        end
+                  # transfer options - units of distribution
+                  unless hOption[:unitsOfDistribution].nil?
+                     @html.em('Units of Distribution: ')
+                     @html.text!(hOption[:unitsOfDistribution].to_s)
+                     @html.br
+                  end
 
-                        # transfer options - transfer size units
-                        s = hTransOption[:transferSizeUnits]
-                        if !s.nil?
-                            @html.em('Transfer size units: ')
-                            @html.text!(s)
-                            @html.br
+                  # transfer options - transfer size
+                  unless hOption[:transferSize].nil?
+                     @html.em('Size of Unit in MB: ')
+                     @html.text!(hOption[:transferSize].to_s)
+                     @html.br
+                  end
+
+                  # transfer options - online options [] {onlineResource}
+                  hOption[:onlineOptions].each do |hOption|
+                     @html.details do
+                        @html.summary('Online Option', {'class' => 'h5'})
+                        @html.section(:class => 'block') do
+                           onlineClass.writeHtml(hOption)
                         end
+                     end
+                  end
 
-                        # transfer options - online options - online resource
-                        aOlRes = hTransOption[:online]
-                        aOlRes.each do |hOlRes|
-                            @html.em('Online option: ')
-                            @html.section(:class=>'block') do
-                                htmlOlRes.writeHtml(hOlRes)
-                            end
+                  # transfer options - offline options [] {medium}
+                  hOption[:offlineOptions].each do |hOption|
+                     @html.details do
+                        @html.summary('Offline Option', {'class' => 'h5'})
+                        @html.section(:class => 'block') do
+                           mediumClass.writeHtml(hOption)
                         end
+                     end
+                  end
 
-                        # transfer options - offline option - medium
-                        hMedium = hTransOption[:offline]
-                        if !hMedium.empty?
-                            @html.em('Offline option: ')
-                            @html.section(:class=>'block') do
-                                htmlMedium.writeHtml(hMedium)
-                            end
+                  # transfer options - transfer frequency {duration}
+                  unless hOption[:transferFrequency].empty?
+                     @html.details do
+                        @html.summary('Transfer Frequency', 'class' => 'h5')
+                        @html.section(:class => 'block') do
+                           durationClass.writeHtml(hOption[:transferFrequency])
                         end
+                     end
+                  end
 
-                    end # writeHtml
+                  # transfer options - distribution formats [] {format}
+                  hOption[:distributionFormats].each do |hFormat|
+                     @html.details do
+                        @html.summary('Distribution Format Option', 'class' => 'h5')
+                        @html.section(:class => 'block') do
+                           formatClass.writeHtml(hFormat)
+                        end
+                     end
+                  end
 
-                end # class
+               end # writeHtml
+            end # Html_TransferOption
 
-            end
-        end
-    end
+         end
+      end
+   end
 end

data/lib/adiwg/mdtranslator/writers/html/sections/html_usage.rb

@@ -0,0 +1,118 @@
+# HTML writer
+# usage
+
+# History:
+#  Stan Smith 2017-03-25 refactored for mdTranslator 2.0
+#  Stan Smith 2015-07-16 refactored to remove global namespace $HtmlNS
+# 	Stan Smith 2015-03-25 original script
+
+require_relative 'html_temporalExtent'
+require_relative 'html_citation'
+require_relative 'html_responsibility'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Html
+
+            class Html_Usage
+
+               def initialize(html)
+                  @html = html
+               end
+
+               def writeHtml(hUsage)
+
+                  # classes used
+                  temporalClass = Html_TemporalExtent.new(@html)
+                  citationClass = Html_Citation.new(@html)
+                  responsibilityClass = Html_Responsibility.new(@html)
+
+                  # resource usage - use
+                  @html.em('Usage: ')
+                  @html.br
+                  @html.text!(hUsage[:specificUsage])
+                  @html.br
+
+                  # resource usage - temporal extent
+                  unless hUsage[:temporalExtents].empty?
+                     @html.details do
+                        @html.summary('Times and Periods of Usage', 'class' => 'h5')
+                        @html.section(:class => 'block') do
+                           hUsage[:temporalExtents].each do |hTemporal|
+                              temporalClass.writeHtml(hTemporal)
+                           end
+                        end
+                     end
+                  end
+
+                  # resource usage - limitation
+                  unless hUsage[:userLimitation].nil? && hUsage[:limitationResponses].empty?
+                     @html.details do
+                        @html.summary('User Defined Limitations', 'class' => 'h5')
+                        @html.section(:class => 'block') do
+
+                           # user limitation
+                           unless hUsage[:userLimitation].nil?
+                              @html.em('Description')
+                              @html.section(:class => 'block') do
+                                 @html.text!(hUsage[:userLimitation])
+                              end
+                           end
+
+                           # limitation responses []
+                           hUsage[:limitationResponses].each do |response|
+                              @html.em('Response')
+                              @html.section(:class => 'block') do
+                                 @html.text!(response)
+                              end
+                           end
+
+                        end
+                     end
+                  end
+
+                  # resource usage - documented issue
+                  unless hUsage[:identifiedIssue].empty?
+                     @html.details do
+                        @html.summary('Cited Issue', 'class' => 'h5')
+                        @html.section(:class => 'block') do
+                           citationClass.writeHtml(hUsage[:identifiedIssue])
+                        end
+                     end
+                  end
+
+                  # resource usage - additional documentation
+                  hUsage[:additionalDocumentation].each do |hCitation|
+                     @html.details do
+                        @html.summary('Additional Documentation', 'class' => 'h5')
+                        @html.section(:class => 'block') do
+                           citationClass.writeHtml(hCitation)
+                        end
+                     end
+                  end
+
+                  # resource usage - user contacts
+                  unless hUsage[:userContacts].empty?
+                     @html.details do
+                        @html.summary('Usage and Limitation Contacts', {'class' => 'h5'})
+                        @html.section(:class => 'block') do
+                           hUsage[:userContacts].each do |hContact|
+                              @html.details do
+                                 @html.summary(hContact[:roleName], 'class' => 'h5')
+                                 @html.section(:class => 'block') do
+                                    responsibilityClass.writeHtml(hContact)
+                                 end
+                              end
+                           end
+                        end
+                     end
+                  end
+
+               end # writeHtml
+            end # Html_Usage
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/writers/html/sections/html_vectorObject.rb

@@ -0,0 +1,40 @@
+# HTML writer
+# vector object
+
+# History:
+#  Stan Smith 2017-03-28 original script
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Html
+
+            class Html_VectorObject
+
+               def initialize(html)
+                  @html = html
+               end
+
+               def writeHtml(hObject)
+
+                  # vector object - type
+                  unless hObject[:objectType].nil?
+                     @html.em('Object Type: ')
+                     @html.text!(hObject[:objectType])
+                     @html.br
+                  end
+
+                  # vector object - count
+                  unless hObject[:objectCount].nil?
+                     @html.em('Object Count: ')
+                     @html.text!(hObject[:objectCount].to_s)
+                     @html.br
+                  end
+
+               end # writeHtml
+            end # Html_VectorObject
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/writers/html/sections/html_vectorRepresentation.rb

@@ -0,0 +1,46 @@
+# HTML writer
+# vector representation
+
+# History:
+#  Stan Smith 2017-03-28 original script
+
+require_relative 'html_vectorObject'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Html
+
+            class Html_VectorRepresentation
+
+               def initialize(html)
+                  @html = html
+               end
+
+               def writeHtml(hVector)
+
+                  # classes used
+                  objectClass = Html_VectorObject.new(@html)
+
+                  # vector representation - topology level
+                  @html.em('Topology Level: ')
+                  @html.text!(hVector[:topologyLevel])
+                  @html.br
+
+                  # vector representation - vector object []
+                  hVector[:vectorObject].each do |hObject|
+                     @html.details do
+                        @html.summary('Vector Object ', 'class' => 'h5')
+                        @html.section(:class => 'block') do
+                           objectClass.writeHtml(hObject)
+                        end
+                     end
+                  end
+
+               end # writeHtml
+            end # Html_VectorRepresentation
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/writers/html/sections/html_verticalExtent.rb

@@ -0,0 +1,62 @@
+# HTML writer
+# vertical extent
+
+# History:
+#  Stan Smith 2017-04-04 refactored for mdTranslator 2.0
+# 	Stan Smith 2015-04-03 original script
+
+require_relative 'html_spatialReference'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Html
+
+            class Html_VerticalExtent
+
+               def initialize(html)
+                  @html = html
+               end
+
+               def writeHtml(hExtent)
+
+                  # classes used
+                  referenceClass = Html_SpatialReference.new(@html)
+
+                  # vertical extent - description
+                  unless hExtent[:description].nil?
+                     @html.em('Description: ')
+                     @html.section(:class => 'block') do
+                        @html.text!(hExtent[:description])
+                     end
+                  end
+
+                  # vertical extent - min value
+                  unless hExtent[:minValue].nil?
+                     @html.em('Minimum Value: ')
+                     @html.text!(hExtent[:minValue].to_s)
+                     @html.br
+                  end
+
+                  # vertical extent - max value
+                  unless hExtent[:maxValue].nil?
+                     @html.em('Maximum Value: ')
+                     @html.text!(hExtent[:maxValue].to_s)
+                     @html.br
+                  end
+
+                  # vertical extent - CRS ID {spatialReference}
+                  unless hExtent[:crsId].empty?
+                     @html.em('Reference System: ')
+                     @html.section(:class => 'block') do
+                        referenceClass.writeHtml(hExtent[:crsId])
+                     end
+                  end
+
+               end # writeHtml
+            end # Html_VerticalExtent
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/writers/html/version.rb

@@ -1,17 +1,18 @@
 # mdJson version history
-# 1.1.0 2015-07-30 added support for locale in metadata record information
-# 1.1.0 2015-07-31 added support for grid information
-# 1.1.0 2015-08-28 added support for content coverage information
+#  Stan Smith 2.0.0 2017-03-21 refactored for mdTranslator 2.0
+#  Stan Smith 1.1.0 2015-08-28 added support for content coverage information
+#  Stan Smith 1.1.0 2015-07-31 added support for grid information
+#  Stan Smith 1.1.0 2015-07-30 added support for locale in metadata record information
 
 module ADIWG
-    module Mdtranslator
-        module Writers
-            module Html
+   module Mdtranslator
+      module Writers
+         module Html
 
-                # current version of html writer
-                VERSION = '1.1.0'
+            # current version of html writer
+            VERSION = '2.0.0'
 
-            end
-        end
-    end
+         end
+      end
+   end
 end