adiwg-mdtranslator 2.15.0 → 2.18.0rc1

data/lib/adiwg/mdtranslator/writers/iso19115_2/classes/class_nominalResolution.rb

@@ -0,0 +1,61 @@
+# ISO <<Class>> LE_NominalResolution
+# 19115-2 writer output in XML
+
+# History:
+# 	Stan Smith 201-09-25 original script.
+
+require_relative '../iso19115_2_writer'
+require_relative 'class_measure'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Iso19115_2
+
+            class LE_NominalResolution
+
+               def initialize(xml, hResponseObj)
+                  @xml = xml
+                  @hResponseObj = hResponseObj
+                  @NameSpace = ADIWG::Mdtranslator::Writers::Iso19115_2
+               end
+
+               def writeXML(hResolution, inContext = nil)
+
+                  # classes used
+                  measureClass = Measure.new(@xml, @hResponseObj)
+
+                  outContext = 'resolution'
+                  outContext = inContext + ' ' + outContext unless inContext.nil?
+
+                  @xml.tag!('gmi:LE_NominalResolution') do
+
+                     haveResolution = false
+
+                     # resolution - scanning resolution {Measure} (required if)
+                     unless hResolution[:scanningResolution].empty?
+                        @xml.tag!('gmi:scanningResolution') do
+                           measureClass.writeXML(hResolution[:scanningResolution], outContext)
+                           haveResolution = true
+                        end
+                     end
+
+                     unless hResolution[:groundResolution].empty?
+                        @xml.tag!('gmi:groundResolution') do
+                           measureClass.writeXML(hResolution[:groundResolution], outContext)
+                           haveResolution = true
+                        end
+                     end
+
+                     unless haveResolution
+                        @NameSpace.issueWarning(400, 'gmi:scanningResolution', outContext)
+                     end
+
+                  end # gmi:LE_NominalResolution
+               end # writeXML
+            end # LE_NominalResolution class
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/writers/iso19115_2/classes/class_onlineResource.rb

@@ -2,6 +2,7 @@
 # 19115-2 writer output in XML
 
 # History:
+#  Stan Smith 2018-09-18 add applicationProfile
 #  Stan Smith 2018-04-10 add error and warning messaging
 #  Stan Smith 2016-11-18 refactored for mdTranslator/mdJson 2.0
 #  Stan Smith 2015-07-14 refactored to eliminate namespace globals $WriterNS and $IsoNS
@@ -37,57 +38,62 @@ module ADIWG
                   @xml.tag! 'gmd:CI_OnlineResource' do
 
                      # online resource - link - required
-                     s = hOlResource[:olResURI]
-                     unless s.nil?
+                     unless hOlResource[:olResURI].nil?
                         @xml.tag!('gmd:linkage') do
-                           @xml.tag!('gmd:URL', s)
+                           @xml.tag!('gmd:URL', hOlResource[:olResURI])
                         end
                      end
-                     if s.nil?
+                     if hOlResource[:olResURI].nil?
                         @NameSpace.issueWarning(250, 'gmd:linkage', inContext)
                      end
 
                      # online resource - protocol
-                     s = hOlResource[:olResProtocol]
-                     unless s.nil?
+                     unless hOlResource[:olResProtocol].nil?
                         @xml.tag!('gmd:protocol') do
-                           @xml.tag!('gco:CharacterString', s)
+                           @xml.tag!('gco:CharacterString', hOlResource[:olResProtocol])
                         end
                      end
-                     if s.nil? && @hResponseObj[:writerShowTags]
+                     if hOlResource[:olResProtocol].nil? && @hResponseObj[:writerShowTags]
                         @xml.tag!('gmd:protocol')
                      end
 
+                     # online resource - application profile
+                     unless hOlResource[:olResApplicationProfile].nil?
+                        @xml.tag!('gmd:applicationProfile') do
+                           @xml.tag!('gco:CharacterString', hOlResource[:olResApplicationProfile])
+                        end
+                     end
+                     if hOlResource[:olResApplicationProfile].nil? && @hResponseObj[:writerShowTags]
+                        @xml.tag!('gmd:applicationProfile')
+                     end
+
                      # online resource - link name
