adiwg-mdtranslator 2.13.0 → 2.13.1

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_geoJson.rb

@@ -2,7 +2,7 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
-#  Stan Smith 2018-02-18 refactored error and warning messaging
+#  Stan Smith 2018-06-19 refactored error and warning messaging
 #  Stan Smith 2016-10-25 original script
 
 require_relative 'module_geometryObject'
@@ -17,11 +17,13 @@ module ADIWG
 
             module GeoJson
 
-               def self.unpack(hGeoJson, responseObj)
+               def self.unpack(hGeoJson, responseObj, inContext = nil)
+
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
 
                   # return nil object if input is empty
                   if hGeoJson.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: GeoJSON object is empty'
+                     @MessagePath.issueWarning(340, responseObj, inContext)
                      return nil
                   end
 
@@ -54,6 +56,9 @@ module ADIWG
                               intGeoEle = hReturn
                            end
                         end
+                        if intGeoEle.empty?
+                           @MessagePath.issueError(341, responseObj, inContext)
+                        end
 
                      end
                   end

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_geodetic.rb

@@ -2,7 +2,7 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
-#  Stan Smith 2018-02-18 refactored error and warning messaging
+#  Stan Smith 2018-06-19 refactored error and warning messaging
 # 	Stan Smith 2017-10-23 original script
 
 require_relative 'module_identifier'
@@ -14,11 +14,13 @@ module ADIWG
 
             module Geodetic
 
-               def self.unpack(hGeodetic, responseObj)
+               def self.unpack(hGeodetic, responseObj, inContext = nil)
+
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
 
                   # return nil object if input is empty
                   if hGeodetic.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: spatial reference geodetic object is empty'
+                     @MessagePath.issueWarning(310, responseObj, inContext)
                      return nil
                   end
 
@@ -26,10 +28,13 @@ module ADIWG
                   intMetadataClass = InternalMetadata.new
                   intGeodetic = intMetadataClass.newGeodetic
 
+                  outContext = 'geodetic parameters'
+                  outContext = inContext + ' > ' + outContext unless inContext.nil?
+
                   # geodetic - datum identifier {identifier}
                   if hGeodetic.has_key?('datumIdentifier')
                      unless hGeodetic['datumIdentifier'].empty?
-                        hReturn = Identifier.unpack(hGeodetic['datumIdentifier'], responseObj)
+                        hReturn = Identifier.unpack(hGeodetic['datumIdentifier'], responseObj, outContext)
                         unless hReturn.nil?
                            intGeodetic[:datumIdentifier] = hReturn
                         end
@@ -46,7 +51,7 @@ module ADIWG
                   # geodetic - ellipsoid identifier {identifier}
                   if hGeodetic.has_key?('ellipsoidIdentifier')
                      unless hGeodetic['ellipsoidIdentifier'].empty?
-                        hReturn = Identifier.unpack(hGeodetic['ellipsoidIdentifier'], responseObj)
+                        hReturn = Identifier.unpack(hGeodetic['ellipsoidIdentifier'], responseObj, outContext)
                         unless hReturn.nil?
                            intGeodetic[:ellipsoidIdentifier] = hReturn
                         end
@@ -58,9 +63,7 @@ module ADIWG
                      intGeodetic[:ellipsoidName] = hGeodetic['ellipsoidName']
                   end
                   if intGeodetic[:ellipsoidName].nil? || intGeodetic[:ellipsoidName] == ''
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: spatial reference geodetic ellipsoid name is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(311, responseObj, inContext)
                   end
 
                   # geodetic - semi-major axis

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_geographicExtent.rb

@@ -3,7 +3,7 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
-#  Stan Smith 2018-02-18 refactored error and warning messaging
+#  Stan Smith 2018-06-19 refactored error and warning messaging
 #  Stan Smith 2017-09-28 added description element to support fgdc
 #  Stan Smith 2016-12-01 original script
 
@@ -18,11 +18,13 @@ module ADIWG
 
             module GeographicExtent
 
