adiwg-mdtranslator 2.13.0 → 2.13.1

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_timePeriod.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-14 original script
 
@@ -19,11 +19,13 @@ module ADIWG
 
             module TimePeriod
 
-               def self.unpack(hTimePeriod, responseObj)
+               def self.unpack(hTimePeriod, responseObj, inContext = nil)
+
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
 
                   # return nil object if input is empty
                   if hTimePeriod.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: time period object is empty'
+                     @MessagePath.issueWarning(870, responseObj, inContext)
                      return nil
                   end
 
@@ -31,6 +33,9 @@ module ADIWG
                   intMetadataClass = InternalMetadata.new
                   intTimePer = intMetadataClass.newTimePeriod
 
+                  outContext = 'time period'
+                  outContext = inContext + ' > ' + outContext unless inContext.nil?
+
                   haveTime = false
 
                   # time period - id
@@ -50,7 +55,7 @@ module ADIWG
                   # time period - identifier {Identifier}
                   if hTimePeriod.has_key?('identifier')
                      unless hTimePeriod['identifier'].empty?
-                        hReturn = Identifier.unpack(hTimePeriod['identifier'], responseObj)
+                        hReturn = Identifier.unpack(hTimePeriod['identifier'], responseObj, outContext)
                         unless hReturn.nil?
                            intTimePer[:identifier] = hReturn
                         end
@@ -69,7 +74,7 @@ module ADIWG
                   # time period - start datetime (required if)
                   if hTimePeriod.has_key?('startDateTime')
                      unless hTimePeriod['startDateTime'] == ''
-                        hReturn = DateTime.unpack(hTimePeriod['startDateTime'], responseObj)
+                        hReturn = DateTime.unpack(hTimePeriod['startDateTime'], responseObj, outContext)
                         unless hReturn.nil?
                            intTimePer[:startDateTime] = hReturn
                            haveTime = true
@@ -80,7 +85,7 @@ module ADIWG
                   # time period - end datetime (required if)
                   if hTimePeriod.has_key?('endDateTime')
                      unless hTimePeriod['endDateTime'] == ''
-                        hReturn = DateTime.unpack(hTimePeriod['endDateTime'], responseObj)
+                        hReturn = DateTime.unpack(hTimePeriod['endDateTime'], responseObj, outContext)
                         unless hReturn.nil?
                            intTimePer[:endDateTime] = hReturn
                            haveTime = true
@@ -91,7 +96,7 @@ module ADIWG
                   # time period - start geologic age (required if)
                   if hTimePeriod.has_key?('startGeologicAge')
                      unless hTimePeriod['startGeologicAge'].empty?
-                        hReturn = GeologicAge.unpack(hTimePeriod['startGeologicAge'], responseObj)
+                        hReturn = GeologicAge.unpack(hTimePeriod['startGeologicAge'], responseObj, outContext)
                         unless hReturn.nil?
                            intTimePer[:startGeologicAge] = hReturn
                            haveTime = true
@@ -102,7 +107,7 @@ module ADIWG
                   # time period - end geologic age (required if)
                   if hTimePeriod.has_key?('endGeologicAge')
                      unless hTimePeriod['endGeologicAge'].empty?
-                        hReturn = GeologicAge.unpack(hTimePeriod['endGeologicAge'], responseObj)
+                        hReturn = GeologicAge.unpack(hTimePeriod['endGeologicAge'], responseObj, outContext)
                         unless hReturn.nil?
                            intTimePer[:endGeologicAge] = hReturn
                            haveTime = true
@@ -112,26 +117,20 @@ module ADIWG
 
                   # error messages
                   unless haveTime
-                     responseObj[:readerExecutionMessages] <<
-                        'ERROR: mdJson reader: time period must have a start and/or end dateTime, or geologic age'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(871, responseObj, inContext)
                   end
 
                   # time period - time interval
                   # time interval must have a start and/or end time
                   if hTimePeriod.has_key?('timeInterval')
                      unless hTimePeriod['timeInterval'].empty?
