adiwg-mdtranslator 2.7.0 → 2.8.0

data/lib/adiwg/mdtranslator/readers/sbJson/modules/module_tag.rb

@@ -36,7 +36,7 @@ module ADIWG
                         if hTag['scheme'].downcase == 'none'
                            hTag['scheme'] = 'none'
                         end
-                        if hTag['scheme'] == 'ISO 19115 Topic Categories'
+                        if hTag['scheme'] == 'ISO 19115 Topic Category'
                            hTag['scheme'] = 'none'
                            hTag['type'] = 'isoTopicCategory'
                         end
@@ -52,7 +52,7 @@ module ADIWG
                         if hTag['type'].downcase == 'none'
                            hTag['type'] = 'none'
                         end
-                        if hTag['type'] == 'ISO 19115 Topic Categories'
+                        if hTag['type'] == 'ISO 19115 Topic Category'
                            hTag['scheme'] = 'none'
                            hTag['type'] = 'isoTopicCategory'
                         end

data/lib/adiwg/mdtranslator/version.rb

@@ -1,6 +1,9 @@
 # adiwg mdTranslator
 
 # version 2 history
+# 2.8.0 2018-01-17 added fgdc writer spatial reference section
+# 2.7.1 2018-01-05 fix issue #171, fully implement deprecation of topicCategories[]
+# 2.7.0 2017-12-28 reinstate schema validation checks for schema 2.4.1
 # 2.7.0 2017-12-26 add fgdc writer identification info section
 # 2.7.0 2017-12-26 add fgdc writer data quality info section
 # 2.7.0 2017-12-26 add fgdc writer spatial domain info section
@@ -55,7 +58,7 @@
 module ADIWG
    module Mdtranslator
       # current mdtranslator version
-      VERSION = "2.7.0"
+      VERSION = "2.8.0"
    end
 end
 

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

@@ -61,6 +61,7 @@ module ADIWG
                               if hDate[:dateType] == 'publication'
                                  pubDate = AdiwgDateTimeFun.stringDateFromDateTime(hDate[:date], hDate[:dateResolution])
                                  pubTime = AdiwgDateTimeFun.stringTimeFromDateTime(hDate[:date], hDate[:dateResolution])
+                                 pubDate.gsub!(/[-]/,'')
                                  unless pubDate == 'ERROR'
                                     @xml.tag!('pubdate', pubDate)
                                     havePubDate = true

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

@@ -2,7 +2,8 @@
 # FGDC CSDGM writer output in XML
 
 # History:
-#   Stan Smith 2017-11-23 original script
+#  Stan Smith 2018-01-19 convert ISO date formats to FGDC
+#  Stan Smith 2017-11-23 original script
 
 require 'adiwg/mdtranslator/internal/module_dateTimeFun'
 
@@ -25,6 +26,10 @@ module ADIWG
                   sEDate = AdiwgDateTimeFun.stringDateFromDateTime(hEndDT[:dateTime], hEndDT[:dateResolution])
                   sETime = AdiwgDateTimeFun.stringTimeFromDateTime(hEndDT[:dateTime], hEndDT[:dateResolution])
 
+                  # convert ISO date format to FGDC
+                  sSDate.gsub!(/[-]/,'')
+                  sEDate.gsub!(/[-]/,'')
+
                   # single date 9.3 (rngdates) - date range
                   @xml.tag!('rngdates') do
 

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

@@ -2,7 +2,8 @@
 # FGDC CSDGM writer output in XML
 
 # History:
-#   Stan Smith 2017-11-23 original script
+#  Stan Smith 2018-01-19 convert ISO date formats to FGDC
+#  Stan Smith 2017-11-23 original script
 
 require 'adiwg/mdtranslator/internal/module_dateTimeFun'
 
@@ -23,6 +24,9 @@ module ADIWG
                   sDate = AdiwgDateTimeFun.stringDateFromDateTime(hDate[:dateTime], hDate[:dateResolution])
                   sTime = AdiwgDateTimeFun.stringTimeFromDateTime(hDate[:dateTime], hDate[:dateResolution])
 
