adiwg-mdtranslator 2.10.0 → 2.12.0.pre

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

@@ -2,97 +2,100 @@
 # 19110 writer output in XML
 
 # History:
-#   Stan Smith 2017-01-23 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 2015-06-11 change all codelists to use 'class_codelist' method
-#   Stan Smith 2014-12-12 refactored to handle namespacing readers and writers
-#   Stan Smith 2014-08-14 added protocol to onlineResource
-#   Stan Smith 2014-07-08 modify require statements to function in RubyGem structure
+#  Stan Smith 2018-04-02 refactored error and warning messaging
+#  Stan Smith 2017-01-23 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 2015-06-11 change all codelists to use 'class_codelist' method
+#  Stan Smith 2014-12-12 refactored to handle namespacing readers and writers
+#  Stan Smith 2014-08-14 added protocol to onlineResource
+#  Stan Smith 2014-07-08 modify require statements to function in RubyGem structure
 # 	Stan Smith 2013-08-14 original script.
 
+require_relative '../iso19110_writer'
 require_relative 'class_codelist'
 
 module ADIWG
-    module Mdtranslator
-        module Writers
-            module Iso19110
+   module Mdtranslator
+      module Writers
+         module Iso19110
 
-                class CI_OnlineResource
+            class CI_OnlineResource
 
-                    def initialize(xml, hResponseObj)
-                        @xml = xml
-                        @hResponseObj = hResponseObj
-                    end
+               def initialize(xml, hResponseObj)
+                  @xml = xml
+                  @hResponseObj = hResponseObj
+                  @NameSpace = ADIWG::Mdtranslator::Writers::Iso19110
+               end
 
-                    def writeXML(hOlResource)
+               def writeXML(hOlResource)
 
-                        # classes used
-                        codelistClass = MD_Codelist.new(@xml, @hResponseObj)
+                  # classes used
+                  codelistClass = MD_Codelist.new(@xml, @hResponseObj)
 
-                        @xml.tag! 'gmd:CI_OnlineResource' do
+                  @xml.tag! 'gmd:CI_OnlineResource' do
 
-                            # online resource - link - required
-                            s = hOlResource[:olResURI]
-                            unless s.nil?
-                                @xml.tag!('gmd:linkage') do
-                                    @xml.tag!('gmd:URL', s)
-                                end
-                            end
-                            if s.nil?
-                                @xml.tag!('gmd:linkage', {'gco:nilReason' => 'missing'})
-                            end
+                     # online resource - link (required)
+                     s = hOlResource[:olResURI]
+                     unless s.nil?
+                        @xml.tag!('gmd:linkage') do
+                           @xml.tag!('gmd:URL', s)
+                        end
+                     end
+                     if s.nil?
+                        @NameSpace.issueError(10)
+                     end
 
-                            # online resource - protocol
-                            s = hOlResource[:olResProtocol]
-                            unless s.nil?
-                                @xml.tag!('gmd:protocol') do
-                                    @xml.tag!('gco:CharacterString', s)
-                                end
-                            end
-                            if s.nil? && @hResponseObj[:writerShowTags]
-                                @xml.tag!('gmd:protocol')
-                            end
+                     # online resource - protocol
+                     s = hOlResource[:olResProtocol]
+                     unless s.nil?
+                        @xml.tag!('gmd:protocol') do
+                           @xml.tag!('gco:CharacterString', s)
+                        end
+                     end
+                     if s.nil? && @hResponseObj[:writerShowTags]
+                        @xml.tag!('gmd:protocol')
+                     end
 
-                            # online resource - link name
-                            s = hOlResource[:olResName]
-                            unless s.nil?
-                                @xml.tag!('gmd:name') do
-                                    @xml.tag!('gco:CharacterString', s)
-                                end
-                            end
-                            if s.nil? && @hResponseObj[:writerShowTags]
-                                @xml.tag!('gmd:name')
-                            end
+                     # online resource - link name
+                     s = hOlResource[:olResName]
+                     unless s.nil?
+                        @xml.tag!('gmd:name') do
+                           @xml.tag!('gco:CharacterString', s)
+                        end
+                     end
+                     if s.nil? && @hResponseObj[:writerShowTags]
+                        @xml.tag!('gmd:name')
+                     end
 
