adiwg-mdtranslator 2.13.0 → 2.13.1

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_additionalDocumentation.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-13 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,9 +23,11 @@ module ADIWG
 
                def self.unpack(hAddDoc, responseObj)
 
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
+
                   # return nil object if input is empty
                   if hAddDoc.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: additional documentation object is empty'
+                     @MessagePath.issueWarning(1, responseObj)
                      return nil
                   end
 
@@ -45,9 +47,7 @@ module ADIWG
                      end
                   end
                   if intAddDoc[:resourceTypes].empty?
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: additional documentation is missing resource type'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(2, responseObj)
                   end
 
                   # additional documentation - citation [] (required)
@@ -60,9 +60,7 @@ module ADIWG
                      end
                   end
                   if intAddDoc[:citation].empty?
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: additional documentation is missing citation'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(3, responseObj)
                   end
 
                   return intAddDoc

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_address.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-13 refactored error and warning messaging
 #  Stan Smith 2016-10-03 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)
@@ -19,11 +19,13 @@ module ADIWG
 
             module Address
 
-               def self.unpack(hAddress, responseObj)
+               def self.unpack(hAddress, responseObj, inContext = nil)
+
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
 
                   # return nil object if input is empty
                   if hAddress.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: address object is empty'
+                     @MessagePath.issueWarning(10, responseObj, inContext)
                      return nil
                   end
 
@@ -40,9 +42,7 @@ module ADIWG
                      end
                   end
                   if intAdd[:addressTypes].empty?
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: address type is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(11, responseObj, inContext)
                   end
 
                   # address - description

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

@@ -2,6 +2,7 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
+#  Stan Smith 2018-06-15 refactored error and warning messaging
 #  Stan Smith 2018-03-28 add responsible party array
 #  Stan Smith 2018-02-18 refactored error and warning messaging
 #  Stan Smith 2017-08-30 refactored for mdJson schema 2.3
@@ -19,9 +20,11 @@ module ADIWG
 
                def self.unpack(hAlloc, responseObj)
 
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
+
                   # return nil object if input is empty
                   if hAlloc.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: budget allocation object is empty'
+                     @MessagePath.issueWarning(20, responseObj)
                      return nil
                   end
 
@@ -41,9 +44,7 @@ module ADIWG
                      intAlloc[:amount] = hAlloc['amount']
                   end
                   if intAlloc[:amount].nil? || intAlloc[:amount] == ''
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: budget allocation amount is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(21, responseObj)
                   end
 
                   # allocation - currency (required)
@@ -51,9 +52,7 @@ module ADIWG
                      intAlloc[:currency] = hAlloc['currency']
                   end
                   if intAlloc[:currency].nil? || intAlloc[:currency] == ''
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: budget allocation currency is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(22, responseObj)
                   end
 
                   # allocation - source ID {contactId}

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_associatedResource.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-15 refactored error and warning messaging
 #  Stan Smith 2016-10-18 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)
@@ -27,9 +27,11 @@ module ADIWG
 
                def self.unpack(hAssocRes, responseObj)
 
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
+
                   # return nil object if input is empty
                   if hAssocRes.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: associated resource object is empty'
+                     @MessagePath.issueWarning(30, responseObj)
                      return nil
                   end
 
@@ -49,9 +51,7 @@ module ADIWG
                      end
                   end
                   if intAssocRes[:resourceTypes].empty?
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: associated resource resource type is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(31, responseObj)
                   end
 
                   # associated resource - association type (required)
@@ -59,9 +59,7 @@ module ADIWG
                      intAssocRes[:associationType] = hAssocRes['associationType']
                   end
                   if intAssocRes[:associationType].nil? || intAssocRes[:associationType] == ''
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: associated resource association type is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(32, responseObj)
                   end
 
                   # associated resource - initiative type
@@ -82,9 +80,7 @@ module ADIWG
                      end
                   end
                   if intAssocRes[:resourceCitation].empty?
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: associated resource citation is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(33, responseObj)
                   end
 
                   # associated resource - metadata citation

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_attribute.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-15 refactored error and warning messaging
 # 	Stan Smith 2016-10-18 original script
 
 require_relative 'module_identifier'
@@ -14,11 +14,13 @@ module ADIWG
 
             module Attribute
 
-               def self.unpack(hAttribute, responseObj)
+               def self.unpack(hAttribute, responseObj, inContext = nil)
+
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
 
                   # return nil object if input is empty
                   if hAttribute.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: coverage description attribute object is empty'
+                     @MessagePath.issueWarning(40, responseObj, inContext)
                      return nil
                   end
 
@@ -26,6 +28,9 @@ module ADIWG
                   intMetadataClass = InternalMetadata.new
                   intAttGroup = intMetadataClass.newAttribute
 
