adiwg-mdtranslator 2.12.0 → 2.13.0

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

@@ -2,76 +2,80 @@
 # 19115-2 writer output in XML
 
 # History:
-#   Stan Smith 2016-12-02 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-05-30 hBBox attributes changed for version 0.5.0
+#  Stan Smith 2018-04-09 add error and warning messaging
+#  Stan Smith 2016-12-02 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-05-30 hBBox attributes changed for version 0.5.0
 # 	Stan Smith 2013-11-01 original script
 
+require_relative '../iso19115_2_writer'
+
 module ADIWG
-    module Mdtranslator
-        module Writers
-            module Iso19115_2
+   module Mdtranslator
+      module Writers
+         module Iso19115_2
 
-                class EX_GeographicBoundingBox
+            class EX_GeographicBoundingBox
 
-                    def initialize(xml, hResponseObj)
-                        @xml = xml
-                        @hResponseObj = hResponseObj
-                    end
+               def initialize(xml, hResponseObj)
+                  @xml = xml
+                  @hResponseObj = hResponseObj
+                  @NameSpace = ADIWG::Mdtranslator::Writers::Iso19115_2
+               end
 
-                    def writeXML(hBBox)
+               def writeXML(hBBox)
 
-                        # bounding box - west longitude (required)
-                        s = hBBox[:westLongitude]
-                        unless s.nil?
-                            @xml.tag!('gmd:westBoundLongitude') do
-                                @xml.tag!('gco:Decimal', s)
-                            end
-                        end
-                        if s.nil?
-                            @xml.tag!('gmd:westBoundLongitude', {'gco:nilReason' => 'missing'})
-                        end
+                  # bounding box - west longitude (required)
+                  s = hBBox[:westLongitude]
+                  unless s.nil?
+                     @xml.tag!('gmd:westBoundLongitude') do
+                        @xml.tag!('gco:Decimal', s)
+                     end
+                  end
+                  if s.nil?
+                     @NameSpace.issueError(10)
+                  end
 
-                        # bounding box - east longitude (required)
-                        s = hBBox[:eastLongitude]
-                        unless s.nil?
-                            @xml.tag!('gmd:eastBoundLongitude') do
-                                @xml.tag!('gco:Decimal', s)
-                            end
-                        end
-                        if s.nil?
-                            @xml.tag!('gmd:eastBoundLongitude', {'gco:nilReason' => 'missing'})
-                        end
+                  # bounding box - east longitude (required)
+                  s = hBBox[:eastLongitude]
+                  unless s.nil?
+                     @xml.tag!('gmd:eastBoundLongitude') do
+                        @xml.tag!('gco:Decimal', s)
+                     end
+                  end
+                  if s.nil?
+                     @NameSpace.issueError(11)
+                  end
 
-                        # bounding box - south latitude (required)
-                        s = hBBox[:southLatitude]
-                        unless s.nil?
-                            @xml.tag!('gmd:southBoundLatitude') do
-                                @xml.tag!('gco:Decimal', s)
-                            end
-                        end
-                        if s.nil?
-                            @xml.tag!('gmd:southBoundLatitude', {'gco:nilReason' => 'missing'})
-                        end
+                  # bounding box - south latitude (required)
+                  s = hBBox[:southLatitude]
+                  unless s.nil?
+                     @xml.tag!('gmd:southBoundLatitude') do
+                        @xml.tag!('gco:Decimal', s)
+                     end
+                  end
+                  if s.nil?
+                     @NameSpace.issueError(12)
+                  end
 
-                        # bounding box - north latitude (required)
-                        s = hBBox[:northLatitude]
-                        unless s.nil?
-                            @xml.tag!('gmd:northBoundLatitude') do
-                                @xml.tag!('gco:Decimal', s)
-                            end
-                        end
-                        if s.nil?
-                            @xml.tag!('gmd:northBoundLatitude', {'gco:nilReason' => 'missing'})
-                        end
+                  # bounding box - north latitude (required)
+                  s = hBBox[:northLatitude]
+                  unless s.nil?
+                     @xml.tag!('gmd:northBoundLatitude') do
+                        @xml.tag!('gco:Decimal', s)
+                     end
+                  end
+                  if s.nil?
+                     @NameSpace.issueError(13)
+                  end
 
