adiwg-mdtranslator 2.13.0 → 2.13.1

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

@@ -2,7 +2,7 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
-#  Stan Smith 2018-02-19 refactored error and warning messaging
+#  Stan Smith 2018-06-25 refactored error and warning messaging
 #  Stan Smith 2016-10-19 original script
 
 require_relative 'module_gridRepresentation'
@@ -17,24 +17,30 @@ module ADIWG
 
             module SpatialRepresentation
 
-               def self.unpack(hRepresent, responseObj)
+               def self.unpack(hRepresent, responseObj, inContext = nil)
+
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
 
                   # return nil object if input is empty
                   if hRepresent.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: spatial representation object is empty'
+                     @MessagePath.issueWarning(790, responseObj, inContext)
                      return nil
                   end
 
                   # instance classes needed in script
                   intMetadataClass = InternalMetadata.new
                   intRepresent = intMetadataClass.newSpatialRepresentation
+
+                  outContext = 'spatial representation'
+                  outContext = inContext + ' > ' + outContext unless inContext.nil?
+
                   haveOne = false
 
                   # spatial representation - grid representation (required if not others)
                   if hRepresent.has_key?('gridRepresentation')
                      hRep = hRepresent['gridRepresentation']
                      unless hRep.empty?
-                        hObject = GridRepresentation.unpack(hRep, responseObj)
+                        hObject = GridRepresentation.unpack(hRep, responseObj, outContext)
                         unless hObject.nil?
                            intRepresent[:gridRepresentation] = hObject
                            haveOne = true
@@ -46,7 +52,7 @@ module ADIWG
                   if hRepresent.has_key?('vectorRepresentation')
                      hRep = hRepresent['vectorRepresentation']
                      unless hRep.empty?
-                        hObject = VectorRepresentation.unpack(hRep, responseObj)
+                        hObject = VectorRepresentation.unpack(hRep, responseObj, outContext)
                         unless hObject.nil?
                            intRepresent[:vectorRepresentation] = hObject
                            haveOne = true
@@ -58,7 +64,7 @@ module ADIWG
                   if hRepresent.has_key?('georectifiedRepresentation')
                      hRep = hRepresent['georectifiedRepresentation']
                      unless hRep.empty?
-                        hObject = GeorectifiedRepresentation.unpack(hRep, responseObj)
+                        hObject = GeorectifiedRepresentation.unpack(hRep, responseObj, outContext)
                         unless hObject.nil?
                            intRepresent[:georectifiedRepresentation] = hObject
                            haveOne = true
@@ -70,7 +76,7 @@ module ADIWG
                   if hRepresent.has_key?('georeferenceableRepresentation')
                      hRep = hRepresent['georeferenceableRepresentation']
                      unless hRep.empty?
-                        hObject = GeoreferenceableRepresentation.unpack(hRep, responseObj)
+                        hObject = GeoreferenceableRepresentation.unpack(hRep, responseObj, outContext)
                         unless hObject.nil?
                            intRepresent[:georeferenceableRepresentation] = hObject
                            haveOne = true
@@ -80,10 +86,7 @@ module ADIWG
 
                   # error messages
                   unless haveOne
-                     responseObj[:readerExecutionMessages] <<
-                        'ERROR: mdJson reader: spatial representation did not have an object of supported type'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(791, responseObj, inContext)
                   end
 
                   return intRepresent

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

@@ -2,7 +2,7 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
-#  Stan Smith 2018-02-19 refactored error and warning messaging
+#  Stan Smith 2018-06-25 refactored error and warning messaging
 #  Stan Smith 2017-10-19 add geographic resolution
 #  Stan Smith 2017-10-19 add bearingDistance resolution
 #  Stan Smith 2017-10-19 add coordinate resolution
@@ -24,17 +24,23 @@ module ADIWG
 
             module SpatialResolution
 
-               def self.unpack(hResolution, responseObj)
+               def self.unpack(hResolution, responseObj, inContext = nil)
+
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
 
                   # return nil object if input is empty
                   if hResolution.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: spatial resolution object is empty'
+                     @MessagePath.issueWarning(800, responseObj, inContext)
                      return nil
                   end
 
                   # instance classes needed in script
                   intMetadataClass = InternalMetadata.new
                   intResolution = intMetadataClass.newSpatialResolution
+
+                  outContext = 'spatial resolution'
+                  outContext = inContext + ' > ' + outContext unless inContext.nil?
+
                   haveOne = false
 
                   # spatial resolution - scale factor (required if not others)
