adiwg-mdtranslator 2.6.1 → 2.7.0

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

@@ -0,0 +1,53 @@
+# FGDC <<Class>> Constraint
+# FGDC CSDGM writer output in XML
+
+# History:
+#  Stan Smith 2017-12-12 original script
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Fgdc
+
+            class Constraint
+
+               def initialize(xml, hResponseObj)
+                  @xml = xml
+                  @hResponseObj = hResponseObj
+               end
+
+               def writeXML(aConstraints)
+
+                  # <- resourceInfo.constraints. first type = legal
+                  aConstraints.each do |hConstraint|
+                     if hConstraint[:type] == 'legal'
+                        hLegal = hConstraint[:legalConstraint]
+
+                        # identification information 1.7 (accconst) - access constraint (required)
+                        unless hLegal[:accessCodes].empty?
+                           @xml.tag!('accconst', hLegal[:accessCodes][0])
+                        end
+                        if hLegal[:accessCodes].empty?
+                           @hResponseObj[:writerPass] = false
+                           @hResponseObj[:writerMessages] << 'Identification section is missing access constraint'
+                        end
+
+                        # identification information 1.8 (useconst) - use constraint (required)
+                        unless hLegal[:useCodes].empty?
+                           @xml.tag!('useconst', hLegal[:useCodes][0])
+                        end
+                        if hLegal[:useCodes].empty?
+                           @hResponseObj[:writerPass] = false
+                           @hResponseObj[:writerMessages] << 'Identification section is missing use constraint'
+                        end
+
+                     end
+                  end
+
+               end # writeXML
+            end # Constraint
+
+         end
+      end
+   end
+end

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

@@ -34,7 +34,7 @@ module ADIWG
                      @hResponseObj[:writerMessages] << 'Description is missing purpose'
                   end
 
-                  # description 1.2.3 (supplinf) - supplemental information (required)
+                  # description 1.2.3 (supplinf) - supplemental information
                   # <- hResourceInfo[:supplementalInfo]
                   unless hResourceInfo[:supplementalInfo].nil?
                      @xml.tag!('supplinf', hResourceInfo[:supplementalInfo])

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

@@ -5,6 +5,8 @@
 #  Stan Smith 2017-11-16 original script
 
 require_relative 'class_identification'
+require_relative 'class_quality'
+require_relative 'class_spatialOrganization'
 
 module ADIWG
    module Mdtranslator
@@ -20,14 +22,18 @@ module ADIWG
 
                def writeXML(intObj)
 
+                  version = @hResponseObj[:translatorVersion]
+                  hResourceInfo = intObj[:metadata][:resourceInfo]
+
                   # classes used
                   idClass = Identification.new(@xml, @hResponseObj)
-                  version = @hResponseObj[:translatorVersion]
+                  qualityClass = Quality.new(@xml, @hResponseObj)
+                  spaceOrgClass = SpatialOrganization.new(@xml, @hResponseObj)
 
                   # document head
                   metadata = @xml.instruct! :xml, encoding: 'UTF-8'
                   @xml.comment!('FGDC METADATA (FGDC-STD-001-1998)')
-                  @xml.comment!('Includes Biological Data Profile (FGDC-STD-001.1-1999)')
+                  @xml.comment!('This file conforms to the Biological Data Profile (FGDC-STD-001.1-1999)')
                   @xml.comment!('The following metadata file was constructed using the ADIwg mdTranslator, http://mdtranslator.adiwg.org')
                   @xml.comment!('mdTranslator software is an open-source project of the Alaska Data Integration working group (ADIwg)')
                   @xml.comment!('mdTranslator and other metadata tools are available at https://github.com/adiwg')
@@ -38,10 +44,40 @@ module ADIWG
                   @xml.tag!('metadata') do
 
                      # metadata 1 (idinfo) - identification information