+                  # convert ISO date format to FGDC
+                  sDate.gsub!(/[-]/,'')
+
                   # single date 9.1 (sngdate) - single date (required)
                   @xml.tag!('sngdate') do
 

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

@@ -7,6 +7,7 @@
 require_relative 'class_identification'
 require_relative 'class_quality'
 require_relative 'class_spatialOrganization'
+require_relative 'class_spatialReference'
 
 module ADIWG
    module Mdtranslator
@@ -29,6 +30,7 @@ module ADIWG
                   idClass = Identification.new(@xml, @hResponseObj)
                   qualityClass = Quality.new(@xml, @hResponseObj)
                   spaceOrgClass = SpatialOrganization.new(@xml, @hResponseObj)
+                  spaceRefClass = SpatialReference.new(@xml, @hResponseObj)
 
                   # document head
                   metadata = @xml.instruct! :xml, encoding: 'UTF-8'
@@ -60,17 +62,17 @@ module ADIWG
                      end
 
                      # metadata 3 (spdoinfo) - spatial domain information
-                     hDomainInfo = false
-                     hDomainInfo = true unless hResourceInfo[:spatialRepresentations].empty?
-                     hDomainInfo = true unless hResourceInfo[:spatialRepresentationTypes].empty?
+                     haveDomain = false
+                     haveDomain = true unless hResourceInfo[:spatialRepresentations].empty?
+                     haveDomain = true unless hResourceInfo[:spatialRepresentationTypes].empty?
                      hResourceInfo[:spatialReferenceSystems].each do |hSystem|
                         unless hSystem[:systemIdentifier].empty?
                            if hSystem[:systemIdentifier][:identifier] == 'indirect'
-                              hDomainInfo = true
+                              haveDomain = true
                            end
                         end
                      end
-                     if hDomainInfo
+                     if haveDomain
                         @xml.tag!('spdoinfo') do
                            spaceOrgClass.writeXML(hResourceInfo)
                         end
@@ -79,6 +81,17 @@ module ADIWG
                      end
 
                      # metadata 4 (spref) - spatial reference systems
+                     haveSpaceRef = false
+                     haveSpaceRef = true unless hResourceInfo[:spatialResolutions].empty?
+                     haveSpaceRef = true unless hResourceInfo[:spatialReferenceSystems].empty?
+                     if haveSpaceRef
+                        @xml.tag!('spref') do
+                           spaceRefClass.writeXML(hResourceInfo)
+                        end
+                     elsif @hResponseObj[:writerShowTags]
+                        @xml.tag!('spref')
+                     end
+
                      # metadata 5 (eainfo) - entity attribute information
                      # metadata 6 (distinfo) - distribution information
                      # metadata 7 (metainfo) - metadata information

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

@@ -0,0 +1,62 @@
+# FGDC <<Class>> SpatialReference
+# FGDC CSDGM writer output in XML
+
+# History:
+#  Stan Smith 2018-01-15 original script
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Fgdc
+
+            class GeodeticReference
+
+               def initialize(xml, hResponseObj)
+                  @xml = xml
+                  @hResponseObj = hResponseObj
+               end
+
+               def writeXML(hGeodetic)
+
+                  # geodetic reference system 4.1.4.1 (horizdn) - horizontal datum name
+                  unless hGeodetic[:datumName].nil?
+                     @xml.tag!('horizdn', hGeodetic[:datumName])
+                  end
+                  if hGeodetic[:datumName].nil? && @hResponseObj[:writerShowTags]
+                     @xml.tag!('horizdn')
+                  end
+
+                  # geodetic reference system 4.1.4.2 (ellips) - ellipsoid name (required)
+                  unless hGeodetic[:ellipsoidName].nil?
+                     @xml.tag!('ellips', hGeodetic[:ellipsoidName])
+                  end
+                  if hGeodetic[:ellipsoidName].nil?
+                     @hResponseObj[:writerPass] = false
+                     @hResponseObj[:writerMessages] << 'Geodetic Coordinate System is missing ellipsoid name'
+                  end
+
+                  # geodetic reference system 4.1.4.3 (semiaxis) - ellipsoid semi-major axis (required)
+                  unless hGeodetic[:semiMajorAxis].nil?
+                     @xml.tag!('semiaxis', hGeodetic[:semiMajorAxis])
+                  end
+                  if hGeodetic[:semiMajorAxis].nil?
+                     @hResponseObj[:writerPass] = false
+                     @hResponseObj[:writerMessages] << 'Geodetic Coordinate System is missing semi-major axis'
+                  end
+
+                  # geodetic reference system 4.1.4.4 (denflat) - ellipsoid denominator of flattening ratio (required)
+                  unless hGeodetic[:denominatorOfFlatteningRatio].nil?
+                     @xml.tag!('denflat', hGeodetic[:denominatorOfFlatteningRatio])
+                  end
+                  if hGeodetic[:denominatorOfFlatteningRatio].nil?
+                     @hResponseObj[:writerPass] = false
+                     @hResponseObj[:writerMessages] << 'Geodetic Coordinate System is missing denominator of flattening ratio'
+                  end
+
+               end # writeXML
+            end # GeodeticReference
+
+         end
+      end
+   end
+end

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

