adiwg-mdtranslator 2.6.0 → 2.6.1

data/lib/adiwg/mdtranslator/writers/fgdc/classes/class_keyword.rb

@@ -0,0 +1,99 @@
+# FGDC <<Class>> Keyword
+# FGDC CSDGM writer output in XML
+
+# History:
+#   Stan Smith 2017-11-26 original script
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Fgdc
+
+            class Keyword
+
+               def initialize(xml, hResponseObj)
+                  @xml = xml
+                  @hResponseObj = hResponseObj
+               end
+
+               def writeXML(aKeywords)
+
+                  # array of keyword sets
+                  aKeywords.each do |hKeySet|
+
+                     # find all the keyword set parts
+                     type = hKeySet[:keywordType]
+                     thesaurusName = nil
+                     thesaurus = hKeySet[:thesaurus]
+                     unless thesaurus.empty?
+                        thesaurusName = thesaurus[:title]
+                     end
+                     aKeywords = hKeySet[:keywords]
+                     if thesaurusName.nil?
+                        @hResponseObj[:writerPass] = false
+                        @hResponseObj[:writerMessages] << 'keyword set is missing thesaurus name'
+                     end
+
+                     # keyword 1.6.1 (theme) - theme keywords
+                     if type == 'theme'
+                        @xml.tag!('theme') do
+                           @xml.tag!('themekt', thesaurusName)
+                           aKeywords.each do |hKeyword|
+                              keyword = hKeyword[:keyword]
+                              unless keyword.nil?
+                                 @xml.tag!('themekey', keyword)
+                              end
+                           end
+                        end
+                     end
+
+                     # keyword 1.6.2 (place) - place keywords
+                     if type == 'place'
+                        @xml.tag!('place') do
+                           @xml.tag!('placekt', thesaurusName)
+                           aKeywords.each do |hKeyword|
+                              keyword = hKeyword[:keyword]
+                              unless keyword.nil?
+                                 @xml.tag!('placekey', keyword)
+                              end
+                           end
+                        end
+                     end
+
+                     # keyword 1.6.3 (stratum) - stratum keywords
+                     if type == 'stratum'
+                        @xml.tag!('stratum') do
+                           @xml.tag!('stratkt', thesaurusName)
+                           aKeywords.each do |hKeyword|
+                              keyword = hKeyword[:keyword]
+                              unless keyword.nil?
+                                 @xml.tag!('stratkey', keyword)
+                              end
+                           end
+                        end
+                     end
+
+                     # keyword 1.6.4 (temporal) - temporal keywords
+                     if type == 'temporal'
+                        @xml.tag!('temporal') do
+                           @xml.tag!('tempkt', thesaurusName)
+                           aKeywords.each do |hKeyword|
+                              keyword = hKeyword[:keyword]
+                              unless keyword.nil?
+                                 @xml.tag!('tempkey', keyword)
+                              end
+                           end
+                        end
+                     end
+
+                     # other keywordType(s) not transferred to FGDC
+
+                  end
+
+               end # writeXML
+            end # Status
+
+         end
+      end
+   end
+end

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

