adiwg-mdtranslator 2.6.1 → 2.7.0

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

@@ -0,0 +1,91 @@
+# FGDC <<Class>> Lineage
+# FGDC CSDGM writer output in XML
+
+# History:
+#  Stan Smith 2017-12-15 original script
+
+require_relative 'class_method'
+require_relative 'class_source'
+require_relative 'class_process'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Fgdc
+
+            class Lineage
+
+               def initialize(xml, hResponseObj)
+                  @xml = xml
+                  @hResponseObj = hResponseObj
+               end
+
+               def writeXML(aLineage)
+
+                  # take only the first lineage description
+                  hLineage = aLineage[0]
+                  aSourceCollection = []
+                  haveStep = false
+
+                  # classes used
+                  methodClass = Method.new(@xml, @hResponseObj)
+                  sourceClass = Source.new(@xml, @hResponseObj)
+                  processClass = Process.new(@xml, @hResponseObj)
+
+                  # lineage bio (method) - methodology
+                  methodClass.writeXML(hLineage)
+
+                  # lineage 2.5.1 (srcinfo) - source information []
+                  # <- lineage.source
+                  hLineage[:dataSources].each do |hSource|
+                     sourceClass.writeXML(hSource, aSourceCollection)
+                  end
+
+                  # lineage 2.5.1 (srcinfo) - source information from source process steps []
+                  # <- lineage.processSteps.stepSources/stepProducts
+                  hLineage[:processSteps].each do |hProcess|
+                     hProcess[:stepSources].each do |hStepSource|
+                        sourceClass.writeXML(hStepSource, aSourceCollection)
+                     end
+                     hProcess[:stepProducts].each do |hStepProduct|
+                        sourceClass.writeXML(hStepProduct, aSourceCollection)
+                     end
+                  end
+
+                  # the search for sources is circular, I'm stopping here.
+
+                  if  aSourceCollection.empty? && @hResponseObj[:writerShowTags]
+                     @xml.tag!('srcinfo')
+                  end
+
+                  # lineage 2.5.2 (procstep) - process step (required)
+                  hLineage[:processSteps].each do |hStep|
+                     @xml.tag!('procstep') do
+                        processClass.writeXML(hStep)
+                        haveStep = true
+                     end
+                  end
+
+                  # lineage 2.5.2 (procstep) - process steps from source (required)
+                  hLineage[:dataSources].each do |hSource|
+                     hSource[:sourceSteps].each do |hStep|
+                        @xml.tag!('procstep') do
+                           processClass.writeXML(hStep)
+                           haveStep = true
+                        end
+                     end
+                  end
+                  unless haveStep
+                     @hResponseObj[:writerPass] = false
+                     @hResponseObj[:writerMessages] << 'Lineage Source is missing process steps'
+                  end
+
+                  # the search for process steps is circular, I'm stopping here.
+
+               end # writeXML
+            end # lineage
+
+         end
+      end
+   end
+end

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

