adiwg-mdtranslator 2.21.0.pre.beta.0 → 2.21.0.pre.beta.2

data/lib/adiwg/mdtranslator/writers/iso19115_3/classes/class_enumerationList.rb

@@ -0,0 +1,52 @@
+# ISO <<CodeLists>> Enumerations
+# 19115-2 writer output in XML
+
+# History:
+#  Stan Smith 2016-12-12 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 (responseObj)
+#  Stan Smith 2015-06-12 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'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Iso19115_3
+
+            class MD_EnumerationList
+
+               def initialize(xml, responseObj)
+                  @xml = xml
+                  @hResponseObj = responseObj
+               end
+
+               def writeXML(codeList, codeName)
+
+                  # get requested codelist from the adiwg-mdcodes gem
+                  mdCodelist = ADIWG::Mdcodes.getCodelistDetail(codeList)
+
+                  sourceName = mdCodelist['sourceName']
+                  codelist = mdCodelist['codelist']
+
+                  # search the codelist for a matching codeName
+                  # only valid enumeration values can be written in ISO
+                  codelist.each do |code|
+                     if code['codeName'] == codeName
+                        @xml.tag!('gmd:' + "#{sourceName}", codeName)
+                        break
+                     end
+                  end
+
+               end # writeXML
+            end # MD_EnumerationList class
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/writers/iso19115_3/classes/class_environment.rb

@@ -0,0 +1,82 @@
+module ADIWG
+    module Mdtranslator
+        module Writers
+            module Iso19115_3
+
+                class MI_EnvironmentalRecord
+                    def initialize(xml, hResponseObj)
+                        @xml = xml
+                        @hResponseObj = hResponseObj
+                    end
+
+                    def writeXML(hEnvironment)
+
+                        @xml.tag!('mac:MI_EnvironmentalRecord') do
+                            unless hEnvironment[:averageAirTemperature].nil?
+                                @xml.tag!('mac:averageAirTemperature') do
+                                    @xml.tag!('gco:Real', hEnvironment[:averageAirTemperature])
+                                end
+                            else
+                                if @hResponseObj[:writerShowTags]
+                                    @xml.tag!('mac:averageAirTemperature')
+                                end
+                            end
+
+                            unless hEnvironment[:maxRelativeHumidity].nil?
+                                @xml.tag!('mac:maxRelativeHumidity') do
+                                    @xml.tag!('gco:Real', hEnvironment[:maxRelativeHumidity])
+                                end
+                            else
+                                if @hResponseObj[:writerShowTags]
+                                    @xml.tag!('mac:maxRelativeHumidity')
+                                end
+                            end
+
+                            unless hEnvironment[:maxAltitude].nil?
+                                @xml.tag!('mac:maxAltitude') do
+                                    @xml.tag!('gco:Real', hEnvironment[:maxAltitude])
+                                end
+                            else
+                                if @hResponseObj[:writerShowTags]
+                                    @xml.tag!('mac:maxAltitude')
+                                end
+                            end
+
+                            unless hEnvironment[:meteorologicalConditions].nil?
+                                @xml.tag!('mac:meteorologicalConditions') do
+                                    @xml.tag!('gco:CharacterString', hEnvironment[:meteorologicalConditions])
+                                end
+                            else
+                                if @hResponseObj[:writerShowTags]
+                                    @xml.tag!('mac:meteorologicalConditions')
+                                end
+                            end
+
+                            unless hEnvironment[:solarAzimuth].nil?
+                                @xml.tag!('mac:solarAzimuth') do
+                                    @xml.tag!('gco:Real', hEnvironment[:solarAzimuth])
+                                end
+                            else
+                                if @hResponseObj[:writerShowTags]
+                                    @xml.tag!('mac:solarAzimuth')
+                                end
+                            end
+
+                            unless hEnvironment[:solarElevation].nil?
+                                @xml.tag!('mac:solarElevation') do
+                                    @xml.tag!('gco:Real', hEnvironment[:solarElevation])
+                                end
+                            else
+                                if @hResponseObj[:writerShowTags]
+                                    @xml.tag!('mac:solarElevation')
+                                end
+                            end
+                        end
+
+                    end
+                end
+
+            end
+        end
+    end
+end

data/lib/adiwg/mdtranslator/writers/iso19115_3/classes/class_event.rb

