adiwg-mdtranslator 2.18.2 → 2.18.4

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

@@ -0,0 +1,108 @@
+# HTML writer
+# domain
+
+# History:
+#  Stan Smith 2017-11-03 added domainReference
+#  Stan Smith 2017-04-05 refactored for mdTranslator 2.0
+#  Stan Smith 2015-07-16 refactored to remove global namespace $HtmlNS
+# 	Stan Smith 2015-03-26 original script
+
+require_relative 'html_domainItem'
+require_relative 'html_citation'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Simple_html
+
+            class Html_Domain
+
+               def initialize(html)
+                  @html = html
+               end
+
+               def writeHtml(aDomains)
+
+                  # classes used
+                  itemClass = Html_DomainItem.new(@html)
+                  citationClass = Html_Citation.new(@html)
+
+                  aDomains.each do |hDomain|
+
+                     dName = 'domain'
+                     dName = hDomain[:domainCode] unless hDomain[:domainCode].nil?
+                     dName = hDomain[:domainName] unless hDomain[:domainName].nil?
+
+                     type = 'UNREPRESENTABLE'
+                     type = 'CODESET' unless hDomain[:domainReference].empty?
+                     type = 'ENUMERATED' unless hDomain[:domainItems].empty?
+
+                     @html.div do
+                        @html.div(dName, {'class' => 'h5'})
+                        @html.div(:class => 'block') do
+
+                           # domain - type
+                           @html.em('Domain Type: ')
+                           @html.text!(type)
+                           @html.br
+
+                           # domain - id
+                           unless hDomain[:domainId].nil?
+                              @html.em('ID: ')
+                              @html.text!(hDomain[:domainId])
+                              @html.br
+                           end
+
+                           # domain - name
+                           unless hDomain[:domainName].nil?
+                              @html.em('Name: ')
+                              @html.text!(hDomain[:domainName])
+                              @html.br
+                           end
+
+                           # domain - code
+                           unless hDomain[:domainCode].nil?
+                              @html.em('Code: ')
+                              @html.text!(hDomain[:domainCode])
+                              @html.br
+                           end
+
+                           # domain - description
+                           unless hDomain[:domainDescription].nil?
+                              @html.em('Description: ')
+                              @html.div(:class => 'block') do
+                                 @html.text!(hDomain[:domainDescription])
+                              end
+                           end
+
+                           # domain - domain reference {citation}
+                           unless hDomain[:domainReference].empty?
+                              @html.div do
+                                 @html.div('Reference', {'class' => 'h5'})
+                                 @html.div(:class => 'block') do
+                                    citationClass.writeHtml(hDomain[:domainReference])
+                                 end
+                              end
+                           end
+
+                           # domain - domain items [] {domainItem}
+                           hDomain[:domainItems].each do |hItem|
+                              @html.div do
+                                 @html.div(hItem[:itemValue], {'class' => 'h5'})
+                                 @html.div(:class => 'block') do
+                                    itemClass.writeHtml(hItem)
+                                 end
+                              end
+                           end
+
+                        end
+                     end
+
+                  end # aDomain
+               end # writeHtml
+            end # Html_Domain
+
+         end
+      end
+   end
+end

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

@@ -0,0 +1,64 @@
+# HTML writer
+# domain item
+
+# History:
+#  Stan Smith 2017-04-05 refactored for mdTranslator 2.0
+# 	Stan Smith 2015-03-26 original script
+
+require_relative 'html_citation'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Simple_html
+
+            class Html_DomainItem
+
+               def initialize(html)
+                  @html = html
+               end
+
+               def writeHtml(hItem)
+
+                  # classes used
+                  citationClass = Html_Citation.new(@html)
+
+                  # domain item - common name
+                  unless hItem[:itemName].nil?
+                     @html.em('Name: ')
+                     @html.text!(hItem[:itemName])
+                     @html.br
+                  end
+
+                  # domain item - value
+                  unless hItem[:itemValue].nil?
+                     @html.em('Value: ')
+                     @html.text!(hItem[:itemValue])
+                     @html.br
+                  end
+
+                  # domain item - definition
+                  unless hItem[:itemDefinition].nil?
+                     @html.em('Definition: ')
+                     @html.div(:class => 'block') do
+                        @html.text!(hItem[:itemDefinition])
+                     end
+                  end
+
+                  # domain item - reference {citation}
+                  unless hItem[:itemReference].empty?
+                     @html.div do
+                        @html.div('Reference', {'class' => 'h5'})
+                        @html.div(:class => 'block') do
+                           citationClass.writeHtml(hItem[:itemReference])
+                        end
+                     end
+                  end
+
+               end # writeHtml
+            end # Html_DomainItem
+
+         end
+      end
+   end
+end

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