-                     idClass.writeXML(intObj)
+                     @xml.tag!('idinfo') do
+                        idClass.writeXML(intObj)
+                     end
 
                      # metadata 2 (dataqual) - data quality information
+                     # currently only lineage is implemented
+                     unless intObj[:metadata][:lineageInfo].empty?
+                        @xml.tag!('dataqual') do
+                           qualityClass.writeXML(intObj)
+                        end
+                     end
+                     if intObj[:metadata][:lineageInfo].empty?
+                        @xml.tag!('dataqual')
+                     end
+
                      # metadata 3 (spdoinfo) - spatial domain information
+                     hDomainInfo = false
+                     hDomainInfo = true unless hResourceInfo[:spatialRepresentations].empty?
+                     hDomainInfo = true unless hResourceInfo[:spatialRepresentationTypes].empty?
+                     hResourceInfo[:spatialReferenceSystems].each do |hSystem|
+                        unless hSystem[:systemIdentifier].empty?
+                           if hSystem[:systemIdentifier][:identifier] == 'indirect'
+                              hDomainInfo = true
+                           end
+                        end
+                     end
+                     if hDomainInfo
+                        @xml.tag!('spdoinfo') do
+                           spaceOrgClass.writeXML(hResourceInfo)
+                        end
+                     elsif @hResponseObj[:writerShowTags]
+                        @xml.tag!('spdoinfo')
+                     end
+
                      # metadata 4 (spref) - spatial reference systems
                      # metadata 5 (eainfo) - entity attribute information
                      # metadata 6 (distinfo) - distribution information

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

@@ -2,7 +2,7 @@
 # FGDC CSDGM writer output in XML
 
 # History:
-#   Stan Smith 2017-11-24 original script
+#  Stan Smith 2017-11-24 original script
 
 require_relative 'class_citation'
 

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

@@ -2,7 +2,7 @@
 # FGDC CSDGM writer output in XML
 
 # History:
-#   Stan Smith 2017-11-17 original script
+#  Stan Smith 2017-11-17 original script
 
 require_relative '../fgdc_writer'
 require_relative 'class_citation'
@@ -12,6 +12,10 @@ require_relative 'class_status'
 require_relative 'class_spatialDomain'
 require_relative 'class_keyword'
 require_relative 'class_contact'
+require_relative 'class_taxonomy'
+require_relative 'class_constraint'
+require_relative 'class_security'
+require_relative 'class_browse'
 
 module ADIWG
    module Mdtranslator
@@ -25,19 +29,6 @@ module ADIWG
                   @hResponseObj = hResponseObj
                end
 
-               def find_responsibility(aResponsibility, roleName)
-                  aParties = []
-                  aResponsibility.each do |hRParty|
-                     if hRParty[:roleName] == roleName
-                        hRParty[:parties].each do |hParty|
-                           aParties << hParty[:contactId]
-                        end
-                     end
-                  end
-                  aParties = aParties.uniq
-                  return aParties
-               end
-
                def writeXML(intObj)
 
                   # classes used
@@ -48,101 +39,169 @@ module ADIWG
                   spDomainClass = SpatialDomain.new(@xml, @hResponseObj)
                   keywordClass = Keyword.new(@xml, @hResponseObj)
                   contactClass = Contact.new(@xml, @hResponseObj)
+                  taxonomyClass = Taxonomy.new(@xml, @hResponseObj)
+                  constraintClass = Constraint.new(@xml, @hResponseObj)
+                  securityClass = Security.new(@xml, @hResponseObj)
+                  browseClass = Browse.new(@xml, @hResponseObj)
 
                   hResourceInfo = intObj[:metadata][:resourceInfo]