@@ -0,0 +1,73 @@
+# FGDC <<Class>> Phone
+# FGDC CSDGM writer output in XML
+
+# History:
+#  Stan Smith 2017-11-28 original script
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Fgdc
+
+            class Phone
+
+               def initialize(xml, hResponseObj)
+                  @xml = xml
+                  @hResponseObj = hResponseObj
+               end
+
+               def writeXML(aPhones)
+
+                  # phone 10.5 (cntvoice) - voice phone [] (required)
+                  # <- hPhone[:phoneNumber] where hPhone[:phoneServiceTypes] = 'voice'
+                  haveVoice = false
+                  aPhones.each do |hPhone|
+                     if hPhone[:phoneServiceTypes].include?('voice')
+                        unless hPhone[:phoneNumber].nil?
+                           @xml.tag!('cntvoice', hPhone[:phoneNumber])
+                           haveVoice = true
+                        end
+                     end
+                  end
+                  unless haveVoice
+                     @hResponseObj[:writerPass] = false
+                     @hResponseObj[:writerMessages] << 'Contact is missing voice phone'
+                  end
+
+                  # phone 10.6 (cnttdd) - tty phone []
+                  # <- hPhone[:phoneNumber] where hPhone[:phoneServiceTypes] = 'tty'
+                  haveTTY = false
+                  aPhones.each do |hPhone|
+                     if hPhone[:phoneServiceTypes].include?('tty')
+                        unless hPhone[:phoneNumber].nil?
+                           @xml.tag!('cnttdd', hPhone[:phoneNumber])
+                           haveTTY = true
+                        end
+                     end
+                  end
+                  if !haveTTY && @hResponseObj[:writerShowTags]
+                     @xml.tag!('cnttdd')
+                  end
+
+                  # phone 10.7 (cntfax) - fax phone []
+                  # <- hPhone[:phoneNumber] where hPhone[:phoneServiceTypes] = ['fax' | 'facsimile']
+                  haveFax = false
+                  aPhones.each do |hPhone|
+                     if hPhone[:phoneServiceTypes].include?('fax') || hPhone[:phoneServiceTypes].include?('facsimile')
+                        unless hPhone[:phoneNumber].nil?
+                           @xml.tag!('cntfax', hPhone[:phoneNumber])
+                           haveFax = true
+                        end
+                     end
+                  end
+                  if !haveFax && @hResponseObj[:writerShowTags]
+                     @xml.tag!('cntfax')
+                  end
+
+               end # writeXML
+            end # Phone
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/writers/fgdc/classes/class_publisher.rb

@@ -0,0 +1,67 @@
+# FGDC <<Class>> Publisher
+# FGDC CSDGM writer output in XML
+
+# History:
+#   Stan Smith 2017-11-21 original script
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Fgdc
+
+            class Publisher
+
+               def initialize(xml, hResponseObj)
+                  @xml = xml
+                  @hResponseObj = hResponseObj
+               end
+
+               def writeXML(hContact)
+
+                  # publication 8.8.1 (pubplace) - publication place
+                  # <- hContact[:addresses][:description] (required)
+                  place = ''
+                  unless hContact[:addresses].empty?
+                     hAddress = hContact[:addresses][0]
+                     unless hAddress.empty?
+                        description = hAddress[:description]
+                        city = hAddress[:city]
+                        state = hAddress[:adminArea]
+                        country = hAddress[:country]
+                        place = ''
+                        place += city unless city.nil?
+                        place += ', ' + state unless state.nil?
+                        place += ', ' + country unless country.nil?
+                        if place.empty?
+                           unless description.nil?
+                              place = description
+                           end
+                        end
+                     end
+                     unless place.empty?
+                        @xml.tag!('pubplace', place)
+                     end
+                  end
+                  if place == ''
+                     @hResponseObj[:writerPass] = false
+                     @hResponseObj[:writerMessages] << 'Publisher is missing place of publication'
+                  end
+
+                  # publication 8.8.2 (publish) - publisher name
+                  # <- hContact[:name] (required)
+                  name = hContact[:name]
+                  unless name.nil?
+                     @xml.tag!('publish', name)
+                  end
+                  if name.nil?
+                     @hResponseObj[:writerPass] = false
+                     @hResponseObj[:writerMessages] << 'Publisher is missing name of publisher'
+                  end
+
+               end # writeXML
+            end # Series
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/writers/fgdc/classes/class_series.rb

@@ -0,0 +1,47 @@
+# FGDC <<Class>> Series
+# FGDC CSDGM writer output in XML
+
+# History:
+#   Stan Smith 2017-11-21 original script
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Fgdc
+
+            class Series
+
+               def initialize(xml, hResponseObj)
+                  @xml = xml
+                  @hResponseObj = hResponseObj
+               end
+
+               def writeXML(hSeries)
+
+                  # series 8.7.1 (sername) - series name
+                  # <- hCitation[:series][:seriesName] (required)
+                  unless hSeries[:seriesName].nil?
+                     @xml.tag!('sername', hSeries[:seriesName])
+                  end
+                  if hSeries[:seriesName].nil?
+                     @hResponseObj[:writerPass] = false
+                     @hResponseObj[:writerMessages] << 'Series is missing name'
+                  end
+
+                  # series 8.7.2 (issue) - series issue
+                  # <- hCitation[:series][:seriesIssue] (required)
+                  unless hSeries[:seriesIssue].nil?
+                     @xml.tag!('issue', hSeries[:seriesIssue])
+                  end
+                  if hSeries[:seriesIssue].nil?
+                     @hResponseObj[:writerPass] = false
+                     @hResponseObj[:writerMessages] << 'Series is missing issue'
+                  end
+
+               end # writeXML
+            end # Series
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/writers/fgdc/classes/class_spatialDomain.rb