+                  outContext = 'attribute'
+                  outContext = inContext + ' > ' + outContext unless inContext.nil?
+
                   # attribute group - sequence identifier
                   if hAttribute.has_key?('sequenceIdentifier')
                      unless hAttribute['sequenceIdentifier'] == ''
@@ -41,9 +46,7 @@ module ADIWG
                         end
                      end
                      if intAttGroup[:sequenceIdentifierType].nil?
-                        responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: coverage description attribute sequence identifierType is missing'
-                        responseObj[:readerExecutionPass] = false
-                        return nil
+                        @MessagePath.issueError(41, responseObj, inContext)
                      end
                   end
 
@@ -58,7 +61,7 @@ module ADIWG
                   if hAttribute.has_key?('attributeIdentifier')
                      aItems = hAttribute['attributeIdentifier']
                      aItems.each do |item|
-                        hReturn = Identifier.unpack(item, responseObj)
+                        hReturn = Identifier.unpack(item, responseObj, outContext)
                         unless hReturn.nil?
                            intAttGroup[:attributeIdentifiers] << hReturn
                         end
@@ -87,9 +90,7 @@ module ADIWG
                         end
                      end
                      if intAttGroup[:units].nil?
-                        responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: coverage description attribute units are missing'
-                        responseObj[:readerExecutionPass] = false
-                        return nil
+                        @MessagePath.issueError(42, responseObj, inContext)
                      end
                   end
 
@@ -157,9 +158,7 @@ module ADIWG
                         end
                      end
                      if intAttGroup[:boundUnits].nil?
-                        responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: coverage description attribute bound units are missing'
-                        responseObj[:readerExecutionPass] = false
-                        return nil
+                        @MessagePath.issueError(43, responseObj, inContext)
                      end
                   end
 

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_attributeGroup.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-15 refactored error and warning messaging
 # 	Stan Smith 2016-10-18 original script
 
 require_relative 'module_attribute'
@@ -16,9 +16,13 @@ module ADIWG
 
                def self.unpack(hAttGroup, responseObj)
 
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
+
+                  inContext = 'coverage description'
+
                   # return nil object if input is empty
                   if hAttGroup.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: coverage description attribute group object is empty'
+                     @MessagePath.issueWarning(50, responseObj, inContext)
                      return nil
                   end
 
@@ -26,6 +30,8 @@ module ADIWG
                   intMetadataClass = InternalMetadata.new
                   intAttGroup = intMetadataClass.newAttributeGroup
 
+                  outContext = inContext + ' attribute group'
+
                   # attribute group - attribute content type [] (required)
                   if hAttGroup.has_key?('attributeContentType')
                      hAttGroup['attributeContentType'].each do |item|
@@ -35,16 +41,14 @@ module ADIWG
                      end
                   end
                   if intAttGroup[:attributeContentTypes].empty?
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: coverage description attribute group attribute content type is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(51, responseObj, inContext)
                   end
 
                   # attribute group - attribute []
                   if hAttGroup.has_key?('attribute')
                      aItems = hAttGroup['attribute']
                      aItems.each do |item|
-                        hReturn = Attribute.unpack(item, responseObj)
+                        hReturn = Attribute.unpack(item, responseObj, outContext)
                         unless hReturn.nil?
                            intAttGroup[:attributes] << hReturn
                         end

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_bearingDistanceResolution.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-15 refactored error and warning messaging
 # 	Stan Smith 2017-10-19 original script
 
 module ADIWG
@@ -12,11 +12,13 @@ module ADIWG
 
             module BearingDistanceResolution
 
-               def self.unpack(hBearRes, responseObj)
+               def self.unpack(hBearRes, responseObj, inContext = nil)
+
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
 
                   # return nil object if input is empty
                   if hBearRes.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: bearing distance resolution object is empty'
+                     @MessagePath.issueWarning(60, responseObj, inContext)
                      return nil
                   end
 
@@ -29,9 +31,7 @@ module ADIWG
                      intBearRes[:distanceResolution] = hBearRes['distanceResolution']
                   end
                   if intBearRes[:distanceResolution].nil? || intBearRes[:distanceResolution] == ''
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: bearing distance resolution is missing distance resolution'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(61, responseObj, inContext)
                   end
 
                   # bearing distance resolution - distance unit of measure (required)
@@ -39,9 +39,7 @@ module ADIWG
                      intBearRes[:distanceUnitOfMeasure] = hBearRes['distanceUnitOfMeasure']
                   end
                   if intBearRes[:distanceUnitOfMeasure].nil? || intBearRes[:distanceUnitOfMeasure] == ''
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: bearing distance resolution distance units are missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(62, responseObj, inContext)
                   end
 
                   # bearing distance resolution - bearing resolution (required)
@@ -49,9 +47,7 @@ module ADIWG
                      intBearRes[:bearingResolution] = hBearRes['bearingResolution']
                   end
                   if intBearRes[:bearingResolution].nil? || intBearRes[:bearingResolution] == ''
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: bearing distance resolution bearing resolution is missing '
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(63, responseObj, inContext)
                   end
 
                   # bearing distance resolution - bearing unit of measure (required)