-
-                  @xml.tag!('idinfo') do
-
-                     # identification information 1.1 (citation) - citation (required)
-                     # <- hResourceInfo[:citation]
-                     hCitation = hResourceInfo[:citation]
-                     aAssocResource = intObj[:metadata][:associatedResources]
-                     unless hCitation.empty?
-                        @xml.tag!('citation') do
-                           citationClass.writeXML(hCitation, aAssocResource)
-                        end
-                     end
-                     if hCitation.empty?
-                        @hResponseObj[:writerPass] = false
-                        @hResponseObj[:writerMessages] << 'Identification section is missing citation'
+                  aAssocResource = intObj[:metadata][:associatedResources]
+
+                  # identification information 1.1 (citation) - citation (required)
+                  # <- hResourceInfo[:citation]
+                  hCitation = hResourceInfo[:citation]
+                  unless hCitation.empty?
+                     @xml.tag!('citation') do
+                        citationClass.writeXML(hCitation, aAssocResource)
                      end
+                  end
+                  if hCitation.empty?
+                     @hResponseObj[:writerPass] = false
+                     @hResponseObj[:writerMessages] << 'Identification section is missing citation'
+                  end
 
-                     # identification information 1.2 (descript) - description (required)
-                     # <- hResourceInfo[:abstract,:purpose,:supplementalInfo] (required)
-                     unless hResourceInfo[:abstract].nil? && hResourceInfo[:purpose].nil? && hResourceInfo[:supplementalInfo].nil?
-                        @xml.tag!('descript') do
-                           descriptionClass.writeXML(hResourceInfo)
-                        end
-                     end
-                     if hResourceInfo[:abstract].nil?
-                        @hResponseObj[:writerPass] = false
-                        @hResponseObj[:writerMessages] << 'Identification section is missing abstract'
+                  # identification information 1.2 (descript) - description (required)
+                  # <- hResourceInfo[:abstract,:purpose,:supplementalInfo] (required)
+                  unless hResourceInfo[:abstract].nil? && hResourceInfo[:purpose].nil? && hResourceInfo[:supplementalInfo].nil?
+                     @xml.tag!('descript') do
+                        descriptionClass.writeXML(hResourceInfo)
                      end
-                     if hResourceInfo[:purpose].nil?
-                        @hResponseObj[:writerPass] = false
-                        @hResponseObj[:writerMessages] << 'Identification section is missing purpose'
+                  end
+                  if hResourceInfo[:abstract].nil?
+                     @hResponseObj[:writerPass] = false
+                     @hResponseObj[:writerMessages] << 'Identification section is missing abstract'
+                  end
+                  if hResourceInfo[:purpose].nil?
+                     @hResponseObj[:writerPass] = false
+                     @hResponseObj[:writerMessages] << 'Identification section is missing purpose'
+                  end
+
+                  # identification information 1.3 (timeperd) - time period of content (required)
+                  # <- hResourceInfo[:timePeriod]
+                  unless hResourceInfo[:timePeriod].empty?
+                     @xml.tag!('timeperd') do
+                        timePeriodClass.writeXML(hResourceInfo[:timePeriod], 'current')
                      end
+                  end
+                  if hResourceInfo[:timePeriod].empty?
+                     @hResponseObj[:writerPass] = false
+                     @hResponseObj[:writerMessages] << 'Identification section is missing time period'
+                  end
 
-                     # identification information 1.3 (timeperd) - time period of content (required)
-                     # <- hResourceInfo[:timePeriod]
-                     unless hResourceInfo[:timePeriod].empty?
-                        @xml.tag!('timeperd') do
-                           timePeriodClass.writeXML(hResourceInfo[:timePeriod])
-                        end
+                  # identification information 1.4 (status) - status
+                  statusClass.writeXML(hResourceInfo)
+
+                  # identification information 1.5 (spdom) - spatial domain
+                  # not required under biological extension rules
+                  unless hResourceInfo[:extents].empty?
+                     spDomainClass.writeXML(hResourceInfo[:extents])
+                  end
+
+                  # identification information 1.6 (keywords) - keywords [] (required)
+                  unless hResourceInfo[:keywords].empty?
+                     @xml.tag!('keywords') do
+                        keywordClass.writeXML(hResourceInfo[:keywords])
                      end