@@ -0,0 +1,123 @@
+require_relative 'class_identifier'
+require_relative 'class_codelist'
+require_relative 'class_gcoDateTime'
+require_relative 'class_objective'
+require_relative 'class_pass'
+require_relative 'class_instrument'
+
+module ADIWG
+    module Mdtranslator
+        module Writers
+            module Iso19115_3
+
+                class MI_Event
+                    def initialize(xml, hResponseObj)
+                        @xml = xml
+                        @hResponseObj = hResponseObj
+                    end
+
+                    def writeXML(hEvent)
+
+                        identifierClass = Identifier.new(@xml, @hResponseObj)
+                        codelistClass = MD_Codelist.new(@xml, @hResponseObj)
+                        gcoDateTimeClass = GcoDateTime.new(@xml, @hResponseObj)
+                        objectiveClass = MI_Objective.new(@xml, @hResponseObj)
+                        passClass = MI_Pass.new(@xml, @hResponseObj)
+                        instrumentClass = MI_Instrument.new(@xml, @hResponseObj)
+
+                        @xml.tag!('mac:MI_Event', id: hEvent[:eventId]) do
+
+                            unless hEvent[:identifier].empty?
+                                @xml.tag!('mac:identifier') do
+                                    identifierClass.writeXML(hEvent[:identifier])
+                                end
+                            else
+                                if @hResponseObj[:writerShowTags]
+                                    @xml.tag!('mac:identifier')
+                                end
+                            end
+
+                            unless hEvent[:trigger].nil?
+                                @xml.tag!('mac:trigger') do
+                                    codelistClass.writeXML('mac', 'iso_triggerCode', hEvent[:trigger])
+                                end
+                            else
+                                if @hResponseObj[:writerShowTags]
+                                    @xml.tag!('mac:trigger')
+                                end
+                            end
+
+                            unless hEvent[:context].nil?
+                                @xml.tag!('mac:context') do
+                                    codeListClass.writeXML('mac', 'iso_contextCode', hEvent[:context])
+                                end
+                            else
+                                if @hResponseObj[:writerShowTags]
+                                    @xml.tag!('mac:context')
+                                end
+                            end
+
+                            unless hEvent[:sequence].nil?
+                                @xml.tag!('mac:sequence') do
+                                    codelistClass.writeXML('mac', 'iso_sequenceCode', hEvent[:sequence])
+                                end
+                            else
+                                if @hResponseObj[:writerShowTags]
+                                    @xml.tag!('mac:sequence')
+                                end
+                            end
+
+                            unless hEvent[:time].nil?
+                                @xml.tag!('mac:time') do
+                                    gcoDateTimeClass.writeXML(hEvent[:time])
+                                end
+                            else
+                                if @hResponseObj[:writerShowTags]
+                                    @xml.tag!('mac:time')
+                                end
+                            end
+
+                            unless hEvent[:expectedObjectives].empty?
+                                hEvent[:expectedObjectives].each do |hObjective|
+                                    @xml.tag!('mac:expectedObjective') do
+                                        objectiveClass.writeXML(hObjective)
+                                    end
+                                end
+                            else
+                                if @hResponseObj[:writerShowTags]
+                                    @xml.tag!('mac:expectedObjective')
+                                end
+                            end
+
+                            unless hEvent[:relatedPass].empty?
+                                hEvent[:relatedPass].each do |hPass|
+                                    @xml.tag!('mac:relatedPass') do
+                                        passClass.writeXML(hPass)
+                                    end
+                                end
+                            else
+                                if @hResponseObj[:writerShowTags]
+                                    @xml.tag!('mac:relatedPass')
+                                end
+                            end
+
+                            unless hEvent[:relatedSensors].empty?
+                                hEvent[:relatedSensors].each do |hSensor|
+                                    @xml.tag!('mac:relatedInstrument') do
+                                        instrumentClass.writeXML(hSensor)
+                                    end
+                                end
+                            else
+                                if @hResponseObj[:writerShowTags]
+                                    @xml.tag!('mac:relatedInstrument')
+                                end
+                            end
+
+                        end
+                    end
+                end
+
+            end
+        end
+    end
+end

data/lib/adiwg/mdtranslator/writers/iso19115_3/classes/class_extension.rb

