adiwg-mdtranslator 2.13.0 → 2.13.1

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_resourceType.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-24 refactored error and warning messaging
 #  Stan Smith 2017-02-15 original script
 
 module ADIWG
@@ -12,11 +12,13 @@ module ADIWG
 
             module ResourceType
 
-               def self.unpack(hType, responseObj)
+               def self.unpack(hType, responseObj, inContext = nil)
+
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
 
                   # return nil object if input is empty
                   if hType.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: resource type object is empty'
+                     @MessagePath.issueWarning(690, responseObj, inContext)
                      return nil
                   end
 
@@ -31,9 +33,7 @@ module ADIWG
                      end
                   end
                   if intType[:type].nil?
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: resource type is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(691, responseObj, inContext)
                   end
 
                   # resource type - name

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

@@ -2,7 +2,7 @@
 # Reader - ADIwg JSON V1 to internal data structure
 
 # History:
-#  Stan Smith 2018-02-19 refactored error and warning messaging
+#  Stan Smith 2018-06-24 refactored error and warning messaging
 #  Stan Smith 2016-10-11 refactored for mdJson 2.0
 #  Stan Smith 2015-07-14 refactored to remove global namespace constants
 #  Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
@@ -25,9 +25,11 @@ module ADIWG
 
                def self.unpack(hUsage, responseObj)
 
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
+
                   # return nil object if input is empty
                   if hUsage.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: resource usage object is empty'
+                     @MessagePath.issueWarning(700, responseObj)
                      return nil
                   end
 
@@ -40,9 +42,7 @@ module ADIWG
                      intUsage[:specificUsage] = hUsage['specificUsage']
                   end
                   if intUsage[:specificUsage].nil? || intUsage[:specificUsage] == ''
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: resource usage specific usage is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(701, responseObj)
                   end
 
                   # resource usage - temporal extent []

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

@@ -2,7 +2,7 @@
 # Reader - ADIwg JSON V1 to internal data structure
 
 # History:
-#  Stan Smith 2018-02-19 refactored error and warning messaging
+#  Stan Smith 2018-06-24 refactored error and warning messaging
 #  Stan Smith 2017-01-19 changed timePeriod to extent []
 #  Stan Smith 2016-10-09 refactored for mdJson 2.0
 #  Stan Smith 2015-07-14 refactored to remove global namespace constants
@@ -25,11 +25,13 @@ module ADIWG
 
             module ResponsibleParty
 
-               def self.unpack(hRParty, responseObj)
+               def self.unpack(hRParty, responseObj, inContext = nil)
+
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
 
                   # return nil object if input is empty
                   if hRParty.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: responsible party object is empty'
+                     @MessagePath.issueWarning(710, responseObj, inContext)
                      return nil
                   end
 
@@ -39,14 +41,15 @@ module ADIWG
                   intMetadataClass = InternalMetadata.new
                   intResParty = intMetadataClass.newResponsibility
 
+                  outContext = 'responsible party'
+                  outContext = inContext + ' > ' + outContext unless inContext.nil?
+
                   # responsible party - role - (required)
                   if hRParty.has_key?('role')
                      intResParty[:roleName] = hRParty['role']
                   end
                   if intResParty[:roleName].nil? || intResParty[:roleName] == ''
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: responsible party role is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(711, responseObj, inContext)
                   end
 
                   # responsible party - role extent
@@ -54,7 +57,7 @@ module ADIWG
                      aExtent = hRParty['roleExtent']
                      aExtent.each do |hItem|
                         unless hItem.empty?
-                           hTimeExtent = Extent.unpack(hItem, responseObj)
+                           hTimeExtent = Extent.unpack(hItem, responseObj, outContext)
                            unless hTimeExtent.nil?
                               intResParty[:roleExtents] << hTimeExtent
                            end
@@ -66,7 +69,7 @@ module ADIWG
                   if hRParty.has_key?('party')
                      hRParty['party'].each do |hParty|
                         unless hParty.empty?
-                           party = Party.unpack(hParty, responseObj)
+                           party = Party.unpack(hParty, responseObj, outContext)
                            unless party.nil?
                               intResParty[:parties] << party
                            end
@@ -74,9 +77,7 @@ module ADIWG
                      end
                   end
                   if intResParty[:parties].empty?
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: responsible party must have at least one party'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(712, responseObj, inContext)
                   end
 
                   return intResParty

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_schema.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-11-02 original script
 
 module ADIWG
@@ -14,10 +14,11 @@ module ADIWG
 
                def self.unpack(hSchema, responseObj)
 
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
+
                   # return nil object if input is empty
                   if hSchema.empty?
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: schema object is empty'
-                     responseObj[:readerExecutionPass] = false
+                     @MessagePath.issueError(720, responseObj)
                      return nil
                   end
 
@@ -30,9 +31,7 @@ module ADIWG
                      intSchema[:name] = hSchema['name']
                   end
                   if intSchema[:name].nil? || intSchema[:name] == ''
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: schema name is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(721, responseObj)
                   end
 
                   # schema - version (required)