@@ -0,0 +1,200 @@
+# FGDC <<Class>> SpatialDomain
+# FGDC CSDGM writer output in XML
+
+# History:
+#   Stan Smith 2017-11-25 original script
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Fgdc
+
+            class SpatialDomain
+
+               def initialize(xml, hResponseObj)
+                  @xml = xml
+                  @hResponseObj = hResponseObj
+               end
+
+               def writeXML(aExtents)
+
+                  # spatial domain section is no required under bio extension rules
+
+                  # look for geographic description - take first
+                  # <- geographicExtent[:description]
+                  geoDescription = ''
+                  aExtents.each do |hExtent|
+                     unless hExtent.empty?
+                        hExtent[:geographicExtents].each do |hGeoExtent|
+                           unless hGeoExtent.empty?
+                              unless hGeoExtent[:description].nil?
+                                 geoDescription = hGeoExtent[:description]
+                                 break
+                              end
+                           end
+                        end
+                     end
+                  end
+
+                  # look for bounding box - take first
+                  # <- geographicExtent[:boundingBox]
+                  hBBox = {}
+                  aExtents.each do |hExtent|
+                     unless hExtent.empty?
+                        hExtent[:geographicExtents].each do |hGeoExtent|
+                           unless hGeoExtent.empty?
+                              unless hGeoExtent[:boundingBox].empty?
+                                 hBBox = hGeoExtent[:boundingBox]
+                                 break
+                              end
+                           end
+                        end
+                     end
+                  end
+
+                  # look for bounding polygon
+                  # <- geographicExtent[:geographicElements]
+                  # polygon must be in FeatureCollection with properties description of 'FGDC bounding polygon'
+                  aBPoly = []
+                  aExtents.each do |hExtent|
+                     unless hExtent.empty?
+                        hExtent[:geographicExtents].each do |hGeoExtent|
+                           unless hGeoExtent.empty?
+                              unless hGeoExtent[:geographicElements].empty?
+                                 hGeoExtent[:geographicElements].each do |hGeoElement|
+                                    if hGeoElement[:type] == 'FeatureCollection'
+                                       hGeoElement[:features].each do |hFeature|
+                                          if hFeature[:geometryObject][:type] == 'Polygon'
+                                             unless hFeature[:properties].empty?
+                                                if hFeature[:properties][:description] == 'FGDC bounding polygon'
+                                                   aBPoly << hFeature[:geometryObject][:coordinates]
+                                                end
+                                             end
+                                          end
+                                       end
+                                    end
+                                 end
+                              end
+                           end
+                        end
+                     end
+                  end
+
+                  # spatial domain 1.5 (spdom)
+                  unless geoDescription.empty? && hBBox.empty? && hBPoly.empty?
+                     @xml.tag!('spdom') do
+
+                        # spatial domain bio (descgeog) - geographic description (required)
+                        unless geoDescription.empty?
+                           @xml.tag!('descgeog', geoDescription)
+                        end
+                        if geoDescription.empty?
+                           @hResponseObj[:writerPass] = false
+                           @hResponseObj[:writerMessages] << 'Spatial Domain section is missing geographic description'
+                        end
+
+                        # spatial domain 1.5.1 (bounding) - bounding box (required)
+                        unless hBBox.empty?
+                           @xml.tag!('bounding') do
+
+                              # bounding box 1.5.1.1 (westbc) - west bounding coordinate
+                              @xml.tag!('westbc', hBBox[:westLongitude])
+
+                              # bounding box 1.5.1.2 (eastbc) - east bounding coordinate
+                              @xml.tag!('eastbc', hBBox[:eastLongitude])
+
+                              # bounding box 1.5.1.3 (northbc) - north bounding coordinate
+                              @xml.tag!('northbc', hBBox[:northLatitude])
+
+                              # bounding box 1.5.1.4 (southbc) - south bounding coordinate
+                              @xml.tag!('southbc', hBBox[:southLatitude])
+
+                              # altitude bounding bio extension
+                              unless hBBox[:minimumAltitude].nil? && hBBox[:maximumAltitude].nil? && hBBox[:unitsOfAltitude].nil?
+                                 @xml.tag!('boundalt') do
+
+                                    # altitude bounding (altmin) - minimum altitude (required)
+                                    unless hBBox[:minimumAltitude].nil?
+                                       @xml.tag!('altmin', hBBox[:minimumAltitude])
+                                    end
+                                    if hBBox[:minimumAltitude].nil?
+                                       @hResponseObj[:writerPass] = false
+                                       @hResponseObj[:writerMessages] << 'Altitude Bounding Box missing minimum altitude'
+                                    end
+
+                                    # altitude bounding (altmax) - maximum altitude (required)
+                                    unless hBBox[:maximumAltitude].nil?
+                                       @xml.tag!('altmax', hBBox[:minimumAltitude])
+                                    end
+                                    if hBBox[:maximumAltitude].nil?
+                                       @hResponseObj[:writerPass] = false
+                                       @hResponseObj[:writerMessages] << 'Altitude Bounding Box missing maximum altitude'
+                                    end
+
+                                    # altitude bounding (altunit) - units of altitude
+                                    unless hBBox[:unitsOfAltitude].nil?
+                                       @xml.tag!('altunit', hBBox[:unitsOfAltitude])
+                                    end
+                                    if hBBox[:unitsOfAltitude].nil?  && @hResponseObj[:writerShowTags]
+                                       @xml.tag!('altunit')
+                                    end
+
+                                 end
+                              end
+                              if hBBox[:minimumAltitude].nil? && hBBox[:maximumAltitude].nil? &&
+                                 hBBox[:unitsOfAltitude].nil? && @hResponseObj[:writerShowTags]
+                                 @xml.tag!('boundalt')
+                              end
+                           end
+                        end
+                        if hBBox.empty?
+                           @hResponseObj[:writerPass] = false
+                           @hResponseObj[:writerMessages] << 'Spatial Domain section is missing bounding box'
+                        end
+
+                        # spatial domain 1.5.2 (dsgpoly) - bounding polygon [] (required)
+                        unless aBPoly.empty?
+                           @xml.tag!('dsgpoly') do
+                              aBPoly.each do |aPoly|
+
+                                 # outer polygon 1.5.2.1 (dsgpolyo) - (required)
+                                 unless aPoly.empty?
+                                    @xml.tag!('dsgpolyo') do
+                                       aPoly[0].each do |aCoord|
+                                          @xml.tag!('grngpoin') do
+                                             @xml.tag!('grnglat', aCoord[0])
+                                             @xml.tag!('grnglon', aCoord[1])
+                                          end
+                                       end
+                                    end
+                                 end
+
+                                 # outer polygon 1.5.2.2 (dsgpolyx)
+                                 aPoly.delete_at(0)
+                                 unless aPoly.empty?
+                                    aPoly.each do |aExclude|
+                                       @xml.tag!('dsgpolyx') do
+                                          aExclude.each do |aCoord|
+                                             @xml.tag!('grngpoin') do
+                                                @xml.tag!('grnglat', aCoord[0])
+                                                @xml.tag!('grnglon', aCoord[1])
+                                             end
+                                          end
+                                       end
+                                    end
+                                 end
+
+                              end
+                           end
+                        end
+
+                     end
+                  end
+
+               end # writeXML
+            end # Status
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/writers/fgdc/classes/class_status.rb

