adiwg-mdtranslator 2.8.0 → 2.9.0

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

@@ -3,7 +3,7 @@
 
 # History:
 #  Stan Smith 2017-05-16 deprecated topic category
-#                    ... topic category is now handled as keyword list
+#   ... topic category is now handled as keyword list
 #  Stan Smith 2016-11-01 original script
 
 require 'adiwg/mdtranslator/internal/internal_metadata_obj'

data/lib/adiwg/mdtranslator/version.rb

@@ -1,6 +1,9 @@
 # adiwg mdTranslator
 
 # version 2 history
+# 2.9.0 2018-02-01 added fgdc writer distribution information section
+# 2.9.0 2018-01-26 deprecate dictionaryFormat in favor of dictionaryFunctionalLanguage
+# 2.9.0 2018-01-25 added fgdc writer entity and attribute section
 # 2.8.0 2018-01-17 added fgdc writer spatial reference section
 # 2.7.1 2018-01-05 fix issue #171, fully implement deprecation of topicCategories[]
 # 2.7.0 2017-12-28 reinstate schema validation checks for schema 2.4.1
@@ -58,7 +61,7 @@
 module ADIWG
    module Mdtranslator
       # current mdtranslator version
-      VERSION = "2.8.0"
+      VERSION = "2.9.0"
    end
 end
 

data/lib/adiwg/mdtranslator/writers/fgdc/classes/class_attribute.rb