@@ -40,9 +39,7 @@ module ADIWG
                      intSchema[:version] = hSchema['version']
                   end
                   if intSchema[:version].nil? || intSchema[:version] == ''
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: schema version is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueWarning(722, responseObj)
                   end
 
                   return intSchema

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_scope.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-14 original script
 
 require_relative 'module_scopeDescription'
@@ -16,11 +16,13 @@ module ADIWG
 
             module Scope
 
-               def self.unpack(hScope, responseObj)
+               def self.unpack(hScope, responseObj, inContext = nil)
+
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
 
                   # return nil object if input is empty
                   if hScope.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: mdJson scope object is empty'
+                     @MessagePath.issueWarning(730, responseObj, inContext)
                      return nil
                   end
 
@@ -28,21 +30,22 @@ module ADIWG
                   intMetadataClass = InternalMetadata.new
                   intScope = intMetadataClass.newScope
 
+                  outContext = 'scope'
+                  outContext = inContext + ' > ' + outContext unless inContext.nil?
+
                   # scope - scope code (required)
                   if hScope.has_key?('scopeCode')
                      intScope[:scopeCode] = hScope['scopeCode']
                   end
                   if intScope[:scopeCode].nil? || intScope[:scopeCode] == ''
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: scope scopeCode is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(731, responseObj, inContext)
                   end
 
                   # scope - scope description [] {MD_ScopeDescription}
                   if hScope.has_key?('scopeDescription')
                      aScopeDes = hScope['scopeDescription']
                      aScopeDes.each do |item|
-                        hScopeDes = ScopeDescription.unpack(item, responseObj)
+                        hScopeDes = ScopeDescription.unpack(item, responseObj, outContext)
                         unless hScopeDes.nil?
                            intScope[:scopeDescriptions] << hScopeDes
                         end
@@ -53,7 +56,7 @@ module ADIWG
                   if hScope.has_key?('scopeExtent')
                      aExtents = hScope['scopeExtent']
                      aExtents.each do |item|
-                        hExtent = Extent.unpack(item, responseObj)
+                        hExtent = Extent.unpack(item, responseObj, outContext)
                         unless hExtent.nil?
                            intScope[:extents] << hExtent
                         end

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_scopeDescription.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-13 original script
 
 module ADIWG
@@ -12,11 +12,13 @@ module ADIWG
 
             module ScopeDescription
 
-               def self.unpack(hScopeDes, responseObj)
+               def self.unpack(hScopeDes, responseObj, inContext = nil)
+
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
 
                   # return nil object if input is empty
                   if hScopeDes.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: scope description object is empty'
+                     @MessagePath.issueWarning(740, responseObj, inContext)
                      return nil
                   end
 
@@ -60,10 +62,7 @@ module ADIWG
 
                   # error messages
                   unless haveScope
-                     responseObj[:readerExecutionMessages] <<
-                        'ERROR: mdJson reader: scope description needs at least one dataset, attribute, feature, or other'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(741, responseObj, inContext)
                   end
 
                   return intScopeDes

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_securityConstraint.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-15 refactored for mdJson 2.0
 #  Stan Smith 2015-07-14 refactored to remove global namespace constants
 #  Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
@@ -17,11 +17,13 @@ module ADIWG
 
             module SecurityConstraint
 
-               def self.unpack(hSecurityCon, responseObj)
+               def self.unpack(hSecurityCon, responseObj, inContext = nil)
+
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
 
                   # return nil object if input is empty
                   if hSecurityCon.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: security constraint object is empty'
+                     @MessagePath.issueWarning(750, responseObj, inContext)
                      return nil
                   end
 
@@ -34,9 +36,7 @@ module ADIWG
                      intSecCon[:classCode] = hSecurityCon['classification']
                   end
                   if intSecCon[:classCode].nil? || intSecCon[:classCode] == ''
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: security constraint classification is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(751, responseObj, inContext)
                   end
 
                   # security constraint - user note

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_series.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-12 original script
 
 module ADIWG
@@ -12,11 +12,13 @@ module ADIWG
 
             module Series
 
-               def self.unpack(hSeries, responseObj)
+               def self.unpack(hSeries, responseObj, inContext = nil)
+
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
 
                   # return nil object if input is empty
                   if hSeries.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: citation series object is empty'
+                     @MessagePath.issueWarning(760, responseObj, inContext)
                      return nil
                   end
 

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_source.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-17 refactored for mdJson 2.0
 #  Stan Smith 2015-07-14 refactored to remove global namespace constants
 #  Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
@@ -23,11 +23,13 @@ module ADIWG
 
             module Source
 
-               def self.unpack(hSource, responseObj)
+               def self.unpack(hSource, responseObj, inContext = nil)
+
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
 
                   # return nil object if input is empty
                   if hSource.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: source object is empty'
+                     @MessagePath.issueWarning(770, responseObj, inContext)
                      return nil
                   end
 
@@ -35,6 +37,9 @@ module ADIWG
                   intMetadataClass = InternalMetadata.new
                   intSource = intMetadataClass.newDataSource
 
+                  outContext = 'source'
+                  outContext = inContext + ' > ' + outContext unless inContext.nil?
+
                   haveRequired = false
 
                   # source - source ID