@@ -0,0 +1,94 @@
+# FGDC <<Class>> Method
+# FGDC CSDGM writer output in XML
+
+# History:
+#  Stan Smith 2017-12-20 original script
+
+require_relative '../fgdc_writer'
+require_relative 'class_methodKeywords'
+require_relative 'class_citation'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Fgdc
+
+            class Method
+
+               def initialize(xml, hResponseObj)
+                  @xml = xml
+                  @hResponseObj = hResponseObj
+               end
+
+               def writeXML(hLineage)
+
+                  # classes used
+                  keywordClass = MethodKeyword.new(@xml, @hResponseObj)
+                  citationClass = Citation.new(@xml, @hResponseObj)
+
+                  hIntObj = ADIWG::Mdtranslator::Writers::Fgdc.get_intObj
+                  haveMethod = false
+                  haveMethod = true unless hLineage[:statement].nil?
+                  haveMethod = true unless hLineage[:lineageCitation].empty?
+                  aKeywords = hIntObj[:metadata][:resourceInfo][:keywords]
+                  aKeywords.each do |hKeyword|
+                     if hKeyword[:keywordType] == 'method'
+                        haveMethod = true
+                     end
+                  end
+
+                  if haveMethod
+                     @xml.tag!('method') do
+
+                        # methodology bio (methtype) - method type (required)
+                        # <- resourceLineage.statement
+                        unless hLineage[:statement].nil?
+                           @xml.tag!('methtype', hLineage[:statement])
+                        end
+                        if hLineage[:statement].nil?
+                           @hResponseObj[:writerPass] = false
+                           @hResponseObj[:writerMessages] << 'Lineage Method is missing type and/or description'
+                        end
+
+                        # methodology bio (methodid) - method id [] {keywords} (required)
+                        # <- resourceInfo.keywords.keywordType = 'method'
+                        keywordClass.writeXML(aKeywords)
+
+                        # methodology bio (methdesc) - method description (required)
+                        # <- resourceLineage.statement
+                        unless hLineage[:statement].nil?
+                           @xml.tag!('methdesc', hLineage[:statement])
+                        end
+                        if hLineage[:statement].nil?
+                           @hResponseObj[:writerPass] = false
+                           @hResponseObj[:writerMessages] << 'Lineage Method is missing type and/or description'
+                        end
+
+                        # methodology bio (methcite) - method citation [] (required)
+                        # <- resourceLineage.lineageCitation
+                        hLineage[:lineageCitation].each do |hCitation|
+                           unless hCitation.empty?
+                              @xml.tag!('methcite') do
+                                 citationClass.writeXML(hCitation, [])
+                              end
+                           end
+                        end
+                        if hLineage[:lineageCitation].empty?
+                           @hResponseObj[:writerPass] = false
+                           @hResponseObj[:writerMessages] << 'Lineage Method is missing citation'
+                        end
+
+                     end
+                  end
+
+                  if !haveMethod && @hResponseObj[:writerShowTags]
+                     @xml.tag!('method')
+                  end
+
+               end # writeXML
+            end # Method
+
+         end
+      end
+   end
+end

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

@@ -0,0 +1,55 @@
+# FGDC <<Class>> MethodKeyword
+# FGDC CSDGM writer output in XML
+
+# History:
+#  Stan Smith 2017-12-20 original script
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Fgdc
+
+            class MethodKeyword
+
+               def initialize(xml, hResponseObj)
+                  @xml = xml
+                  @hResponseObj = hResponseObj
+               end
+
+               def writeXML(aKeywords)
+
+                  # method bio (methodid) - lineage method keywords (required)
+                  haveMethod = false
+                  aKeywords.each do |hKeySet|
+                     type = hKeySet[:keywordType]
+                     if type == 'method'
+                        aKeywords = hKeySet[:keywords]
+                        thesaurus = hKeySet[:thesaurus]
+                        if thesaurus.empty?
+                           @hResponseObj[:writerPass] = false
+                           @hResponseObj[:writerMessages] << 'Lineage Method Keyword Set is missing thesaurus'
+                        end
+                        @xml.tag!('methodid') do
+                           @xml.tag!('methkt', thesaurus[:title])
+                           aKeywords.each do |hKeyword|
+                              keyword = hKeyword[:keyword]
+                              unless keyword.nil?
+                                 @xml.tag!('methkey', keyword)
+                                 haveMethod = true
+                              end
+                           end
+                        end
+                     end
+                  end
+                  unless haveMethod
+                     @hResponseObj[:writerPass] = false
+                     @hResponseObj[:writerMessages] << 'Lineage Method is missing keyword set'
+                  end
+
+               end # writeXML
+            end # MethodKeyword
+
+         end
+      end
+   end
+end

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