-                            # online resource - link description
-                            s = hOlResource[:olResDesc]
-                            unless s.nil?
-                                @xml.tag!('gmd:description') do
-                                    @xml.tag!('gco:CharacterString', s)
-                                end
-                            end
-                            if s.nil? && @hResponseObj[:writerShowTags]
-                                @xml.tag!('gmd:description')
-                            end
+                     # online resource - link description
+                     s = hOlResource[:olResDesc]
+                     unless s.nil?
+                        @xml.tag!('gmd:description') do
+                           @xml.tag!('gco:CharacterString', s)
+                        end
+                     end
+                     if s.nil? && @hResponseObj[:writerShowTags]
+                        @xml.tag!('gmd:description')
+                     end
 
-                            # online resource - link function {CI_OnLineFunctionCode}
-                            s = hOlResource[:olResFunction]
-                            unless s.nil?
-                                @xml.tag!('gmd:function') do
-                                    codelistClass.writeXML('gmd', 'iso_onlineFunction',s)
-                                end
-                            end
-                            if s.nil? && @hResponseObj[:writerShowTags]
-                                @xml.tag!('gmd:function')
-                            end
+                     # online resource - link function {CI_OnLineFunctionCode}
+                     s = hOlResource[:olResFunction]
+                     unless s.nil?
+                        @xml.tag!('gmd:function') do
+                           codelistClass.writeXML('gmd', 'iso_onlineFunction', s)
+                        end
+                     end
+                     if s.nil? && @hResponseObj[:writerShowTags]
+                        @xml.tag!('gmd:function')
+                     end
 
-                        end # CI_OnlineResource tag
-                    end # write XML
-                end # CI_OnlineResource class
+                  end # CI_OnlineResource tag
+               end # write XML
+            end # CI_OnlineResource class
 
-            end
-        end
-    end
+         end
+      end
+   end
 end

data/lib/adiwg/mdtranslator/writers/iso19110/classes/class_phone.rb

@@ -2,82 +2,82 @@
 # 19110 writer output in XML
 
 # History:
-#   Stan Smith 2017-01-23 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-14 reorganized for JSON schema 0.4.0
+#  Stan Smith 2017-01-23 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-14 reorganized for JSON schema 0.4.0
 # 	Stan Smith 2013-08-12 original script.
 
 module ADIWG
-    module Mdtranslator
-        module Writers
-            module Iso19110
+   module Mdtranslator
+      module Writers
+         module Iso19110
 
-                class CI_Telephone
+            class CI_Telephone
 
-                    def initialize(xml, hResponseObj)
-                        @xml = xml
-                        @hResponseObj = hResponseObj
-                    end
+               def initialize(xml, hResponseObj)
+                  @xml = xml
+                  @hResponseObj = hResponseObj
+               end
 
-                    def writeXML(aPhones)
+               def writeXML(aPhones)
 
-                        # ISO requires phones to be grouped in order (voice, fax)
-                        @xml.tag!('gmd:CI_Telephone') do
+                  # ISO requires phones to be grouped in order (voice, fax)
+                  @xml.tag!('gmd:CI_Telephone') do
 
-                            # voice phones
-                            voiceCount = 0
-                            aPhones.each do |hPhone|
-                                if hPhone[:phoneServiceTypes].empty?
-                                    hPhone[:phoneServiceTypes] << 'voice'
-                                end
-                                if hPhone[:phoneServiceTypes].include?('voice')
-                                    pName = hPhone[:phoneName]
-                                    pNumber = hPhone[:phoneNumber]
-                                    if pName.nil?
-                                        s = pNumber
-                                    else
-                                        s = pName + ': ' + pNumber
-                                    end
-                                    @xml.tag!('gmd:voice') do
-                                        @xml.tag!('gco:CharacterString', s)
-                                        voiceCount += 1
-                                    end
-                                end
-                            end
-                            if  voiceCount == 0 && @hResponseObj[:writerShowTags]
-                                @xml.tag!('gmd:voice')
-                            end
+                     # voice phones
+                     voiceCount = 0
+                     aPhones.each do |hPhone|
+                        if hPhone[:phoneServiceTypes].empty?
+                           hPhone[:phoneServiceTypes] << 'voice'
+                        end
+                        if hPhone[:phoneServiceTypes].include?('voice')
+                           pName = hPhone[:phoneName]
+                           pNumber = hPhone[:phoneNumber]
+                           if pName.nil?
+                              s = pNumber
+                           else
+                              s = pName + ': ' + pNumber
+                           end
+                           @xml.tag!('gmd:voice') do
+                              @xml.tag!('gco:CharacterString', s)
+                              voiceCount += 1
+                           end
+                        end
+                     end
+                     if voiceCount == 0 && @hResponseObj[:writerShowTags]
+                        @xml.tag!('gmd:voice')
+                     end
 
