adiwg-mdtranslator 1.4.0 → 2.0.0rc2

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

@@ -1,5 +1,5 @@
 # ISO <<Class>> BaseUnit
-# writer output in XML
+# 19115-2 writer output in XML
 
 # History:
 # 	Stan Smith 2015-08-27 copied from 19110 writer
@@ -11,16 +11,16 @@ module ADIWG
 
                 class BaseUnit
 
-                    def initialize(xml, responseObj)
+                    def initialize(xml, hResponseObj)
                         @xml = xml
-                        @responseObj = responseObj
+                        @hResponseObj = hResponseObj
                     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/iso19115_2/classes/class_boundingBox.rb

@@ -0,0 +1,77 @@
+# ISO <<Class>> EX_GeographicBoundingBox
+# 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 2013-11-01 original script
+
+module ADIWG
+    module Mdtranslator
+        module Writers
+            module Iso19115_2
+
+                class EX_GeographicBoundingBox
+
+                    def initialize(xml, hResponseObj)
+                        @xml = xml
+                        @hResponseObj = hResponseObj
+                    end
+
+                    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 - 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 - 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 - 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
+
+                    end # writeXML
+                end # EX_GeographicBoundingBox class
+
+            end
+        end
+    end
+end

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

@@ -1,12 +1,13 @@
 # ISO <<Class>> MD_BrowseGraphic
-# writer output in XML
+# 19115-2 writer output in XML
 
 # History:
-# 	Stan Smith 2013-10-17 original script
-#   Stan Smith 2014-12-15 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 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
 
 module ADIWG
     module Mdtranslator
@@ -15,50 +16,51 @@ module ADIWG
 
                 class MD_BrowseGraphic
 
-                    def initialize(xml, responseObj)
+                    def initialize(xml, hResponseObj)
                         @xml = xml
-                        @responseObj = responseObj
+                        @hResponseObj = hResponseObj
                     end
 
-                    def writeXML(graphic)
+                    def writeXML(hGraphic)
 
                         @xml.tag!('gmd:MD_BrowseGraphic') do
 
-                            # browse graphic - file name - required
-                            s = graphic[:bGName]
-                            if !s.nil?
+                            # browse graphic - file name (required)
+                            s = hGraphic[:graphicName]
+                            unless s.nil?
                                 @xml.tag!('gmd:fileName') do
                                     @xml.tag!('gco:CharacterString', s)
                                 end
-                            elsif @responseObj[:writerShowTags]
-                                @xml.tag!('gmd:fileName')
+                            end
+                            if s.nil?
+                                @xml.tag!('gmd:fileName', {'gco:nilReason' => 'missing'})
                             end
 
                             # browse graphic - file description
-                            s = graphic[:bGDescription]
-                            if !s.nil?
+                            s = hGraphic[:graphicDescription]
+                            unless s.nil?
                                 @xml.tag!('gmd:fileDescription') do
                                     @xml.tag!('gco:CharacterString', s)
                                 end
-                            elsif @responseObj[:writerShowTags]
+                            end
+                            if s.nil? && @hResponseObj[:writerShowTags]
                                 @xml.tag!('gmd:fileDescription')
                             end
 
                             # browse graphic - file type
-                            s = graphic[:bGType]
-                            if !s.nil?
+                            s = hGraphic[:graphicType]
+                            unless s.nil?
                                 @xml.tag!('gmd:fileType') do
                                     @xml.tag!('gco:CharacterString', s)
                                 end
-                            elsif @responseObj[:writerShowTags]
+                            end
+                            if s.nil? && @hResponseObj[:writerShowTags]
                                 @xml.tag!('gmd:fileType')
                             end
 
-                        end
-
-                    end
-
-                end
+                        end # MD_BrowseGraphic tag
+                    end # writeXML
+                end # MD_BrowseGraphic class
 
             end
         end

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

@@ -1,26 +1,28 @@
 # ISO <<Class>> CI_Citation
-# writer output in XML
+# 19115-2 writer output in XML
 
 # History:
-# 	Stan Smith 2013-08-26 original script
-# 	Stan Smith 2013-12-30 added ISBN, ISSN
-#   Stan Smith 2014-05-16 modified for JSON schema 0.4.0
-#   Stan Smith 2014-05-16 added MD_Identifier
-#   Stan Smith 2014-05-28 modified for json schema 0.5.0
-#   Stan Smith 2014-07-08 modify require statements to function in RubyGem structure
-#   Stan Smith 2014-08-18 modify identifier section for schema 0.6.0
-#   Stan Smith 2014-08-18 process isbn and ISSN from identifier section per 0.6.0
-#   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
-#   Stan Smith 2015-06-11 change all codelists to use 'class_codelist' method
-#   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 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
+#   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-15 refactored to handle namespacing readers and writers
+#   Stan Smith 2014-08-18 process isbn and ISSN from identifier section per 0.6.0
+#   Stan Smith 2014-08-18 modify identifier section for schema 0.6.0
+#   Stan Smith 2014-07-08 modify require statements to function in RubyGem structure
+#   Stan Smith 2014-05-28 modified for json schema 0.5.0
+#   Stan Smith 2014-05-16 added MD_Identifier
+#   Stan Smith 2014-05-16 modified for JSON schema 0.4.0
+# 	Stan Smith 2013-12-30 added ISBN, ISSN
+# 	Stan Smith 2013-08-26 original script
 
 require_relative 'class_codelist'
 require_relative 'class_responsibleParty'
 require_relative 'class_date'