@@ -0,0 +1,119 @@
+# FGDC <<Class>> Process
+# FGDC CSDGM writer output in XML
+
+# History:
+#  Stan Smith 2017-12-18 original script
+
+require 'adiwg/mdtranslator/internal/module_dateTimeFun'
+require_relative '../fgdc_writer'
+require_relative 'class_contact'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Fgdc
+
+            class Process
+
+               def initialize(xml, hResponseObj)
+                  @xml = xml
+                  @hResponseObj = hResponseObj
+               end
+
+               def writeXML(hStep)
+
+                  # classes used
+                  contactClass = Contact.new(@xml, @hResponseObj)
+
+                  # process 2.5.2.1 (procdesc) - process description (required)
+                  # <- resourceLineage.processStep.description
+                  unless hStep[:description].nil?
+                     @xml.tag!('procdesc', hStep[:description] )
+                  end
+                  if hStep[:description].nil?
+                     @hResponseObj[:writerPass] = false
+                     @hResponseObj[:writerMessages] << 'Lineage Source is missing description'
+                  end
+
+                  # process 2.5.2.2 (srcused) - source used citation abbreviation []
+                  # <- processStep.stepSources.sourceId
+                  haveSource = false
+                  hStep[:stepSources].each do |hSource|
+                     unless hSource[:sourceId].nil?
+                        @xml.tag!('srcused', hSource[:sourceId])
+                        haveSource = true
+                     end
+                  end
+                  if !haveSource && @hResponseObj[:writerShowTags]
+                     @xml.tag!('srcused')
+                  end
+
+                  # process 2.5.2.3 (procdate) - process date (required)
+                  # process 2.5.2.4 (proctime) - process time
+                  # <- processStep.timePeriod.endDateTime
+                  haveProcDate = false
+                  haveProcTime = false
+                  unless hStep[:timePeriod].empty?
+                     hTimePeriod = hStep[:timePeriod]
+                     unless hTimePeriod.empty?
+                        hEndDT = hTimePeriod[:endDateTime]
+                        unless hEndDT.empty?
+                           procDate = AdiwgDateTimeFun.stringDateFromDateTime(hEndDT[:dateTime], hEndDT[:dateResolution])
+                           procTime = AdiwgDateTimeFun.stringTimeFromDateTime(hEndDT[:dateTime], hEndDT[:dateResolution])
+                           unless procDate == 'ERROR'
+                              @xml.tag!('procdate', procDate)
+                              haveProcDate = true
+                           end
+                           unless procTime == 'ERROR'
+                              @xml.tag!('proctime', procTime)
+                              haveProcTime = true
+                           end
+                        end
+                     end
+                  end
+                  unless haveProcDate
+                     @hResponseObj[:writerPass] = false
+                     @hResponseObj[:writerMessages] << 'Process Step is missing process date'
+                  end
+                  if !haveProcTime && @hResponseObj[:writerShowTags]
+                     @xml.tag!('proctime')
+                  end
+
+                  # process 2.5.2.5 (srcprod) - source products citation abbreviation []
+                  # <- processStep.stepProducts.sourceId
+                  haveSource = false
+                  hStep[:stepProducts].each do |hSource|
+                     unless hSource[:sourceId].nil?
+                        @xml.tag!('srcprod', hSource[:sourceId])
+                        haveSource = true
+                     end
+                  end
+                  if !haveSource && @hResponseObj[:writerShowTags]
+                     @xml.tag!('srcprod')
+                  end
+
+                  # process 2.5.2.6 (proccont) - process contact {contact} first
+                  haveProcessor = false
+                  aRParties = hStep[:processors]
+                  aProcessors = ADIWG::Mdtranslator::Writers::Fgdc.find_responsibility(aRParties, 'processor')
+                  aProcessors.each do |contactId|
+                     hContact = ADIWG::Mdtranslator::Writers::Fgdc.get_contact(contactId)
+                     unless hContact.empty?
+                        @xml.tag!('proccont') do
+                           contactClass.writeXML(hContact)
+                           haveProcessor = true
+                           break
+                        end
+                     end
+                  end
+                  if !haveProcessor && @hResponseObj[:writerShowTags]
+                     @xml.tag!('proccont')
+                  end
+
+               end # writeXML
+            end # Process
+
+         end
+      end
+   end
+end

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

@@ -2,7 +2,7 @@
 # FGDC CSDGM writer output in XML
 
 # History:
-#   Stan Smith 2017-11-21 original script
+#  Stan Smith 2017-11-21 original script
 
 module ADIWG
    module Mdtranslator

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