-                        hReturn = TimeInterval.unpack(hTimePeriod['timeInterval'], responseObj)
+                        hReturn = TimeInterval.unpack(hTimePeriod['timeInterval'], responseObj, outContext)
                         unless hReturn.nil?
                            intTimePer[:timeInterval] = hReturn
                         end
-                     end
-                     if intTimePer[:startDateTime].empty? && intTimePer[:endDateTime].empty?
-                        responseObj[:readerExecutionMessages] <<
-                           'ERROR: mdJson reader: time interval must be accompanied by a start and/or end dateTime'
-                        responseObj[:readerExecutionPass] = false
-                        return nil
+                        if intTimePer[:startDateTime].empty? && intTimePer[:endDateTime].empty?
+                           @MessagePath.issueError(872, responseObj, inContext)
+                        end
                      end
                   end
 
@@ -139,16 +138,13 @@ module ADIWG
                   # duration must have a start and/or end time
                   if hTimePeriod.has_key?('duration')
                      unless hTimePeriod['duration'].empty?
-                        hReturn = Duration.unpack(hTimePeriod['duration'], responseObj)
+                        hReturn = Duration.unpack(hTimePeriod['duration'], responseObj, outContext)
                         unless hReturn.nil?
                            intTimePer[:duration] = hReturn
                         end
-                     end
-                     if intTimePer[:startDateTime].empty? && intTimePer[:endDateTime].empty?
-                        responseObj[:readerExecutionMessages] <<
-                           'ERROR: mdJson reader: duration must be accompanied by a start and/or end dateTime'
-                        responseObj[:readerExecutionPass] = false
-                        return nil
+                        if intTimePer[:startDateTime].empty? && intTimePer[:endDateTime].empty?
+                           @MessagePath.issueError(873, responseObj, inContext)
+                        end
                      end
                   end
 

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_transferOption.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-21 original script
 
 require_relative 'module_medium'
@@ -17,11 +17,13 @@ module ADIWG
 
             module TransferOption
 
-               def self.unpack(hTransOp, responseObj)
+               def self.unpack(hTransOp, responseObj, inContext = nil)
+
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
 
                   # return nil object if input is empty
                   if hTransOp.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: distributor transfer option object is empty'
+                     @MessagePath.issueWarning(880, responseObj, inContext)
                      return nil
                   end
 
@@ -29,6 +31,9 @@ module ADIWG
                   intMetadataClass = InternalMetadata.new
                   intTransOpt = intMetadataClass.newTransferOption
 
+                  outContext = 'transfer option'
+                  outContext = inContext + ' > ' + outContext unless inContext.nil?
+
                   # transfer option - units of distribution
                   if hTransOp.has_key?('unitsOfDistribution')
                      unless hTransOp['unitsOfDistribution'] == ''
@@ -47,7 +52,7 @@ module ADIWG
                   # transfer option - online option [onlineResource]
                   if hTransOp.has_key?('onlineOption')
                      hTransOp['onlineOption'].each do |item|
-                        hReturn = OnlineResource.unpack(item, responseObj)
+                        hReturn = OnlineResource.unpack(item, responseObj, outContext)
                         unless hReturn.nil?
                            intTransOpt[:onlineOptions] << hReturn
                            haveOption = true
@@ -58,7 +63,7 @@ module ADIWG
                   # transfer option - offline option [medium]
                   if hTransOp.has_key?('offlineOption')
                      hTransOp['offlineOption'].each do |item|
-                        hReturn = Medium.unpack(item, responseObj)
+                        hReturn = Medium.unpack(item, responseObj, outContext)
                         unless hReturn.nil?
                            intTransOpt[:offlineOptions] << hReturn
                            haveOption = true
@@ -70,7 +75,7 @@ module ADIWG
                   if hTransOp.has_key?('transferFrequency')
                      hObject = hTransOp['transferFrequency']
                      unless hObject.empty?
-                        hReturn = Duration.unpack(hObject, responseObj)
+                        hReturn = Duration.unpack(hObject, responseObj, outContext)
                         unless hReturn.nil?
                            intTransOpt[:transferFrequency] = hReturn
                         end