@@ -0,0 +1,68 @@
+# HTML writer
+# duration
+
+# History:
+#  Stan Smith 2017-03-27 original script
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Simple_html
+
+            class Html_Duration
+
+               def initialize(html)
+                  @html = html
+               end
+
+               def writeHtml(hDuration)
+
+                  # duration - years
+                  unless hDuration[:years] == 0
+                     @html.em('Years: ')
+                     @html.text!(hDuration[:years].to_s)
+                     @html.br
+                  end
+
+                  # duration - months
+                  unless hDuration[:months] == 0
+                     @html.em('Months: ')
+                     @html.text!(hDuration[:months].to_s)
+                     @html.br
+                  end
+
+                  # duration - days
+                  unless hDuration[:days] == 0
+                     @html.em('Days: ')
+                     @html.text!(hDuration[:days].to_s)
+                     @html.br
+                  end
+
+                  # duration - hours
+                  unless hDuration[:hours] == 0
+                     @html.em('Hours: ')
+                     @html.text!(hDuration[:hours].to_s)
+                     @html.br
+                  end
+
+                  # duration - minutes
+                  unless hDuration[:minutes] == 0
+                     @html.em('Minutes: ')
+                     @html.text!(hDuration[:minutes].to_s)
+                     @html.br
+                  end
+
+                  # duration - seconds
+                  unless hDuration[:seconds] == 0
+                     @html.em('Seconds: ')
+                     @html.text!(hDuration[:seconds].to_s)
+                     @html.br
+                  end
+
+               end # writeHtml
+            end # Html_Duration
+
+         end
+      end
+   end
+end

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