@@ -49,7 +55,7 @@ module ADIWG
                   if hResolution.has_key?('measure')
                      hMeasure = hResolution['measure']
                      unless hMeasure.empty?
-                        hObject = Measure.unpack(hMeasure, responseObj)
+                        hObject = Measure.unpack(hMeasure, responseObj, outContext)
                         unless hObject.nil?
                            intResolution[:measure] = hObject
                            haveOne = true
@@ -61,7 +67,7 @@ module ADIWG
                   if hResolution.has_key?('coordinateResolution')
                      hCoordRes = hResolution['coordinateResolution']
                      unless hCoordRes.empty?
-                        hReturn = CoordinateResolution.unpack(hCoordRes, responseObj)
+                        hReturn = CoordinateResolution.unpack(hCoordRes, responseObj, outContext)
                         unless hReturn.nil?
                            intResolution[:coordinateResolution] = hReturn
                            haveOne = true
@@ -73,7 +79,7 @@ module ADIWG
                   if hResolution.has_key?('bearingDistanceResolution')
                      hBearRes = hResolution['bearingDistanceResolution']
                      unless hBearRes.empty?
-                        hReturn = BearingDistanceResolution.unpack(hBearRes, responseObj)
+                        hReturn = BearingDistanceResolution.unpack(hBearRes, responseObj, outContext)
                         unless hReturn.nil?
                            intResolution[:bearingDistanceResolution] = hReturn
                            haveOne = true
@@ -85,7 +91,7 @@ module ADIWG
                   if hResolution.has_key?('geographicResolution')
                      hGeoRes = hResolution['geographicResolution']
                      unless hGeoRes.empty?
-                        hReturn = GeographicResolution.unpack(hGeoRes, responseObj)
+                        hReturn = GeographicResolution.unpack(hGeoRes, responseObj, outContext)
                         unless hReturn.nil?
                            intResolution[:geographicResolution] = hReturn
                            haveOne = true
@@ -103,9 +109,7 @@ module ADIWG
 
                   # error messages
                   unless haveOne
-                     responseObj[:readerExecutionMessages] <<
-                        'WARNING: mdJson reader: spatial resolution did not have an object of supported type'
-                     return nil
+                     @MessagePath.issueError(801, responseObj, inContext)
                   end
 
                   return intResolution

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

@@ -2,7 +2,7 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
-#  Stan Smith 2018-04-06 renamed taxonomicRank to taxonomicLevel
+#  Stan Smith 2018-06-26 refactored error and warning messaging
 #  Stan Smith 2018-04-06 renamed latinName to taxonomicName
 #  Stan Smith 2018-02-19 refactored error and warning messaging
 #  Stan Smith 2017-01-31 added taxonomicSystemId
@@ -19,10 +19,11 @@ module ADIWG
 
                def self.unpack(hTaxClass, responseObj)
 
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
+
                   # return nil object if input is empty
                   if hTaxClass.empty?
-                     responseObj[:readerExecutionMessages] <<
-                        'WARNING: mdJson reader: taxonomic classification object is empty'
+                     @MessagePath.issueWarning(810, responseObj)
                      return nil
                   end
 
@@ -45,14 +46,10 @@ module ADIWG
                   # support deprecation until schema version 3.0
                   if hTaxClass.has_key?('taxonomicRank')
                      intTaxClass[:taxonRank] = hTaxClass['taxonomicRank']
-                     responseObj[:readerExecutionMessages] <<
-                        'NOTICE: mdJson reader: taxonomic classification taxonomicRank is deprecated, use taxonomicLevel'
+                     @MessagePath.issueNotice(811, responseObj)
                   end
                   if intTaxClass[:taxonRank].nil? || intTaxClass[:taxonRank] == ''
-                     responseObj[:readerExecutionMessages] <<
-                        'ERROR: mdJson reader: taxonomic classification level is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(812, responseObj)
                   end
 
                   # taxonomic classification - taxonomic name (required)
@@ -63,14 +60,10 @@ module ADIWG
                   # support deprecation until schema version 3.0
                   if hTaxClass.has_key?('latinName')
                      intTaxClass[:taxonValue] = hTaxClass['latinName']
-                     responseObj[:readerExecutionMessages] <<
-                        'NOTICE: mdJson reader: taxonomic classification latinName is deprecated, use taxonomicName'
+                     @MessagePath.issueNotice(813, responseObj)
                   end
                   if intTaxClass[:taxonValue].nil? || intTaxClass[:taxonValue] == ''
