adiwg-mdtranslator 2.4.0 → 2.5.0

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_entityAttribute.rb

@@ -2,129 +2,200 @@
 # Reader - ADIwg JSON V1 to internal data structure
 
 # History:
-#   Stan Smith 2016-10-05 refactored for mdJson 2.0
-#   Stan Smith 2015-07-24 added error reporting of missing items
-#   Stan Smith 2015-07-14 refactored to remove global namespace constants
-#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
-#   Stan Smith 2015-02-17 added support for attribute aliases
-#   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+#  Stan Smith 2017-11-01 added new elements to support fgdc and flat files
+#  Stan Smith 2016-10-05 refactored for mdJson 2.0
+#  Stan Smith 2015-07-24 added error reporting of missing items
+#  Stan Smith 2015-07-14 refactored to remove global namespace constants
+#  Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
+#  Stan Smith 2015-02-17 added support for attribute aliases
+#  Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
 # 	Stan Smith 2013-12-01 original script
 
-module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
-
-                module EntityAttribute
-
-                    def self.unpack(hAttribute, responseObj)
-
-                        # return nil object if input is empty
-                        if hAttribute.empty?
-                            responseObj[:readerExecutionMessages] << 'Entity Attribute object is empty'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intAttribute = intMetadataClass.newEntityAttribute
-
-                        # attribute - common name
-                        if hAttribute.has_key?('commonName')
-                            if hAttribute['commonName'] != ''
-                                intAttribute[:attributeName] = hAttribute['commonName']
-                            end
-                        end
-
-                        # attribute - code name (required)
-                        if hAttribute.has_key?('codeName')
-                            intAttribute[:attributeCode] = hAttribute['codeName']
-                        end
-                        if intAttribute[:attributeCode].nil? || intAttribute[:attributeCode] == ''
-                            responseObj[:readerExecutionMessages] << 'Data Dictionary attribute code name is missing'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        # attribute - alias []
-                        if hAttribute.has_key?('alias')
-                            hAttribute['alias'].each do |item|
-                                if item != ''
-                                    intAttribute[:attributeAlias] << item
-                                end
-                            end
-                        end
-
-                        # attribute - definition (required)
-                        if hAttribute.has_key?('definition')
-                            intAttribute[:attributeDefinition] = hAttribute['definition']
-                        end
-                        if intAttribute[:attributeDefinition].nil? || intAttribute[:attributeDefinition] == ''
-                            responseObj[:readerExecutionMessages] << 'Data Dictionary attribute definition is missing'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        # attribute - data type (required)
-                        if hAttribute.has_key?('dataType')
-                            intAttribute[:dataType] = hAttribute['dataType']
-                        end
-                        if intAttribute[:dataType].nil? || intAttribute[:dataType] == ''
-                            responseObj[:readerExecutionMessages] << 'Data Dictionary attribute data type is missing'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        # attribute - minimum cardinality (required)
-                        if hAttribute.has_key?('allowNull')
-                            if hAttribute['allowNull'] === true
-                                intAttribute[:allowNull] = hAttribute['allowNull']
-                            end
-                        end
 
-                        # attribute - maximum cardinality
-                        if hAttribute.has_key?('allowMany')
-                            if hAttribute['allowMany'] === true
-                                intAttribute[:allowMany] = hAttribute['allowMany']
-                            end
-                        end
+require_relative 'module_citation'
+require_relative 'module_valueRange'
+require_relative 'module_timePeriod'
 
