adiwg-mdtranslator 1.4.0 → 2.0.0rc2

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

@@ -1,15 +1,16 @@
 # ISO <<Class>> CI_Address
-# writer output in XML
+# 19110 writer output in XML
 
 # History:
-# 	Stan Smith 2013-08-09 original script
-#   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
-#   Stan Smith 2014-12-22 added return if passed nil address objects
+#   Stan Smith 2016-11-18 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-23 refactored to drop physical address elements if no
 #                     ... deliveryPoints are provided
-#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
-#   Stan Smith 2015-07-14 refactored to make iso19110 independent of iso19115_2 classes
-#   Stan Smith 2015-07-14 refactored to eliminate namespace globals $WriterNS and $IsoNS
+#   Stan Smith 2014-12-22 added return if passed nil address objects
+#   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+# 	Stan Smith 2013-08-09 original script
 
 module ADIWG
     module Mdtranslator
@@ -18,97 +19,91 @@ module ADIWG
 
                 class CI_Address
 
-                    def initialize(xml, responseObj)
+                    def initialize(xml, hResponseObj)
                         @xml = xml
-                        @responseObj = responseObj
+                        @hResponseObj = hResponseObj
                     end
 
-                    def writeXML(hAddress)
-
-                        return if hAddress.nil?
+                    def writeXML(hAddress, aEmail)
 
-                        deliveryPoints = hAddress[:deliveryPoints].length
-                        eMails = hAddress[:eMailList].length
+                        @xml.tag!('gmd:CI_Address') do
 
-                        if deliveryPoints + eMails > 0
-                            @xml.tag!('gmd:CI_Address') do
+                            unless hAddress.nil?
 
-                                # physical address
-                                # ... if no delivery points are provided ignore rest
-                                # ... of physical address items
-                                if deliveryPoints > 0
+                                # address - address type (not used by ISO 19115-2)
 
-                                    # address - delivery points (address lines)
-                                    aDeliveryPoints = hAddress[:deliveryPoints]
-                                    aDeliveryPoints.each do |myPoint|
-                                        @xml.tag!('gmd:deliveryPoint') do
-                                            @xml.tag!('gco:CharacterString', myPoint)
-                                        end
-                                    end
+                                # address - description (not used by ISO 19115-2)
 
-                                    # address - city
-                                    s = hAddress[:city]
-                                    if !s.nil?
-                                        @xml.tag!('gmd:city') do
-                                            @xml.tag!('gco:CharacterString', s)
-                                        end
-                                    elsif @responseObj[:writerShowTags]
-                                        @xml.tag!('gmd:city')
+                                # address - delivery points []
+                                aDeliveryPoints = hAddress[:deliveryPoints]
+                                aDeliveryPoints.each do |myPoint|
+                                    @xml.tag!('gmd:deliveryPoint') do
+                                        @xml.tag!('gco:CharacterString', myPoint)
                                     end
+                                end
+                                if aDeliveryPoints.empty? && @hResponseObj[:writerShowTags]
+                                    @xml.tag!('gmd:deliveryPoint')
+                                end
 
-                                    # address - admin area (state)
-                                    s = hAddress[:adminArea]
-                                    if !s.nil?
-                                        @xml.tag!('gmd:administrativeArea') do
-                                            @xml.tag!('gco:CharacterString', s)
-                                        end
-                                    elsif @responseObj[:writerShowTags]
-                                        @xml.tag!('gmd:administrativeArea')
+                                # address - city
+                                s = hAddress[:city]
+                                unless s.nil?
+                                    @xml.tag!('gmd:city') do
+                                        @xml.tag!('gco:CharacterString', s)
                                     end
+                                end
+                                if s.nil? && @hResponseObj[:writerShowTags]
+                                    @xml.tag!('gmd:city')
+                                end
 
-                                    # address - postal code
-                                    s = hAddress[:postalCode]
-                                    if !s.nil?
-                                        @xml.tag!('gmd:postalCode') do
-                                            @xml.tag!('gco:CharacterString', s)
-                                        end
-                                    elsif @responseObj[:writerShowTags]
-                                        @xml.tag!('gmd:postalCode')
+                                # address - administrative area
+                                s = hAddress[:adminArea]
+                                unless s.nil?
+                                    @xml.tag!('gmd:administrativeArea') do
+                                        @xml.tag!('gco:CharacterString', s)
                                     end