@@ -0,0 +1,56 @@
+# FGDC <<Class>> GeographicResolution
+# FGDC CSDGM writer output in XML
+
+# History:
+#  Stan Smith 2017-12-29 original script
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Fgdc
+
+            class GeographicResolution
+
+               def initialize(xml, hResponseObj)
+                  @xml = xml
+                  @hResponseObj = hResponseObj
+               end
+
+               def writeXML(hGeoRes)
+
+                  # horizontal reference 4.1.1 (geograph) - geographic resolution
+
+                  # geographic resolution 4.1.1.1 (latres) - latitude resolution (required)
+                  unless hGeoRes[:latitudeResolution].nil?
+                     @xml.tag!('latres', hGeoRes[:latitudeResolution]).to_s
+                  end
+                  if hGeoRes[:latitudeResolution].nil?
+                     @hResponseObj[:writerPass] = false
+                     @hResponseObj[:writerMessages] << 'Geographic Resolution is missing latitude resolution'
+                  end
+
+                  # geographic resolution 4.1.1.2 (longres) - longitude resolution (required)
+                  unless hGeoRes[:longitudeResolution].nil?
+                     @xml.tag!('longres', hGeoRes[:longitudeResolution]).to_s
+                  end
+                  if hGeoRes[:longitudeResolution].nil?
+                     @hResponseObj[:writerPass] = false
+                     @hResponseObj[:writerMessages] << 'Geographic Resolution is missing longitude resolution'
+                  end
+
+                  # geographic resolution 4.1.1.3 (geogunit) - longitude resolution (required)
+                  unless hGeoRes[:unitOfMeasure].nil?
+                     @xml.tag!('geogunit', hGeoRes[:unitOfMeasure])
+                  end
+                  if hGeoRes[:unitOfMeasure].nil?
+                     @hResponseObj[:writerPass] = false
+                     @hResponseObj[:writerMessages] << 'Geographic Resolution is missing unit of measure'
+                  end
+
+               end # writeXML
+            end # GeographicResolution
+
+         end
+      end
+   end
+end

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

@@ -37,6 +37,7 @@ module ADIWG
                      # keyword 1.6.1 (theme) - theme keywords
                      if type == 'theme' || type == 'isoTopicCategory'
                         @xml.tag!('theme') do
+                           thesaurusName = 'ISO 19115 Topic Category' if type == 'isoTopicCategory'
                            @xml.tag!('themekt', thesaurusName)
                            aKeywords.each do |hKeyword|
                               keyword = hKeyword[:keyword]

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