@@ -0,0 +1,208 @@
+# ISO <<Class>> MD_MetadataExtensionInformation
+# 19115-2 writer output in XML
+
+# History:
+#  Stan Smith 2019-03-22 replaced Enumeration class with method
+#  Stan Smith 2018-04-09 add error and warning messaging
+#  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 2013-11-22 original script.
+
+require 'adiwg/mdtranslator/internal/module_codelistFun'
+require_relative '../iso19115_3_writer'
+require_relative 'class_codelist'
+require_relative 'class_enumerationList'
+require_relative 'class_onlineResource'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Iso19115_3
+
+            class MD_MetadataExtensionInformation
+
+               def initialize(xml, hResponseObj)
+                  @xml = xml
+                  @hResponseObj = hResponseObj
+                  @NameSpace = ADIWG::Mdtranslator::Writers::Iso19115_3
+               end
+
+               def writeXML(hExtension)
+
+                  # classes used
+                  codelistClass = MD_Codelist.new(@xml, @hResponseObj)
+                  olResClass = CI_OnlineResource.new(@xml, @hResponseObj)
+
+                  outContext = 'extension information'
+                  outContext = 'extension name ' + hExtension[:name] unless hExtension[:name].nil?
+
+                  @xml.tag!('gmd:MD_MetadataExtensionInformation') do
+
+                     # metadata extension - online resource {CI_OnLineResource}
+                     hOLResource = hExtension[:onLineResource]
+                     unless hOLResource.empty?
+                        @xml.tag!('gmd:extensionOnLineResource') do
+                           olResClass.writeXML(hOLResource, outContext)
+                        end
+                     end
+                     if hOLResource.empty? && @hResponseObj[:writerShowTags]
+                        @xml.tag!('gmd:extensionOnLineResource')
+                     end
+
+                     # metadata extension = extended element information
+                     @xml.tag!('gmd:extendedElementInformation') do
+                        @xml.tag!('gmd:MD_ExtendedElementInformation') do
+
+                           # extended element info - name (required)
+                           s = hExtension[:name]
+                           unless s.nil?
+                              @xml.tag!('gmd:name') do
+                                 @xml.tag!('gco:CharacterString', s)
+                              end
+                           end
+                           if s.nil?
+                              @NameSpace.issueWarning(100, 'gmd:name')
+                           end
+
+                           # extended element info - short name
+                           s = hExtension[:shortName]
+                           unless s.nil?
+                              @xml.tag!('gmd:shortName') do
+                                 @xml.tag!('gco:CharacterString', s)
+                              end
+                           end
+                           if s.nil? && @hResponseObj[:writerShowTags]
+                              @xml.tag!('gmd:shortName')
+                           end
+
+                           # extended element info - definition (required)
+                           s = hExtension[:definition]
+                           unless s.nil?
+                              @xml.tag!('gmd:definition') do
+                                 @xml.tag!('gco:CharacterString', s)
+                              end
+                           end
+                           if s.nil?
+                              @NameSpace.issueWarning(101, 'gmd:definition', outContext)
+                           end
+
+                           # extended element info - obligation {MD_ObligationCode}
+                           obligation = hExtension[:obligation]
+                           unless obligation.nil?
+                              if CodelistFun.validateItem('iso_obligation', obligation)
+                                 @xml.tag!('gmd:obligation') do
+                                    @xml.tag!('gmd:MD_ObligationCode', obligation)
+                                 end
+                              else
+                                 @NameSpace.issueWarning(380, 'gmd:obligation', "#{obligation}")
+                              end
+                           end
+                           if obligation.nil? && @hResponseObj[:writerShowTags]
+                              @xml.tag!('gmd:obligation')
+                           end
+
+                           # extended element info - data type (required)
+                           s = hExtension[:dataType]
+                           unless s.nil?
+                              @xml.tag!('gmd:dataType') do
+                                 codelistClass.writeXML('gmd', 'iso_entityClass', s)
+                              end
+                           end
+                           if s.nil?
+                              @NameSpace.issueWarning(102, 'gmd:dataType', outContext)
+                           end
+
+                           # extended element info - maximum occurrence
+                           s = hExtension[:maxOccurrence]
+                           unless s.nil?
+                              @xml.tag!('gmd:maximumOccurrence') do
+                                 @xml.tag!('gco:CharacterString', s)
+                              end
+                           end
+                           if s.nil? && @hResponseObj[:writerShowTags]
+                              @xml.tag!('gmd:maximumOccurrence')
+                           end
+
+                           # extended element info - parent entity [] (required)
+                           aParents = hExtension[:parentEntities]
+                           aParents.each do |parent|
+                              @xml.tag!('gmd:parentEntity') do
+                                 @xml.tag!('gco:CharacterString', parent)
+                              end
+                           end
+                           if aParents.empty?
+                              @NameSpace.issueWarning(103, 'gmd:parentEntity', outContext)
+                           end
+
+                           # extended element info - rule
+                           s = hExtension[:rule]
+                           unless s.nil?
+                              @xml.tag!('gmd:rule') do
+                                 @xml.tag!('gco:CharacterString', s)
+                              end
+                           end
+                           if s.nil?
+                              @NameSpace.issueWarning(104, 'gmd:rule', outContext)
+                           end
+
+                           # extended element info - rationale []
+                           aRations = hExtension[:rationales]
+                           aRations.each do |ration|
+                              @xml.tag!('gmd:rationale') do
+                                 @xml.tag!('gco:CharacterString', ration)
+                              end
+                           end
+                           if aRations.empty? && @hResponseObj[:writerShowTags]
+                              @xml.tag!('gmd:rationale')
+                           end
+
+                           # extended element info - source [] (required)
+                           # only allowing 1 for now
+                           role = hExtension[:sourceRole]
+                           unless role.nil?
+                              @xml.tag!('gmd:source') do
+                                 @xml.tag!('gmd:CI_ResponsibleParty') do
+                                    orgName = hExtension[:sourceOrganization]
+                                    unless orgName.nil?
+                                       @xml.tag!('gmd:organisationName') do
+                                          @xml.tag!('gco:CharacterString', orgName)
+                                       end
+                                    end
+                                    uri = hExtension[:sourceURI]
+                                    unless uri.nil?
+                                       @xml.tag!('gmd:contactInfo') do
+                                          @xml.tag!('gmd:CI_Contact') do
+                                             @xml.tag!('gmd:onlineResource') do
+                                                @xml.tag!('gmd:CI_OnlineResource') do
+                                                   @xml.tag!('gmd:linkage') do
+                                                      @xml.tag!('gmd:URL', uri)
+                                                   end
+                                                end
+                                             end
+                                          end
+                                       end
+                                    end
+                                    @xml.tag!('gmd:role') do
+                                       codelistClass.writeXML('gmd', 'iso_role', role)
+                                    end
+                                 end
+                              end
+                           end
+                           if role.nil?
+                              @NameSpace.issueWarning(105, 'gmd:source', outContext)
+                           end
+
+                        end # gmd:MD_ExtendedElementInformation tag
+                     end # gmd:extendedElementInformation
+                  end # gmd:MD_MetadataExtensionInformation
+               end # writeXML
+            end # MD_MetadataExtensionInformation class
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/writers/iso19115_3/classes/class_instrument.rb