@@ -0,0 +1,169 @@
+# HTML writer
+# entity
+
+# History:
+#  Stan Smith 2017-11-03 added new elements to support fgdc
+#  Stan Smith 2017-04-05 refactored for mdTranslator 2.0
+#  Stan Smith 2015-07-16 refactored to remove global namespace $HtmlNS
+# 	Stan Smith 2015-03-26 original script
+
+require_relative 'html_entityIndex'
+require_relative 'html_entityAttribute'
+require_relative 'html_entityForeignKey'
+require_relative 'html_citation'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Simple_html
+
+            class Html_Entity
+
+               def initialize(html)
+                  @html = html
+               end
+
+               def writeHtml(aEntities)
+
+                  # classes used
+                  indexClass = Html_EntityIndex.new(@html)
+                  attributeClass = Html_EntityAttribute.new(@html)
+                  foreignClass = Html_EntityForeignKey.new(@html)
+                  citationClass = Html_Citation.new(@html)
+
+                  aEntities.each do |hEntity|
+
+                     eName = 'entity'
+                     eName = hEntity[:entityCode] unless hEntity[:entityCode].nil?
+                     eName = hEntity[:entityName] unless hEntity[:entityName].nil?
+
+                     @html.div do
+                        @html.div(eName, {'class' => 'h5'})
+                        @html.div(:class => 'block') do
+
+                           # entity - entity id
+                           unless hEntity[:entityId].nil?
+                              @html.em('ID: ')
+                              @html.text!(hEntity[:entityId])
+                              @html.br
+                           end
+
+                           # entity - name
+                           unless hEntity[:entityName].nil?
+                              @html.em('Name: ')
+                              @html.text!(hEntity[:entityName])
+                              @html.br
+                           end
+
+                           # entity - code
+                           unless hEntity[:entityCode].nil?
+                              @html.em('Code: ')
+                              @html.text!(hEntity[:entityCode])
+                              @html.br
+                           end
+
+                           # entity - alias names
+                           hEntity[:entityAlias].each do |otherName|
+                              @html.em('Alias: ')
+                              @html.div(:class => 'block') do
+                                 @html.text!(otherName)
+                              end
+                           end
+
+                           # entity - definition
+                           unless hEntity[:entityDefinition].nil?
+                              @html.em('Definition: ')
+                              @html.div(:class => 'block') do
+                                 @html.text!(hEntity[:entityDefinition])
+                              end
+                           end
+
+                           # entity - primary key
+                           unless hEntity[:primaryKey].empty?
+                              @html.em('Primary Key Attribute(s):')
+                              @html.div(:class => 'block') do
+                                 hEntity[:primaryKey].each do |attribute|
+                                    @html.text!(attribute)
+                                    @html.br
+                                 end
+                              end
+                           end
+
+                           # entity - field separator character
+                           unless hEntity[:fieldSeparatorCharacter].nil?
+                              @html.em('Field Separator Character: ')
+                              @html.text!(hEntity[:fieldSeparatorCharacter])
+                              @html.br
+                           end
+
+                           # entity - number of header lines
+                           unless hEntity[:numberOfHeaderLines].nil?
+                              @html.em('Number of Header Lines: ')
+                              @html.text!(hEntity[:numberOfHeaderLines].to_s)
+                              @html.br
+                           end
+
+                           # entity - quote character
+                           unless hEntity[:quoteCharacter].nil?
+                              @html.em('Quote Character: ')
+                              @html.text!(hEntity[:quoteCharacter])
+                              @html.br
+                           end
+
+                           # entity - indexes [] {entityIndex}
+                           hEntity[:indexes].each do |hIndex|
+                              iName = 'index'
+                              iName = hIndex[:indexCode] unless hIndex[:indexCode].nil?
+                              iName = hIndex[:indexName] unless hIndex[:indexName].nil?
+                              @html.div do
+                                 @html.div('Index: '+iName, {'class' => 'h5'})
+                                 @html.div(:class => 'block') do
+                                    indexClass.writeHtml(hIndex)
+                                 end
+                              end
+                           end
+
+                           # entity - foreign keys [] {entityForeignKey}
+                           hEntity[:foreignKeys].each do |hForeign|
+                              @html.div do
+                                 @html.div('ForeignKey', {'class' => 'h5'})
+                                 @html.div(:class => 'block') do
+                                    foreignClass.writeHtml(hForeign)
+                                 end
+                              end
+                           end
+
+                           # entity - entity reference [] {citation}
+                           hEntity[:entityReferences].each do |hReference|
+                              @html.div do
+                                 @html.div('Reference', {'class' => 'h5'})
+                                 @html.div(:class => 'block') do
+                                    citationClass.writeHtml(hReference)
+                                 end
+                              end
+                           end
+
+                           # entity - attributes [] {entityAttribute}
+                           hEntity[:attributes].each do |hAttribute|
+                              aName = 'attribute'
+                              aName = hAttribute[:attributeCode] unless hAttribute[:attributeCode].nil?
+                              aName = hAttribute[:attributeName] unless hAttribute[:attributeName].nil?
+                              @html.div do
+                                 @html.div('Attribute: '+aName, {'class' => 'h5'})
+                                 @html.div(:class => 'block') do
+                                    attributeClass.writeHtml(hAttribute)
+                                 end
+                              end
+                           end
+
+                        end
+                     end
+
+                  end # aEntity
+               end # writeHtml
+            end # Html_Entity
+
+         end
+      end
+   end
+end

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