@@ -0,0 +1,45 @@
+# FGDC <<Class>> SpatialReference
+# FGDC CSDGM writer output in XML
+
+# History:
+#  Stan Smith 2018-01-15 original script
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Fgdc
+
+            class LocalSystem
+
+               def initialize(xml, hResponseObj)
+                  @xml = xml
+                  @hResponseObj = hResponseObj
+               end
+
+               def writeXML(hProjection)
+
+                  # local system (local) - local coordinate system description (required)
+                  unless hProjection[:localPlanarDescription].nil?
+                     @xml.tag!('localdes', hProjection[:localPlanarDescription])
+                  end
+                  if hProjection[:localPlanarDescription].nil?
+                     @hResponseObj[:writerPass] = false
+                     @hResponseObj[:writerMessages] << 'Local Coordinate System is missing description'
+                  end
+
+                  # local system (local) - local coordinate system georeference information (required)
+                  unless hProjection[:localPlanarGeoreference].nil?
+                     @xml.tag!('localgeo', hProjection[:localPlanarGeoreference])
+                  end
+                  if hProjection[:localPlanarGeoreference].nil?
+                     @hResponseObj[:writerPass] = false
+                     @hResponseObj[:writerMessages] << 'Local Coordinate System is missing georeference information'
+                  end
+
+               end # writeXML
+            end # LocalSystem
+
+         end
+      end
+   end
+end

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