@@ -0,0 +1,178 @@
+# FGDC <<Class>> Attribute
+# FGDC CSDGM writer output in XML
+
+# History:
+#  Stan Smith 2018-01-24 original script
+
+require 'adiwg/mdtranslator/internal/module_dateTimeFun'
+require_relative 'class_dataDomain'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Fgdc
+
+            class Attribute
+
+               def initialize(xml, hResponseObj)
+                  @xml = xml
+                  @hResponseObj = hResponseObj
+               end
+
+               def writeXML(hAttribute)
+
+                  # classes used
+                  domainClass = DataDomain.new(@xml, @hResponseObj)
+
+                  # attribute 5.1.2.1 (attrlabl) - attribute label (required)
+                  # <- attribute.attributeCode
+                  unless hAttribute[:attributeCode].nil?
+                     @xml.tag!('attrlabl', hAttribute[:attributeCode])
+                  end
+                  if hAttribute[:attributeCode].nil?
+                     @hResponseObj[:writerPass] = false
+                     @hResponseObj[:writerMessages] << 'Attribute Detail missing label'
+                  end
+
+                  # attribute 5.1.2.2 (attrdef) - attribute definition (required)
+                  # <- attribute.attributeDefinition
+                  unless hAttribute[:attributeDefinition].nil?
+                     @xml.tag!('attrdef', hAttribute[:attributeDefinition])
+                  end
+                  if hAttribute[:attributeDefinition].nil?
+                     @hResponseObj[:writerPass] = false
+                     @hResponseObj[:writerMessages] << 'Attribute missing definition'
+                  end
+
+                  # attribute 5.1.2.3 (attrdefs) - attribute definition source (required)
+                  # <- take title from first attributeReference {citation}
+                  unless hAttribute[:attributeReference].empty?
+                     unless hAttribute[:attributeReference].empty?
+                        @xml.tag!('attrdefs', hAttribute[:attributeReference][:title])
+                     end
+                  end
+                  if hAttribute[:attributeReference].empty?
+                     @hResponseObj[:writerPass] = false
+                     @hResponseObj[:writerMessages] << 'Attribute missing definition citation'
+                  end
+
+                  # attribute 5.1.2.4 (attrdomv) - attribute domain value
+                  # enumerated domain <- dictionary.domainItems[]
+                  # codeset domain <- dictionary.domainReference and no dictionary.domainItems[]
+                  # unrepresented domain <- dictionary.domainDescription and no dictionary.domainItems[]
+                  unless hAttribute[:domainId].nil?
+                     domainClass.writeXML(hAttribute[:domainId])
+                  end
+
+                  # attribute 5.1.2.4 (attrdomv) - attribute domain value
+                  # attribute 5.1.2.4.2 (rdom) - value range
+                  # <- attribute.valueRange[]
+                  hAttribute[:valueRange].each do |hRange|
+                     unless hRange.empty?
+                        @xml.tag!('attrdomv') do
+                           @xml.tag!('rdom') do
+
+                              # value range 5.1.2.4.2.1 (rdommin) - range minimum (required)
+                              # <- valueRange[].minRangeValue
+                              unless hRange[:minRangeValue].nil?
+                                 @xml.tag!('rdommin', hRange[:minRangeValue])
+                              end
+                              if hRange[:minRangeValue].nil?
+                                 @hResponseObj[:writerPass] = false
+                                 @hResponseObj[:writerMessages] << 'Attribute Range Value missing minimum'
+                              end
+
+                              # value range 5.1.2.4.2.2 (rdommax) - range maximum (required)
+                              # <- valueRange[].maxRangeValue
+                              unless hRange[:maxRangeValue].nil?
+                                 @xml.tag!('rdommax', hRange[:maxRangeValue])
+                              end
+                              if hRange[:maxRangeValue].nil?
+                                 @hResponseObj[:writerPass] = false
+                                 @hResponseObj[:writerMessages] << 'Attribute Range Value missing maximum'
+                              end
+
+                              # value range 5.1.2.4.2.3 (attrunit) - unit of measure
+                              # <- attribute.unitOfMeasure
+                              unless hAttribute[:unitOfMeasure].nil?
+                                 @xml.tag!('attrunit', hAttribute[:unitOfMeasure])
+                              end
+                              if hAttribute[:unitOfMeasure].nil? && @hResponseObj[:writerShowTags]
+                                 @xml.tag!('attrunit')
+                              end
+
+                              # value range 5.1.2.4.2.4 (attrmres) - unit of measure resolution
+                              # <- attribute.measureResolution
+                              unless hAttribute[:measureResolution].nil?
+                                 @xml.tag!('attrmres', hAttribute[:measureResolution])
+                              end
+                              if hAttribute[:measureResolution].nil? && @hResponseObj[:writerShowTags]
+                                 @xml.tag!('attrmres')
+                              end
+
+                           end
+                        end
+                     end
+                  end
+
+                  # attribute 5.1.2.5 & 5.1.2.6 (begdatea & enddatea) - attribute value date range
+                  # <- attribute.timePeriod[]
+                  hAttribute[:timePeriod].each do |hTimePeriod|
+
+                     # date range 5.1.2.5 (begdatea) -  begin date range
+                     # <- timePeriod.startDateTime
+                     unless hTimePeriod[:startDateTime].empty?
+                        hDate = hTimePeriod[:startDateTime]
+                        begDate = AdiwgDateTimeFun.stringDateFromDateTime(hDate[:dateTime], hDate[:dateResolution])
+                        begDate.gsub!(/[-]/,'')
+                        unless begDate == 'ERROR'
+                           @xml.tag!('begdatea', begDate)
+                        end
+                        if begDate == 'ERROR'
+                           @hResponseObj[:writerPass] = false
+                           @hResponseObj[:writerMessages] << 'Attribute Beginning Range Date error'
+                        end
+                     end
+                     if hTimePeriod[:startDateTime].empty? && @hResponseObj[:writerShowTags]
+                        @xml.tag!('begdatea')
+                     end
+
+                     # date range 5.1.2.6 (enddatea) -  end date range
+                     # <- timePeriod.endDateTime
+                     unless hTimePeriod[:endDateTime].empty?
+                        hDate = hTimePeriod[:endDateTime]
+                        endDate = AdiwgDateTimeFun.stringDateFromDateTime(hDate[:dateTime], hDate[:dateResolution])
+                        endDate.gsub!(/[-]/,'')
+                        unless endDate == 'ERROR'
+                           @xml.tag!('enddatea', endDate)
+                        end
+                        if endDate == 'ERROR'
+                           @hResponseObj[:writerPass] = false
+                           @hResponseObj[:writerMessages] << 'Attribute Ending Range Date error'
+                        end
+                     end
+                     if hTimePeriod[:endDateTime].empty? && @hResponseObj[:writerShowTags]
+                        @xml.tag!('enddatea')
+                     end
+
+                  end
+
+                  # attribute 5.1.2.7 (attrvai) - attribute value accuracy information
+                  # not supported
+
+                  # entity attribute 5.1.2.7.1 (attrva) - attribute value accuracy
+                  # -> not supported
+
+                  # entity attribute 5.1.2.7.2 (attrvae) - attribute value accuracy explanation
+                  # -> not supported
+
+                  # entity attribute 5.1.2.8 (attrmfrq) - attribute measurement frequency
+                  # -> not supported; same as resource maintenance but at attribute level
+
+               end # writeXML
+            end # Attribute
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/writers/fgdc/classes/class_dataDomain.rb

