adiwg-mdtranslator 2.14.2 → 2.15.0

data/lib/adiwg/mdtranslator/writers/iso19115_1/readme.md

@@ -0,0 +1,12 @@
+
+## iso19115_1
+
+### Writer for ISO 19115-1:2014 Geographic Metadata
+
+The mdTranslator iso19115_1 writer implements approximately 95% of 
+the for ISO 19115-3:2014 standard. Efforts were made to include all 
+elements of the ISO standard that support general data descriptions 
+to ensure generation of health and robust project and data metadata 
+records. The sections of 19115-3 not supported by the mdTranslator 
+writer are the 'quantitative' section for data quality, portrayal 
+catalog reference, acquisition, and application schema information. 

data/lib/adiwg/mdtranslator/writers/iso19115_1/version.rb

@@ -0,0 +1,15 @@
+# iso19115-1 version history
+#  1.0.0 Original
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Iso19115_1
+
+            # current version of ISO 19115-1 writer
+            VERSION = '1.0.0'
+
+         end
+      end
+   end
+end

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

@@ -119,8 +119,9 @@ module ADIWG
                      end
 
                      # citation - cited responsible party [{CI_ResponsibleParty}]
-                     # contacts are grouped by role in the internal object
-                     # output a separate <gmd:contact> for each role:contact pairing
+                     # responsibilities are grouped by role in the internal object
+                     # to output in ISO ...
+                     # create a separate record for each role-contact pair
                      # check for duplicates and eliminate
                      aRoleParty = []
                      aRParties = hCitation[:responsibleParties]

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

@@ -2,6 +2,7 @@
 # 19115-2 writer output in XML
 
 # History:
+#  Stan Smith 2019-03-22 replaced Enumeration class with method
 #  Stan Smith 2018-10-26 refactor for mdJson schema 2.6.0
 #  Stan Smith 2018-05-25 block non-ISO19115-2 topic categories
 #  Stan Smith 2018-04-09 add error and warning messaging
@@ -31,9 +32,9 @@
 # 	Stan Smith 2013-08-26 original script
 
 require 'adiwg/mdtranslator/internal/internal_metadata_obj'
+require 'adiwg/mdtranslator/internal/module_codelistFun'
 require_relative '../iso19115_2_writer'
 require_relative 'class_codelist'
-require_relative 'class_enumerationList'
 require_relative 'class_citation'
 require_relative 'class_responsibleParty'
 require_relative 'class_maintenance'
@@ -62,12 +63,11 @@ module ADIWG
                   @NameSpace = ADIWG::Mdtranslator::Writers::Iso19115_2
                end
 
-               def writeXML(hData, aAssocRes, aDistInfo)
+               def writeXML(hMetadata)
 
                   # classes used
                   intMetadataClass = InternalMetadata.new
                   codelistClass = MD_Codelist.new(@xml, @hResponseObj)
-                  enumerationClass = MD_EnumerationList.new(@xml, @hResponseObj)
                   citationClass = CI_Citation.new(@xml, @hResponseObj)
                   rPartyClass = CI_ResponsibleParty.new(@xml, @hResponseObj)
                   mInfoClass = MD_MaintenanceInformation.new(@xml, @hResponseObj)
@@ -83,11 +83,16 @@ module ADIWG
                   resolutionClass = MD_Resolution.new(@xml, @hResponseObj)
                   extentClass = EX_Extent.new(@xml, @hResponseObj)
 
+                  # create shortcuts to sections of internal object
+                  hResource = hMetadata[:resourceInfo]
+                  aAssocRes = hMetadata[:associatedResources]
+                  aDistInfo = hMetadata[:distributorInfo]
+
                   # data identification
                   @xml.tag!('gmd:MD_DataIdentification') do
 
                      # data identification - citation {CI_Citation} (required)
-                     hCitation = hData[:citation]
+                     hCitation = hResource[:citation]
                      unless hCitation.empty?
                         @xml.tag!('gmd:citation') do
                            citationClass.writeXML(hCitation, 'main resource')