-                            # fax phones
-                            faxCount = 0
-                            aPhones.each do |hPhone|
-                                if hPhone[:phoneServiceTypes].include?('fax') ||
-                                    hPhone[:phoneServiceTypes].include?('facsimile')
-                                    pName = hPhone[:phoneName]
-                                    pNumber = hPhone[:phoneNumber]
-                                    if pName.nil?
-                                        s = pNumber
-                                    else
-                                        s = pName + ': ' + pNumber
-                                    end
-                                    @xml.tag!('gmd:facsimile') do
-                                        @xml.tag!('gco:CharacterString', s)
-                                        faxCount += 1
-                                    end
-                                end
-                            end
-                            if faxCount == 0 && @hResponseObj[:writerShowTags]
-                                @xml.tag!('gmd:facsimile')
-                            end
+                     # fax phones
+                     faxCount = 0
+                     aPhones.each do |hPhone|
+                        if hPhone[:phoneServiceTypes].include?('fax') ||
+                           hPhone[:phoneServiceTypes].include?('facsimile')
+                           pName = hPhone[:phoneName]
+                           pNumber = hPhone[:phoneNumber]
+                           if pName.nil?
+                              s = pNumber
+                           else
+                              s = pName + ': ' + pNumber
+                           end
+                           @xml.tag!('gmd:facsimile') do
+                              @xml.tag!('gco:CharacterString', s)
+                              faxCount += 1
+                           end
+                        end
+                     end
+                     if faxCount == 0 && @hResponseObj[:writerShowTags]
+                        @xml.tag!('gmd:facsimile')
+                     end
 
-                        end # CI_Telephone tag
-                    end # write XML
-                end # CI_Telephone class
+                  end # CI_Telephone tag
+               end # write XML
+            end # CI_Telephone class
 
-            end
-        end
-    end
+         end
+      end
+   end
 end

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

@@ -2,118 +2,127 @@
 # 19110 writer output in XML
 
 # History:
-#   Stan Smith 2017-01-23 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 2015-06-11 change all codelists to use 'class_codelist' method
-#   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-14 modified for JSON schema 0.4.0
+#  Stan Smith 2018-04-03 refactored error and warning messaging
+#  Stan Smith 2017-01-23 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 2015-06-11 change all codelists to use 'class_codelist' method
+#  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-14 modified for JSON schema 0.4.0
 # 	Stan Smith 2013-08-13 original script.
 
+require_relative '../iso19110_writer'
 require_relative 'class_codelist'
 require_relative 'class_contact'
 
 module ADIWG