-require_relative 'class_identifier'
+require_relative 'class_mdIdentifier'
+require_relative 'class_series'
 
 module ADIWG
     module Mdtranslator
@@ -29,23 +31,24 @@ module ADIWG
 
                 class CI_Citation
 
-                    def initialize(xml, responseObj)
+                    def initialize(xml, hResponseObj)
                         @xml = xml
-                        @responseObj = responseObj
+                        @hResponseObj = hResponseObj
                     end
 
                     def writeXML(hCitation)
 
                         # classes used
-                        codelistClass =  MD_Codelist.new(@xml, @responseObj)
-                        rPartyClass =  CI_ResponsibleParty.new(@xml, @responseObj)
-                        dateClass =  CI_Date.new(@xml, @responseObj)
-                        idClass =  MD_Identifier.new(@xml, @responseObj)
+                        codelistClass =  MD_Codelist.new(@xml, @hResponseObj)
+                        rPartyClass =  CI_ResponsibleParty.new(@xml, @hResponseObj)
+                        dateClass =  CI_Date.new(@xml, @hResponseObj)
+                        idClass =  MD_Identifier.new(@xml, @hResponseObj)
+                        seriesClass =  CI_Series.new(@xml, @hResponseObj)
 
                         @xml.tag!('gmd:CI_Citation') do
 
-                            # citation - title - required
-                            s = hCitation[:citTitle]
+                            # citation - title (required)
+                            s = hCitation[:title]
                             if s.nil?
                                 @xml.tag!('gmd:title', {'gco:nilReason' => 'missing'})
                             else
@@ -54,129 +57,137 @@ module ADIWG
                                 end
                             end
 
-                            # citation - alternate title
-                            s = hCitation[:citAltTitle]
-                            if !s.nil?
+                            # citation - alternate title []
+                            aTitles = hCitation[:alternateTitles]
+                            aTitles.each do |title|
                                 @xml.tag!('gmd:alternateTitle') do
-                                    @xml.tag!('gco:CharacterString', s)
+                                    @xml.tag!('gco:CharacterString', title)
                                 end
-                            elsif @responseObj[:writerShowTags]
+                            end
+                            if aTitles.empty? && @hResponseObj[:writerShowTags]
                                 @xml.tag!('gmd:alternateTitle')
                             end
 
-                            # citation - date - required
-                            aDate = hCitation[:citDate]
+                            # citation - date [] (required)
+                            aDate = hCitation[:dates]
+                            aDate.each do |hDate|
+                                @xml.tag!('gmd:date') do
+                                    dateClass.writeXML(hDate)
+                                end
+                            end
                             if aDate.empty?
                                 @xml.tag!('gmd:date', {'gco:nilReason' => 'missing'})
-                            else
-                                aDate.each do |hDate|
-                                    @xml.tag!('gmd:date') do
-                                        dateClass.writeXML(hDate)
-                                    end
-                                end
                             end
 
                             # citation - edition
-                            s = hCitation[:citEdition]
-                            if !s.nil?
+                            s = hCitation[:edition]
+                            unless s.nil?
                                 @xml.tag!('gmd:edition') do
                                     @xml.tag!('gco:CharacterString', s)
                                 end
-                            elsif @responseObj[:writerShowTags]
+                            end
+                            if s.nil? && @hResponseObj[:writerShowTags]
                                 @xml.tag!('gmd:edition')
                             end
 
-                            # citation - resource identifiers - MD_Identifier
+                            # citation - resource identifier []
                             # do not process ISBN and ISSN as MD_identifier(s)
-                            # ... these are processed separately in ISO 19115-2
-                            aResIDs = hCitation[:citResourceIds]
-                            if !aResIDs.empty?
-                                aResIDs.each do |hResID|
-                                    if !hResID[:identifierType].nil?
-                                        next if hResID[:identifierType].downcase == 'isbn'
-                                        next if hResID[:identifierType].downcase == 'issn'
+                            # ... these are written separately in ISO 19115-x
+                            isbn = ''
+                            issn = ''
+                            aIds = hCitation[:identifiers]
+                            aIds.each do |hIdentifier|
+                                unless hIdentifier[:namespace].nil?
+                                    if hIdentifier[:namespace].downcase == 'isbn'
+                                        isbn = hIdentifier[:identifier]
+                                    elsif hIdentifier[:namespace].downcase == 'issn'
+                                        issn = hIdentifier[:identifier]
                                     end
+                                end
+                                if issn == ''  && isbn == ''
                                     @xml.tag!('gmd:identifier') do