-                     s = hOlResource[:olResName]
-                     unless s.nil?
+                     unless hOlResource[:olResName].nil?
                         @xml.tag!('gmd:name') do
-                           @xml.tag!('gco:CharacterString', s)
+                           @xml.tag!('gco:CharacterString', hOlResource[:olResName])
                         end
                      end
-                     if s.nil? && @hResponseObj[:writerShowTags]
+                     if hOlResource[:olResName].nil? && @hResponseObj[:writerShowTags]
                         @xml.tag!('gmd:name')
                      end
 
                      # online resource - link description
-                     s = hOlResource[:olResDesc]
-                     unless s.nil?
+                     unless hOlResource[:olResDesc].nil?
                         @xml.tag!('gmd:description') do
-                           @xml.tag!('gco:CharacterString', s)
+                           @xml.tag!('gco:CharacterString', hOlResource[:olResDesc])
                         end
                      end
-                     if s.nil? && @hResponseObj[:writerShowTags]
+                     if hOlResource[:olResDesc].nil? && @hResponseObj[:writerShowTags]
                         @xml.tag!('gmd:description')
                      end
 
                      # online resource - link function {CI_OnLineFunctionCode}
-                     s = hOlResource[:olResFunction]
-                     unless s.nil?
+                     unless hOlResource[:olResFunction].nil?
                         @xml.tag!('gmd:function') do
-                           codelistClass.writeXML('gmd', 'iso_onlineFunction', s)
+                           codelistClass.writeXML('gmd', 'iso_onlineFunction', hOlResource[:olResFunction])
                         end
                      end
-                     if s.nil? && @hResponseObj[:writerShowTags]
+                     if hOlResource[:olResFunction].nil? && @hResponseObj[:writerShowTags]
                         @xml.tag!('gmd:function')
                      end
 

data/lib/adiwg/mdtranslator/writers/iso19115_2/classes/class_processReport.rb

@@ -0,0 +1,66 @@
+# ISO <<Class>> LE_ProcessStepReport
+# 19115-2 writer output in XML
+
+# History:
+# 	Stan Smith 2019-09-25 original script.
+
+require_relative '../iso19115_2_writer'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Iso19115_2
+
+            class LE_ProcessStepReport
+
+               def initialize(xml, hResponseObj)
+                  @xml = xml
+                  @hResponseObj = hResponseObj
+                  @NameSpace = ADIWG::Mdtranslator::Writers::Iso19115_2
+               end
+
+               def writeXML(hReport, inContext = nil)
+
+                  outContext = 'process step report'
+                  outContext = inContext + ' ' + outContext unless inContext.nil?
+
+                  @xml.tag!('gmi:LE_ProcessStepReport') do
+
+                     # process step report - name (required)
+                     unless hReport[:name].nil?
+                        @xml.tag!('gmi:name') do
+                           @xml.tag!('gco:CharacterString', hReport[:name])
+                        end
+                     end
+                     if hReport[:name].nil?
+                        @NameSpace.issueWarning(410, 'gmi:name', outContext)
+                     end
+
+                     # process step report - description
+                     unless hReport[:description].nil?
+                        @xml.tag!('gmi:description') do
+                           @xml.tag!('gco:CharacterString', hReport[:description])
+                        end
+                     end
+                     if hReport[:description].nil? && @hResponseObj[:writerShowTags]
+                        @xml.tag!('gmi:description')
+                     end
+
+                     # process step report - file type
+                     unless hReport[:fileType].nil?
+                        @xml.tag!('gmi:fileType') do
+                           @xml.tag!('gco:CharacterString', hReport[:fileType])
+                        end
+                     end
+                     if hReport[:fileType].nil? && @hResponseObj[:writerShowTags]
+                        @xml.tag!('gmi:fileType')
+                     end
+
+                  end # gmi:LE_ProcessStepReport
+               end # writeXML
+            end # LE_ProcessStepReport class
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/writers/iso19115_2/classes/class_processStep.rb

@@ -1,123 +1,49 @@
-# ISO <<Class>> LI_ProcessStep
+# ISO <<Abstract>> ProcessStep
 # 19115-2 writer output in XML
 
 # History:
-#  Stan Smith 2018-04-10 add error and warning messaging
-#  Stan Smith 2017-08-30 added support for step sources
-#  Stan Smith 2016-12-13 refactored for mdTranslator/mdJson 2.0
-#  Stan Smith 2015-07-14 refactored to eliminate namespace globals $WriterNS and $IsoNS
-#  Stan Smith 2015-07-14 refactored to make iso19110 independent of iso19115_2 classes
-#  Stan Smith 2015-06-22 replace global ($response) with passed in object (hResponseObj)
-#  Stan Smith 2014-12-12 refactored to handle namespacing readers and writers
-#  Stan Smith 2014-07-09 modify require statements to function in RubyGem structure
-# 	Stan Smith 2013-11-20 original script.
+# 	Stan Smith 2019-09-25 original script.
 
-require_relative '../iso19115_2_writer'
-require_relative 'class_responsibleParty'
-require_relative 'class_source'
+require_relative 'class_liProcessStep'
+require_relative 'class_leProcessStep'
 
 module ADIWG
    module Mdtranslator
       module Writers
          module Iso19115_2
 
-            class LI_ProcessStep
+            class ProcessStep
 
                def initialize(xml, hResponseObj)
                   @xml = xml
                   @hResponseObj = hResponseObj
-                  @NameSpace = ADIWG::Mdtranslator::Writers::Iso19115_2
                end
 
-               def writeXML(hStep)
+               def writeXML(hProcess, inContext = nil)
 
                   # classes used
-                  partyClass = CI_ResponsibleParty.new(@xml, @hResponseObj)
-                  sourceClass = LI_Source.new(@xml, @hResponseObj)
+                  liProcessClass = LI_ProcessStep.new(@xml, @hResponseObj)
+                  leProcessClass = LE_ProcessStep.new(@xml, @hResponseObj)
 
-                  outContext = 'process step'
-                  outContext = 'process step ' + hStep[:stepId].to_s unless hStep[:stepId].nil?
+                  outContext = inContext
 
-                  # process step - id
-                  attributes = {}
-                  s = hStep[:stepId]
-                  unless s.nil?
-                     attributes = { id: s.gsub(/[^0-9A-Za-z]/,'') }
-                  end
-
-                  @xml.tag!('gmd:LI_ProcessStep', attributes) do
-
-                     # process step - description (required)
-                     s = hStep[:description]
-                     unless s.nil?
-                        @xml.tag!('gmd:description') do
-                           @xml.tag!('gco:CharacterString', s)
-                        end
-                     end
-                     if s.nil?
-                        @NameSpace.issueWarning(260, 'gmd:description')
-                     end
+                  # use LE_ProcessStep if hProcess has any ...
+                  # processingInformation, reports
+                  # stepProducts (output)
 
-                     # process step - rationale
-                     s = hStep[:rationale]
-                     unless s.nil?
-                        @xml.tag!('gmd:rationale') do
-                           @xml.tag!('gco:CharacterString', s)
-                        end
-                     end
-                     if s.nil? && @hResponseObj[:writerShowTags]
-                        @xml.tag!('gmd:rationale')
-                     end
+                  useLE = false
+                  useLE = true unless hProcess[:processingInformation].empty?
+                  useLE = true unless hProcess[:reports].empty?
+                  useLE = true unless hProcess[:stepProducts].empty?
 