-                     responseObj[:readerExecutionMessages] <<
-                        'ERROR: mdJson reader: taxonomic classification name is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(814, responseObj)
                   end
 
                   # taxonomic classification - common name []

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

@@ -2,7 +2,7 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
-#  Stan Smith 2018-02-19 refactored error and warning messaging
+#  Stan Smith 2018-06-26 refactored error and warning messaging
 #  Stan Smith 2016-12-09 original script
 
 require_relative 'module_citation'
@@ -16,9 +16,11 @@ module ADIWG
 
                def self.unpack(hSystem, responseObj)
 
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
+
                   # return nil object if input is empty
                   if hSystem.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: taxonomic system object is empty'
+                     @MessagePath.issueWarning(820, responseObj)
                      return nil
                   end
 
@@ -37,9 +39,7 @@ module ADIWG
                      end
                   end
                   if intSystem[:citation].empty?
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: taxonomic system citation is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(821, responseObj)
                   end
 
                   # taxonomy system - modifications

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

@@ -2,7 +2,7 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
-#  Stan Smith 2018-02-19 refactored error and warning messaging
+#  Stan Smith 2018-06-26 refactored error and warning messaging
 #  Stan Smith 2016-10-22 original script
 
 require_relative 'module_taxonomicSystem'
@@ -20,9 +20,11 @@ module ADIWG
 
                def self.unpack(hTaxonomy, responseObj)
 
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
+
                   # return nil object if input is empty
                   if hTaxonomy.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: taxonomy object is empty'
+                     @MessagePath.issueWarning(830, responseObj)
                      return nil
                   end
 
@@ -41,9 +43,7 @@ module ADIWG
                      end
                   end
                   if intTaxonomy[:taxonSystem].empty?
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: taxonomy taxonomic classification system object is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(831, responseObj)
                   end
 
                   # taxonomy - general taxonomic scope
@@ -84,9 +84,7 @@ module ADIWG
                      end
                   end
                   if intTaxonomy[:idProcedure].nil? || intTaxonomy[:idProcedure] == ''
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: taxonomy identification procedure is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(832, responseObj)
                   end
 
                   # taxonomy - identification completeness
@@ -118,9 +116,7 @@ module ADIWG
                      end
                   end
                   if intTaxonomy[:taxonClass].empty?
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: taxonomic classification is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(833, responseObj)
                   end
 
                   return intTaxonomy

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

@@ -2,7 +2,7 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
-#  Stan Smith 2018-02-19 refactored error and warning messaging
+#  Stan Smith 2018-06-26 refactored error and warning messaging
 # 	Stan Smith 2016-10-24 original script
 
 require_relative 'module_timeInstant'
@@ -15,24 +15,30 @@ module ADIWG
 
             module TemporalExtent
 
-               def self.unpack(hTemporal, responseObj)
+               def self.unpack(hTemporal, responseObj, inContext = nil)
+
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
 
                   # return nil object if input is empty
                   if hTemporal.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: temporal extent object is empty'
+                     @MessagePath.issueWarning(840, responseObj, inContext)
                      return nil
                   end
 
                   # instance classes needed in script
                   intMetadataClass = InternalMetadata.new
                   intTemporal = intMetadataClass.newTemporalExtent
+
+                  outContext = 'temporal extent'
+                  outContext = inContext + ' > ' + outContext unless inContext.nil?
+
                   haveOne = false
 
                   # temporal extent - time instant (required if not others)
                   if hTemporal.has_key?('timeInstant')
                      hTime = hTemporal['timeInstant']
                      unless hTime.empty?
-                        hObject = TimeInstant.unpack(hTime, responseObj)
+                        hObject = TimeInstant.unpack(hTime, responseObj, outContext)
                         unless hObject.nil?
                            intTemporal[:timeInstant] = hObject
                            haveOne = true
@@ -44,7 +50,7 @@ module ADIWG
                   if hTemporal.has_key?('timePeriod')
                      hTime = hTemporal['timePeriod']
                      unless hTime.empty?
-                        hObject = TimePeriod.unpack(hTime, responseObj)
+                        hObject = TimePeriod.unpack(hTime, responseObj, outContext)
                         unless hObject.nil?
                            intTemporal[:timePeriod] = hObject
                            haveOne = true
@@ -54,10 +60,7 @@ module ADIWG
 
                   # error messages
                   unless haveOne
-                     responseObj[:readerExecutionMessages] <<
-                        'ERROR: mdJson reader: temporal extent must have a time period or time instant'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(841, responseObj, inContext)
                   end
 
                   return intTemporal

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