-                        # attribute - units of measure
-                        if hAttribute.has_key?('units')
-                            if hAttribute['units'] != ''
-                                intAttribute[:unitOfMeasure] = hAttribute['units']
-                            end
+module ADIWG
+   module Mdtranslator
+      module Readers
+         module MdJson
+
+            module EntityAttribute
+
+               def self.unpack(hAttribute, responseObj)
+
+                  # return nil object if input is empty
+                  if hAttribute.empty?
+                     responseObj[:readerExecutionMessages] << 'Entity Attribute object is empty'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intAttribute = intMetadataClass.newEntityAttribute
+
+                  # attribute - common name
+                  if hAttribute.has_key?('commonName')
+                     if hAttribute['commonName'] != ''
+                        intAttribute[:attributeName] = hAttribute['commonName']
+                     end
+                  end
+
+                  # attribute - code name (required)
+                  if hAttribute.has_key?('codeName')
+                     intAttribute[:attributeCode] = hAttribute['codeName']
+                  end
+                  if intAttribute[:attributeCode].nil? || intAttribute[:attributeCode] == ''
+                     responseObj[:readerExecutionMessages] << 'Data Dictionary attribute code name is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
+                  # attribute - alias []
+                  if hAttribute.has_key?('alias')
+                     hAttribute['alias'].each do |item|
+                        if item != ''
+                           intAttribute[:attributeAlias] << item
                         end
-
-                        # attribute - domain ID
-                        if hAttribute.has_key?('domainId')
-                            if hAttribute['domainId'] != ''
-                                intAttribute[:domainId] = hAttribute['domainId']
-                            end
+                     end
+                  end
+
+                  # attribute - definition (required)
+                  if hAttribute.has_key?('definition')
+                     intAttribute[:attributeDefinition] = hAttribute['definition']
+                  end
+                  if intAttribute[:attributeDefinition].nil? || intAttribute[:attributeDefinition] == ''
+                     responseObj[:readerExecutionMessages] << 'Data Dictionary attribute definition is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
+                  # attribute - attribute reference
+                  if hAttribute.has_key?('attributeReference')
+                     hCitation = hAttribute['attributeReference']
+                     unless hCitation.empty?
+                        hReturn = Citation.unpack(hCitation, responseObj)
+                        unless hReturn.nil?
+                           intAttribute[:attributeReference] = hReturn
                         end
-
-                        # attribute - minimum value
-                        if hAttribute.has_key?('minValue')
-                            if hAttribute['minValue'] != ''
-                                intAttribute[:minValue] = hAttribute['minValue']
-                            end
+                     end
+                  end
+
+                  # attribute - data type (required)
+                  if hAttribute.has_key?('dataType')
+                     intAttribute[:dataType] = hAttribute['dataType']
+                  end
+                  if intAttribute[:dataType].nil? || intAttribute[:dataType] == ''
+                     responseObj[:readerExecutionMessages] << 'Data Dictionary attribute data type is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
+                  # attribute - minimum cardinality (required)
+                  if hAttribute.has_key?('allowNull')
+                     if hAttribute['allowNull'] === true
+                        intAttribute[:allowNull] = hAttribute['allowNull']
+                     end
+                  end
+
+                  # attribute - maximum cardinality
+                  if hAttribute.has_key?('allowMany')
+                     if hAttribute['allowMany'] === true
+                        intAttribute[:allowMany] = hAttribute['allowMany']
+                     end
+                  end
+
+                  # attribute - units of measure
+                  if hAttribute.has_key?('units')
+                     if hAttribute['units'] != ''
+                        intAttribute[:unitOfMeasure] = hAttribute['units']
+                     end
+                  end
+
+                  # attribute - units of measure resolution
+                  if hAttribute.has_key?('unitsResolution')
+                     if hAttribute['unitsResolution'] != ''
+                        intAttribute[:measureResolution] = hAttribute['unitsResolution']
+                     end
+                  end
+
+                  # attribute - case sensitive {Boolean} (default = false)
+                  if hAttribute.has_key?('isCaseSensitive')
+                     if hAttribute['unitsResolution'] != ''
+                        intAttribute[:isCaseSensitive] = hAttribute['isCaseSensitive']
+                     end
+                  end
+
+                  # attribute - field width
+                  if hAttribute.has_key?('fieldWidth')
+                     if hAttribute['fieldWidth'] != ''
+                        intAttribute[:fieldWidth] = hAttribute['fieldWidth']
+                     end
+                  end
+
+                  # attribute - missing value
+                  if hAttribute.has_key?('missingValue')
+                     if hAttribute['missingValue'] != ''
+                        intAttribute[:missingValue] = hAttribute['missingValue']
+                     end
+                  end
+
+                  # attribute - domain ID
+                  if hAttribute.has_key?('domainId')
+                     if hAttribute['domainId'] != ''
+                        intAttribute[:domainId] = hAttribute['domainId']
+                     end
+                  end
+
+                  # attribute - minimum value
+                  if hAttribute.has_key?('minValue')
+                     if hAttribute['minValue'] != ''
+                        intAttribute[:minValue] = hAttribute['minValue']
+                     end
+                  end
+
+                  # attribute - maximum value
+                  if hAttribute.has_key?('maxValue')
+                     if hAttribute['maxValue'] != ''
+                        intAttribute[:maxValue] = hAttribute['maxValue']
+                     end
+                  end
+
+                  # attribute - domain range of values [] {valueRange}
+                  if hAttribute.has_key?('rangeOfValues')
+                     aValueRange = hAttribute['rangeOfValues']
+                     aValueRange.each do |hRange|
+                        unless hRange.empty?
+                           hReturn = ValueRange.unpack(hRange, responseObj)
+                           unless hReturn.nil?
+                              intAttribute[:rangeOfValues] << hReturn
+                           end
                         end