@@ -0,0 +1,63 @@
+# FGDC <<Class>> Status
+# FGDC CSDGM writer output in XML
+
+# History:
+#   Stan Smith 2017-11-25 original script
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Fgdc
+
+            class Status
+
+               def initialize(xml, hResponseObj)
+                  @xml = xml
+                  @hResponseObj = hResponseObj
+               end
+
+               def writeXML(hResourceInfo)
+
+                  status = nil
+                  status = hResourceInfo[:status][0] unless hResourceInfo[:status].empty?
+                  frequency = nil
+                  frequency = hResourceInfo[:resourceMaintenance][0][:frequency] unless hResourceInfo[:resourceMaintenance].empty?
+
+                  # status 1.4 (status) - resource status
+                  unless status.nil? && frequency.nil?
+                     @xml.tag!('status') do
+
+                        # status 1.4.1 (progress) - status (required)
+                        # <- hResourceInfo[:status][0]
+                        unless status.nil?
+                           @xml.tag!('progress', status)
+                        end
+                        if status.nil?
+                           @hResponseObj[:writerPass] = false
+                           @hResponseObj[:writerMessages] << 'Status section missing progress'
+                        end
+
+                        # status 1.4.2 (update) - maintenance and update frequency (required)
+                        # <- hResourceInfo[:resourceMaintenance][:frequency]
+                        unless frequency.nil?
+                           @xml.tag!('update', frequency)
+                        end
+                        if frequency.nil?
+                           @hResponseObj[:writerPass] = false
+                           @hResponseObj[:writerMessages] << 'Status section missing maintenance frequency'
+                        end
+
+                     end
+                  end
+                  if status.nil? && frequency.nil?
+                     @hResponseObj[:writerPass] = false
+                     @hResponseObj[:writerMessages] << 'Identification section missing status section'
+                  end
+
+               end # writeXML
+            end # Status
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/writers/fgdc/classes/class_timePeriod.rb

