adiwg-mdtranslator 2.13.0 → 2.13.1

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

@@ -2,7 +2,7 @@
 # Reader - ADIwg JSON data structure
 
 # History:
-#  Stan Smith 2018-02-18 refactored error and warning messaging
+#  Stan Smith 2018-06-18 refactored error and warning messaging
 #  Stan Smith 2016-10-12 original script
 
 require 'adiwg/mdtranslator/internal/module_dateTimeFun'
@@ -14,11 +14,13 @@ module ADIWG
 
             module Date
 
-               def self.unpack(hDate, responseObj)
+               def self.unpack(hDate, responseObj, inContext = nil)
+
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
 
                   # return nil object if input is empty
                   if hDate.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: date object is empty'
+                     @MessagePath.issueWarning(150, responseObj, inContext)
                      return nil
                   end
 
@@ -31,17 +33,13 @@ module ADIWG
                   if hDate.has_key?('date') && hDate['date'] != ''
                      aDateTimeReturn = AdiwgDateTimeFun.dateTimeFromString(hDate['date'])
                      if aDateTimeReturn[1] == 'ERROR'
-                        responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: date string is invalid'
-                        responseObj[:readerExecutionPass] = false
-                        return nil
+                        @MessagePath.issueError(151, responseObj, inContext)
                      else
                         intDate[:date] = aDateTimeReturn[0]
                         intDate[:dateResolution] = aDateTimeReturn[1]
                      end
                   else
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: date string is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(152, responseObj, inContext)
                   end
 
                   # date - date type (required)
@@ -49,9 +47,7 @@ module ADIWG
                      intDate[:dateType] = hDate['dateType']
                   end
                   if intDate[:dateType].nil? || intDate[:dateType] == ''
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: date type is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(153, responseObj, inContext)
                   end
 
                   # date - description

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

@@ -2,7 +2,7 @@
 # Reader - ADIwg JSON V1 to internal data structure
 
 # History:
-#  Stan Smith 2018-02-18 refactored error and warning messaging
+#  Stan Smith 2018-06-18 refactored error and warning messaging
 #  Stan Smith 2016-10-05 refactored for mdJson 2.0
 #  Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
 #  Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
@@ -18,11 +18,13 @@ module ADIWG
 
             module DateTime
 
-               def self.unpack(sDateTime, responseObj)
+               def self.unpack(sDateTime, responseObj, inContext = nil)
+
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
 
                   # return nil object if input is empty
                   if sDateTime == ''
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: dateTime string is empty'
+                     @MessagePath.issueWarning(160, responseObj, inContext)
                      return nil
                   end
 
@@ -34,9 +36,7 @@ module ADIWG
                   # if dateTimeFromString fails, [0] = nil; [1] = 'ERROR'
                   aDateTimeReturn = AdiwgDateTimeFun.dateTimeFromString(sDateTime)
                   if aDateTimeReturn[1] == 'ERROR'
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: dateTime string is invalid'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(161, responseObj, inContext)
                   else
                      intDateTime[:dateTime] = aDateTimeReturn[0]
                      intDateTime[:dateResolution] = aDateTimeReturn[1]

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

@@ -2,11 +2,9 @@
 # Reader - ADIwg JSON to internal dimension
 
 # History:
-#  Stan Smith 2018-02-18 refactored error and warning messaging
+#  Stan Smith 2018-06-18 refactored error and warning messaging
 # 	Stan Smith 2016-10-18 original script
 
-require_relative 'module_measure'
-
 module ADIWG
    module Mdtranslator
       module Readers
@@ -14,11 +12,13 @@ module ADIWG
 
             module Dimension
 
-               def self.unpack(hDimension, responseObj)
+               def self.unpack(hDimension, responseObj, inContext = nil)
+
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
 
                   # return nil object if input is empty
                   if hDimension.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: spatial representation dimension object is empty'
+                     @MessagePath.issueWarning(170, responseObj, inContext)
                      return nil
                   end
 
@@ -33,9 +33,7 @@ module ADIWG
                      end
                   end
                   if intDimension[:dimensionType].nil?
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: spatial representation dimension type is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(171, responseObj, inContext)
                   end
 
                   # dimension - dimension size (required)