@@ -0,0 +1,167 @@
+# FGDC <<Class>> SpatialReference
+# FGDC CSDGM writer output in XML
+
+# History:
+#  Stan Smith 2018-01-12 original script
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Fgdc
+
+            class CoordinateInformation
+
+               def initialize(xml, hResponseObj)
+                  @xml = xml
+                  @hResponseObj = hResponseObj
+               end
+
+               def writeXML(aRepTypes, aResolutions)
+
+                  haveCInfo = false
+                  haveCInfo = true unless aRepTypes.empty?
+                  aResolutions.each do |hResolution|
+                     haveCInfo = true if hResolution[:coordinateResolution]
+                     haveCInfo = true if hResolution[:bearingDistanceResolution]
+                  end
+                  unitOfMeasure = nil
+
+                  # coordinate information 4.1.2.4 (planci) - planar coordinate information
+                  if haveCInfo
+                     @xml.tag!('planar') do
+                        @xml.tag!('planci') do
+
+                           # coordinate information 4.1.2.4.1 (plance) - planar coordinate encoding method (required)
+                           # <- spatialRepresentationTypes[].first
+                           unless aRepTypes.empty?
+                              @xml.tag!('plance', aRepTypes[0])
+                           end
+                           if aRepTypes.empty?
+                              @hResponseObj[:writerPass] = false
+                              @hResponseObj[:writerMessages] << 'Planar Coordinate Information is missing encoding method'
+                           end
+
+                           # <- spatialResolutions[] look for coordinateResolution and bearingDistanceResolution
+                           # take first encountered, only one is permitted from file
+                           aResolutions.each do |hResolution|
+                              unless hResolution[:coordinateResolution].empty?
+                                 hCoordRes = hResolution[:coordinateResolution]
+
+                                 # coordinate information 4.1.2.4.2 (coordrep) - coordinate representation
+                                 @xml.tag!('coordrep') do
+
+                                    # coordinate information 4.1.2.4.2.1 (absres) - abscissa resolution (required)
+                                    unless hCoordRes[:abscissaResolutionX].nil?
+                                       @xml.tag!('absres', hCoordRes[:abscissaResolutionX].to_f)
+                                    end
+                                    if hCoordRes[:abscissaResolutionX].nil?
+                                       @hResponseObj[:writerPass] = false
+                                       @hResponseObj[:writerMessages] << 'Coordinate Representation is missing abscissa resolution'
+                                    end
+
+                                    # coordinate information 4.1.2.4.2.2 (ordres) - ordinate resolution (required)
+                                    unless hCoordRes[:ordinateResolutionY].nil?
+                                       @xml.tag!('ordres', hCoordRes[:ordinateResolutionY].to_f)
+                                    end
+                                    if hCoordRes[:ordinateResolutionY].nil?
+                                       @hResponseObj[:writerPass] = false
+                                       @hResponseObj[:writerMessages] << 'Coordinate Representation is missing ordinate resolution'
+                                    end
+
+                                    # coordinate information 4.1.2.4.4 (plandu) - distance unit of measure (required)
+                                    unless hCoordRes[:unitOfMeasure].nil?
+                                       unitOfMeasure = hCoordRes[:unitOfMeasure]
+                                    end
+                                    if hCoordRes[:unitOfMeasure].nil?
+                                       @hResponseObj[:writerPass] = false
+                                       @hResponseObj[:writerMessages] << 'Bearing-Distance Representation is missing planar distance units'
+                                    end
+
+                                 end
+                                 break
+                              end
+
+                              unless hResolution[:bearingDistanceResolution].empty?
+                                 hBearRes = hResolution[:bearingDistanceResolution]
+
+                                 # coordinate information 4.1.2.4.3 (distbrep) - bearing and distance representation
+                                 @xml.tag!('distbrep') do
+
+                                    # coordinate information 4.1.2.4.3.1 (distres) - distance resolution (required)
+                                    unless hBearRes[:distanceResolution].nil?
+                                       @xml.tag!('distres', hBearRes[:distanceResolution].to_f)
+                                    end
+                                    if hBearRes[:distanceResolution].nil?
+                                       @hResponseObj[:writerPass] = false
+                                       @hResponseObj[:writerMessages] << 'Bearing-Distance Representation is missing distance resolution'
+                                    end
+
+                                    # coordinate information 4.1.2.4.3.2 (bearres) - bearing resolution (required)
+                                    unless hBearRes[:bearingResolution].nil?
+                                       @xml.tag!('bearres', hBearRes[:bearingResolution])
+                                    end
+                                    if hBearRes[:bearingResolution].nil?
+                                       @hResponseObj[:writerPass] = false
+                                       @hResponseObj[:writerMessages] << 'Bearing-Distance Representation is missing bearing resolution'
+                                    end
+
+                                    # coordinate information 4.1.2.4.3.3 (bearunit) - bearing units of measure (required)
+                                    unless hBearRes[:bearingUnitOfMeasure].nil?
+                                       @xml.tag!('bearunit', hBearRes[:bearingUnitOfMeasure])
+                                    end
+                                    if hBearRes[:bearingUnitOfMeasure].nil?
+                                       @hResponseObj[:writerPass] = false
+                                       @hResponseObj[:writerMessages] << 'Bearing-Distance Representation is missing bearing units'
+                                    end
+
+                                    # coordinate information 4.1.2.4.3.4 (bearrefd) - bearing units of measure (required)
+                                    unless hBearRes[:bearingReferenceDirection].nil?
+                                       @xml.tag!('bearrefd', hBearRes[:bearingReferenceDirection])
+                                    end
+                                    if hBearRes[:bearingReferenceDirection].nil?
+                                       @hResponseObj[:writerPass] = false
+                                       @hResponseObj[:writerMessages] << 'Bearing-Distance Representation is missing bearing reference direction'
+                                    end
+
+                                    # coordinate information 4.1.2.4.3.5 (bearrefm) - bearing reference meridian (required)
+                                    unless hBearRes[:bearingReferenceMeridian].nil?
+                                       @xml.tag!('bearrefm', hBearRes[:bearingReferenceMeridian])
+                                    end
+                                    if hBearRes[:bearingReferenceMeridian].nil?
+                                       @hResponseObj[:writerPass] = false
+                                       @hResponseObj[:writerMessages] << 'Bearing-Distance Representation is missing bearing reference meridian'
+                                    end
+
+                                    # coordinate information 4.1.2.4.4 (plandu) - distance unit of measure (required)
+                                    unless hBearRes[:distanceUnitOfMeasure].nil?
+                                       unitOfMeasure = hBearRes[:distanceUnitOfMeasure]
+                                    end
+                                    if hBearRes[:distanceUnitOfMeasure].nil?
+                                       @hResponseObj[:writerPass] = false
+                                       @hResponseObj[:writerMessages] << 'Bearing-Distance Representation is missing planar distance units'
+                                    end
+
+                                 end
+                                 break
+
+                              end
+                           end
+
+                           # planar distance units 4.1.2.4.4 (plandu) - (required)
+                           # value and error messages handled in above code
+                           # just write it out here
+                           unless unitOfMeasure.nil?
+                              @xml.tag!('plandu', unitOfMeasure)
+                           end
+
+                        end
+                     end
+                  end
+
+               end # writeXML
+            end # CoordinateInformation
+
+         end
+      end
+   end
+end