-                     # process step - datetime
-                     hPeriod = hStep[:timePeriod]
-                     unless hPeriod.empty?
-                        hDate = hPeriod[:startDateTime]
-                        if hDate.empty?
-                           hDate = hPeriod[:endDateTime]
-                        end
-                        date = hDate[:dateTime]
-                        dateResolution = hDate[:dateResolution]
-                        s = AdiwgDateTimeFun.stringDateTimeFromDateTime(date, dateResolution)
-                        if s != 'ERROR'
-                           @xml.tag!('gmd:dateTime') do
-                              @xml.tag!('gco:DateTime', s)
-                           end
-                        end
-                     end
-                     if hPeriod.empty? && @hResponseObj[:writerShowTags]
-                        @xml.tag!('gmd:dateTime')
-                     end
-
-                     # process step - processor [] {CI_ResponsibleParty}
-                     aParties = hStep[:processors]
-                     aParties.each do |hRParty|
-                        role = hRParty[:roleName]
-                        aParties = hRParty[:parties]
-                        aParties.each do |hParty|
-                           @xml.tag!('gmd:processor') do
-                              partyClass.writeXML(role, hParty, outContext)
-                           end
-                        end
-                     end
-                     if aParties.empty? && @hResponseObj[:writerShowTags]
-                        @xml.tag!('gmd:processor')
-                     end
-
-                     # process step - source [] {LI_Source}
-                     aSources = hStep[:stepSources]
-                     aSources.each do |hSource|
-                        @xml.tag!('gmd:source') do
-                           sourceClass.writeXML(hSource)
-                        end
-                     end
-                     if aSources.empty? && @hResponseObj[:writerShowTags]
-                        @xml.tag!('gmd:source')
-                     end
+                  if useLE
+                     leProcessClass.writeXML(hProcess, outContext)
+                  else
+                     liProcessClass.writeXML(hProcess, outContext)
+                  end
 
-                  end # gmd:LI_ProcessStep tag
                end # writeXML
-            end # LI_ProcessStep class
+            end # processStep class
 
          end
       end

data/lib/adiwg/mdtranslator/writers/iso19115_2/classes/class_processing.rb

@@ -0,0 +1,110 @@
+# ISO <<Class>> LE_Processing
+# 19115-2 writer output in XML
+
+# History:
+# 	Stan Smith 201-09-25 original script.
+
+require_relative '../iso19115_2_writer'
+require_relative 'class_rsIdentifier'
+require_relative 'class_citation'
+require_relative 'class_algorithm'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Iso19115_2
+
+            class LE_Processing
+
+               def initialize(xml, hResponseObj)
+                  @xml = xml
+                  @hResponseObj = hResponseObj
+                  @NameSpace = ADIWG::Mdtranslator::Writers::Iso19115_2
+               end
+
+               def writeXML(hProcessing, inContext = nil)
+
+                  # classes used
+                  identifierClass = RS_Identifier.new(@xml, @hResponseObj)
+                  citationClass = CI_Citation.new(@xml, @hResponseObj)
+                  algorithmClass = LE_Algorithm.new(@xml, @hResponseObj)
+
+                  outContext = 'processing'
+                  outContext = inContext + ' ' + outContext unless inContext.nil?
+
+                  @xml.tag!('gmi:LE_Processing') do
+
+                     # processing - identifier {RS_Identifier} (required)
+                     unless hProcessing[:identifier].empty?
+                        hIdentifier = hProcessing[:identifier]
+                        unless hIdentifier.empty?
+                           @xml.tag!('gmi:identifier') do
+                              identifierClass.writeXML(hIdentifier, outContext)
+                           end
+                        end
+                     end
+                     if hProcessing[:identifier].nil?
+                        @NameSpace.issueWarning(420, 'gmi:identifier', outContext)
+                     end
+
+                     # processing - software reference {CI_Citation}
+                     hCitation = hProcessing[:softwareReference]
+                     unless hCitation.empty?
+                        @xml.tag!('gmi:softwareReference') do
+                           citationClass.writeXML(hCitation, outContext)
+                        end
+                     end
+                     if hCitation.empty? && @hResponseObj[:writerShowTags]
+                        @xml.tag!('gmi:softwareReference')
+                     end
+
+                     # processing - procedure description
+                     unless hProcessing[:procedureDescription].nil?
+                        @xml.tag!('gmi:procedureDescription') do
+                           @xml.tag!('gco:CharacterString', hProcessing[:procedureDescription])
+                        end
+                     end
+                     if hProcessing[:procedureDescription].nil? && @hResponseObj[:writerShowTags]
+                        @xml.tag!('gmi:procedureDescription')
+                     end
+
+                     # processing - documentation [] {CI_Citation}
+                     aCitations = hProcessing[:documentation]
+                     aCitations.each do |hCitation|
+                        @xml.tag!('gmi:documentation') do
+                           citationClass.writeXML(hCitation, outContext)
+                        end
+                     end
+                     if aCitations.empty? && @hResponseObj[:writerShowTags]
+                        @xml.tag!('gmi:documentation')
+                     end
+
+                     # processing - runtime parameters
+                     unless hProcessing[:runtimeParameters].nil?
+                        @xml.tag!('gmi:runTimeParameters') do
+                           @xml.tag!('gco:CharacterString', hProcessing[:runtimeParameters])
+                        end
+                     end
+                     if hProcessing[:runtimeParameters].nil? && @hResponseObj[:writerShowTags]
+                        @xml.tag!('gmi:runTimeParameters')
+                     end
+
+                     # processing - algorithm [] {LE_Algorithm}
+                     aAlgorithms = hProcessing[:algorithms]
+                     aAlgorithms.each do |hAlgorithm|
+                        @xml.tag!('gmi:algorithm') do
+                           algorithmClass.writeXML(hAlgorithm, outContext)
+                        end
+                     end
+                     if aAlgorithms.empty? && @hResponseObj[:writerShowTags]
+                        @xml.tag!('gmi:algorithm')
+                     end
+
+                  end # gmi:LE_ProcessStepReport
+               end # writeXML
+            end # LE_ProcessStepReport class
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/writers/iso19115_2/classes/class_source.rb