-               def self.unpack(hGeoExt, responseObj)
+               def self.unpack(hGeoExt, responseObj, inContext = nil)
+
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
 
                   # return nil object if input is empty
                   if hGeoExt.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: geographic extent object is empty'
+                     @MessagePath.issueWarning(320, responseObj, inContext)
                      return nil
                   end
 
@@ -30,6 +32,9 @@ module ADIWG
                   intMetadataClass = InternalMetadata.new
                   intGeoExt = intMetadataClass.newGeographicExtent
 
+                  outContext = 'geographic extent'
+                  outContext = inContext + ' > ' + outContext unless inContext.nil?
+
                   haveGExtent = false
 
                   # geographic extent - description
@@ -50,7 +55,7 @@ module ADIWG
                   # geographic extent - identifier
                   if hGeoExt.has_key?('identifier')
                      unless hGeoExt['identifier'].empty?
-                        hReturn = Identifier.unpack(hGeoExt['identifier'], responseObj)
+                        hReturn = Identifier.unpack(hGeoExt['identifier'], responseObj, outContext)
                         unless hReturn.nil?
                            intGeoExt[:identifier] = hReturn
                         end
@@ -61,7 +66,7 @@ module ADIWG
                   # geographic extent - bounding box
                   if hGeoExt.has_key?('boundingBox')
                      unless hGeoExt['boundingBox'].empty?
-                        hReturn = BoundingBox.unpack(hGeoExt['boundingBox'], responseObj)
+                        hReturn = BoundingBox.unpack(hGeoExt['boundingBox'], responseObj, outContext)
                         unless hReturn.nil?
                            intGeoExt[:boundingBox] = hReturn
                            haveGExtent = true
@@ -72,7 +77,7 @@ module ADIWG
                   # geographic extent - geographic elements
                   if hGeoExt.has_key?('geographicElement')
                      hGeoExt['geographicElement'].each do |hElement|
-                        hReturn = GeoJson.unpack(hElement, responseObj)
+                        hReturn = GeoJson.unpack(hElement, responseObj, outContext)
                         unless hReturn.nil?
                            intGeoExt[:geographicElements] << hReturn
                            haveGExtent = true
@@ -94,10 +99,7 @@ module ADIWG
 
                   # error messages
                   unless haveGExtent
-                     responseObj[:readerExecutionMessages] <<
-                        'ERROR: mdJson reader: geographic extent must have at least one description, identifier, bounding box, or geographic element'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(321, responseObj, inContext)
                   end
 
                   return intGeoExt

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_geographicResolution.rb

@@ -2,7 +2,7 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
-#  Stan Smith 2018-02-18 refactored error and warning messaging
+#  Stan Smith 2018-06-19 refactored error and warning messaging
 # 	Stan Smith 2017-10-19 original script
 
 module ADIWG
@@ -12,11 +12,15 @@ module ADIWG
 
             module GeographicResolution
 
-               def self.unpack(hGeoRes, responseObj)
+               def self.unpack(hGeoRes, responseObj, outContext = nil)
+
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
+
+                  outContext = 'spatial resolution'
 
                   # return nil object if input is empty
                   if hGeoRes.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: geographic spatial resolution object is empty'
+                     @MessagePath.issueWarning(330, responseObj, outContext)
                      return nil
                   end
 
@@ -29,10 +33,7 @@ module ADIWG
                      intGeoRes[:latitudeResolution] = hGeoRes['latitudeResolution']
                   end
                   if intGeoRes[:latitudeResolution].nil? || intGeoRes[:latitudeResolution] == ''
-                     responseObj[:readerExecutionMessages] <<
-                        'WARNING: mdJson reader: geographic spatial resolution latitude resolution is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(331, responseObj, outContext)
                   end
 
                   # geographic resolution - longitude resolution (required)
@@ -40,9 +41,7 @@ module ADIWG
                      intGeoRes[:longitudeResolution] = hGeoRes['longitudeResolution']
                   end
                   if intGeoRes[:longitudeResolution].nil? || intGeoRes[:longitudeResolution] == ''
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: geographic spatial resolution longitude resolution is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(332, responseObj, outContext)
                   end
 
                   # geographic resolution - unit of measure (required)