@@ -0,0 +1,64 @@
+# FGDC <<Class>> Quality
+# FGDC CSDGM writer output in XML
+
+# History:
+#  Stan Smith 2017-12-15 original script
+
+require_relative 'class_lineage'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Fgdc
+
+            class Quality
+
+               def initialize(xml, hResponseObj)
+                  @xml = xml
+                  @hResponseObj = hResponseObj
+               end
+
+               def writeXML(intObj)
+
+                  # classes used
+                  lineageClass = Lineage.new(@xml, @hResponseObj)
+
+                  # data quality 2.1 (attracc) - attribute accuracy (not implemented)
+                  if @hResponseObj[:writerShowTags]
+                     @xml.tag!('attracc', 'Not Reported')
+                  end
+
+                  # data quality 2.2 (logic) - logical consistency (not implemented) (required)
+                  @xml.tag!('logic', 'Not Reported')
+
+                  # data quality 2.3 (complete) - completion report (not implemented) (required)
+                  @xml.tag!('complete', 'Not Reported')
+
+                  # data quality 2.4 (position) - positional accuracy (not implemented)
+                  if @hResponseObj[:writerShowTags]
+                     @xml.tag!('position', 'Not Reported')
+                  end
+
+                  # data quality 2.5 (lineage) - lineage (required)
+                  unless intObj[:metadata][:lineageInfo].empty?
+                     @xml.tag!('lineage') do
+                        lineageClass.writeXML(intObj[:metadata][:lineageInfo])
+                     end
+                  end
+                  if intObj[:metadata][:lineageInfo].empty?
+                     @hResponseObj[:writerPass] = false
+                     @hResponseObj[:writerMessages] << 'Data Quality is missing lineage section'
+                  end
+
+                  # data quality 2.6 (cloud) - cloud cover (not implemented)
+                  if @hResponseObj[:writerShowTags]
+                     @xml.tag!('cloud', 'Not Reported')
+                  end
+
+               end # writeXML
+            end # Quality
+
+         end
+      end
+   end
+end

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

@@ -0,0 +1,69 @@
+# FGDC <<Class>> Security
+# FGDC CSDGM writer output in XML
+
+# History:
+#  Stan Smith 2017-12-12 original script
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Fgdc
+
+            class Security
+
+               def initialize(xml, hResponseObj)
+                  @xml = xml
+                  @hResponseObj = hResponseObj
+               end
+
+               def writeXML(aConstraints)
+
+                  # <- resourceInfo.constraints. first type = security
+                  haveSecurity = false
+                  aConstraints.each do |hConstraint|
+                     if hConstraint[:type] == 'security'
+                        hSecurity = hConstraint[:securityConstraint]
+                        @xml.tag!('secinfo') do
+                           haveSecurity = true
+
+                           # security 1.12.1 (secsys) - security system name (required)
+                           unless hSecurity[:classSystem].nil?
+                              @xml.tag!('secsys', hSecurity[:classSystem])
+                           end
+                           if hSecurity[:classSystem].nil?
+                              @hResponseObj[:writerPass] = false
+                              @hResponseObj[:writerMessages] << 'Security is missing classification system'
+                           end
+
+                           # security 1.12.2 (secclass) - security classification (required)
+                           unless hSecurity[:classCode].nil?
+                              @xml.tag!('secclass', hSecurity[:classCode])
+                           end
+                           if hSecurity[:classCode].nil?
+                              @hResponseObj[:writerPass] = false
+                              @hResponseObj[:writerMessages] << 'Security is missing classification'
+                           end
+
+                           # security 1.12.3 (sechandl) - security classification (required)
+                           unless hSecurity[:handling].nil?
+                              @xml.tag!('sechandl', hSecurity[:handling])
+                           end
+                           if hSecurity[:handling].nil?
+                              @hResponseObj[:writerPass] = false
+                              @hResponseObj[:writerMessages] << 'Security is missing handling instructions'
+                           end
+
+                        end
+                     end
+                  end
+                  if !haveSecurity && @hResponseObj[:writerShowTags]
+                     @xml.tag!('secinfo')
+                  end
+
+               end # writeXML
+            end # Security
+
+         end
+      end
+   end
+end