-                    end # writeXML
-                end # EX_GeographicBoundingBox class
+               end # writeXML
+            end # EX_GeographicBoundingBox class
 
-            end
-        end
-    end
+         end
+      end
+   end
 end

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

@@ -2,67 +2,71 @@
 # 19115-2 writer output in XML
 
 # History:
-#   Stan Smith 2016-11-29 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-15 refactored to handle namespacing readers and writers
+#  Stan Smith 2018-04-09 add error and warning messaging
+#  Stan Smith 2016-11-29 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-15 refactored to handle namespacing readers and writers
 # 	Stan Smith 2013-10-17 original script
 
+require_relative '../iso19115_2_writer'
+
 module ADIWG
-    module Mdtranslator
-        module Writers
-            module Iso19115_2
+   module Mdtranslator
+      module Writers
+         module Iso19115_2
 
-                class MD_BrowseGraphic
+            class MD_BrowseGraphic
 
-                    def initialize(xml, hResponseObj)
-                        @xml = xml
-                        @hResponseObj = hResponseObj
-                    end
+               def initialize(xml, hResponseObj)
+                  @xml = xml
+                  @hResponseObj = hResponseObj
+                  @NameSpace = ADIWG::Mdtranslator::Writers::Iso19115_2
+               end
 
-                    def writeXML(hGraphic)
+               def writeXML(hGraphic, inContext = nil)
 
-                        @xml.tag!('gmd:MD_BrowseGraphic') do
+                  @xml.tag!('gmd:MD_BrowseGraphic') do
 
-                            # browse graphic - file name (required)
-                            s = hGraphic[:graphicName]
-                            unless s.nil?
-                                @xml.tag!('gmd:fileName') do
-                                    @xml.tag!('gco:CharacterString', s)
-                                end
-                            end
-                            if s.nil?
-                                @xml.tag!('gmd:fileName', {'gco:nilReason' => 'missing'})
-                            end
+                     # browse graphic - file name (required)
+                     s = hGraphic[:graphicName]
+                     unless s.nil?
+                        @xml.tag!('gmd:fileName') do
+                           @xml.tag!('gco:CharacterString', s)
+                        end
+                     end
+                     if s.nil?
+                        @NameSpace.issueWarning(20, 'gmd:fileName', inContext)
+                     end
 
-                            # browse graphic - file description
-                            s = hGraphic[:graphicDescription]
-                            unless s.nil?
-                                @xml.tag!('gmd:fileDescription') do
-                                    @xml.tag!('gco:CharacterString', s)
-                                end
-                            end
-                            if s.nil? && @hResponseObj[:writerShowTags]
-                                @xml.tag!('gmd:fileDescription')
-                            end
+                     # browse graphic - file description
+                     s = hGraphic[:graphicDescription]
+                     unless s.nil?
+                        @xml.tag!('gmd:fileDescription') do
+                           @xml.tag!('gco:CharacterString', s)
+                        end
+                     end
+                     if s.nil? && @hResponseObj[:writerShowTags]
+                        @xml.tag!('gmd:fileDescription')
+                     end
 
-                            # browse graphic - file type
-                            s = hGraphic[:graphicType]
-                            unless s.nil?
-                                @xml.tag!('gmd:fileType') do
-                                    @xml.tag!('gco:CharacterString', s)
-                                end
-                            end
-                            if s.nil? && @hResponseObj[:writerShowTags]
-                                @xml.tag!('gmd:fileType')
-                            end
+                     # browse graphic - file type
+                     s = hGraphic[:graphicType]
+                     unless s.nil?
+                        @xml.tag!('gmd:fileType') do
+                           @xml.tag!('gco:CharacterString', s)
+                        end
+                     end
+                     if s.nil? && @hResponseObj[:writerShowTags]
+                        @xml.tag!('gmd:fileType')
+                     end
 