@@ -98,7 +103,7 @@ module ADIWG
                      end
 
                      # data identification - abstract (required)
-                     s = hData[:abstract]
+                     s = hResource[:abstract]
                      unless s.nil?
                         @xml.tag!('gmd:abstract') do
                            @xml.tag!('gco:CharacterString', s)
@@ -109,7 +114,7 @@ module ADIWG
                      end
 
                      # data identification - purpose
-                     s = hData[:purpose]
+                     s = hResource[:purpose]
                      unless s.nil?
                         @xml.tag!('gmd:purpose') do
                            @xml.tag!('gco:CharacterString', s)
@@ -121,16 +126,16 @@ module ADIWG
 
                      # data identification - time period {timePeriod}
                      # package as a temporal extent
-                     unless hData[:timePeriod].empty?
+                     unless hResource[:timePeriod].empty?
                         hExtent = intMetadataClass.newExtent
                         hTempExtent = intMetadataClass.newTemporalExtent
-                        hTempExtent[:timePeriod] = hData[:timePeriod]
+                        hTempExtent[:timePeriod] = hResource[:timePeriod]
                         hExtent[:temporalExtents] << hTempExtent
-                        hData[:extents] << hExtent
+                        hResource[:extents] << hExtent
                      end
 
                      # data identification - credit []
-                     aCredits = hData[:credits]
+                     aCredits = hResource[:credits]
                      aCredits.each do |credit|
                         @xml.tag!('gmd:credit') do
                            @xml.tag!('gco:CharacterString', credit)
@@ -141,7 +146,7 @@ module ADIWG
                      end
 
                      # data identification - status []
-                     aStatus = hData[:status]
+                     aStatus = hResource[:status]
                      aStatus.each do |code|
                         @xml.tag!('gmd:status') do
                            codelistClass.writeXML('gmd', 'iso_progress', code)
@@ -152,13 +157,13 @@ module ADIWG
                      end
 
                      # data identification - point of contact
-                     aRParties = hData[:pointOfContacts]
+                     aRParties = hResource[:pointOfContacts]
                      aRParties.each do |hRParty|
                         role = hRParty[:roleName]
                         aParties = hRParty[:parties]
                         aParties.each do |hParty|
                            @xml.tag!('gmd:pointOfContact') do
-                              rPartyClass.writeXML(role, hParty, 'main resource point of contact')
+                              rPartyClass.writeXML(role, hParty, 'resource point of contact')
                            end
                         end
                      end
@@ -167,7 +172,7 @@ module ADIWG
                      end
 
                      # data identification - resource maintenance []
-                     aMaint = hData[:resourceMaintenance]
+                     aMaint = hResource[:resourceMaintenance]
                      aMaint.each do |hMaint|
                         @xml.tag!('gmd:resourceMaintenance') do
                            mInfoClass.writeXML(hMaint, 'main resource')
@@ -178,7 +183,7 @@ module ADIWG
                      end
 
                      # data identification - graphic overview []
-                     aGraphics = hData[:graphicOverviews]
+                     aGraphics = hResource[:graphicOverviews]
                      aGraphics.each do |hGraphic|
                         @xml.tag!('gmd:graphicOverview') do
                            bGraphicClass.writeXML(hGraphic, 'main resource')
@@ -189,7 +194,7 @@ module ADIWG
                      end
 
                      # data identification - resource format []
-                     aFormats = hData[:resourceFormats]
+                     aFormats = hResource[:resourceFormats]
                      aFormats.each do |hResFormat|
                         @xml.tag!('gmd:resourceFormat') do
                            rFormatClass.writeXML(hResFormat)
@@ -200,7 +205,7 @@ module ADIWG
                      end
 
                      # data identification - descriptive keywords []
-                     aKeywords = hData[:keywords]
+                     aKeywords = hResource[:keywords]
                      aKeywords.each do |hKeyword|
                         @xml.tag!('gmd:descriptiveKeywords') do
                            keywordClass.writeXML(hKeyword)