@@ -59,9 +55,7 @@ module ADIWG
                      intBearRes[:bearingUnitOfMeasure] = hBearRes['bearingUnitOfMeasure']
                   end
                   if intBearRes[:bearingUnitOfMeasure].nil? || intBearRes[:bearingUnitOfMeasure] == ''
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: bearing distance resolution bearing units is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(64, responseObj, inContext)
                   end
 
                   # bearing distance resolution - bearing reference direction (required)
@@ -69,9 +63,7 @@ module ADIWG
                      intBearRes[:bearingReferenceDirection] = hBearRes['bearingReferenceDirection']
                   end
                   if intBearRes[:bearingReferenceDirection].nil? || intBearRes[:bearingReferenceDirection] == ''
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: bearing distance resolution bearing direction is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(65, responseObj, inContext)
                   end
 
                   # bearing distance resolution - bearing reference meridian (required)
@@ -79,9 +71,7 @@ module ADIWG
                      intBearRes[:bearingReferenceMeridian] = hBearRes['bearingReferenceMeridian']
                   end
                   if intBearRes[:bearingReferenceMeridian].nil? || intBearRes[:bearingReferenceMeridian] == ''
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: bearing distance resolution bearing meridian is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(66, responseObj, inContext)
                   end
 
                   return intBearRes

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_boundingBox.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-15 refactored error and warning messaging
 #  Stan Smith 2017-09-28 add altitude to support fgdc
 #  Stan Smith 2016-12-01 original script
 
@@ -13,11 +13,13 @@ module ADIWG
 
             module BoundingBox
 
-               def self.unpack(hBBox, responseObj)
+               def self.unpack(hBBox, responseObj, inContext = nil)
+
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
 
                   # return nil object if input is empty
                   if hBBox.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: bounding box object is empty'
+                     @MessagePath.issueWarning(70, responseObj, inContext)
                      return nil
                   end
 
@@ -30,14 +32,9 @@ module ADIWG
                      intBBox[:westLongitude] = hBBox['westLongitude']
                   end
                   if intBBox[:westLongitude].nil? || intBBox[:westLongitude] == ''
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: bounding box west boundary is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
-                  end
-                  if intBBox[:westLongitude].abs > 180
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: bounding box longitude must be between -180 and +180'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(71, responseObj, inContext)
+                  elsif intBBox[:westLongitude].abs > 180
+                     @MessagePath.issueError(72, responseObj, inContext)
                   end
 
                   # bounding box - east longitude (required)
@@ -45,14 +42,9 @@ module ADIWG
                      intBBox[:eastLongitude] = hBBox['eastLongitude']
                   end
                   if intBBox[:eastLongitude].nil? || intBBox[:eastLongitude] == ''
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: bounding box east boundary is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
-                  end
-                  if intBBox[:eastLongitude].abs > 180
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: bounding box longitude must be between -180 and +180'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(73, responseObj, inContext)
+                  elsif intBBox[:eastLongitude].abs > 180
+                     @MessagePath.issueError(72, responseObj, inContext)
                   end
 
                   # bounding box - south latitude (required)
@@ -60,14 +52,9 @@ module ADIWG
                      intBBox[:southLatitude] = hBBox['southLatitude']
                   end
                   if intBBox[:southLatitude].nil? || intBBox[:southLatitude] == ''
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: bounding box south boundary is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
-                  end
-                  if intBBox[:southLatitude].abs > 90
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: bounding box latitude must be between -90 and +90'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(74, responseObj, inContext)
+                  elsif intBBox[:southLatitude].abs > 90
+                     @MessagePath.issueError(75, responseObj, inContext)
                   end
 
                   # bounding box - north latitude (required)
@@ -75,14 +62,9 @@ module ADIWG
                      intBBox[:northLatitude] = hBBox['northLatitude']
                   end
                   if intBBox[:northLatitude].nil? || intBBox[:northLatitude] == ''
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: bounding box north boundary is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
-                  end
-                  if intBBox[:northLatitude].abs > 90
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: bounding box latitude must be between -90 and +90'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(76, responseObj, inContext)
+                  elsif intBBox[:northLatitude].abs > 90
+                     @MessagePath.issueError(75, responseObj, inContext)
                   end
 
                   # bounding box - minimum altitude
@@ -107,9 +89,7 @@ module ADIWG
                   end
                   unless intBBox[:minimumAltitude].nil? && intBBox[:maximumAltitude].nil?
                      if intBBox[:unitsOfAltitude].nil? || intBBox[:unitsOfAltitude] == ''
-                        responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: bounding box altitude units of measure are missing'
-                        responseObj[:readerExecutionPass] = false
-                        return nil
+                        @MessagePath.issueError(77, responseObj, inContext)
                      end
                   end