-
-                        # attribute - maximum value
-                        if hAttribute.has_key?('maxValue')
-                            if hAttribute['maxValue'] != ''
-                                intAttribute[:maxValue] = hAttribute['maxValue']
-                            end
+                     end
+                  end
+
+                  # attribute - time period of values [] {timePeriod}
+                  if hAttribute.has_key?('timePeriodOfValues')
+                     aTimePeriods = hAttribute['timePeriodOfValues']
+                     aTimePeriods.each do |hTimePeriod|
+                        unless hTimePeriod.empty?
+                           hReturn = TimePeriod.unpack(hTimePeriod, responseObj)
+                           unless hReturn.nil?
+                              intAttribute[:timePeriodOfValues] << hReturn
+                           end
                         end
+                     end
+                  end
 
-                        return intAttribute
-
-                    end
+                  return intAttribute
 
-                end
+               end
 
             end
-        end
-    end
+
+         end
+      end
+   end
 end

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_valueRange.rb

@@ -0,0 +1,56 @@
+# unpack series
+# Reader - ADIwg JSON to internal data structure
+
+# History:
+# 	Stan Smith 2017-11-01 original script
+
+module ADIWG
+   module Mdtranslator
+      module Readers
+         module MdJson
+
+            module ValueRange
+
+               def self.unpack(hRange, responseObj)
+
+                  # return nil object if input is empty
+                  if hRange.empty?
+                     responseObj[:readerExecutionMessages] << 'Value Range object is empty'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intRange = intMetadataClass.newValueRange
+
+                  # value range - minimum range value (required)
+                  if hRange.has_key?('minRangeValue')
+                     intRange[:minRangeValue] = hRange['minRangeValue']
+                  end
+                  if intRange[:minRangeValue].nil? || intRange[:minRangeValue] == ''
+                     responseObj[:readerExecutionMessages] << 'Value Range object is missing minimum'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
+                  # value range - maximum range value (required)
+                  if hRange.has_key?('maxRangeValue')
+                     intRange[:maxRangeValue] = hRange['maxRangeValue']
+                  end
+                  if intRange[:maxRangeValue].nil? || intRange[:maxRangeValue] == ''
+                     responseObj[:readerExecutionMessages] << 'Value Range object is missing maximum'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
+                  return intRange
+
+               end
+
+            end
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/version.rb

@@ -1,6 +1,12 @@
 # adiwg mdTranslator
 
 # version 2 history
+# 2.5.0 2017-11-03 bug fix, add test to verify mdJson reader version is compatible with schema version
+# 2.5.0 2017-11-03 added support for additional fgdc and bio data dictionary element
+# 2.4.1 2017-11-02 refactored mdJson writer for added entity, attribute, and domain elements
+# 2.4.1 2017-10-31 fix issue with computation of federal fiscal year in sbJson budget writer
+# 2.4.1 2017-10-30 refactored fgdc reader for added entity, attribute, and domain elements
+# 2.4.0 2017-10-25 added html writers for reference system parameter set
 # 2.4.0 2017-10-24 added mdJson writers for reference system parameter set
 # 2.4.0 2017-10-19 added mdJson reader for geographicResolution
 # 2.4.0 2017-10-19 added mdJson reader for bearingDistanceResolution