@@ -211,7 +216,7 @@ module ADIWG
                      end
 
                      # data identification - resource specific usage []
-                     aUses = hData[:resourceUsages]
+                     aUses = hResource[:resourceUsages]
                      aUses.each do |hResUse|
                         @xml.tag!('gmd:resourceSpecificUsage') do
                            useClass.writeXML(hResUse)
@@ -223,7 +228,7 @@ module ADIWG
 
                      # data identification - resource constraints {}
                      haveCon = false
-                     aCons = hData[:constraints]
+                     aCons = hResource[:constraints]
                      aCons.each do |hCon|
                         @xml.tag!('gmd:resourceConstraints') do
                            type = hCon[:type]
@@ -271,24 +276,24 @@ module ADIWG
                      end
 
                      # data identification - taxonomy (first)
-                     unless hData[:taxonomy].empty?
-                        hTaxonomy = hData[:taxonomy][0]
+                     unless hResource[:taxonomy].empty?
+                        hTaxonomy = hResource[:taxonomy][0]
                         unless hTaxonomy.empty?
                            @xml.tag!('gmd:taxonomy') do
                               taxClass.writeXML(hTaxonomy)
                            end
                         end
-                        if hData[:taxonomy].length > 1
+                        if hResource[:taxonomy].length > 1
                            @NameSpace.issueNotice(53, 'main resource')
                            @NameSpace.issueNotice(54, 'main resource')
                         end
                      end
-                     if hData[:taxonomy].empty? && @hResponseObj[:writerShowTags]
+                     if hResource[:taxonomy].empty? && @hResponseObj[:writerShowTags]
                         @xml.tag!('gmd:taxonomy')
                      end
 
                      # data identification - spatial representation type []
-                     aSpatialType = hData[:spatialRepresentationTypes]
+                     aSpatialType = hResource[:spatialRepresentationTypes]
                      aSpatialType.each do |spType|
                         @xml.tag!('gmd:spatialRepresentationType') do
                            codelistClass.writeXML('gmd', 'iso_spatialRepresentation', spType)
@@ -299,7 +304,7 @@ module ADIWG
                      end
 
                      # data identification - spatial resolution []
-                     aSpatialRes = hData[:spatialResolutions]
+                     aSpatialRes = hResource[:spatialResolutions]
                      aSpatialRes.each do |hSpRes|
                         @xml.tag!('gmd:spatialResolution') do
                            resolutionClass.writeXML(hSpRes)
@@ -310,8 +315,8 @@ module ADIWG
                      end
 
                      # data identification - language [] (required)
-                     aLocale = hData[:otherResourceLocales]
-                     aLocale.insert(0, hData[:defaultResourceLocale])
+                     aLocale = hResource[:otherResourceLocales]
+                     aLocale.insert(0, hResource[:defaultResourceLocale])
                      aLocale.each do |hLocale|
                         s = hLocale[:languageCode]
                         unless hLocale[:countryCode].nil?
@@ -344,10 +349,10 @@ module ADIWG
                         end
                      end
 
-                     # data identification - topic category []
-                     # <- hData.keywords where keywordType='isoTopicCategory'
+                     # data identification - topic category [] {MD_TopicCategoryCode}
+                     # get from hData.keywords where keywordType='isoTopicCategory'
                      aTopics = []
-                     aKeywords = hData[:keywords]
+                     aKeywords = hResource[:keywords]
                      aKeywords.each do |hKeyword|
                         if hKeyword[:keywordType] == 'isoTopicCategory'
                            hKeyword[:keywords].each do |hKeyObj|
@@ -356,15 +361,13 @@ module ADIWG
                         end
                      end
                      # only allow valid ISO 19115-2 topic categories to be written