-                        end # MD_BrowseGraphic tag
-                    end # writeXML
-                end # MD_BrowseGraphic class
+                  end # MD_BrowseGraphic tag
+               end # writeXML
+            end # MD_BrowseGraphic class
 
-            end
-        end
-    end
+         end
+      end
+   end
 end

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

@@ -2,6 +2,7 @@
 # 19115-2 writer output in XML
 
 # History:
+#  Stan Smith 2018-04-09 add error and warning messaging
 #  Stan Smith 2016-11-29 refactored for mdTranslator/mdJson 2.0
 #  Stan Smith 2015-08-28 added alternate title
 #  Stan Smith 2015-07-14 refactored to eliminate namespace globals $WriterNS and $IsoNS
@@ -18,6 +19,7 @@
 # 	Stan Smith 2013-12-30 added ISBN, ISSN
 # 	Stan Smith 2013-08-26 original script
 
+require_relative '../iso19115_2_writer'
 require_relative 'class_codelist'
 require_relative 'class_responsibleParty'
 require_relative 'class_date'
@@ -34,9 +36,10 @@ module ADIWG
                def initialize(xml, hResponseObj)
                   @xml = xml
                   @hResponseObj = hResponseObj
+                  @NameSpace = ADIWG::Mdtranslator::Writers::Iso19115_2
                end
 
-               def writeXML(hCitation)
+               def writeXML(hCitation, inContext = nil)
 
                   # classes used
                   codelistClass = MD_Codelist.new(@xml, @hResponseObj)
@@ -45,12 +48,15 @@ module ADIWG
                   idClass = MD_Identifier.new(@xml, @hResponseObj)
                   seriesClass = CI_Series.new(@xml, @hResponseObj)
 
+                  outContext = 'citation'
+                  outContext = inContext + ' citation' unless inContext.nil?
+
                   @xml.tag!('gmd:CI_Citation') do
 
                      # citation - title (required)
                      s = hCitation[:title]
                      if s.nil?
-                        @xml.tag!('gmd:title', {'gco:nilReason' => 'missing'})
+                        @NameSpace.issueWarning(30, 'gmd:title', inContext)
                      else
                         @xml.tag!('gmd:title') do
                            @xml.tag!('gco:CharacterString', s)
@@ -72,11 +78,11 @@ module ADIWG
                      aDate = hCitation[:dates]
                      aDate.each do |hDate|
                         @xml.tag!('gmd:date') do
-                           dateClass.writeXML(hDate)
+                           dateClass.writeXML(hDate, outContext)
                         end
                      end
                      if aDate.empty?
-                        @xml.tag!('gmd:date', {'gco:nilReason' => 'missing'})
+                        @NameSpace.issueWarning(31, 'gmd:date', outContext)
                      end
 
                      # citation - edition
@@ -91,8 +97,8 @@ module ADIWG
                      end
 
                      # citation - resource identifier []
-                     # do not process ISBN and ISSN as MD_identifier(s)
-                     # ... these are written separately in ISO 19115-x
+                     # process ISBN and ISSN as MD_identifier(s)
+                     # ... then also write separately in ISBN or ISSN tag
                      isbn = ''
                      issn = ''
                      aIds = hCitation[:identifiers]
@@ -104,10 +110,8 @@ module ADIWG
                               issn = hIdentifier[:identifier]
                            end
                         end
-                        if issn == '' && isbn == ''
-                           @xml.tag!('gmd:identifier') do
-                              idClass.writeXML(hIdentifier)
-                           end
+                        @xml.tag!('gmd:identifier') do
+                           idClass.writeXML(hIdentifier, outContext)
                         end
                      end
                      if aIds.empty? && @hResponseObj[:writerShowTags]