@@ -45,9 +43,7 @@ module ADIWG
                      end
                   end
                   if intDimension[:dimensionSize].nil?
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: spatial representation dimension size is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(172, responseObj, inContext)
                   end
 
                   # dimension - resolution {measure}

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

@@ -2,10 +2,11 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
-#  Stan Smith 2018-02-18 refactored error and warning messaging
+#  Stan Smith 2018-06-18 refactored error and warning messaging
 #  Stan Smith 2018-01-29 add liabilityStatement
 #  Stan Smith 2016-10-21 original script
 
+require_relative '../mdJson_reader'
 require_relative 'module_distributor'
 
 module ADIWG
@@ -17,9 +18,11 @@ module ADIWG
 
                def self.unpack(hDistribution, responseObj)
 
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
+
                   # return nil object if input is empty
                   if hDistribution.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: distribution object is empty'
+                     @MessagePath.issueWarning(180, responseObj)
                      return nil
                   end
 
@@ -58,9 +61,7 @@ module ADIWG
 
                   # error messages
                   unless haveDist
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: distribution must have description or distributor'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(181, responseObj)
                   end
 
                   return intDistribution

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_distributor.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-18 refactored error and warning messaging
 #  Stan Smith 2016-10-21 original script
 
 require_relative 'module_responsibleParty'
@@ -18,9 +18,11 @@ module ADIWG
 
                def self.unpack(hDistrib, responseObj)
 
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
+
                   # return nil object if input is empty
                   if hDistrib.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: distributor object is empty'
+                     @MessagePath.issueWarning(190, responseObj)
                      return nil
                   end
 
@@ -28,27 +30,34 @@ module ADIWG
                   intMetadataClass = InternalMetadata.new
                   intDistrib = intMetadataClass.newDistributor
 
+                  outContext = 'distributor'
+
                   # distributor - contact {responsibleParty} (required)
                   if hDistrib.has_key?('contact')
                      hObject = hDistrib['contact']
                      unless hObject.empty?
-                        hReturn = ResponsibleParty.unpack(hObject, responseObj)
+                        hReturn = ResponsibleParty.unpack(hObject, responseObj, outContext)
                         unless hReturn.nil?
                            intDistrib[:contact] = hReturn
+                           contactId = hReturn[:parties][0][:contactId]
+                           unless contactId.nil?
+                              contactName = @MessagePath.findContact(contactId)[2]
+                              unless contactName.nil?
+                                 outContext = outContext + ' > ' + contactName
+                              end
+                           end
                         end
                      end
                   end
                   if intDistrib[:contact].empty?
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: distributor contact is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(191, responseObj)
                   end
 
                   # distributor - order process [orderProcess]
                   if hDistrib.has_key?('orderProcess')
                      aItems = hDistrib['orderProcess']
                      aItems.each do |item|
-                        hReturn = OrderProcess.unpack(item, responseObj)
+                        hReturn = OrderProcess.unpack(item, responseObj, outContext)
                         unless hReturn.nil?
                            intDistrib[:orderProcess] << hReturn
                         end
@@ -59,7 +68,7 @@ module ADIWG
                   if hDistrib.has_key?('transferOption')
                      aItemss = hDistrib['transferOption']
                      aItemss.each do |item|
-                        hReturn = TransferOption.unpack(item, responseObj)
+                        hReturn = TransferOption.unpack(item, responseObj, outContext)
                         unless hReturn.nil?
                            intDistrib[:transferOptions] << hReturn
                         end

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

@@ -2,7 +2,7 @@
 # Reader - ADIwg JSON V1 to internal data structure
 
 # History:
-#  Stan Smith 2018-02-18 refactored error and warning messaging
+#  Stan Smith 2018-06-18 refactored error and warning messaging
 #  Stan Smith 2017-11-01 added domainReference
 #  Stan Smith 2016-10-07 refactored for mdJson 2.0
 #  Stan Smith 2015-07-23 added error reporting of missing items
@@ -23,9 +23,11 @@ module ADIWG
 
                def self.unpack(hDomain, responseObj)
 
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
+
                   # return nil object if input is empty
                   if hDomain.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: data dictionary domain object is empty'