-                     aAcceptable = %w(farming biota boundaries climatologyMeteorologyAtmosphere economy
-                                       elevation environment geoscientificInformation health imageryBaseMapsEarthCover
-                                       intelligenceMilitary inlandWaters location oceans planningCadastre society
-                                       structure transportation utilitiesCommunication)
                      aTopics.each do |topic|
-                        if aAcceptable.include?(topic)
+                        if CodelistFun.validateItem('iso_topicCategory', topic)
                            @xml.tag!('gmd:topicCategory') do
-                              enumerationClass.writeXML('iso_topicCategory', topic)
+                              @xml.tag!('gmd:MD_TopicCategoryCode', topic)
                            end
+                        else
+                           @NameSpace.issueWarning(380, 'gmd:topicCategory', "#{topic}")
                         end
                      end
                      if aTopics.empty? && @hResponseObj[:writerShowTags]
@@ -372,7 +375,7 @@ module ADIWG
                      end
 
                      # data identification - environment description
-                     s = hData[:environmentDescription]
+                     s = hResource[:environmentDescription]
                      unless s.nil?
                         @xml.tag!('gmd:environmentDescription') do
                            @xml.tag!('gco:CharacterString', s)
@@ -383,7 +386,7 @@ module ADIWG
                      end
 
                      # data identification - extent []
-                     aExtents = hData[:extents]
+                     aExtents = hResource[:extents]
                      aExtents.each do |hExtent|
                         @xml.tag!('gmd:extent') do
                            extentClass.writeXML(hExtent)
@@ -394,7 +397,7 @@ module ADIWG
                      end
 
                      # data identification - supplemental info
-                     s = hData[:supplementalInfo]
+                     s = hResource[:supplementalInfo]
                      unless s.nil?
                         @xml.tag!('gmd:supplementalInformation') do
                            @xml.tag!('gco:CharacterString', s)

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

@@ -36,7 +36,7 @@ module ADIWG
                   scopeClass = DQ_Scope.new(@xml, @hResponseObj)
                   lineClass = LI_Lineage.new(@xml, @hResponseObj)
 
-                  outContext = 'data quality'
+                  outContext = 'data quality - lineage'
 
                   @xml.tag!('gmd:DQ_DataQuality') do
 
@@ -48,7 +48,7 @@ module ADIWG
                         end
                      end
                      if hScope.empty?
-                        @NameSpace.issueWarning(60, 'gmd:scope')
+                        @NameSpace.issueWarning(60, 'gmd:scope', outContext)
                      end
 
                      # date quality - report (moved to ISO 19157)

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

@@ -39,6 +39,8 @@ module ADIWG
                   formatClass = MD_Format.new(@xml, @hResponseObj)
                   transferClass = MD_DigitalTransferOptions.new(@xml, @hResponseObj)
 
+                  outContext = 'distributor'
+
                   @xml.tag!('gmd:MD_Distributor') do
 
                      # distributor - contact (required) {CI_ResponsibleParty}
@@ -72,7 +74,7 @@ module ADIWG
                         aFormats.each do |hFormat|
                            format = true
                            @xml.tag!('gmd:distributorFormat') do
-                              formatClass.writeXML(hFormat)
+                              formatClass.writeXML(hFormat, outContext + ' format')
                            end
                         end
                      end

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

@@ -2,6 +2,7 @@
 # 19115-2 writer output in XML
 
 # History:
+#  Stan Smith 2019-03-22 replaced Enumeration class with method
 #  Stan Smith 2018-04-09 add error and warning messaging
 #  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
@@ -11,6 +12,7 @@
 #  Stan Smith 2014-07-08 modify require statements to function in RubyGem structure
 # 	Stan Smith 2013-11-22 original script.
 
+require 'adiwg/mdtranslator/internal/module_codelistFun'
 require_relative '../iso19115_2_writer'
 require_relative 'class_codelist'
 require_relative 'class_enumerationList'
@@ -33,7 +35,6 @@ module ADIWG
 
                   # classes used
                   codelistClass = MD_Codelist.new(@xml, @hResponseObj)