+                                end
+                                if s.nil? && @hResponseObj[:writerShowTags]
+                                    @xml.tag!('gmd:administrativeArea')
+                                end
 
-                                    # address - country
-                                    s = hAddress[:country]
-                                    if !s.nil?
-                                        @xml.tag!('gmd:country') do
-                                            @xml.tag!('gco:CharacterString', s)
-                                        end
-                                    elsif @responseObj[:writerShowTags]
-                                        @xml.tag!('gmd:country')
+                                # address - postal code
+                                s = hAddress[:postalCode]
+                                unless s.nil?
+                                    @xml.tag!('gmd:postalCode') do
+                                        @xml.tag!('gco:CharacterString', s)
                                     end
-
-                                elsif @responseObj[:writerShowTags]
-                                    @xml.tag!('gmd:deliveryPoint')
-                                    @xml.tag!('gmd:city')
-                                    @xml.tag!('gmd:administrativeArea')
+                                end
+                                if s.nil? && @hResponseObj[:writerShowTags]
                                     @xml.tag!('gmd:postalCode')
-                                    @xml.tag!('gmd:country')
                                 end
 
-                                # address - email addresses
-                                if eMails > 0
-                                    hAddress[:eMailList].each do |myEmail|
-                                        @xml.tag!('gmd:electronicMailAddress') do
-                                            @xml.tag!('gco:CharacterString', myEmail)
-                                        end
+                                # address - country
+                                s = hAddress[:country]
+                                unless s.nil?
+                                    @xml.tag!('gmd:country') do
+                                        @xml.tag!('gco:CharacterString', s)
                                     end
-                                elsif @responseObj[:writerShowTags]
-                                    @xml.tag!('gmd:electronicMailAddress')
                                 end
+                                if s.nil? && @hResponseObj[:writerShowTags]
+                                    @xml.tag!('gmd:country')
+                                end
+
+                            end
 
+                            # address - email addresses []
+                            aEmail.each do |myEmail|
+                                @xml.tag!('gmd:electronicMailAddress') do
+                                    @xml.tag!('gco:CharacterString', myEmail)
+                                end
                             end
-                        end
+                            if aEmail.empty? && @hResponseObj[:writerShowTags]
+                                @xml.tag!('gmd:electronicMailAddress')
+                            end
+
+                        end # CI_Address tag
                     end # writeXML
-                end # CI_Address
+                end # CI_Address class
 
             end
         end

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

@@ -17,14 +17,14 @@ module ADIWG
 
                     def initialize(xml, responseObj)
                         @xml = xml
-                        @responseObj = responseObj
+                        @hResponseObj = responseObj
                     end
 
                     def writeXML(hBase)
 
                         # create and identity for the unit
-                        @responseObj[:writerMissingIdCount] = @responseObj[:writerMissingIdCount].succ
-                        unitID = 'unit' + @responseObj[:writerMissingIdCount]
+                        @hResponseObj[:writerMissingIdCount] = @hResponseObj[:writerMissingIdCount].succ
+                        unitID = 'unit' + @hResponseObj[:writerMissingIdCount]
                         @xml.tag!('gml:BaseUnit', {'gml:id' => unitID}) do
                             @xml.tag!('gml:identifier', {'codeSpace' => hBase[:codeSpace]}, hBase[:identifier])
                             @xml.tag!('gml:name', hBase[:name])

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

@@ -2,14 +2,15 @@
 
 # from http://mdtranslator.adiwg.org/api/codelists?format=xml
 # History:
-# 	Stan Smith 2013-08-09 original script
-#   Stan Smith 2014-10-15 allow non-ISO codesNames to be rendered
-#   Stan Smith 2014-12-12 refactored to handle namespacing readers and writers
-#   Stan Smith 2014-12-15 replaced NOAA CT_CodelistCatalogue with mdTranslator CT_CodelistCatalogue
-#   Stan Smith 2015-06-11 refactored to use mdCodes gem for codelist contents
-#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
-#   Stan Smith 2015-07-14 refactored to make iso19110 independent of iso19115_2 classes
+#   Stan Smith 2016-11-19 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 refactored to use mdCodes gem for codelist contents
+#   Stan Smith 2014-12-15 replaced NOAA CT_CodelistCatalogue with mdTranslator CT_CodelistCatalogue
+#   Stan Smith 2014-12-12 refactored to handle namespacing readers and writers
+#   Stan Smith 2014-10-15 allow non-ISO codesNames to be rendered
+# 	Stan Smith 2013-08-09 original script
 
 require 'adiwg-mdcodes'
 