@@ -1,109 +1,47 @@
-# ISO <<Class>> LI_Source
+# ISO <<Abstract>> Source
 # 19115-2 writer output in XML
 
 # History:
-#  Stan Smith 2016-12-07 refactored for mdTranslator/mdJson 2.0
-#  Stan Smith 2015-07-14 refactored to eliminate namespace globals $WriterNS and $IsoNS
-#  Stan Smith 2015-07-14 refactored to make iso19110 independent of iso19115_2 classes
-#  Stan Smith 2015-06-22 replace global ($response) with passed in object (hResponseObj)
-#  Stan Smith 2014-12-12 refactored to handle namespacing readers and writers
-#  Stan Smith 2014-07-09 modify require statements to function in RubyGem structure
-# 	Stan Smith 2013-11-20 original script.
+# 	Stan Smith 2019-09-25 original script.
 
-require_relative 'class_fraction'
-require_relative 'class_referenceSystem'
-require_relative 'class_citation'
-require_relative 'class_processStep'
+require_relative 'class_liSource'
+require_relative 'class_leSource'
 
 module ADIWG
    module Mdtranslator
       module Writers
          module Iso19115_2
 
-            class LI_Source
+            class Source
 
                def initialize(xml, hResponseObj)
                   @xml = xml
                   @hResponseObj = hResponseObj
                end
 
-               def writeXML(hSource)
+               def writeXML(hSource, inContext = nil)
 
                   # classes used
-                  fractionClass = MD_RepresentativeFraction.new(@xml, @hResponseObj)
-                  systemClass = MD_ReferenceSystem.new(@xml, @hResponseObj)
-                  citationClass = CI_Citation.new(@xml, @hResponseObj)
-                  stepClass = LI_ProcessStep.new(@xml, @hResponseObj)
+                  liSourceClass = LI_Source.new(@xml, @hResponseObj)
+                  leSourceClass = LE_Source.new(@xml, @hResponseObj)
 
-                  # source - id
-                  attributes = {}
-                  s = hSource[:sourceId]
-                  unless s.nil?
-                     attributes = { id: s.gsub(/[^0-9A-Za-z]/,'') }
-                  end
-
-                  @xml.tag!('gmd:LI_Source', attributes) do
-
-                     # source - description
-                     s = hSource[:description]
-                     unless s.nil?
-                        @xml.tag!('gmd:description') do
-                           @xml.tag!('gco:CharacterString', s)
-                        end
-                     end
-                     if s.nil? && @hResponseObj[:writerShowTags]
-                        @xml.tag!('gmd:description')
-                     end
+                  outContext = inContext
 
-                     # source - scale denominator
-                     hResolution = hSource[:spatialResolution]
-                     unless hResolution[:scaleFactor].nil?
-                        @xml.tag!('gmd:scaleDenominator') do
-                           fractionClass.writeXML(hResolution[:scaleFactor])
-                        end
-                     end
-                     if hResolution[:scaleFactor].nil? && @hResponseObj[:writerShowTags]
-                        @xml.tag!('gmd:scaleDenominator')
-                     end
+                  # use LE_Source if hSource has any ...
+                  # processedLevel, resolution
 