-                  enumerationClass = MD_EnumerationList.new(@xml, @hResponseObj)
                   olResClass = CI_OnlineResource.new(@xml, @hResponseObj)
 
                   outContext = 'extension information'
@@ -89,14 +90,18 @@ module ADIWG
                               @NameSpace.issueWarning(101, 'gmd:definition', outContext)
                            end
 
-                           # extended element info - obligation
-                           s = hExtension[:obligation]
-                           unless s.nil?
-                              @xml.tag!('gmd:obligation') do
-                                 enumerationClass.writeXML('iso_obligation', s)
+                           # extended element info - obligation {MD_ObligationCode}
+                           obligation = hExtension[:obligation]
+                           unless obligation.nil?
+                              if CodelistFun.validateItem('iso_obligation', obligation)
+                                 @xml.tag!('gmd:obligation') do
+                                    @xml.tag!('gmd:MD_ObligationCode', obligation)
+                                 end
+                              else
+                                 @NameSpace.issueWarning(380, 'gmd:obligation', "#{obligation}")
                               end
                            end
-                           if s.nil? && @hResponseObj[:writerShowTags]
+                           if obligation.nil? && @hResponseObj[:writerShowTags]
                               @xml.tag!('gmd:obligation')
                            end
 

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

@@ -95,7 +95,6 @@ module ADIWG
                   hMetadata = intObj[:metadata]
                   hMetaInfo = hMetadata[:metadataInfo]
                   hResInfo = hMetadata[:resourceInfo]
-                  aAssocRes = hMetadata[:associatedResources]
                   aDistInfo = hMetadata[:distributorInfo]
                   version = @hResponseObj[:translatorVersion]
 
@@ -211,7 +210,7 @@ module ADIWG
 
                      # metadata information - metadata standard name (default)
                      @xml.tag!('gmd:metadataStandardName') do
-                        @xml.tag!('gco:CharacterString', 'ISO 19115-2')
+                        @xml.tag!('gco:CharacterString', 'ISO 19139')
                      end
 
                      # metadata information - metadata standard version (default)
@@ -298,7 +297,7 @@ module ADIWG
                      # metadata information - identification info - required
                      unless hResInfo.empty?
                         @xml.tag!('gmd:identificationInfo') do
-                           dataIdClass.writeXML(hResInfo, aAssocRes, aDistInfo)
+                           dataIdClass.writeXML(hMetadata)
                         end
                      end
                      if hResInfo.empty?

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

@@ -1,6 +1,6 @@
 # ISO <<Class>> MD_ReferenceSystem
 # writer
-# 19115-2 output for ISO 19115-2 XML
+# 19115-2 output for XML
 
 # History:
 #  Stan Smith 2018-10-17 refactor to support schema 2.6.0 changes to projection

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

@@ -40,7 +40,7 @@ module ADIWG
                   end
 
                   # spatial resolution - distance (only if type='distance')
-                  unless hResolution[:measure].nil?
+                  unless hResolution[:measure].empty?
                      hMeasure = hResolution[:measure]
                      unless hMeasure.empty?
                         if hMeasure[:type] == 'distance'

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

@@ -2,6 +2,7 @@
 # 19115-2 writer output in XML
 
 # History:
+#  Stan Smith 2019-03-14 added test for empty parameters
 #  Stan Smith 2018-04-10 add error and warning messaging
 #  Stan Smith 2016-11-17 refactored for mdTranslator/mdJson 2.0
 #  Stan Smith 2015-07-14 refactored to eliminate namespace globals $WriterNS and $IsoNS
@@ -39,80 +40,86 @@ module ADIWG
                   outContext = 'responsible party'
                   outContext = inContext + ' responsible party' unless inContext.nil?
 
-                  contactId = hParty[:contactId]
-                  hContact = ADIWG::Mdtranslator::Writers::Iso19115_2.getContact(contactId)
+                  hContact = ADIWG::Mdtranslator::Writers::Iso19115_2.getContact(hParty[:contactId])
+
                   unless hContact.empty?
