adiwg-mdtranslator 1.2.1 → 1.3.0

data/lib/adiwg/mdtranslator/writers/iso19110/iso19110_writer.rb

@@ -4,54 +4,74 @@
 # 	Stan Smith 2014-12-01 original script
 #   Stan Smith 2014-12-12 refactored to handle namespacing readers and writers
 #   Stan Smith 2015-03-02 added test and return for missing data dictionary
-
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '../iso/units'))
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '../iso/codelists'))
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '../iso/classes'))
+#   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
 
 require 'builder'
 require 'date'
 require 'uuidtools'
-require 'adiwg/mdtranslator/writers/iso19110/class_FCfeatureCatalogue'
+require_relative 'version'
+require_relative 'class_FCfeatureCatalogue'
 
 module ADIWG
     module Mdtranslator
         module Writers
             module Iso19110
 
-                def self.startWriter(intObj)
+                def self.startWriter(intObj, responseObj, paramsObj)
 
-                    # reset ISO id='' counter
-                    $idCount = '_000'
+                    # make internal object available to writer methods in this namespace
+                    @intObj = intObj
 
                     # set the format of the output file based on the writer specified
-                    $response[:writerFormat] = 'xml'
-                    $response[:writerVersion] = ADIWG::Mdtranslator::VERSION
+                    responseObj[:writerFormat] = 'xml'
+                    responseObj[:writerVersion] = ADIWG::Mdtranslator::Writers::Iso19110::VERSION
 
                     # test for a valid dataDictionary object in the internal object
                     aDictionaries = intObj[:dataDictionary]
                     if aDictionaries.length == 0
-                        $response[:writerMessages] << 'Writer Failed - see following message(s):\n'
-                        $response[:writerMessages] << 'No data dictionary was loaded from the input file'
-                        $response[:writerPass] = false
+                        responseObj[:writerMessages] << 'Writer Failed - see following message(s):\n'
+                        responseObj[:writerMessages] << 'No data dictionary was loaded from the input file'
+                        responseObj[:writerPass] = false
                         return
                     end
 
                     # create new XML document
                     xml = Builder::XmlMarkup.new(indent: 3)
-                    metadataWriter = $WriterNS::FC_FeatureCatalogue.new(xml)
+                    metadataWriter = FC_FeatureCatalogue.new(xml, responseObj)
                     metadata = metadataWriter.writeXML(intObj)
 
                     # set writer pass to true if no writer modules set it to false
                     # false or warning will be set by code that places the message
                     # load metadata into $response
-                    if $response[:writerPass].nil?
-                        $response[:writerPass] = true
+                    if responseObj[:writerPass].nil?
+                        responseObj[:writerPass] = true
                     end
 
                     return metadata
                 end
 
+                # find contact in contact array and return the contact hash
+                def self.getContact(contactID)
+                    @intObj[:contacts].each do |hContact|
+                        if hContact[:contactId] == contactID
+                            return hContact
+                        end
+                    end
+                    return {}
+                end
+
+                # find domain in domain array and return the domain hash
+                def self.getDomain(domainID)
+                    @intObj[:dataDictionary][0][:domains].each do |hDomain|
+                        if hDomain[:domainId] == domainID
+                            return hDomain
+                        end
+                    end
+                    return {}
+                end
+
             end
         end
     end

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

@@ -0,0 +1,14 @@
+# mdJson version history
+
+module ADIWG
+    module Mdtranslator
+        module Writers
+            module Iso19110
+
+                # current version of iso19110 writer
+                VERSION = '1.0.1'
+
+            end
+        end
+    end
+end

data/lib/adiwg/mdtranslator/writers/iso19115_2/class_MImetadata.rb

@@ -1,5 +1,5 @@
 # ISO 19115-2 <<Class>> MI_Metadata
-# writer output in XML
+# writer output in XML.
 
 # History:
 # 	Stan Smith 2013-08-09 original script