+                     @MessagePath.issueWarning(200, responseObj)
                      return nil
                   end
 
@@ -33,14 +35,16 @@ module ADIWG
                   intMetadataClass = InternalMetadata.new
                   intDomain = intMetadataClass.newDictionaryDomain
 
+                  outContext = nil
+
                   # data dictionary domain - id (required)
                   if hDomain.has_key?('domainId')
                      intDomain[:domainId] = hDomain['domainId']
                   end
                   if intDomain[:domainId].nil? || intDomain[:domainId] == ''
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: data dictionary domain ID is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(201, responseObj)
+                  else
+                     outContext = 'domain ID ' + hDomain['domainId']
                   end
 
                   # data dictionary domain - name
@@ -55,9 +59,7 @@ module ADIWG
                      intDomain[:domainCode] = hDomain['codeName']
                   end
                   if intDomain[:domainCode].nil? || intDomain[:domainCode] == ''
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: data dictionary domain code is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(202, responseObj, outContext)
                   end
 
                   # data dictionary domain - description (required)
@@ -65,9 +67,7 @@ module ADIWG
                      intDomain[:domainDescription] = hDomain['description']
                   end
                   if intDomain[:domainDescription].nil? || intDomain[:domainDescription] == ''
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: data dictionary domain description is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(203, responseObj, outContext)
                   end
 
                   # data dictionary domain - domain reference {citation}
@@ -84,7 +84,7 @@ module ADIWG
                   # data dictionary domain - items []
                   if hDomain.has_key?('domainItem')
                      hDomain['domainItem'].each do |item|
-                        hDom = DomainItem.unpack(item, responseObj)
+                        hDom = DomainItem.unpack(item, responseObj, outContext)
                         unless hDom.nil?
                            intDomain[:domainItems] << hDom
                         end

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

@@ -2,7 +2,7 @@
 # Reader - ADIwg JSON V1 to internal data structure
 
 # History:
-#  Stan Smith 2018-02-18 refactored error and warning messaging
+#  Stan Smith 2018-06-18 refactored error and warning messaging
 #  Stan Smith 2018-01-24 add domain item reference
 #  Stan Smith 2016-10-07 refactored for mdJson 2.0
 #  Stan Smith 2015-07-23 added error reporting of missing items
@@ -20,11 +20,13 @@ module ADIWG
 
             module DomainItem
 
-               def self.unpack(hDomItem, responseObj)
+               def self.unpack(hDomItem, responseObj, inContext = nil)
+
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
 
                   # return nil object if input is empty
                   if hDomItem.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: data dictionary domain item object is empty'
+                     @MessagePath.issueWarning(210, responseObj, inContext)
                      return nil
                   end
 
@@ -37,9 +39,7 @@ module ADIWG
                      intItem[:itemName] = hDomItem['name']
                   end
                   if intItem[:itemName].nil? || intItem[:itemName] == ''
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: data dictionary domain item name is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(211, responseObj, inContext)
                   end
 
                   # data dictionary domain item - value (required)
@@ -47,9 +47,7 @@ module ADIWG
                      intItem[:itemValue] = hDomItem['value']
                   end
                   if intItem[:itemValue].nil? || intItem[:itemValue] == ''
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: data dictionary domain item value is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(212, responseObj, inContext)
                   end
 
                   # data dictionary domain item - definition (required)
@@ -57,16 +55,14 @@ module ADIWG
                      intItem[:itemDefinition] = hDomItem['definition']
                   end
                   if intItem[:itemDefinition].nil? || intItem[:itemDefinition] == ''
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: data dictionary domain item definition is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(213, responseObj, inContext)
                   end
 
                   # data dictionary domain item - reference {citation}
                   if hDomItem.has_key?('reference')
                      hCitation = hDomItem['reference']
                      unless hCitation.empty?
-                        hReturn = Citation.unpack(hCitation, responseObj)
+                        hReturn = Citation.unpack(hCitation, responseObj, inContext)
                         unless hReturn.nil?
                            intItem[:itemReference] = hReturn
                         end

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_duration.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-18 refactored error and warning messaging
 # 	Stan Smith 2016-10-03 original script
 
 module ADIWG