-                     if hResourceInfo[:timePeriod].empty?
-                        @hResponseObj[:writerPass] = false
-                        @hResponseObj[:writerMessages] << 'Identification section is missing time period'
+                  end
+                  if hResourceInfo[:keywords].empty?
+                     @hResponseObj[:writerPass] = false
+                     @hResponseObj[:writerMessages] << 'Identification section is missing keywords'
+                  end
+
+                  # identification information bio (taxonomy) - taxonomy
+                  unless hResourceInfo[:taxonomy].empty?
+                     @xml.tag!('taxonomy') do
+                        taxonomyClass.writeXML(hResourceInfo[:taxonomy], hResourceInfo[:keywords])
                      end
+                  end
+                  if hResourceInfo[:taxonomy].empty? && @hResponseObj[:writerShowTags]
+                     @xml.tag!('taxonomy')
+                  end
 
-                     # identification information 1.4 (status) - status
-                     statusClass.writeXML(hResourceInfo)
+                  # identification information 1.7 (accconst) - access constraint (required)
+                  # identification information 1.8 (useconst) - use constraint (required)
+                  unless hResourceInfo[:constraints].empty?
+                     constraintClass.writeXML(hResourceInfo[:constraints])
+                  end
+                  if hResourceInfo[:constraints].empty?
+                     @hResponseObj[:writerPass] = false
+                     @hResponseObj[:writerMessages] << 'Identification section is missing access and use constraints'
+                  end
 
-                     # identification information 1.5 (spdom) - spatial domain
-                     # not required under biological extension rules
-                     unless hResourceInfo[:extents].empty?
-                        spDomainClass.writeXML(hResourceInfo[:extents])
+                  # identification information 1.9 (ptcontac) - point of contact
+                  unless hResourceInfo[:pointOfContacts].empty?
+                     aRParties = hResourceInfo[:pointOfContacts]
+                     aParties = ADIWG::Mdtranslator::Writers::Fgdc.find_responsibility(aRParties, 'pointOfContact')
+                     unless aParties.empty?
+                        hContact = ADIWG::Mdtranslator::Writers::Fgdc.get_contact(aParties[0])
+                        unless hContact.empty?
+                           @xml.tag!('ptcontac') do
+                              contactClass.writeXML(hContact)
+                           end
+                        end
                      end
+                  end
+                  if hResourceInfo[:pointOfContacts].empty? && @hResponseObj[:writerShowTags]
+                     @xml.tag!('ptcontac')
+                  end
 
-                     # identification information 1.6 (keywords) - keywords [] (required)
-                     unless hResourceInfo[:keywords].empty?
-                        @xml.tag!('keywords') do
-                           keywordClass.writeXML(hResourceInfo[:keywords])
-                        end
+                  # identification information 1.10 (browse) - browse graphic []
+                  hResourceInfo[:graphicOverviews].each do |hGraphic|
+                     @xml.tag!('browse') do
+                        browseClass.writeXML(hGraphic)
                      end
-                     if hResourceInfo[:keywords].empty?
-                        @hResponseObj[:writerPass] = false
-                        @hResponseObj[:writerMessages] << 'Identification section is missing keywords'
+                  end
+                  if hResourceInfo[:graphicOverviews].empty? && @hResponseObj[:writerShowTags]
+                     @xml.tag!('browse')
+                  end
+
+                  # identification information 1.11 (datacred) - dataset credit
+                  # <- concatenate  resourceInfo.credits[]
+                  unless hResourceInfo[:credits].empty?
+                     dataCred = ''
+                     hResourceInfo[:credits].each do |credit|
+                        dataCred += credit + '; '
                      end
+                     dataCred.chomp!('; ')
+                     @xml.tag!('datacred', dataCred)
+                  end
+                  if hResourceInfo[:credits].empty? && @hResponseObj[:writerShowTags]
+                     @xml.tag!('datacred')
+                  end
 