@@ -26,16 +26,24 @@
 #   Stan Smith 2014-12-29 set builder object '@xml' into string 'metadata'
 #   Stan Smith 2015-06-11 change all codelists to use 'class_codelist' method
 #   Stan Smith 2015-06-12 added support for user to specify metadataCharacterSet
-
-require 'class_codelist'
-require 'class_responsibleParty'
-require 'class_metadataExtension'
-require 'class_dataIdentification'
-require 'class_distribution'
-require 'class_dataQuality'
-require 'class_maintenanceInformation'
-require 'class_referenceSystem'
-require 'module_dateTimeFun'
+#   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 2015-07-28 added support for PT_Locale
+#   Stan Smith 2015-07-30 added support for grid information
+#   Stan Smith 2015-08-27 added support for content information
+
+require_relative 'classes/class_codelist'
+require_relative 'classes/class_responsibleParty'
+require_relative 'classes/class_metadataExtension'
+require_relative 'classes/class_dataIdentification'
+require_relative 'classes/class_distribution'
+require_relative 'classes/class_dataQuality'
+require_relative 'classes/class_maintenanceInformation'
+require_relative 'classes/class_referenceSystem'
+require_relative 'classes/class_locale'
+require_relative 'classes/class_gridInfo'
+require_relative 'classes/class_contentInfo'
 
 module ADIWG
     module Mdtranslator
@@ -44,36 +52,39 @@ module ADIWG
 
                 class MI_Metadata
 
-                    def initialize(xml)
+                    def initialize(xml, responseObj)
                         @xml = xml
+                        @responseObj = responseObj
                     end
 
-                    def writeXML(internalObj)
-                        $IsoNS = ADIWG::Mdtranslator::Writers::Iso
+                    def writeXML(intObj)
 
                         # classes used
-                        codelistClass = $IsoNS::MD_Codelist.new(@xml)
-                        rPartyClass = $IsoNS::CI_ResponsibleParty.new(@xml)
-                        mdExtClass = $IsoNS::MD_MetadataExtensionInformation.new(@xml)
-                        dataIdClass = $IsoNS::MD_DataIdentification.new(@xml)
-                        distClass = $IsoNS::MD_Distribution.new(@xml)
-                        dqClass = $IsoNS::DQ_DataQuality.new(@xml)
-                        metaMaintClass = $IsoNS::MD_MaintenanceInformation.new(@xml)
-                        refSysClass = $IsoNS::MD_ReferenceSystem.new(@xml)
-
-                        intMetadata = internalObj[:metadata]
+                        codelistClass = MD_Codelist.new(@xml, @responseObj)
+                        rPartyClass = CI_ResponsibleParty.new(@xml, @responseObj)
+                        mdExtClass = MD_MetadataExtensionInformation.new(@xml, @responseObj)
+                        dataIdClass = MD_DataIdentification.new(@xml, @responseObj)
+                        distClass = MD_Distribution.new(@xml, @responseObj)
+                        dqClass = DQ_DataQuality.new(@xml, @responseObj)
+                        metaMaintClass = MD_MaintenanceInformation.new(@xml, @responseObj)
+                        refSysClass = MD_ReferenceSystem.new(@xml, @responseObj)
+                        localeClass = PT_Locale.new(@xml, @responseObj)
+                        gridClass = MD_GridInfo.new(@xml, @responseObj)
+                        contentClass = ContentInfo.new(@xml, @responseObj)
+
+                        intMetadata = intObj[:metadata]
                         hMetaInfo = intMetadata[:metadataInfo]
                         hResInfo = intMetadata[:resourceInfo]
                         aAssocRes = intMetadata[:associatedResources]
-                        $intContactList = internalObj[:contacts]
 
                         # document head
                         metadata = @xml.instruct! :xml, encoding: 'UTF-8'
                         @xml.comment!('core gmi based instance document ISO 19115-2')