-                     # source - reference system
-                     hSystem = hSource[:referenceSystem]
-                     unless hSystem.empty?
-                        @xml.tag!('gmd:sourceReferenceSystem') do
-                           systemClass.writeXML(hSystem)
-                        end
-                     end
-                     if hSystem.empty? && @hResponseObj[:writerShowTags]
-                        @xml.tag!('gmd:sourceReferenceSystem')
-                     end
+                  useLE = false
+                  useLE = true unless hSource[:processedLevel].empty?
+                  useLE = true unless hSource[:resolution].empty?
 
-                     # source - citation
-                     hCitation = hSource[:sourceCitation]
-                     unless hCitation.empty?
-                        @xml.tag!('gmd:sourceCitation') do
-                           citationClass.writeXML(hCitation, 'lineage source')
-                        end
-                     end
-                     if hCitation.empty? && @hResponseObj[:writerShowTags]
-                        @xml.tag!('gmd:sourceCitation')
-                     end
-
-                     # source - extent [] (not implemented)
-
-                     # source - process step []
-                     aSteps = hSource[:sourceSteps]
-                     aSteps.each do |hStep|
-                        @xml.tag!('gmd:sourceStep') do
-                           stepClass.writeXML(hStep)
-                        end
-                     end
-                     if aSteps.empty? && @hResponseObj[:writerShowTags]
-                        @xml.tag!('gmd:sourceStep')
-                     end
+                  if useLE
+                     leSourceClass.writeXML(hSource, outContext)
+                  else
+                     liSourceClass.writeXML(hSource, outContext)
+                  end
 
-                  end # gmd:LI_Source tag
                end # writeXML
-            end # LI_Source class
+            end # Source class
 
          end
       end

data/lib/adiwg/mdtranslator/writers/iso19115_2/classes/class_taxonomy.rb

@@ -67,7 +67,7 @@ module ADIWG
                         @xml.tag!('gmd:taxongen')
                      end
 
-                     # taxon system - identification reference (required) [{citation}]
+                     # taxon system - identification reference [] (required) {citation}
                      # convert to RS_Identifier
                      aCitations = hSystem[:idReferences]
                      aCitations.each do |hCitation|
@@ -84,7 +84,7 @@ module ADIWG
                         @NameSpace.issueWarning(311, 'gmd:idref')
                      end
 
-                     # taxon system - observers [{CI_ResponsibleParty}]
+                     # taxon system - observers [] {CI_ResponsibleParty}
                      aObservers = hSystem[:observers]
                      aObservers.each do |hObserver|
                         role = hObserver[:roleName]

data/lib/adiwg/mdtranslator/writers/iso19115_2/iso19115_2_writer_messages_eng.yml

@@ -116,3 +116,12 @@ messageList:
    - {id: 370, message: "invalid obligation code"}
 
    - {id: 380, message: "invalid topic category"}
+
+   - {id: 390, message: "algorithm citation is missing"}
+   - {id: 391, message: "algorithm description is missing"}
+
+   - {id: 400, message: "nominal resolution is missing"}
+
+   - {id: 410, message: "process step report name is missing"}
+
+   - {id: 420, message: "processing identifier is missing"}

data/lib/adiwg/mdtranslator/writers/mdJson/sections/mdJson_algorithm.rb

@@ -0,0 +1,31 @@
+# mdJson 2.0 writer - algorithm
+
+# History:
+#  Stan Smith 2019-09-24 original script
+
+require 'jbuilder'
+require_relative 'mdJson_citation'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module MdJson
+
+            module Algorithm
+
+               @Namespace = ADIWG::Mdtranslator::Writers::MdJson
+
+               def self.build(hAlgorithm)
+
+                  Jbuilder.new do |json|
+                     json.citation Citation.build(hAlgorithm[:citation]) unless hAlgorithm[:citation].empty?
+                     json.description hAlgorithm[:description]
+                  end
+
+               end # build
+            end # Algorithm
+
+         end
+      end
+   end
+end