@@ -2,7 +2,7 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
-#  Stan Smith 2018-02-19 refactored error and warning messaging
+#  Stan Smith 2018-06-27 refactored error and warning messaging
 #  Stan Smith 2017-11-07 add geologic age
 # 	Stan Smith 2016-10-24 original script
 
@@ -17,11 +17,13 @@ module ADIWG
 
             module TimeInstant
 
-               def self.unpack(hInstant, responseObj)
+               def self.unpack(hInstant, responseObj, inContext = nil)
+
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
 
                   # return nil object if input is empty
                   if hInstant.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: time instant object is empty'
+                     @MessagePath.issueWarning(850, responseObj, inContext)
                      return nil
                   end
 
@@ -29,6 +31,9 @@ module ADIWG
                   intMetadataClass = InternalMetadata.new
                   intInstant = intMetadataClass.newTimeInstant
 
+                  outContext = 'time instant'
+                  outContext = inContext + ' > ' + outContext unless inContext.nil?
+
                   # time instant - id
                   if hInstant.has_key?('id')
                      unless hInstant['id'] == ''
@@ -46,7 +51,7 @@ module ADIWG
                   # time instant - identifier {Identifier}
                   if hInstant.has_key?('identifier')
                      unless hInstant['identifier'].empty?
-                        hReturn = Identifier.unpack(hInstant['identifier'], responseObj)
+                        hReturn = Identifier.unpack(hInstant['identifier'], responseObj, outContext)
                         unless hReturn.nil?
                            intInstant[:identifier] = hReturn
                         end
@@ -65,7 +70,7 @@ module ADIWG
                   # time instant - datetime
                   if hInstant.has_key?('dateTime')
                      unless hInstant['dateTime'] == ''
-                        hDate = DateTime.unpack(hInstant['dateTime'], responseObj)
+                        hDate = DateTime.unpack(hInstant['dateTime'], responseObj, outContext)
                         unless hDate.nil?
                            intInstant[:timeInstant] = hDate
                         end
@@ -74,7 +79,7 @@ module ADIWG
                   # time instant - geologic age
                   if hInstant.has_key?('geologicAge')
                      unless hInstant['geologicAge'].empty?
-                        hGeoAge = GeologicAge.unpack(hInstant['geologicAge'], responseObj)
+                        hGeoAge = GeologicAge.unpack(hInstant['geologicAge'], responseObj, outContext)
                         unless hGeoAge.nil?
                            intInstant[:geologicAge] = hGeoAge
                         end
@@ -83,9 +88,7 @@ module ADIWG
 
                   # time instant must have either a timeInstant or geologicAge
                   if intInstant[:timeInstant].empty? && intInstant[:geologicAge].empty?
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: time instant must have dateTime or geologic age'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(851, responseObj, inContext)
                   end
 
                   return intInstant

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

@@ -2,7 +2,7 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
-#  Stan Smith 2018-02-19 refactored error and warning messaging
+#  Stan Smith 2018-06-27 refactored error and warning messaging
 # 	Stan Smith 2016-10-14 original script
 
 module ADIWG
@@ -12,11 +12,13 @@ module ADIWG
 
             module TimeInterval
 
-               def self.unpack(hTimeInt, responseObj)
+               def self.unpack(hTimeInt, responseObj, inContext = nil)
+
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
 
                   # return nil object if input is empty
                   if hTimeInt.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: time interval object is empty'
+                     @MessagePath.issueWarning(860, responseObj, inContext)
                      return nil
                   end
 
@@ -28,19 +30,15 @@ module ADIWG
                   if hTimeInt.has_key?('interval')
                      interval = hTimeInt['interval']
                      unless interval == ''
-                        if interval.is_a?(Integer) || interval.is_a?(Float)
+                        if interval.is_a?(Integer)
                            intTime[:interval] = hTimeInt['interval']
                         else
-                           responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: time interval must be a number'
-                           responseObj[:readerExecutionPass] = false
-                           return nil
+                           @MessagePath.issueError(861, responseObj, inContext)
                         end
                      end
                   end
                   if intTime[:interval].nil? || intTime[:interval] == ''
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: time interval is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(862, responseObj, inContext)
                   end
 
                   # time interval - units (required) {enum}
@@ -53,9 +51,7 @@ module ADIWG
                      end
                   end
                   if intTime[:units].nil? || intTime[:units] == ''
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: time interval units are missing or invalid'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(863, responseObj, inContext)
                   end
 
                   return intTime