-    module Mdtranslator
-        module Writers
-            module Iso19110
-
-                class CI_ResponsibleParty
-
-                    def initialize(xml, hResponseObj)
-                        @xml = xml
-                        @hResponseObj = hResponseObj
-                    end
-
-                    def writeXML(role, hParty)
-
-                        # classes used
-                        codelistClass = MD_Codelist.new(@xml, @hResponseObj)
-                        contactClass = CI_Contact.new(@xml, @hResponseObj)
-
-                        contactId = hParty[:contactId]
-                        hContact = ADIWG::Mdtranslator::Writers::Iso19110.getContact(contactId)
-                        unless hContact.empty?
-                            isOrg = hContact[:isOrganization]
-                            @xml.tag!('gmd:CI_ResponsibleParty') do
-
-                                # responsible party - (if individual)
-                                unless isOrg
-
-                                    # individual name
-                                    s = hContact[:name]
-                                    unless s.nil?
-                                        @xml.tag!('gmd:individualName') do
-                                            @xml.tag!('gco:CharacterString', s)
-                                        end
-                                    end
-                                    if s.nil? && @hResponseObj[:writerShowTags]
-                                        @xml.tag!('gmd:individualName')
-                                    end
-
-                                    # position name
-                                    s = hContact[:positionName]
-                                    unless s.nil?
-                                        @xml.tag!('gmd:positionName') do
-                                            @xml.tag!('gco:CharacterString', s)
-                                        end
-                                    end
-                                    if s.nil? && @hResponseObj[:writerShowTags]
-                                        @xml.tag!('gmd:positionName')
-                                    end
-
-                                end
-
-                                # responsible party - (if organization)
-                                if isOrg
-
-                                    # organization name
-                                    s = hContact[:name]
-                                    unless s.nil?
-                                        @xml.tag!('gmd:organisationName') do
-                                            @xml.tag!('gco:CharacterString', s)
-                                        end
-                                    end
-                                    if s.nil? && @hResponseObj[:writerShowTags]
-                                        @xml.tag!('gmd:organisationName')
-                                    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?
-
-                                    @xml.tag!('gmd:contactInfo') do
-                                        contactClass.writeXML(hContact)
-                                    end
-                                elsif @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)
-                                    end
-                                end
-                                if s.nil?
-                                    @xml.tag!('gmd:role', {'gco:nilReason' => 'missing'})
-                                end
-
-                            end# CI_ResponsibleParty tag
-                        end # valid contact returned
-                    end # write XML
-                end # CI_ResponsibleParty class
-
-            end
-        end
-    end
+   module Mdtranslator
+      module Writers
+         module Iso19110
+
+            class CI_ResponsibleParty
+
+               def initialize(xml, hResponseObj)
+                  @xml = xml
+                  @hResponseObj = hResponseObj
+                  @NameSpace = ADIWG::Mdtranslator::Writers::Iso19110
+               end
+
+               def writeXML(role, hParty)
+
+                  # classes used
+                  codelistClass = MD_Codelist.new(@xml, @hResponseObj)
+                  contactClass = CI_Contact.new(@xml, @hResponseObj)
+
+                  contactId = hParty[:contactId]
+                  hContact = ADIWG::Mdtranslator::Writers::Iso19110.getContact(contactId)
+                  unless hContact.empty?
+                     isOrg = hContact[:isOrganization]
+                     @xml.tag!('gmd:CI_ResponsibleParty') do
+
+                        # ISO19110 follows ISO19115-2 rules and requires either an individual
+                        # or organization name and allows for both.  Since mdJson 2+ patterns
+                        # after ISO19115-3 only one name is maintained.  So individual name
+                        # becomes required for individual and organization name for organization.
+
+                        # responsible party - (if individual)
+                        unless isOrg
+
+                           # individual name (required)
+                           s = hContact[:name]
+                           unless s.nil?
+                              @xml.tag!('gmd:individualName') do
+                                 @xml.tag!('gco:CharacterString', s)
+                              end
+                           end
+                           if s.nil?
+                              @NameSpace.issueWarning(22, 'gmd:individualName')
+                           end
+
+                           # position name
+                           s = hContact[:positionName]
+                           unless s.nil?
+                              @xml.tag!('gmd:positionName') do
+                                 @xml.tag!('gco:CharacterString', s)
+                              end
+                           end
+                           if s.nil? && @hResponseObj[:writerShowTags]
+                              @xml.tag!('gmd:positionName')
+                           end
+
+                        end
+
+                        # responsible party - (if organization)
+                        if isOrg
+
+                           # organization name (required)
+                           s = hContact[:name]
+                           unless s.nil?
+                              @xml.tag!('gmd:organisationName') do
+                                 @xml.tag!('gco:CharacterString', s)
+                              end
+                           end
+                           if s.nil?
+                              @NameSpace.issueWarning(21, 'gmd:organisationName')
+                           end
+
+                        end
+
+                        # responsible party - contact info
+                        haveInfo = false
+                        haveInfo = true unless hContact[:phones].empty?
+                        haveInfo = true unless hContact[:addresses].empty?
+                        haveInfo = true unless hContact[:eMailList].empty?
+                        haveInfo = true unless hContact[:onlineResources].empty?
+                        haveInfo = true unless hContact[:hoursOfService].empty?
+                        haveInfo = true unless hContact[:contactInstructions].nil?
+                        if haveInfo
+                           @xml.tag!('gmd:contactInfo') do
+                              contactClass.writeXML(hContact)
+                           end
+                        elsif @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)
+                           end
+                        end
+                        if s.nil?
+                           @NameSpace.issueWarning(20, 'gmd:role')
+                        end
+
+                     end # CI_ResponsibleParty tag
+                  end # valid contact returned
+               end # write XML
+            end # CI_ResponsibleParty class
+
+         end
+      end
+   end
 end