@@ -56,7 +61,7 @@ module ADIWG
                   if hSource.has_key?('sourceCitation')
                      hObject = hSource['sourceCitation']
                      unless hObject.empty?
-                        hReturn = Citation.unpack(hObject, responseObj)
+                        hReturn = Citation.unpack(hObject, responseObj, outContext)
                         unless hReturn.nil?
                            intSource[:sourceCitation] = hReturn
                         end
@@ -67,7 +72,7 @@ module ADIWG
                   if hSource.has_key?('metadataCitation')
                      aCitation = hSource['metadataCitation']
                      aCitation.each do |item|
-                        hCitation = Citation.unpack(item, responseObj)
+                        hCitation = Citation.unpack(item, responseObj, outContext)
                         unless hCitation.nil?
                            intSource[:metadataCitation] << hCitation
                         end
@@ -78,7 +83,7 @@ module ADIWG
                   if hSource.has_key?('spatialResolution')
                      hObject = hSource['spatialResolution']
                      unless hObject.empty?
-                        hReturn = SpatialResolution.unpack(hObject, responseObj)
+                        hReturn = SpatialResolution.unpack(hObject, responseObj, outContext)
                         unless hReturn.nil?
                            intSource[:spatialResolution] = hReturn
                         end
@@ -89,7 +94,7 @@ module ADIWG
                   if hSource.has_key?('referenceSystem')
                      hObject = hSource['referenceSystem']
                      unless hObject.empty?
-                        hReturn = SpatialReferenceSystem.unpack(hObject, responseObj)
+                        hReturn = SpatialReferenceSystem.unpack(hObject, responseObj, outContext)
                         unless hReturn.nil?
                            intSource[:referenceSystem] = hReturn
                         end
@@ -100,7 +105,7 @@ module ADIWG
                   if hSource.has_key?('sourceProcessStep')
                      aSteps = hSource['sourceProcessStep']
                      aSteps.each do |item|
-                        hStep = ProcessStep.unpack(item, responseObj)
+                        hStep = ProcessStep.unpack(item, responseObj, outContext)
                         unless hStep.nil?
                            intSource[:sourceSteps] << hStep
                         end
@@ -111,7 +116,7 @@ module ADIWG
                   if hSource.has_key?('scope')
                      hObject = hSource['scope']
                      unless hObject.empty?
-                        hReturn = Scope.unpack(hObject, responseObj)
+                        hReturn = Scope.unpack(hObject, responseObj, outContext)
                         unless hReturn.nil?
                            intSource[:scope] = hReturn
                            haveRequired = true
@@ -120,10 +125,7 @@ module ADIWG
                   end
 
                   unless haveRequired
-                     responseObj[:readerExecutionMessages] <<
-                        'ERROR: mdJson reader: source requires a description or scope'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(771, responseObj, inContext)
                   end
 
                   return intSource

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_spatialReference.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 2018-01-10 added reference system WKT
 #  Stan Smith 2017-10-23 added reference system parameter set
 #  Stan Smith 2016-10-16 refactored for mdJson 2.0
@@ -21,11 +21,13 @@ module ADIWG
 
             module SpatialReferenceSystem
 
-               def self.unpack(hSpatialRef, responseObj)
+               def self.unpack(hSpatialRef, responseObj, inContext = nil)
+
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
 
                   # return nil object if input is empty
                   if hSpatialRef.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: spatial reference system object is empty'
+                     @MessagePath.issueWarning(780, responseObj, inContext)
                      return nil
                   end
 
@@ -33,6 +35,8 @@ module ADIWG
                   intMetadataClass = InternalMetadata.new
                   intSpatialRef = intMetadataClass.newSpatialReferenceSystem
 
+                  outContext = 'spatial reference system'
+
                   haveSystem = false
 
                   # spatial reference system - type
@@ -47,7 +51,7 @@ module ADIWG
                   if hSpatialRef.has_key?('referenceSystemIdentifier')
                      hObject = hSpatialRef['referenceSystemIdentifier']
                      unless hObject.empty?
-                        hReturn = Identifier.unpack(hObject, responseObj)
+                        hReturn = Identifier.unpack(hObject, responseObj, outContext)
                         unless hReturn.nil?
                            intSpatialRef[:systemIdentifier] = hReturn
                            haveSystem = true
@@ -67,7 +71,7 @@ module ADIWG
                   if hSpatialRef.has_key?('referenceSystemParameterSet')
                      hObject = hSpatialRef['referenceSystemParameterSet']
                      unless hObject.empty?
-                        hReturn = ReferenceSystemParameters.unpack(hObject, responseObj)
+                        hReturn = ReferenceSystemParameters.unpack(hObject, responseObj, outContext)
                         unless hReturn.nil?
                            intSpatialRef[:systemParameterSet] = hReturn
                            haveSystem = true
@@ -76,10 +80,7 @@ module ADIWG
                   end
 
                   unless haveSystem
-                     responseObj[:readerExecutionMessages] <<
-                        'ERROR: mdJson reader: spatial reference system must declare reference system type, identifier, WKT, or parameter set'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(781, responseObj, inContext)
                   end
 
                   return intSpatialRef