-                     # identification information bio (taxonomy) - taxonomy
-                     # identification information 1.7 (accconst) - access constraint (required)
-                     # identification information 1.8 (useconst) - use constraint (required)
-
-                     # identification information 1.9 (ptcontac) - point of contact
-                     unless hResourceInfo[:pointOfContacts].empty?
-                        aParties = find_responsibility(hResourceInfo[:pointOfContacts], 'pointOfContact')
-                        unless aParties.empty?
-                           hContact = ADIWG::Mdtranslator::Writers::Fgdc.get_contact(aParties[0])
-                           unless hContact.empty?
-                              @xml.tag!('ptcontac') do
-                                 contactClass.writeXML(hContact)
-                              end
-                           end
+                  # identification information 1.12 (secinfo) - security information
+                  unless hResourceInfo[:constraints].empty?
+                     securityClass.writeXML(hResourceInfo[:constraints])
+                  end
+                  if hResourceInfo[:constraints].empty? && @hResponseObj[:writerShowTags]
+                     @xml.tag!('secinfo')
+                  end
+
+                  # identification information 1.13 (native) - native dataset environment
+                  unless hResourceInfo[:environmentDescription].nil?
+                     @xml.tag!('native', hResourceInfo[:environmentDescription])
+                  end
+                  if hResourceInfo[:environmentDescription].nil? && @hResponseObj[:writerShowTags]
+                     @xml.tag!('native')
+                  end
+
+                  # identification information 1.14 (crossref) - cross reference []
+                  # <- associatedResources[:associationType] = 'crossReference'
+                  haveXRef = false
+                  aAssocResource.each do |hAssocRes|
+                     if hAssocRes[:associationType] == 'crossReference'
+                        haveXRef = true
+                        @xml.tag!('crossref') do
+                           citationClass.writeXML(hAssocRes[:resourceCitation], [])
                         end
                      end
-                     if hResourceInfo[:pointOfContacts].empty? && @hResponseObj[:writerShowTags]
-                        @xml.tag!('ptcontac')
-                     end
+                  end
+                  if !haveXRef && @hResponseObj[:writerShowTags]
+                     @xml.tag!('crossref')
+                  end
 
-                     # identification information 1.10 (browse) - browse graphic []
-                     # identification information 1.11 (datacred) - dataset credit
-                     # identification information 1.12 (secinfo) - security information
-                     # identification information 1.13 (native) - native dataset environment
-                     # identification information 1.14 (crossref) - cross reference []
-                     # identification information bio (tool) - analytical tool [] (not supported)
+                  # identification information bio (tool) - analytical tool [] (not supported)
 
-                  end # idinfo tag
                end # writeXML
             end # Identification
 

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

@@ -21,21 +21,21 @@ module ADIWG
                   # array of keyword sets
                   aKeywords.each do |hKeySet|
 
-                     # find all the keyword set parts
+                     # find the keyword set parts
                      type = hKeySet[:keywordType]
-                     thesaurusName = nil
+                     aKeywords = hKeySet[:keywords]
                      thesaurus = hKeySet[:thesaurus]
+                     thesaurusName = nil
                      unless thesaurus.empty?
                         thesaurusName = thesaurus[:title]
                      end
-                     aKeywords = hKeySet[:keywords]
-                     if thesaurusName.nil?
+                     if thesaurus.empty?
                         @hResponseObj[:writerPass] = false
-                        @hResponseObj[:writerMessages] << 'keyword set is missing thesaurus name'
+                        @hResponseObj[:writerMessages] << 'Keyword Set is missing thesaurus'
                      end
 
                      # keyword 1.6.1 (theme) - theme keywords
-                     if type == 'theme'
+                     if type == 'theme' || type == 'isoTopicCategory'
                         @xml.tag!('theme') do
                            @xml.tag!('themekt', thesaurusName)
                            aKeywords.each do |hKeyword|