@@ -0,0 +1,122 @@
+# FGDC <<Class>> DataDomain
+# FGDC CSDGM writer output in XML
+
+# History:
+#  Stan Smith 2018-01-24 original script
+
+require_relative '../fgdc_writer'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Fgdc
+
+            class DataDomain
+
+               def initialize(xml, hResponseObj)
+                  @xml = xml
+                  @hResponseObj = hResponseObj
+               end
+
+               def writeXML(domainId)
+
+                  # classes used
+
+                  # get the domain
+                  hIntObj = ADIWG::Mdtranslator::Writers::Fgdc.get_intObj
+                  hDictionary = hIntObj[:dataDictionaries][0]
+                  hDomain = {}
+                  hDictionary[:domains].each do |hItem|
+                     if hItem[:domainId] == domainId
+                        hDomain = hItem
+                     end
+                  end
+                  if hDomain.empty?
+                     @hResponseObj[:writerPass] = false
+                     @hResponseObj[:writerMessages] << "Dictionary Domain #{domainId} not found"
+                     return
+                  end
+
+                  # attribute 5.1.2.4.1 (edom) - enumerated domain
+                  hDomain[:domainItems].each do |hItem|
+                     @xml.tag!('attrdomv') do
+                        @xml.tag!('edom') do
+
+                           # value 5.1.2.4.1.1 (edomv) - enumerated value (required)
+                           unless hItem[:itemValue].nil?
+                              @xml.tag!('edomv', hItem[:itemValue])
+                           end
+                           if hItem[:itemValue].nil?
+                              @hResponseObj[:writerPass] = false
+                              @hResponseObj[:writerMessages] << 'Enumerated Domain Value missing value'
+                           end
+
+                           # definition 5.1.2.4.1.2 (edomvd) - enumerated value definition (required)
+                           unless hItem[:itemDefinition].nil?
+                              @xml.tag!('edomvd', hItem[:itemDefinition])
+                           end
+                           if hItem[:itemDefinition].nil?
+                              @hResponseObj[:writerPass] = false
+                              @hResponseObj[:writerMessages] << 'Enumerated Domain Value missing definition'
+                           end
+
+                           # source 5.1.2.4.1.3 (edomvds) - enumerated value definition source (default='author defined')
+                           unless hItem[:itemReference].empty?
+                              @xml.tag!('edomvds', hItem[:itemReference][:title])
+                           end
+                           if hItem[:itemReference].empty?
+                              @xml.tag!('edomvds', 'author defined')
+                           end
+
+                        end
+                     end
+                  end
+
+                  # attribute 5.1.2.4.3 (codesetd) - codeset domain
+                  unless hDomain[:domainReference].empty?
+                     @xml.tag!('attrdomv') do
+                        @xml.tag!('codesetd') do
+
+                           # codeset 5.1.2.4.3.1 (codesetn) - codeset name (required)
+                           # <- domain.name
+                           unless hDomain[:domainName].nil?
+                              @xml.tag!('codesetn', hDomain[:domainName])
+                           end
+                           if hDomain[:domainName].nil?
+                              @hResponseObj[:writerPass] = false
+                              @hResponseObj[:writerMessages] << 'Codeset Domain missing domain name'
+                           end
+
+                           # codeset 5.1.2.4.3.2 (codesets) - codeset source (required)
+                           # <- domain.domainReference.title
+                           unless hDomain[:domainReference][:title].nil?
+                              @xml.tag!('codesets', hDomain[:domainReference][:title])
+                           end
+                           unless hDomain[:domainReference][:title].nil?
+                              @hResponseObj[:writerPass] = false
+                              @hResponseObj[:writerMessages] << 'Codeset Domain missing domain reference citation title'
+                           end
+
+                        end
+                     end
+                  end
+
+
+                  # attribute 5.1.2.4.4 (4dom) - unrepresented domain
+                  if hDomain[:domainItems].empty?
+                     if hDomain[:domainReference].empty?
+                        unless hDomain[:domainDescription].nil?
+                           @xml.tag!('attrdomv') do
+                              @xml.tag!('udom', hDomain[:domainDescription])
+                           end
+                        end
+                     end
+                  end
+
+               end # writeXML
+            end # DataDomain
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/writers/fgdc/classes/class_dictionary.rb