-                     isOrg = hContact[:isOrganization]
                      @xml.tag!('gmd:CI_ResponsibleParty') do
 
+                        name = hContact[:name]
+                        position = hContact[:positionName]
+
                         # responsible party
-                        if isOrg
+                        if hContact[:isOrganization]
 
-                           # organization name
-                           s = hContact[:name]
-                           unless s.nil?
+                           # responsible party - organization name
+                           unless name.nil?
                               @xml.tag!('gmd:organisationName') do
-                                 @xml.tag!('gco:CharacterString', s)
+                                 @xml.tag!('gco:CharacterString', name)
                               end
                            end
-                           if s.nil? && @hResponseObj[:writerShowTags]
+                           if name.nil? && @hResponseObj[:writerShowTags]
                               @xml.tag!('gmd:organisationName')
                            end
 
                         else
 
-                           # individual name
-                           s = hContact[:name]
-                           unless s.nil?
+                           # responsible party - individual name
+                           unless name.nil?
                               @xml.tag!('gmd:individualName') do
-                                 @xml.tag!('gco:CharacterString', s)
+                                 @xml.tag!('gco:CharacterString', name)
                               end
                            end
-                           if s.nil? && @hResponseObj[:writerShowTags]
+                           if name.nil? && @hResponseObj[:writerShowTags]
                               @xml.tag!('gmd:individualName')
                            end
 
-                           # position name
-                           s = hContact[:positionName]
-                           unless s.nil?
+                           # responsible party - position name
+                           unless position.nil?
                               @xml.tag!('gmd:positionName') do
-                                 @xml.tag!('gco:CharacterString', s)
+                                 @xml.tag!('gco:CharacterString', position)
                               end
                            end
-                           if s.nil? && @hResponseObj[:writerShowTags]
+                           if position.nil? && @hResponseObj[:writerShowTags]
                               @xml.tag!('gmd:positionName')
                            end
 
                         end
 
                         # responsible party - contact info
-                        if !hContact[:phones].empty? ||
-                           !hContact[:addresses].empty? ||
-                           !hContact[:eMailList].empty? ||
-                           !hContact[:onlineResources].empty? ||
-                           !hContact[:hoursOfService].empty? ||
-                           !hContact[:contactInstructions].nil?
-
+                        haveInfo = false
+                        unless hContact[:phones].empty? &&
+                           hContact[:addresses].empty? &&
+                           hContact[:eMailList].empty? &&
+                           hContact[:onlineResources].empty? &&
+                           hContact[:hoursOfService].empty? &&
+                           hContact[:contactInstructions].nil?
+                           haveInfo = true
+                        end
+                        if haveInfo
                            @xml.tag!('gmd:contactInfo') do
                               contactClass.writeXML(hContact)
                            end
-                        elsif @hResponseObj[:writerShowTags]
+                        end
+                        if !haveInfo && @hResponseObj[:writerShowTags]
                            @xml.tag!('gmd:contactInfo')
                         end
 
                         # responsible party - role (required)
-                        s = role
-                        unless s.nil?
-                           @xml.tag! 'gmd:role' do
-                              codelistClass.writeXML('gmd', 'iso_role', s)
+                        unless role.nil?
+                           @xml.tag!('gmd:role') do
+                              codelistClass.writeXML('gmd', 'iso_role', role)
                            end
                         end
-                        if s.nil?
-                           @NameSpace.issueWarning(270, 'gmd:role', inContext)
+                        if role.nil?
+                           @NameSpace.issueWarning(270, 'gmd:role', outContext)
                         end
 
-                     end # CI_ResponsibleParty tag
-                  end # valid contact returned
+                     end
+                  end
+                  if hContact.empty? && @hResponseObj[:writerShowTags]
+                     @xml.tag!('gmd:CI_ResponsibleParty')
+                  end
+
                end # write XML
             end # CI_ResponsibleParty class