-                        @xml.comment!('metadata file constructed using mdTranslator')
-                        @xml.comment!('mdTranslator software is an open-source project sponsored by the Alaska Data Integration working group (ADIwg)')
-                        @xml.comment!('Alaska Data Integration working group is not responsible for the metadata content')
+                        @xml.comment!('metadata file constructed using ADIwg mdTranslator')
+                        @xml.comment!('mdTranslator software is an open-source project of the Alaska Data Integration working group (ADIwg)')
+                        @xml.comment!('Alaska Data Integration working group is not responsible for the content of this metadata record')
                         @xml.comment!('mdTranslator and other metadata tools available at https://github.com/adiwg')
+                        @xml.comment!('metadata record generated ' + Time.now.to_s)
                         @xml.tag!('gmi:MI_Metadata', {'xmlns:gmi' => 'http://www.isotc211.org/2005/gmi',
                                                       'xmlns:gmd' => 'http://www.isotc211.org/2005/gmd',
                                                       'xmlns:gco' => 'http://www.isotc211.org/2005/gco',
@@ -149,7 +160,7 @@ module ADIWG
                                 @xml.tag!('gmd:parentIdentifier') do
                                     @xml.tag!('gco:CharacterString', s)
                                 end
-                            elsif $showAllTags
+                            elsif @responseObj[:writerShowTags]
                                 @xml.tag!('gmd:parentIdentifier')
                             end
 
@@ -235,10 +246,30 @@ module ADIWG
                                 @xml.tag!('gmd:dataSetURI') do
                                     @xml.tag!('gco:CharacterString', s)
                                 end
-                            elsif $showAllTags
+                            elsif @responseObj[:writerShowTags]
                                 @xml.tag!('gmd:dataSetURI')
                             end
 
+                            # metadata information - locale
+                            if hMetaInfo
+                                if hMetaInfo[:metadataLocales]
+                                    aLocales = hMetaInfo[:metadataLocales]
+                                    aLocales.each do |hLocale|
+                                        @xml.tag!('gmd:locale') do
+                                            localeClass.writeXML(hLocale)
+                                        end
+                                    end
+                                end
+                            end
+
+                            # metadata information - grid info
+                            aGrids = hResInfo[:gridInfo]
+                            aGrids.each do |hGrid|
+                                @xml.tag!('gmd:spatialRepresentationInfo') do
+                                    gridClass.writeXML(hGrid)
+                                end
+                            end
+
                             # metadata information - reference system
                             hRefSystems = hResInfo[:spatialReferenceSystem]
                             if !hRefSystems.empty?
@@ -267,7 +298,7 @@ module ADIWG
                                     end
                                 end
 
-                            elsif $showAllTags
+                            elsif @responseObj[:writerShowTags]
                                 @xml.tag!('gmd:referenceSystemInfo')
                             end
 
@@ -286,7 +317,7 @@ module ADIWG
                                     end
                                 end
                             end
-                            if !extensions && $showAllTags
+                            if !extensions && @responseObj[:writerShowTags]
                                 @xml.tag!('gmd:metadataExtensionInfo')
                             end
 
@@ -300,8 +331,13 @@ module ADIWG
                             end
 
                             # metadata information - content info
-                            # ... information about data and link to 19110
-                            # ... on hold until 19115-1 release
+                            # ... information about data content and/or link to 19110
+                            aContentInfo = hResInfo[:coverageInfo]
+                            aContentInfo.each do |hContent|
+                                @xml.tag!('gmd:contentInfo') do
+                                    contentClass.writeXML(hContent)
+                                end
+                            end
 
                             # metadata information - distribution info []
                             aDistInfo = intMetadata[:distributorInfo]
@@ -309,7 +345,7 @@ module ADIWG
                                 @xml.tag!('gmd:distributionInfo') do
                                     distClass.writeXML(aDistInfo)
                                 end
-                            elsif $showAllTags
+                            elsif @responseObj[:writerShowTags]
                                 @xml.tag!('gmd:distributionInfo')
                             end
 
@@ -321,7 +357,7 @@ module ADIWG
                                         dqClass.writeXML(hDQInfo)
                                     end
                                 end
-                            elsif $showAllTags
+                            elsif @responseObj[:writerShowTags]
                                 @xml.tag!('gmd:dataQualityInfo')
                             end
 
@@ -338,7 +374,7 @@ module ADIWG
                                     end
                                 end
                             end
-                            if !maintInfo && $showAllTags
+                            if !maintInfo && @responseObj[:writerShowTags]
                                 @xml.tag!('gmd:metadataMaintenance')
                             end
 

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

@@ -0,0 +1,116 @@
+# ISO <<Class>> CI_Address
+# 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 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
+
+module ADIWG
+    module Mdtranslator
+        module Writers
+            module Iso19115_2
+
+                class CI_Address
+
+                    def initialize(xml, responseObj)
+                        @xml = xml
+                        @responseObj = responseObj
+                    end
+
+                    def writeXML(hAddress)
+
+                        return if hAddress.nil?
+
+                        deliveryPoints = hAddress[:deliveryPoints].length
+                        eMails = hAddress[:eMailList].length
+
+                        if deliveryPoints + eMails > 0
+                            @xml.tag!('gmd:CI_Address') do
+
+                                # physical address
+                                # ... if no delivery points are provided ignore rest
+                                # ... of physical address items
+                                if deliveryPoints > 0
+
+                                    # 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 - 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')
+                                    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')
+                                    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')
+                                    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')
+                                    end
+
+                                elsif @responseObj[:writerShowTags]
+                                    @xml.tag!('gmd:deliveryPoint')
+                                    @xml.tag!('gmd:city')
+                                    @xml.tag!('gmd:administrativeArea')
+                                    @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
+                                    end
+                                elsif @responseObj[:writerShowTags]
+                                    @xml.tag!('gmd:electronicMailAddress')
+                                end
+
+                            end
+                        end
+                    end # writeXML
+                end # CI_Address
+
+            end
+        end
+    end
+end

data/lib/adiwg/mdtranslator/writers/{iso → iso19115_2}/classes/class_aggregateInformation.rb

@@ -8,19 +8,23 @@
 #   ... rather than resourceType for 0.9.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
 
-require 'class_codelist'
-require 'class_citation'
+require_relative 'class_codelist'
+require_relative 'class_citation'
 
 module ADIWG
     module Mdtranslator
         module Writers
-            module Iso
+            module Iso19115_2
 
                 class MD_AggregateInformation
 
-                    def initialize(xml)
+                    def initialize(xml, responseObj)
                         @xml = xml
+                        @responseObj = responseObj
                     end
 
                     def writeXML(hAssocRes)
@@ -31,8 +35,8 @@ module ADIWG
                         # ... citation > identifier section
 
                         # classes used
-                        codelistClass = $IsoNS::MD_Codelist.new(@xml)
-                        citationClass = $IsoNS::CI_Citation.new(@xml)
+                        codelistClass =  MD_Codelist.new(@xml, @responseObj)
+                        citationClass =  CI_Citation.new(@xml, @responseObj)
 
                         @xml.tag!('gmd:MD_AggregateInformation') do
 
@@ -42,7 +46,7 @@ module ADIWG
                                 @xml.tag!('gmd:aggregateDataSetName') do
                                     citationClass.writeXML(hAssocCit)
                                 end
-                            elsif $showAllTags
+                            elsif @responseObj[:writerShowTags]
                                 @xml.tag!('gmd:aggregateDataSetName')
                             end
 
@@ -54,7 +58,7 @@ module ADIWG
                                 @xml.tag!('gmd:associationType') do
                                     codelistClass.writeXML('iso_associationType',s)
                                 end
-                            elsif $showAllTags
+                            elsif @responseObj[:writerShowTags]
                                 @xml.tag!('gmd:associationType')
                             end
 
@@ -64,7 +68,7 @@ module ADIWG
                                 @xml.tag!('gmd:initiativeType') do
                                     codelistClass.writeXML('iso_initiativeType',s)
                                 end
-                            elsif $showAllTags
+                            elsif @responseObj[:writerShowTags]
                                 @xml.tag!('gmd:initiativeType')
                             end