@@ -0,0 +1,92 @@
+require_relative 'class_citation'
+require_relative 'class_identifier'
+require_relative 'class_platform'
+require_relative 'class_instrumentationEventList'
+
+
+module ADIWG
+    module Mdtranslator
+        module Writers
+            module Iso19115_3
+
+                class MI_Instrument
+                    def initialize(xml, hResponseObj)
+                        @xml = xml
+                        @hResponseObj = hResponseObj
+                    end
+
+                    def writeXML(hInstrument)
+
+                        citationClass = CI_Citation.new(@xml, @hResponseObj)
+                        identifierClass = MD_Identifier.new(@xml, @hResponseObj)
+                        platformClass = MI_Platform.new(@xml, @hResponseObj)
+                        instrumentationEventListClass = MI_InstrumentationEventList.new(@xml, @hResponseObj)
+
+                        @xml.tag!('mac:MI_Instrument', id: hInstrument[:instrumentId]) do
+                            unless hInstrument[:citation].empty?
+                                @xml.tag!('mac:citation') do
+                                    citationClass.writeXML(hInstrument[:citation])
+                                end
+                            else
+                                if @hResponseObj[:writerShowTags]
+                                    @xml.tag!('mac:citation')
+                                end
+                            end
+
+                            unless hInstrument[:identifier].empty?
+                                @xml.tag!('mac:identifier') do
+                                    identifierClass.writeXML(hInstrument[:identifier])
+                                end
+                            else
+                                if @hResponseObj[:writerShowTags]
+                                    @xml.tag!('mac:identifier')
+                                end
+                            end
+
+                            unless hInstrument[:instrumentType].empty?
+                                @xml.tag!('mac:type') do
+                                    @xml.tag!('gco:CharacterString', hInstrument[:instrumentType])
+                                end
+                            else
+                                if @hResponseObj[:writerShowTags]
+                                    @xml.tag!('mac:type')
+                                end
+                            end
+
+                            unless hInstrument[:description].nil?
+                                @xml.tag!('mac:description') do
+                                    @xml.tag!('gco:CharacterString', hInstrument[:description])
+                                end
+                            else
+                                if @hResponseObj[:writerShowTags]
+                                    @xml.tag!('mac:description')
+                                end
+                            end
+
+                            unless hInstrument[:mountedOn].empty?
+                                @xml.tag!('mac:mountedOn') do
+                                    platformClass.writeXML(hInstrument[:mountedOn])
+                                end
+                            else
+                                if @hResponseObj[:writerShowTags]
+                                    @xml.tag!('mac:mountedOn')
+                                end
+                            end
+
+                            unless hInstrument[:histories].empty?
+                                @xml.tag!('mac:history') do
+                                    hInstrument[:histories].each do |history|
+                                        instrumentationEventListClass.writeXML(history)
+                                    end
+                                end
+                            end
+
+                        end
+                        
+                    end
+                end
+            end
+        end
+    end
+end
+