@@ -12,11 +12,13 @@ module ADIWG
 
             module Duration
 
-               def self.unpack(hDuration, responseObj)
+               def self.unpack(hDuration, responseObj, inContext = nil)
+
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
 
                   # return nil object if input is empty
                   if hDuration.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: duration object is empty'
+                     @MessagePath.issueWarning(220, responseObj, inContext)
                      return nil
                   end
 
@@ -98,9 +100,7 @@ module ADIWG
                      intDuration[:minutes] +
                      intDuration[:seconds]
                   unless totalDuration > 0
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: duration not specified'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(221, responseObj, inContext)
                   end
 
                   return intDuration

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

@@ -2,7 +2,7 @@
 # Reader - mdJson to internal data structure
 
 # History:
-#  Stan Smith 2018-02-18 refactored error and warning messaging
+#  Stan Smith 2018-06-18 refactored error and warning messaging
 #  Stan Smith 2017-11-01 added entityReference, fieldSeparator, headerLines, quoteCharacter
 #  Stan Smith 2016-10-07 refactored for mdJson 2.0
 #  Stan Smith 2015-07-24 added error reporting of missing items
@@ -26,9 +26,11 @@ module ADIWG
 
                def self.unpack(hEntity, responseObj)
 
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
+
                   # return nil object if input is empty
                   if hEntity.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: data dictionary entity object is empty'
+                     @MessagePath.issueWarning(230, responseObj)
                      return nil
                   end
 
@@ -36,6 +38,8 @@ module ADIWG
                   intMetadataClass = InternalMetadata.new
                   intEntity = intMetadataClass.newEntity
 
+                  outContext = nil
+
                   # entity - id
                   if hEntity.has_key?('entityId')
                      s = hEntity['entityId']
@@ -56,9 +60,9 @@ module ADIWG
                      intEntity[:entityCode] = hEntity['codeName']
                   end
                   if intEntity[:entityCode].nil? || intEntity[:entityCode] == ''
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: data dictionary entity code name is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(231, responseObj)
+                  else
+                     outContext = 'entity code name ' + hEntity['codeName']
                   end
 
                   # entity - alias []
@@ -75,16 +79,14 @@ module ADIWG
                      intEntity[:entityDefinition] = hEntity['definition']
                   end
                   if intEntity[:entityDefinition].nil? || intEntity[:entityDefinition] == ''
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: data dictionary entity definition is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(232, responseObj, outContext)
                   end
 
                   # entity - entity reference [] {citation}
                   if hEntity.has_key?('entityReference')
                      hEntity['entityReference'].each do |hCitation|
                         unless hCitation.empty?
-                           hReturn = Citation.unpack(hCitation, responseObj)
+                           hReturn = Citation.unpack(hCitation, responseObj, outContext)
                            unless hReturn.nil?
                               intEntity[:entityReferences] << hReturn
                            end
@@ -105,7 +107,7 @@ module ADIWG
                   if hEntity.has_key?('index')
                      hEntity['index'].each do |hIndex|
                         unless hIndex.empty?
-                           index = EntityIndex.unpack(hIndex, responseObj)
+                           index = EntityIndex.unpack(hIndex, responseObj, outContext)
                            unless index.nil?
                               intEntity[:indexes] << index
                            end
@@ -117,7 +119,7 @@ module ADIWG
                   if hEntity.has_key?('attribute')
                      hEntity['attribute'].each do |hAttribute|
                         unless hAttribute.empty?
-                           attribute = EntityAttribute.unpack(hAttribute, responseObj)
+                           attribute = EntityAttribute.unpack(hAttribute, responseObj, outContext)
                            unless attribute.nil?
                               intEntity[:attributes] << attribute
                            end
@@ -129,7 +131,7 @@ module ADIWG
                   if hEntity.has_key?('foreignKey')
                      hEntity['foreignKey'].each do |hFKey|
                         unless hFKey.empty?
-                           fKey = EntityForeignKey.unpack(hFKey, responseObj)
+                           fKey = EntityForeignKey.unpack(hFKey, responseObj, outContext)
                            unless fKey.nil?
                               intEntity[:foreignKeys] << fKey
                            end