@@ -0,0 +1,179 @@
+# HTML writer
+# data attribute
+
+# History:
+#  Stan Smith 2017-11-03 added new elements for fgdc
+#  Stan Smith 2017-04-05 refactored for mdTranslator 2.0
+# 	Stan Smith 2015-03-26 original script
+
+require_relative 'html_timePeriod'
+require_relative 'html_citation'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Simple_html
+
+            class Html_EntityAttribute
+
+               def initialize(html)
+                  @html = html
+               end
+
+               def writeHtml(hAttribute)
+
+                  # classes used
+                  periodClass = Html_TimePeriod.new(@html)
+                  citationClass = Html_Citation.new(@html)
+
+                  # entity attribute - common name
+                  unless hAttribute[:attributeName].nil?
+                     @html.em('Name: ')
+                     @html.text!(hAttribute[:attributeName])
+                     @html.br
+                  end
+
+                  # entity attribute - code name
+                  unless hAttribute[:attributeCode].nil?
+                     @html.em('Code: ')
+                     @html.text!(hAttribute[:attributeCode])
+                     @html.br
+                  end
+
+                  # entity attribute - aliases
+                  hAttribute[:attributeAlias].each do |otherName|
+                     @html.em('Alias: ')
+                     @html.text!(otherName)
+                     @html.br
+                  end
+
+                  # entity attribute - definition
+                  unless hAttribute[:attributeDefinition].nil?
+                     @html.em('Definition: ')
+                     @html.div(:class => 'block') do
+                        @html.text!(hAttribute[:attributeDefinition])
+                     end
+                  end
+
+                  # entity attribute - datatype
+                  unless hAttribute[:dataType].nil?
+                     @html.em('Datatype: ')
+                     @html.text!(hAttribute[:dataType])
+                     @html.br
+                  end
+
+                  # entity attribute - allow nulls {Boolean}
+                  @html.em('Allow NULL Values: ')
+                  @html.text!(hAttribute[:allowNull].to_s)
+                  @html.br
+
+                  # entity attribute - must be unique {Boolean}
+                  @html.em('Attribute Values Must Be Unique: ')
+                  @html.text!(hAttribute[:mustBeUnique].to_s)
+                  @html.br
+
+                  # entity attribute - unit of measure
+                  unless hAttribute[:unitOfMeasure].nil?
+                     @html.em('Unit of Measure: ')
+                     @html.text!(hAttribute[:unitOfMeasure])
+                     @html.br
+                  end
+
+                  # entity attribute - measure resolution {real}
+                  unless hAttribute[:measureResolution].nil?
+                     @html.em('Unit of Measure Resolution: ')
+                     @html.text!(hAttribute[:measureResolution].to_s)
+                     @html.br
+                  end
+
+                  # entity attribute - case sensitive {Boolean}
+                  @html.em('Value is Case Sensitive: ')
+                  @html.text!(hAttribute[:isCaseSensitive].to_s)
+                  @html.br
+
+                  # entity attribute - field width {integer}
+                  unless hAttribute[:fieldWidth].nil?
+                     @html.em('Field Width: ')
+                     @html.text!(hAttribute[:fieldWidth].to_s)
+                     @html.br
+                  end
+
+                  # entity attribute - missing value
+                  unless hAttribute[:missingValue].nil?
+                     @html.em('Missing Value: ')
+                     @html.text!(hAttribute[:missingValue])
+                     @html.br
+                  end
+
+                  # entity attribute - domain ID
+                  unless hAttribute[:domainId].nil?
+                     @html.em('Domain ID: ')
+                     @html.text!(hAttribute[:domainId])
+                     @html.br
+                  end
+
+                  # entity attribute - minimum value
+                  unless hAttribute[:minValue].nil?
+                     @html.em('Minimum Value: ')
+                     @html.text!(hAttribute[:minValue].to_s)
+                     @html.br
+                  end
+
+                  # entity attribute - code name
+                  unless hAttribute[:maxValue].nil?
+                     @html.em('Maximum Value: ')
+                     @html.text!(hAttribute[:maxValue].to_s)
+                     @html.br
+                  end
+
+                  # entity attribute - range of values [] {citation}
+                  hAttribute[:valueRange].each do |hRange|
+                     @html.div do
+                        @html.div('Range of Values', {'class' => 'h5'})
+                        @html.div(:class => 'block') do
+
+                           # range of values - minimum value
+                           unless hRange[:minRangeValue].nil?
+                              @html.em('Range Minimum: ')
+                              @html.text!(hRange[:minRangeValue].to_s)
+                              @html.br
+                           end
+
+                           # range of values - maximum value
+                           unless hRange[:maxRangeValue].nil?
+                              @html.em('Range Maximum: ')
+                              @html.text!(hRange[:maxRangeValue].to_s)
+                              @html.br
+                           end
+
+                        end
+                     end
+                  end
+
+                  # entity attribute - time period of values {timePeriod}
+                  hAttribute[:timePeriod].each do |hPeriod|
+                     @html.div do
+                        @html.div('Time Period of Values', {'class' => 'h5'})
+                        @html.div(:class => 'block') do
+                           periodClass.writeHtml(hPeriod)
+                        end
+                     end
+                  end
+
+                  # entity attribute - attribute reference {citation}
+                  unless hAttribute[:attributeReference].empty?
+                     @html.div do
+                        @html.div('Reference', {'class' => 'h5'})
+                        @html.div(:class => 'block') do
+                           citationClass.writeHtml(hAttribute[:attributeReference])
+                        end
+                     end
+                  end
+
+               end # writeHtml
+            end # Html_EntityAttribute
+
+         end
+      end
+   end
+end

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