@@ -117,17 +121,23 @@ module ADIWG
                      # 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
+                     # check for duplicates and eliminate
+                     aRoleParty = []
                      aRParties = hCitation[:responsibleParties]
                      aRParties.each do |hRParty|
                         role = hRParty[:roleName]
                         aParties = hRParty[:parties]
                         aParties.each do |hParty|
-                           @xml.tag!('gmd:citedResponsibleParty') do
-                              rPartyClass.writeXML(role, hParty)
-                           end
+                           aRoleParty << {role: role, hParty: hParty}
+                        end
+                     end
+                     aRoleParty.uniq!
+                     aRoleParty.each do |hRoleParty|
+                        @xml.tag!('gmd:citedResponsibleParty') do
+                           rPartyClass.writeXML(hRoleParty[:role], hRoleParty[:hParty], outContext)
                         end
                      end
-                     if aRParties.empty? && @hResponseObj[:writerShowTags]
+                     if aRoleParty.empty? && @hResponseObj[:writerShowTags]
                         @xml.tag!('gmd:citedResponsibleParty')
                      end
 

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

@@ -2,14 +2,14 @@
 # 19115-2 writer output in XML
 
 # History:
-#   Stan Smith 2016-11-17 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-08 modify require statements to function in RubyGem structure
-#   Stan Smith 2014-05-16 added method to return contact from array
-#   Stan Smith 2014-05-14 modified for JSON schema version 0.4.0
+#  Stan Smith 2016-11-17 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-08 modify require statements to function in RubyGem structure
+#  Stan Smith 2014-05-16 added method to return contact from array
+#  Stan Smith 2014-05-14 modified for JSON schema version 0.4.0
 # 	Stan Smith 2013-08-12 original script
 
 require_relative 'class_phone'
@@ -17,87 +17,92 @@ require_relative 'class_address'
 require_relative 'class_onlineResource'
 
 module ADIWG