@@ -0,0 +1,66 @@
+# FGDC <<Class>> Series
+# FGDC CSDGM writer output in XML
+
+# History:
+#  Stan Smith 2018-01-21 original script
+
+require_relative 'class_entityDetail'
+require_relative 'class_entityOverview'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Fgdc
+
+            class DataDictionary
+
+               def initialize(xml, hResponseObj)
+                  @xml = xml
+                  @hResponseObj = hResponseObj
+               end
+
+               def writeXML(hDictionary)
+
+                  # classes used
+                  detailClass = EntityDetail.new(@xml, @hResponseObj)
+                  overviewClass = EntityOverview.new(@xml, @hResponseObj)
+
+                  haveDescription = false
+                  hDictionary[:entities].each do |hEntity|
+                     unless hEntity.empty?
+
+                        # dictionary 5.1 (detailed) - detailed description
+                        # <- hDictionary.entity[].entityCode != 'overview'
+                        unless hEntity[:entityCode] == 'overview'
+                           @xml.tag!('detailed') do
+                              detailClass.writeXML(hEntity)
+                           end
+                           haveDescription = true
+                        end
+
+                        # dictionary 5.2 (overview) - overview description
+                        # <- hDictionary.entity[].entityCode == 'overview'
+                        if hEntity[:entityCode] == 'overview'
+                           @xml.tag!('overview') do
+                              overviewClass.writeXML(hEntity)
+                           end
+                           haveDescription = true
+                        end
+
+                     end
+
+                  end
+
+                  # must have at least on detailed description or overview description
+                  unless haveDescription
+                     @hResponseObj[:writerPass] = false
+                     @hResponseObj[:writerMessages] << 'Data Dictionary requires at least one detail or overview description'
+                  end
+
+               end # writeXML
+            end # Series
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/writers/fgdc/classes/class_digitalForm.rb

@@ -0,0 +1,81 @@
+# FGDC <<Class>> DigitalForm
+# FGDC CSDGM writer output in XML
+
+# History:
+#  Stan Smith 2018-01-31 original script
+
+require_relative 'class_transferInfo'
+require_relative 'class_onlineOption'
+require_relative 'class_offlineOption'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Fgdc
+
+            class DigitalFormat
+
+               def initialize(xml, hResponseObj)
+                  @xml = xml
+                  @hResponseObj = hResponseObj
+               end
+
+               def writeXML(hTransOpt)
+
+                  # classes used
+                  transClass = TransferInformation.new(@xml, @hResponseObj)
+                  onClass = OnlineOption.new(@xml, @hResponseObj)
+                  offClass = OfflineOption.new(@xml, @hResponseObj)
+
+                  # digital format 6.4.2.1 (digtinfo) - digital transfer information
+                  @xml.tag!('digtinfo') do
+                     transClass.writeXML(hTransOpt)
+                  end
+
+                  # digital format 6.4.2.2 (digtopt) - digital transfer option
+                  aOnline = hTransOpt[:onlineOptions]
+                  aOffline = hTransOpt[:offlineOptions]
+                  unless aOffline.empty? && aOnline.empty?
+                     @xml.tag!('digtopt') do
+
+                        # online option 6.4.2.2.1 (onlinopt) - online option
+                        aOnline.each do |hOnline|
+                           unless hOnline.empty?
+                              @xml.tag!('onlinopt') do
+                                 onClass.writeXML(hOnline)
+                              end
+                           end
+                        end
+
+                        # offline option 6.4.2.2.2 (offoptn) - offline option
+                        aOffline.each do |hOffline|
+                           unless hOffline.empty?
+
+                              # skip offlineOptions handled as non-digital media
+                              isNonDig = false
+                              isNonDig = true unless hOffline[:note].nil?
+                              isNonDig = false unless hOffline[:mediumSpecification].empty?
+                              isNonDig = false unless hOffline[:density].nil?
+                              isNonDig = false unless hOffline[:units].nil?
+                              isNonDig = false unless hOffline[:numberOfVolumes].nil?
+                              isNonDig = false unless hOffline[:mediumFormat].empty?
+                              isNonDig = false unless hOffline[:identifier].empty?
+                              unless isNonDig
+                                 @xml.tag!('offoptn') do
+                                    offClass.writeXML(hOffline)
+                                 end
+                              end
+
+                           end
+                        end
+
+                     end
+                  end
+
+               end # writeXML
+            end # DigitalFormat
+
+         end
+      end
+   end
+end