@@ -20,19 +21,19 @@ module ADIWG
 
                 class MD_Codelist
 
-                    def initialize(xml, responseObj)
+                    def initialize(xml, hResponseObj)
                         @xml = xml
-                        @responseObj = responseObj
+                        @hResponseObj = hResponseObj
                     end
 
-                    def writeXML(codeList, codeName)
+                    def writeXML(codeSpace, codeList, codeName)
 
                         # get requested codelist from the adiwg-mdcodes gem
-                        mdCodelist = ADIWG::Mdcodes.getCodelistDetail(codeList, @responseObj)
+                        mdCodelist = ADIWG::Mdcodes.getCodelistDetail(codeList, @hResponseObj)
 
                         sourceName = mdCodelist['sourceName']
                         codelist = mdCodelist['codelist']
-                        codeId = 'user-provided-code'
+                        codeId = 'userCode'
 
                         # search the codelist for a matching codeName
                         codelist.each do |code|
@@ -43,7 +44,7 @@ module ADIWG
                         end
 
                         # generate the iso code block
-                        @xml.tag!('gmd:' + "#{sourceName}", {:codeList => 'http://mdtranslator.adiwg.org/api/codelists?format=xml#' + "#{sourceName}",
+                        @xml.tag!(codeSpace + ':' + "#{sourceName}", {:codeList => 'http://mdtranslator.adiwg.org/api/codelists?format=xml#' + "#{sourceName}",
                                                        :codeListValue => "#{codeName}",
                                                        :codeSpace => "#{codeId}"})
                     end

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

@@ -1,17 +1,18 @@
 # ISO <<Class>> CI_Contact
-# writer output in XML
+# 19110 writer output in XML
 
 # History:
-# 	Stan Smith 2013-08-12 original script
-#   Stan Smith 2014-05-14 modified for JSON schema version 0.4.0
-#   Stan Smith 2014-05-16 added method to return contact from array
-#   Stan Smith 2014-07-08 modify require statements to function in RubyGem structure
-#   Stan Smith 2014-12-12 refactored to handle namespacing readers and writers
-#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
-#   Stan Smith 2015-07-14 refactored to make iso19110 independent of iso19115_2 classes
+#   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-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_telephone'
+require_relative 'class_phone'
 require_relative 'class_address'
 require_relative 'class_onlineResource'
 
@@ -22,64 +23,79 @@ module ADIWG
 
                 class CI_Contact
 
-                    def initialize(xml, responseObj)
+                    def initialize(xml, hResponseObj)
                         @xml = xml
-                        @responseObj = responseObj
+                        @hResponseObj = hResponseObj
                     end
 
                     def writeXML(hContact)
 
                         # classes used
-                        pBookClass = CI_Telephone.new(@xml, @responseObj)
-                        addClass = CI_Address.new(@xml, @responseObj)
-                        resourceClass = CI_OnlineResource.new(@xml, @responseObj)
+                        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 - phone list - all services
+                            # contact - phones [] (pass all phones)
                             aPhones = hContact[:phones]
-                            if !aPhones.empty?
+                            unless aPhones.empty?
                                 @xml.tag!('gmd:phone') do
-                                    pBookClass.writeXML(aPhones)
+                                    phoneClass.writeXML(aPhones)
                                 end
-                            elsif @responseObj[:writerShowTags]
+                            end
+                            if aPhones.empty? && @hResponseObj[:writerShowTags]
                                 @xml.tag!('gmd:phone')
                             end
 
-                            # contact - address
-                            hAddress = hContact[:address]
-                            if !hAddress.empty?
+                            # contact - address [0]
+                            hAddress = hContact[:addresses][0]
+                            aEmail = hContact[:eMailList]
+                            unless hAddress.nil? && aEmail.empty?
                                 @xml.tag!('gmd:address') do
-                                    addClass.writeXML(hAddress)
+                                    addClass.writeXML(hAddress, aEmail)
                                 end
-                            elsif @responseObj[:writerShowTags]
+                            end
+                            if hAddress.nil? && hContact[:eMailList].empty? && @hResponseObj[:writerShowTags]
                                 @xml.tag!('gmd:address')
                             end
 
-                            # contact - online resource
-                            aResource = hContact[:onlineRes]
-                            if !aResource.empty?
+                            # contact - online resource [0]
+                            hOlResource = hContact[:onlineResources][0]
+                            unless hOlResource.nil?
                                 @xml.tag!('gmd:onlineResource') do
-                                    resourceClass.writeXML(aResource[0])
+                                    resourceClass.writeXML(hOlResource)
                                 end
-                            elsif @responseObj[:writerShowTags]
+                            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]
-                            if !s.nil?
+                            unless s.nil?
                                 @xml.tag!('gmd:contactInstructions') do
                                     @xml.tag!('gco:CharacterString', hContact[:contactInstructions])
                                 end
-                            elsif @responseObj[:writerShowTags]
+                            end
+                            if s.nil? && @hResponseObj[:writerShowTags]
                                 @xml.tag!('gmd:contactInstructions')
                             end
 
-                        end
-                    end
-
-                end
+                        end # CI_Contact tag
+                    end # write XML
+                end # CI_Contact class
 
             end
         end

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

@@ -17,14 +17,14 @@ module ADIWG
 
                     def initialize(xml, responseObj)
                         @xml = xml
-                        @responseObj = responseObj
+                        @hResponseObj = responseObj
                     end
 
                     def writeXML(hConv)
 
                         # create and identity for the unit
-                        @responseObj[:writerMissingIdCount] = @responseObj[:writerMissingIdCount].succ
-                        unitID = 'unit' + @responseObj[:writerMissingIdCount]
+                        @hResponseObj[:writerMissingIdCount] = @hResponseObj[:writerMissingIdCount].succ
+                        unitID = 'unit' + @hResponseObj[:writerMissingIdCount]
 
                         @xml.tag!('gml:ConventionalUnit', {'gml:id' => unitID}) do
                             @xml.tag!('gml:identifier', {'codeSpace' => hConv[:codeSpace]}, hConv[:identifier])

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

@@ -17,14 +17,14 @@ module ADIWG
 
                     def initialize(xml, responseObj)
                         @xml = xml
-                        @responseObj = responseObj
+                        @hResponseObj = responseObj
                     end
 
                     def writeXML(unit)
 
                         # create an identity for the unit
-                        @responseObj[:writerMissingIdCount] = @responseObj[:writerMissingIdCount].succ
-                        unitID = 'unit' + @responseObj[:writerMissingIdCount]
+                        @hResponseObj[:writerMissingIdCount] = @hResponseObj[:writerMissingIdCount].succ
+                        unitID = 'unit' + @hResponseObj[:writerMissingIdCount]
                         @xml.tag!('gml:UnitDefinition', {'gml:id' => unitID}) do
                             @xml.tag!('gml:identifier', {'codeSpace' => ''}, unit)
                         end

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

@@ -17,14 +17,14 @@ module ADIWG
 
                     def initialize(xml, responseObj)
                         @xml = xml
-                        @responseObj = responseObj
+                        @hResponseObj = responseObj
                     end
 
                     def writeXML(hDerived)
 
                         # create and identity for the unit
-                        @responseObj[:writerMissingIdCount] = @responseObj[:writerMissingIdCount].succ
-                        unitID = 'unit' + @responseObj[:writerMissingIdCount]
+                        @hResponseObj[:writerMissingIdCount] = @hResponseObj[:writerMissingIdCount].succ
+                        unitID = 'unit' + @hResponseObj[:writerMissingIdCount]
                         @xml.tag!('gml:DerivedUnit', {'gml:id' => unitID}) do
                             @xml.tag!('gml:identifier', {'codeSpace' => hDerived[:codeSpace]}, hDerived[:identifier])
                             @xml.tag!('gml:name', hDerived[:name])