@@ -0,0 +1,102 @@
+# FGDC <<Class>> TimePeriod
+# FGDC CSDGM writer output in XML
+
+# History:
+#   Stan Smith 2017-11-22 original script
+
+require_relative 'class_dateSingle'
+require_relative 'class_dateRange'
+require_relative 'class_geologicAge'
+require_relative 'class_geologicRange'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Fgdc
+
+            class TimePeriod
+
+               def initialize(xml, hResponseObj)
+                  @xml = xml
+                  @hResponseObj = hResponseObj
+               end
+
+               def writeXML(hTimePeriod)
+
+                  # classes used
+                  singDateClass = DateSingle.new(@xml, @hResponseObj)
+                  rangeDateClass = DateRange.new(@xml, @hResponseObj)
+                  geologicAgeClass = GeologicAge.new(@xml, @hResponseObj)
+                  geologicRangeClass = GeologicRange.new(@xml, @hResponseObj)
+
+                  hStartDate = hTimePeriod[:startDateTime]
+                  hEndDate = hTimePeriod[:endDateTime]
+                  hStartGeoAge = hTimePeriod[:startGeologicAge]
+                  hEndGeoAge = hTimePeriod[:endGeologicAge]
+
+                  dateCount = 0
+                  ageCount = 0
+                  dateCount += 1 unless hStartDate.empty?
+                  dateCount += 1 unless hEndDate.empty?
+                  ageCount += 1 unless hStartGeoAge.empty?
+                  ageCount += 1 unless hEndGeoAge.empty?
+
+                  if dateCount + ageCount == 0
+                     @hResponseObj[:writerPass] = false
+                     @hResponseObj[:writerMessages] << 'Time Period missing date item'
+                  end
+
+                  if dateCount > 0 && ageCount > 0
+                     @hResponseObj[:writerPass] = false
+                     @hResponseObj[:writerMessages] << 'Time Period must be either conventional or geologic time, not both'
+                  end
+
+                  # single date
+                  if dateCount == 1
+                     @xml.tag!('timeinfo') do
+                        if hStartDate.empty?
+                           singDateClass.writeXML(hEndDate)
+                        else
+                           singDateClass.writeXML(hStartDate)
+                        end
+                     end
+                  end
+
+                  # date range
+                  if dateCount == 2
+                     @xml.tag!('timeinfo') do
+                        rangeDateClass.writeXML(hStartDate, hEndDate)
+                     end
+                  end
+
+                  # single geologic age
+                  if ageCount == 1
+                     @xml.tag!('timeinfo') do
+                        @xml.tag!('sngdate') do
+                           @xml.tag!('geolage') do
+                              if hStartGeoAge.empty?
+                                 geologicAgeClass.writeXML(hEndGeoAge)
+                              else
+                                 geologicAgeClass.writeXML(hStartGeoAge)
+                              end
+                           end
+                        end
+                     end
+                  end
+
+                  # geologic age range
+                  if ageCount == 2
+                     @xml.tag!('timeinfo') do
+                        @xml.tag!('rngdates') do
+                           geologicRangeClass.writeXML(hStartGeoAge,hEndGeoAge )
+                        end
+                     end
+                  end
+
+               end # writeXML
+            end # TimePeriod
+
+         end
+      end
+   end
+end