-                                        idClass.writeXML(hResID)
+                                        idClass.writeXML(hIdentifier)
                                     end
                                 end
-                            elsif @responseObj[:writerShowTags]
+                            end
+                            if aIds.empty? && @hResponseObj[:writerShowTags]
                                 @xml.tag!('gmd:identifier')
                             end
 
-                            # citation - cited responsible party
-                            aResParty = hCitation[:citResponsibleParty]
-                            if !aResParty.empty?
-                                aResParty.each do |rParty|
+                            # 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
+                            aRParties = hCitation[:responsibleParties]
+                            aRParties.each do |hRParty|
+                                role = hRParty[:roleName]
+                                aParties = hRParty[:parties]
+                                aParties.each do |hParty|
                                     @xml.tag!('gmd:citedResponsibleParty') do
-                                        rPartyClass.writeXML(rParty)
+                                        rPartyClass.writeXML(role, hParty)
                                     end
                                 end
-                            elsif @responseObj[:writerShowTags]
+                            end
+                            if aRParties.empty? && @hResponseObj[:writerShowTags]
                                 @xml.tag!('gmd:citedResponsibleParty')
                             end
 
-                            # citation - presentation forms - CI_PresentationFormCode
-                            aPresForms = hCitation[:citResourceForms]
-                            if !aPresForms.empty?
-                                aPresForms.each do |presForm|
-                                    @xml.tag!('gmd:presentationForm') do
-                                        codelistClass.writeXML('iso_presentationForm',presForm)
-                                    end
+                            # citation - presentation forms [{CI_PresentationFormCode}]
+                            aPresForms = hCitation[:presentationForms]
+                            aPresForms.each do |presForm|
+                                @xml.tag!('gmd:presentationForm') do
+                                    codelistClass.writeXML('gmd', 'iso_presentationForm', presForm)
                                 end
-                            elsif @responseObj[:writerShowTags]
+                            end
+                            if aPresForms.empty? && @hResponseObj[:writerShowTags]
                                 @xml.tag!('gmd:presentationForm')
                             end
 
+                            # citation - series {CI_Series}
+                            hSeries = hCitation[:series]
+                            unless hSeries.empty?
+                                @xml.tag!('gmd:series') do
+                                    seriesClass.writeXML(hSeries)
+                                end
+                            end
+                            if hSeries.empty? && @hResponseObj[:writerShowTags]
+                                @xml.tag!('gmd:series')
+                            end
+
+                            # citation - other citation details
+                            aOther = hCitation[:otherDetails]
+                            unless aOther.empty?
+                                other = aOther[0]
+                                @xml.tag!('gmd:otherCitationDetails') do
+                                    @xml.tag!('gco:CharacterString', other)
+                                end
+                            end
+                            if aOther.empty? && @hResponseObj[:writerShowTags]
+                                @xml.tag!('gmd:otherCitationDetails')
+                            end
+
                             # citation - ISBN
-                            needTag = true
-                            aResIDs = hCitation[:citResourceIds]
-                            if !aResIDs.empty?
-                                aResIDs.each do |hResID|
-                                    if !hResID[:identifierType].nil?
-                                        if hResID[:identifierType].downcase == 'isbn'
-                                            s = hResID[:identifier]
-                                            if !s.nil?
-                                                @xml.tag!('gmd:ISBN') do
-                                                    @xml.tag!('gco:CharacterString', s)
-                                                    needTag = false
-                                                end
-                                            end
-                                        end
-                                    end
+                            unless isbn == ''
+                                @xml.tag!('gmd:ISBN') do
+                                    @xml.tag!('gco:CharacterString', isbn)
                                 end
                             end
-                            if @responseObj[:writerShowTags] && needTag
+                            if isbn == '' && @hResponseObj[:writerShowTags]
                                 @xml.tag!('gmd:ISBN')
                             end
 
                             # citation - ISSN
-                            needTag = true
-                            aResIDs = hCitation[:citResourceIds]
-                            if !aResIDs.empty?
-                                aResIDs.each do |hResID|
-                                    if !hResID[:identifierType].nil?
-                                        if hResID[:identifierType].downcase == 'issn'
-                                            s = hResID[:identifier]
-                                            if !s.nil?
-                                                @xml.tag!('gmd:ISSN') do
-                                                    @xml.tag!('gco:CharacterString', s)
-                                                    needTag = false
-                                                end
-                                            end
-                                        end
-                                    end
+                            unless issn == ''
+                                @xml.tag!('gmd:ISSN') do
+                                    @xml.tag!('gco:CharacterString', issn)
                                 end
                             end
-                            if @responseObj[:writerShowTags] && needTag
+                            if issn == '' && @hResponseObj[:writerShowTags]
                                 @xml.tag!('gmd:ISSN')
                             end
 
-                        end
-
-                    end
-
-                end
+                        end # CI_Citation tag
+                    end # writeXML
+                end # CI_Citation class
 
             end
         end

data/lib/adiwg/mdtranslator/writers/iso19115_2/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