@@ -50,9 +49,7 @@ module ADIWG
                      intGeoRes[:unitOfMeasure] = hGeoRes['unitOfMeasure']
                   end
                   if intGeoRes[:unitOfMeasure].nil? || intGeoRes[:unitOfMeasure] == ''
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: geographic spatial resolution units are missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(333, responseObj, outContext)
                   end
 
                   return intGeoRes

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_geologicAge.rb

@@ -2,7 +2,7 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
-#  Stan Smith 2018-02-18 refactored error and warning messaging
+#  Stan Smith 2018-06-20 refactored error and warning messaging
 # 	Stan Smith 2017-11-07 original script
 
 require_relative 'module_citation'
@@ -14,11 +14,13 @@ module ADIWG
 
             module GeologicAge
 
-               def self.unpack(hGeoAge, responseObj)
+               def self.unpack(hGeoAge, responseObj, inContext = nil)
+
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
 
                   # return nil object if input is empty
                   if hGeoAge.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: geologic age object is empty'
+                     @MessagePath.issueWarning(350, responseObj, inContext)
                      return nil
                   end
 
@@ -26,14 +28,15 @@ module ADIWG
                   intMetadataClass = InternalMetadata.new
                   intGeoAge = intMetadataClass.newGeologicAge
 
+                  outContext = 'geologic age'
+                  outContext = inContext + ' > ' + outContext unless inContext.nil?
+
                   # geologic age - time scale (required)
                   if hGeoAge.has_key?('ageTimeScale')
                      intGeoAge[:ageTimeScale] = hGeoAge['ageTimeScale']
                   end
                   if intGeoAge[:ageTimeScale].nil? || intGeoAge[:ageTimeScale] == ''
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: geologic age time scale is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(351, responseObj, inContext)
                   end
 
                   # geologic age - age estimate (required)
@@ -41,9 +44,7 @@ module ADIWG
                      intGeoAge[:ageEstimate] = hGeoAge['ageEstimate']
                   end
                   if intGeoAge[:ageEstimate].nil? || intGeoAge[:ageEstimate] == ''
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: geologic age age-estimate is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(352, responseObj, inContext)
                   end
 
                   # geologic age - age uncertainty
@@ -64,7 +65,7 @@ module ADIWG
                   if hGeoAge.has_key?('ageReference')
                      hGeoAge['ageReference'].each do |hCitation|
                         unless hCitation.empty?
-                           hReturn = Citation.unpack(hCitation, responseObj)
+                           hReturn = Citation.unpack(hCitation, responseObj, outContext)
                            unless hReturn.nil?
                               intGeoAge[:ageReferences] << hReturn
                            end

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_geometryCollection.rb

@@ -2,12 +2,12 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
-#  Stan Smith 2018-02-18 refactored error and warning messaging
+#  Stan Smith 2018-06-20 refactored error and warning messaging
 #  Stan Smith 2016-11-11 added computedBbox computation
 #  Stan Smith 2016-10-25 original script
 
-require_relative 'module_geoJson'
 require 'adiwg/mdtranslator/internal/module_coordinates'
+require_relative 'module_geoJson'
 
 module ADIWG
    module Mdtranslator
@@ -18,9 +18,11 @@ module ADIWG
 
                def self.unpack(hGeoCol, responseObj)
 
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
+
                   # return nil object if input is empty
                   if hGeoCol.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: GeoJSON geometry collection object is empty'
+                     @MessagePath.issueWarning(360, responseObj)
                      return nil
                   end
 
@@ -34,16 +36,12 @@ module ADIWG
                         if hGeoCol['type'] == 'GeometryCollection'
                            intGeoCol[:type] = hGeoCol['type']
                         else