-    module Mdtranslator
-        module Writers
-            module Iso19115_2
-
-                class CI_Contact
-
-                    def initialize(xml, hResponseObj)
-                        @xml = xml
-                        @hResponseObj = hResponseObj
-                    end
-
-                    def writeXML(hContact)
-
-                        # classes used
-                        phoneClass = CI_Telephone.new(@xml, @hResponseObj)
-                        addClass = CI_Address.new(@xml, @hResponseObj)
-                        resourceClass = CI_OnlineResource.new(@xml, @hResponseObj)
-
-                        @xml.tag!('gmd:CI_Contact') do
-
-                            # contact - phones [] (pass all phones)
-                            aPhones = hContact[:phones]
-                            unless aPhones.empty?
-                                @xml.tag!('gmd:phone') do
-                                    phoneClass.writeXML(aPhones)
-                                end
-                            end
-                            if aPhones.empty? && @hResponseObj[:writerShowTags]
-                                @xml.tag!('gmd:phone')
-                            end
-
-                            # contact - address [0]
-                            hAddress = hContact[:addresses][0]
-                            aEmail = hContact[:eMailList]
-                            unless hAddress.nil? && aEmail.empty?
-                                @xml.tag!('gmd:address') do
-                                    addClass.writeXML(hAddress, aEmail)
-                                end
-                            end
-                            if hAddress.nil? && hContact[:eMailList].empty? && @hResponseObj[:writerShowTags]
-                                @xml.tag!('gmd:address')
-                            end
-
-                            # contact - online resource [0]
-                            hOlResource = hContact[:onlineResources][0]
-                            unless hOlResource.nil?
-                                @xml.tag!('gmd:onlineResource') do
-                                    resourceClass.writeXML(hOlResource)
-                                end
-                            end
-                            if hOlResource.nil? && @hResponseObj[:writerShowTags]
-                                @xml.tag!('gmd:onlineResource')
-                            end
-
-                            # contact - hours of service [0]
-                            s = hContact[:hoursOfService][0]
-                            unless s.nil?
-                                @xml.tag!('gmd:hoursOfService') do
-                                    @xml.tag!('gco:CharacterString', s)
-                                end
-                            end
-                            if s.nil? && @hResponseObj[:writerShowTags]
-                                @xml.tag!('gmd:hoursOfService')
-                            end
-
-                            # contact - contact instructions
-                            s = hContact[:contactInstructions]
-                            unless s.nil?
-                                @xml.tag!('gmd:contactInstructions') do
-                                    @xml.tag!('gco:CharacterString', hContact[:contactInstructions])
-                                end
-                            end
-                            if s.nil? && @hResponseObj[:writerShowTags]
-                                @xml.tag!('gmd:contactInstructions')
-                            end
-
-                        end # CI_Contact tag
-                    end # write XML
-                end # CI_Contact class
-
-            end
-        end
-    end
+   module Mdtranslator
+      module Writers
+         module Iso19115_2
+
+            class CI_Contact
+
+               def initialize(xml, hResponseObj)
+                  @xml = xml
+                  @hResponseObj = hResponseObj
+               end
+
+               def writeXML(hContact)
+
+                  # classes used
+                  phoneClass = CI_Telephone.new(@xml, @hResponseObj)
+                  addClass = CI_Address.new(@xml, @hResponseObj)
+                  resourceClass = CI_OnlineResource.new(@xml, @hResponseObj)
+
+                  # outContext
+                  outContext = 'contact information'
+                  outContext +=  ' ' + hContact[:name] unless hContact[:name].nil?
+                  outContext += ' (' + hContact[:contactId] + ')' unless hContact[:contactId].nil?
+
+                  @xml.tag!('gmd:CI_Contact') do
+
+                     # contact - phones [] (pass all phones)
+                     aPhones = hContact[:phones]
+                     unless aPhones.empty?
+                        @xml.tag!('gmd:phone') do
+                           phoneClass.writeXML(aPhones)
+                        end
+                     end
+                     if aPhones.empty? && @hResponseObj[:writerShowTags]
+                        @xml.tag!('gmd:phone')
+                     end
+
+                     # contact - address [0]
+                     hAddress = hContact[:addresses][0]
+                     aEmail = hContact[:eMailList]
+                     unless hAddress.nil? && aEmail.empty?
+                        @xml.tag!('gmd:address') do
+                           addClass.writeXML(hAddress, aEmail)
+                        end
+                     end
+                     if hAddress.nil? && hContact[:eMailList].empty? && @hResponseObj[:writerShowTags]
+                        @xml.tag!('gmd:address')
+                     end
+
+                     # contact - online resource [0]
+                     hOlResource = hContact[:onlineResources][0]
+                     unless hOlResource.nil?
+                        @xml.tag!('gmd:onlineResource') do
+                           resourceClass.writeXML(hOlResource, outContext)
+                        end
+                     end
+                     if hOlResource.nil? && @hResponseObj[:writerShowTags]
+                        @xml.tag!('gmd:onlineResource')
+                     end
+
+                     # contact - hours of service [0]
+                     s = hContact[:hoursOfService][0]
+                     unless s.nil?
+                        @xml.tag!('gmd:hoursOfService') do
+                           @xml.tag!('gco:CharacterString', s)
+                        end
+                     end
+                     if s.nil? && @hResponseObj[:writerShowTags]
+                        @xml.tag!('gmd:hoursOfService')
+                     end
+
+                     # contact - contact instructions
+                     s = hContact[:contactInstructions]
+                     unless s.nil?
+                        @xml.tag!('gmd:contactInstructions') do
+                           @xml.tag!('gco:CharacterString', hContact[:contactInstructions])
+                        end
+                     end
+                     if s.nil? && @hResponseObj[:writerShowTags]
+                        @xml.tag!('gmd:contactInstructions')
+                     end
+
+                  end # CI_Contact tag
+               end # write XML
+            end # CI_Contact class
+
+         end
+      end
+   end
 end