@@ -38,7 +44,7 @@
 module ADIWG
    module Mdtranslator
       # current mdtranslator version
-      VERSION = "2.4.0"
+      VERSION = "2.5.0"
    end
 end
 

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

@@ -90,9 +90,9 @@ module ADIWG
                      end
 
                      # report title
-                     aShortVersion = version.split('.')
-                     shortVersion = aShortVersion[0].to_s + '.' + aShortVersion[1].to_s
-                     @html.h1('mdTranslator ' + shortVersion + ' HTML Metadata Record', 'id' => 'mdtranslator-metadata-report')
+                     # aShortVersion = version.split('.')
+                     # shortVersion = aShortVersion[0].to_s + '.' + aShortVersion[1].to_s
+                     @html.h1('mdTranslator ' + version + ' HTML Metadata Record', 'id' => 'mdtranslator-metadata-report')
 
                      # report date
                      @html.section(:class => 'block') do

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

@@ -40,21 +40,21 @@ module ADIWG
                   end
 
                   # dictionary - domains [] {domain}
-                  hDictionary[:domains].each do |hDomain|
+                  unless hDictionary[:domains].empty?
                      @html.details do
-                        @html.summary('Domain: '+hDomain[:domainCode], {'class' => 'h5'})
+                        @html.summary('Domains', {'class' => 'h5'})
                         @html.section(:class => 'block') do
-                           domainClass.writeHtml(hDomain)
+                           domainClass.writeHtml(hDictionary[:domains])
                         end
                      end
                   end
 
                   # dictionary - entities [] {entity}
-                  hDictionary[:entities].each do |hEntity|
+                  unless hDictionary[:entities].empty?
                      @html.details do
-                        @html.summary('Entity: '+hEntity[:entityCode], {'class' => 'h5'})
+                        @html.summary('Entities', {'class' => 'h5'})
                         @html.section(:class => 'block') do
-                           entityClass.writeHtml(hEntity)
+                           entityClass.writeHtml(hDictionary[:entities])
                         end
                      end
                   end

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

@@ -2,11 +2,13 @@
 # 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
@@ -19,50 +21,84 @@ module ADIWG
                   @html = html
                end
 
-               def writeHtml(hDomain)
-
-                  # classes used
-                  itemClass = Html_DomainItem.new(@html)
-
-                  # 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.section(:class => 'block') do
-                        @html.text!(hDomain[:domainDescription])
-                     end
-                  end
+               def writeHtml(aDomains)
+
+                  aDomains.each do |hDomain|
+
+                     # classes used
+                     itemClass = Html_DomainItem.new(@html)
+                     citationClass = Html_Citation.new(@html)
+
+                     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?
 
-                  # domain - domain items [] {domainItem}
-                  hDomain[:domainItems].each do |hItem|
                      @html.details do
-                        @html.summary(hItem[:itemValue], {'class' => 'h5'})
+                        @html.summary(dName, {'class' => 'h5'})
                         @html.section(:class => 'block') do
-                           itemClass.writeHtml(hItem)
+
+                           # 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.section(:class => 'block') do
+                                 @html.text!(hDomain[:domainDescription])
+                              end
+                           end
+
+                           # domain - domain reference {citation}
+                           unless hDomain[:domainReference].empty?
+                              @html.details do
+                                 @html.summary('Reference', {'class' => 'h5'})
+                                 @html.section(:class => 'block') do
+                                    citationClass.writeHtml(hDomain[:domainReference])
+                                 end
+                              end
+                           end
+
+                           # domain - domain items [] {domainItem}
+                           hDomain[:domainItems].each do |hItem|
+                              @html.details do
+                                 @html.summary(hItem[:itemValue], {'class' => 'h5'})
+                                 @html.section(:class => 'block') do
+                                    itemClass.writeHtml(hItem)
+                                 end
+                              end
+                           end
+
                         end
                      end
-                  end
 
+                  end # aDomain
                end # writeHtml
             end # Html_Domain