@@ -80,7 +85,7 @@ module ADIWG
                   # transfer option - distribution format [format]
                   if hTransOp.has_key?('distributionFormat')
                      hTransOp['distributionFormat'].each do |item|
-                        hReturn = Format.unpack(item, responseObj)
+                        hReturn = Format.unpack(item, responseObj, outContext)
                         unless hReturn.nil?
                            intTransOpt[:distributionFormats] << hReturn
                         end
@@ -89,8 +94,7 @@ module ADIWG
 
                   # error messages
                   unless haveOption
-                     responseObj[:readerExecutionMessages] <<
-                        'WARNING: mdJson reader: transfer option did not provide an online or offline option'
+                     @MessagePath.issueWarning(881, responseObj, inContext)
                   end
 
                   return intTransOpt

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_valueRange.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-01 original script
 
 module ADIWG
@@ -12,11 +12,13 @@ module ADIWG
 
             module ValueRange
 
-               def self.unpack(hRange, responseObj)
+               def self.unpack(hRange, responseObj, inContext = nil)
+
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
 
                   # return nil object if input is empty
                   if hRange.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: value range object is empty'
+                     @MessagePath.issueWarning(890, responseObj, inContext)
                      return nil
                   end
 
@@ -29,9 +31,7 @@ module ADIWG
                      intRange[:minRangeValue] = hRange['minRangeValue']
                   end
                   if intRange[:minRangeValue].nil? || intRange[:minRangeValue] == ''
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: value range minimum is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(891, responseObj, inContext)
                   end
 
                   # value range - maximum range value (required)
@@ -39,9 +39,7 @@ module ADIWG
                      intRange[:maxRangeValue] = hRange['maxRangeValue']
                   end
                   if intRange[:maxRangeValue].nil? || intRange[:maxRangeValue] == ''
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: value range maximum is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(892, responseObj, inContext)
                   end
 
                   return intRange

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_vectorObject.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-19 original script
 
 module ADIWG
@@ -12,11 +12,13 @@ module ADIWG
 
             module VectorObject
 
-               def self.unpack(hVecObj, responseObj)
+               def self.unpack(hVecObj, responseObj, inContext = nil)
+
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
 
                   # return nil object if input is empty
                   if hVecObj.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: vector object is empty'
+                     @MessagePath.issueWarning(900, responseObj, inContext)
                      return nil
                   end
 
@@ -31,9 +33,7 @@ module ADIWG
                      end
                   end
                   if intVecObj[:objectType].nil?
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: vector object type is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(901, responseObj, inContext)
                   end
 
                   # vector object - object count

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_vectorRepresentation.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-19 original script
 
 require_relative 'module_vectorObject'
@@ -14,20 +14,25 @@ module ADIWG
 
             module VectorRepresentation
 
-               def self.unpack(hVector, responseObj)
+               def self.unpack(hVector, responseObj, inContext = nil)
+
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
 
                   # return nil object if input is empty
                   if hVector.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: vector representation object is empty'
+                     @MessagePath.issueWarning(910, responseObj, inContext)
                      return nil
                   end
 
-                  haveVector = false
-
                   # instance classes needed in script
                   intMetadataClass = InternalMetadata.new
                   intVector = intMetadataClass.newVectorInfo
 
+                  outContext = 'vector representation'
+                  outContext = inContext + ' > ' + outContext unless inContext.nil?
+
+                  haveVector = false
+
                   # vector representation - topology level
                   if hVector.has_key?('topologyLevel')
                      unless hVector['topologyLevel'] == ''
@@ -39,7 +44,7 @@ module ADIWG
                   # vector representation - vector object []
                   if hVector.has_key?('vectorObject')
                      hVector['vectorObject'].each do |item|
-                        hVec = VectorObject.unpack(item, responseObj)
+                        hVec = VectorObject.unpack(item, responseObj, outContext)
                         unless hVec.nil?
                            intVector[:vectorObject] << hVec
                            haveVector = true