@@ -0,0 +1,55 @@
+# HTML writer
+# entity foreign key
+
+# History:
+#  Stan Smith 2017-04-05 original script
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Simple_html
+
+            class Html_EntityForeignKey
+
+               def initialize(html)
+                  @html = html
+               end
+
+               def writeHtml(hKey)
+
+                  # foreign key - attributes []
+                  unless hKey[:fkLocalAttributes].empty?
+                     @html.em('Local Attribute(s):')
+                     @html.div(:class => 'block') do
+                        hKey[:fkLocalAttributes].each do |attribute|
+                           @html.text!(attribute)
+                           @html.br
+                        end
+                     end
+                  end
+
+                  # foreign key - referenced entity
+                  unless hKey[:fkReferencedEntity].nil?
+                     @html.em('Referenced Entity Code: ')
+                     @html.text!(hKey[:fkReferencedEntity])
+                     @html.br
+                  end
+
+                  # foreign key - referenced attributes []
+                  unless hKey[:fkReferencedAttributes].empty?
+                     @html.em('Referenced Attribute(s):')
+                     @html.div(:class => 'block') do
+                        hKey[:fkReferencedAttributes].each do |attribute|
+                           @html.text!(attribute)
+                           @html.br
+                        end
+                     end
+                  end
+
+               end # writeHtml
+            end # Html_EntityForeignKey
+
+         end
+      end
+   end
+end

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

@@ -0,0 +1,50 @@
+# HTML writer
+# entity index
+
+# History:
+#  Stan Smith 2017-04-05 refactored for mdTranslator 2.0
+# 	Stan Smith 2015-03-26 original script
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Simple_html
+
+            class Html_EntityIndex
+
+               def initialize(html)
+                  @html = html
+               end
+
+               def writeHtml(hIndex)
+
+                  # entity index - name
+                  unless hIndex[:indexCode].nil?
+                     @html.em('Code: ')
+                     @html.text!(hIndex[:indexCode])
+                     @html.br
+                  end
+
+                  # entity index - duplicate {Boolean}
+                  @html.em('Allow Duplicates: ')
+                  @html.text!(hIndex[:duplicate].to_s)
+                  @html.br
+
+                  # entity index - attribute names
+                  unless hIndex[:attributeNames].empty?
+                     @html.em('Index Attribute(s):')
+                     @html.div(:class => 'block') do
+                        hIndex[:attributeNames].each do |attribute|
+                           @html.text!(attribute)
+                           @html.br
+                        end
+                     end
+                  end
+
+               end # writeHtml
+            end # Html_EntityIndex
+
+         end
+      end
+   end
+end