-                           responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: GeoJSON geometry collection type must be GeometryCollection'
-                           responseObj[:readerExecutionPass] = false
-                           return nil
+                           @MessagePath.issueError(361, responseObj)
                         end
                      end
                   end
                   if intGeoCol[:type].nil? || intGeoCol[:type] == ''
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: GeoJSON geometry collection type is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(362, responseObj)
                   end
 
                   # geometry collection - bounding box
@@ -62,9 +60,7 @@ module ADIWG
                         end
                      end
                   else
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: GeoJSON geometry collection geometries are missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(363, responseObj)
                   end
 
                   # geometry collection - compute bbox for geometry collection

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_geometryFeature.rb

@@ -2,14 +2,14 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
-#  Stan Smith 2018-02-18 refactored error and warning messaging
+#  Stan Smith 2018-06-20 refactored error and warning messaging
 #  Stan Smith 2016-11-10 added computedBbox computation
 #  Stan Smith 2016-10-25 original script
 
+require 'adiwg/mdtranslator/internal/module_coordinates'
 require_relative 'module_geometryObject'
 require_relative 'module_geometryProperties'
 require_relative 'module_geometryCollection'
-require 'adiwg/mdtranslator/internal/module_coordinates'
 
 module ADIWG
    module Mdtranslator
@@ -20,9 +20,11 @@ module ADIWG
 
                def self.unpack(hFeature, responseObj)
 
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
+
                   # return nil object if input is empty
                   if hFeature.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: GeoJSON geometry feature object is empty'
+                     @MessagePath.issueWarning(370, responseObj)
                      return nil
                   end
 
@@ -36,16 +38,12 @@ module ADIWG
                         if hFeature['type'] == 'Feature'
                            intFeature[:type] = hFeature['type']
                         else
-                           responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: GeoJSON geometry feature type must be Feature'
-                           responseObj[:readerExecutionPass] = false
-                           return nil
+                           @MessagePath.issueError(371, responseObj)
                         end
                      end
                   end
                   if intFeature[:type].nil? || intFeature[:type] == ''
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: GeoJSON geometry feature type is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(372, responseObj)
                   end
 
                   # geometry feature - id
@@ -76,9 +74,7 @@ module ADIWG
                         end
                      end
                   else
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: GeoJSON geometry feature geometry is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(373, responseObj)
                   end
 
                   # geometry feature - properties

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_geometryObject.rb

@@ -2,7 +2,7 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
-#  Stan Smith 2018-02-18 refactored error and warning messaging
+#  Stan Smith 2018-06-20 refactored error and warning messaging
 #  Stan Smith 2016-10-24 original script
 
 require_relative 'module_geometryCollection'
@@ -16,9 +16,11 @@ module ADIWG
 
                def self.unpack(hGeoObject, responseObj)
 
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
+
                   # return nil object if input is empty
                   if hGeoObject.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: GeoJSON geometry object is empty'
+                     @MessagePath.issueWarning(380, responseObj)
                      return nil
                   end
 
@@ -33,17 +35,12 @@ module ADIWG
                         if %w{ Point LineString Polygon MultiPoint MultiLineString MultiPolygon }.one? {|word| word == type}
                            intGeoObject[:type] = hGeoObject['type']
                         else
-                           responseObj[:readerExecutionMessages] <<
-                              'ERROR: mdJson reader: GeoJSON geometry object type must be Point, LineString, Polygon, MultiPoint, MultiLineString, or MultiPolygon'
-                           responseObj[:readerExecutionPass] = false
-                           return nil
+                           @MessagePath.issueError(381, responseObj)
                         end
                      end
                   end
                   if intGeoObject[:type].nil? || intGeoObject[:type] == ''
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: GeoJSON geometry object type is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(382, responseObj)
                   end
 
                   # geometry object - coordinates (required)
@@ -51,9 +48,7 @@ module ADIWG
                      intGeoObject[:coordinates] = hGeoObject['coordinates']
                   end
                   if intGeoObject[:coordinates].empty?
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: GeoJSON geometry object coordinates are missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(383, responseObj)
                   end
 
                   # geometry object - save native GeoJSON