data/lib/adiwg/mdtranslator/writers/iso19115_3/classes/class_instrumentationEvent.rb

@@ -0,0 +1,83 @@
+require_relative 'class_citation'
+require_relative 'class_extent'
+require_relative 'class_revision'
+
+module ADIWG
+    module Mdtranslator
+        module Writers
+            module Iso19115_3
+
+                class MI_InstrumentationEvent
+                    def initialize(xml, hResponseObj)
+                        @xml = xml
+                        @hResponseObj = hResponseObj
+                    end
+
+                    def writeXML(hInstrumentationEvent)
+
+                        citationClass = CI_Citation.new(@xml, @hResponseObj)
+                        extentClass = EX_Extent.new(@xml, @hResponseObj)
+                        revisionClass = MI_Revision.new(@xml, @hResponseObj)
+                        codeListClass = MD_Codelist.new(@xml, @hResponseObj)
+
+                        @xml.tag!('mac:MI_InstrumentationEvent') do
+                            unless hInstrumentationEvent[:citations].empty?
+                                hInstrumentationEvent[:citations].each do |hCitation|
+                                    @xml.tag!('mac:citation') do
+                                        citationClass.writeXML(hCitation)
+                                    end
+                                end
+                            else
+                                if @hResponseObj[:writerShowTags]
+                                    @xml.tag!('mac:citation')
+                                end
+                            end
+
+                            unless hInstrumentationEvent[:description].nil?
+                                @xml.tag!('mac:description') do
+                                    @xml.tag!('gco:CharacterString', hInstrumentationEvent[:description])
+                                end
+                            else
+                                if @hResponseObj[:writerShowTags]
+                                    @xml.tag!('mac:description')
+                                end
+                            end
+
+                            unless hInstrumentationEvent[:extent].empty?
+                                @xml.tag!('mac:extent') do
+                                    extentClass.writeXML(hInstrumentationEvent[:extent])
+                                end
+                            else
+                                if @hResponseObj[:writerShowTags]
+                                    @xml.tag!('mac:extent')
+                                end
+                            end
+
+                            unless hInstrumentationEvent[:eventType].nil?
+                                @xml.tag!('mac:type') do
+                                    codeListClass.writeXML('mac', 'iso_eventTypeCode', hInstrumentationEvent[:eventType])
+                                end
+                            else
+                                if @hResponseObj[:writerShowTags]
+                                    @xml.tag!('mac:type')
+                                end
+                            end
+
+                            unless hInstrumentationEvent[:revisionHistories].empty?
+                                hInstrumentationEvent[:revisionHistories].each do |hRevision|
+                                    @xml.tag!('mac:revisionHistory') do
+                                        revisionClass.writeXML(hRevision)
+                                    end
+                                end
+                            else
+                                if @hResponseObj[:writerShowTags]
+                                    @xml.tag!('mac:revisionHistory')
+                                end
+                            end
+                        end
+                    end
+                end
+            end
+        end
+    end
+end