@@ -49,10 +54,7 @@ module ADIWG
 
                   # error messages
                   unless haveVector
-                     responseObj[:readerExecutionMessages] <<
-                        'ERROR: mdJson reader: vector representation must have a topology level or vector object'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(911, responseObj, inContext)
                   end
 
                   return intVector

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_verticalDatum.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-10-23 original script
 
 require_relative 'module_identifier'
@@ -14,11 +14,13 @@ module ADIWG
 
             module VerticalDatum
 
-               def self.unpack(hDatum, responseObj)
+               def self.unpack(hDatum, responseObj, inContext = nil)
+
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
 
                   # return nil object if input is empty
                   if hDatum.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: vertical datum object is empty'
+                     @MessagePath.issueWarning(920, responseObj, inContext)
                      return nil
                   end
 
@@ -26,10 +28,13 @@ module ADIWG
                   intMetadataClass = InternalMetadata.new
                   intDatum = intMetadataClass.newVerticalDatum
 
+                  outContext = 'vertical datum'
+                  outContext = inContext + ' > ' + outContext unless inContext.nil?
+
                   # vertical datum - identifier {identifier}
                   if hDatum.has_key?('datumIdentifier')
                      unless hDatum['datumIdentifier'].empty?
-                        hReturn = Identifier.unpack(hDatum['datumIdentifier'], responseObj)
+                        hReturn = Identifier.unpack(hDatum['datumIdentifier'], responseObj, outContext)
                         unless hReturn.nil?
                            intDatum[:datumIdentifier] = hReturn
                         end
@@ -79,10 +84,7 @@ module ADIWG
 
                   # error messages
                   if intDatum[:datumIdentifier].empty? && haveOthers != 4
-                     responseObj[:readerExecutionMessages] <<
-                        'ERROR: mdJson reader: vertical datum must have an identifier or all other elements'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(921, responseObj, inContext)
                   end
 
                   return intDatum

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_verticalExtent.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-24 original script
 
 require_relative 'module_spatialReference'
@@ -14,11 +14,13 @@ module ADIWG
 
             module VerticalExtent
 
-               def self.unpack(hVertical, responseObj)
+               def self.unpack(hVertical, responseObj, inContext = nil)
+
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
 
                   # return nil object if input is empty
                   if hVertical.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: vertical extent object is empty'
+                     @MessagePath.issueWarning(930, responseObj, inContext)
                      return nil
                   end
 
@@ -26,6 +28,9 @@ module ADIWG
                   intMetadataClass = InternalMetadata.new
                   intVertical = intMetadataClass.newVerticalExtent
 
+                  outContext = 'vertical extent'
+                  outContext = inContext + ' > ' + outContext unless inContext.nil?
+
                   # vertical extent - description
                   if hVertical.has_key?('description')
                      unless hVertical['description'] == ''
@@ -38,9 +43,7 @@ module ADIWG
                      intVertical[:minValue] = hVertical['minValue']
                   end
                   if intVertical[:minValue].nil? || intVertical[:minValue] == ''
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: vertical extent minimum value is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(931, responseObj, inContext)
                   end
 
                   # vertical extent - max value (required)
@@ -48,25 +51,21 @@ module ADIWG
                      intVertical[:maxValue] = hVertical['maxValue']
                   end
                   if intVertical[:maxValue].nil? || intVertical[:maxValue] == ''
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: vertical extent maximum value is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(932, responseObj, inContext)
                   end
 
                   # vertical extent - crs ID {spatialReference} (required)
                   if hVertical.has_key?('crsId')
                      hObject = hVertical['crsId']
                      unless hObject.empty?
-                        hReturn = SpatialReferenceSystem.unpack(hObject, responseObj)
+                        hReturn = SpatialReferenceSystem.unpack(hObject, responseObj, outContext)
                         unless hReturn.nil?
                            intVertical[:crsId] = hReturn
                         end
                      end
                   end
                   if intVertical[:crsId].empty?
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: vertical extent CRS identifier is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(933, responseObj, inContext)
                   end
 
                   return intVertical