adiwg-mdtranslator 2.13.0 → 2.13.1

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_entityAttribute.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-02-14 rename allowMany to mustBeUnique
 #  Stan Smith 2017-11-01 added new elements to support fgdc and flat files
 #  Stan Smith 2016-10-05 refactored for mdJson 2.0
@@ -13,7 +13,6 @@
 #  Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
 # 	Stan Smith 2013-12-01 original script
 
-
 require_relative 'module_citation'
 require_relative 'module_valueRange'
 require_relative 'module_timePeriod'
@@ -25,11 +24,13 @@ module ADIWG
 
             module EntityAttribute
 
-               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: data dictionary entity attribute object is empty'
+                     @MessagePath.issueWarning(240, responseObj, inContext)
                      return nil
                   end
 
@@ -37,6 +38,8 @@ module ADIWG
                   intMetadataClass = InternalMetadata.new
                   intAttribute = intMetadataClass.newEntityAttribute
 
+                  outContext = nil
+
                   # attribute - common name
                   if hAttribute.has_key?('commonName')
                      unless hAttribute['commonName'] == ''
@@ -49,9 +52,13 @@ module ADIWG
                      intAttribute[:attributeCode] = hAttribute['codeName']
                   end
                   if intAttribute[:attributeCode].nil? || intAttribute[:attributeCode] == ''
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: data dictionary entity attribute code name is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(241, responseObj, inContext)
+                  else
+                     if inContext.nil?
+                        outContext = 'attribute code name ' + hAttribute['codeName']
+                     else
+                        outContext = inContext + ' attribute code name ' + hAttribute['codeName']
+                     end
                   end
 
                   # attribute - alias []
@@ -68,16 +75,14 @@ module ADIWG
                      intAttribute[:attributeDefinition] = hAttribute['definition']
                   end
                   if intAttribute[:attributeDefinition].nil? || intAttribute[:attributeDefinition] == ''
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: data dictionary entity attribute definition is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(242, responseObj, outContext)
                   end
 
                   # attribute - attribute reference
                   if hAttribute.has_key?('attributeReference')
                      hCitation = hAttribute['attributeReference']
                      unless hCitation.empty?
-                        hReturn = Citation.unpack(hCitation, responseObj)
+                        hReturn = Citation.unpack(hCitation, responseObj, outContext)
                         unless hReturn.nil?
                            intAttribute[:attributeReference] = hReturn
                         end
@@ -89,9 +94,7 @@ module ADIWG
                      intAttribute[:dataType] = hAttribute['dataType']
                   end
                   if intAttribute[:dataType].nil? || intAttribute[:dataType] == ''
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: data dictionary entity attribute data type is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(243, responseObj, outContext)
                   end
 
                   # attribute - allow nulls (required)
@@ -106,9 +109,7 @@ module ADIWG
                   if hAttribute.has_key?('allowMany')
                      if hAttribute['allowMany'] === false
                         intAttribute[:mustBeUnique] = hAttribute['allowMany']
-                        responseObj[:readerExecutionMessages] <<
-                           'NOTICE: mdJson reader: data dictionary entity attribute "allowMany" is deprecated, use "mustBeUnique"'
-                        return nil
+                        @MessagePath.issueNotice(244, responseObj, outContext)
                      end
                   end
                   if hAttribute.has_key?('mustBeUnique')
@@ -178,7 +179,7 @@ module ADIWG
                      aValueRange = hAttribute['valueRange']
                      aValueRange.each do |hRange|
                         unless hRange.empty?
-                           hReturn = ValueRange.unpack(hRange, responseObj)
+                           hReturn = ValueRange.unpack(hRange, responseObj, outContext)
                            unless hReturn.nil?
                               intAttribute[:valueRange] << hReturn
                            end
@@ -191,7 +192,7 @@ module ADIWG
                      aTimePeriods = hAttribute['timePeriod']
                      aTimePeriods.each do |hTimePeriod|
                         unless hTimePeriod.empty?
-                           hReturn = TimePeriod.unpack(hTimePeriod, responseObj)
+                           hReturn = TimePeriod.unpack(hTimePeriod, responseObj, outContext)
                            unless hReturn.nil?
                               intAttribute[:timePeriod] << hReturn
                            end

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_entityForeignKey.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-06 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)
@@ -17,11 +17,13 @@ module ADIWG
 
             module EntityForeignKey
 
-               def self.unpack(hFKey, responseObj)
+               def self.unpack(hFKey, responseObj, inContext = nil)
+
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
 
                   # return nil object if input is empty
                   if hFKey.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: data entity foreign key object is empty'
+                     @MessagePath.issueWarning(250, responseObj, inContext)
                      return nil
                   end
 
@@ -35,10 +37,7 @@ module ADIWG
                      intFKey[:fkLocalAttributes] = hFKey['localAttributeCodeName']
                   end
                   if intFKey[:fkLocalAttributes].empty?
-                     responseObj[:readerExecutionMessages] <<
-                        'ERROR: mdJson reader: data entity foreign key local attribute code name is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(251, responseObj, inContext)
                   end
 
                   # entity foreign key - referenced entity code name (required)
@@ -47,10 +46,7 @@ module ADIWG
                      intFKey[:fkReferencedEntity] = hFKey['referencedEntityCodeName']
                   end
                   if intFKey[:fkReferencedEntity].nil? || intFKey[:fkReferencedEntity] == ''
-                     responseObj[:readerExecutionMessages] <<
-                        'ERROR: mdJson reader: data entity foreign key referenced entity name is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(252, responseObj, inContext)
                   end
 
                   # entity foreign key - referenced attribute code name [] (required)
@@ -59,10 +55,7 @@ module ADIWG
                      intFKey[:fkReferencedAttributes] = hFKey['referencedAttributeCodeName']
                   end
                   if intFKey[:fkReferencedAttributes].empty?
-                     responseObj[:readerExecutionMessages] <<
-                        'ERROR: mdJson reader: data entity foreign key referenced attribute name is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(253, responseObj, inContext)
                   end
 
                   return intFKey

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_entityIndex.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-07 refactored for mdJson 2.0
 #  Stan Smith 2015-07-24 added error reporting of missing items
 #  Stan Smith 2015-07-14 refactored to remove global namespace constants
@@ -17,11 +17,13 @@ module ADIWG
 
             module EntityIndex
 
-               def self.unpack(hIndex, responseObj)
+               def self.unpack(hIndex, responseObj, inContext = nil)
+
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
 
                   # return nil object if input is empty
                   if hIndex.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: data dictionary entity index object is empty'
+                     @MessagePath.issueWarning(260, responseObj, inContext)
                      return nil
                   end
 
@@ -35,9 +37,7 @@ module ADIWG
                      intIndex[:indexCode] = hIndex['codeName']
                   end
                   if intIndex[:indexCode].nil? || intIndex[:indexCode] == ''
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: data dictionary entity index code name is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(261, responseObj, inContext)
                   end
 
                   # entity index - allow duplicates (required)
@@ -53,10 +53,7 @@ module ADIWG
                      intIndex[:attributeNames] = hIndex['attributeCodeName']
                   end
                   if intIndex[:attributeNames].empty?
-                     responseObj[:readerExecutionMessages] <<
-                        'ERROR: mdJson reader: data dictionary entity index attribute list is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(262, responseObj, inContext)
                   end
 
                   return intIndex

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_extent.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 2016-10-30 original script
 
 require_relative 'module_geographicExtent'
@@ -16,11 +16,13 @@ module ADIWG
 
             module Extent
 
-               def self.unpack(hExtent, responseObj)
+               def self.unpack(hExtent, responseObj, inContext = nil)
+
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
 
                   # return nil object if input is empty
                   if hExtent.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: extent object is empty'
+                     @MessagePath.issueWarning(270, responseObj, inContext)
                      return nil
                   end
 
@@ -28,6 +30,9 @@ module ADIWG
                   intMetadataClass = InternalMetadata.new
                   intExtent = intMetadataClass.newExtent
 
+                  outContext = 'extent'
+                  outContext = inContext + ' > ' + outContext unless inContext.nil?
+
                   haveExtent = false
 
                   # extent - description
@@ -42,7 +47,7 @@ module ADIWG
                   if hExtent.has_key?('geographicExtent')
                      hExtent['geographicExtent'].each do |item|
                         unless item.empty?
-                           hReturn = GeographicExtent.unpack(item, responseObj)
+                           hReturn = GeographicExtent.unpack(item, responseObj, outContext)
                            unless hReturn.nil?
                               intExtent[:geographicExtents] << hReturn
                               haveExtent = true
@@ -55,7 +60,7 @@ module ADIWG
                   if hExtent.has_key?('temporalExtent')
                      hExtent['temporalExtent'].each do |item|
                         unless item.empty?
-                           hReturn = TemporalExtent.unpack(item, responseObj)
+                           hReturn = TemporalExtent.unpack(item, responseObj, outContext)
                            unless hReturn.nil?
                               intExtent[:temporalExtents] << hReturn
                               haveExtent = true
@@ -68,7 +73,7 @@ module ADIWG
                   if hExtent.has_key?('verticalExtent')
                      hExtent['verticalExtent'].each do |item|
                         unless item.empty?
-                           hReturn = VerticalExtent.unpack(item, responseObj)
+                           hReturn = VerticalExtent.unpack(item, responseObj, outContext)
                            unless hReturn.nil?
                               intExtent[:verticalExtents] << hReturn
                               haveExtent = true
@@ -79,10 +84,7 @@ module ADIWG
 
                   # error messages
                   unless haveExtent
-                     responseObj[:readerExecutionMessages] <<
-                        'ERROR: mdJson reader: extent must have description or at least one geographic, temporal, or vertical extent'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(271, responseObj, inContext)
                   end
 
                   return intExtent

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

@@ -2,12 +2,12 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
-#  Stan Smith 2018-02-18 refactored error and warning messaging
+#  Stan Smith 2018-06-19 refactored error and warning messaging
 #  Stan Smith 2016-11-10 added computedBbox computation
 #  Stan Smith 2016-10-25 original script
 
-require_relative 'module_geoJson'
 require 'adiwg/mdtranslator/internal/module_coordinates'
+require_relative 'module_geoJson'
 
 module ADIWG
    module Mdtranslator
@@ -18,9 +18,11 @@ module ADIWG
 
                def self.unpack(hFeatCol, responseObj)
 
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
+
                   # return nil object if input is empty
                   if hFeatCol.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: GeoJson feature collection object is empty'
+                     @MessagePath.issueWarning(280, responseObj)
                      return nil
                   end
 
@@ -34,17 +36,12 @@ module ADIWG
                         if hFeatCol['type'] == 'FeatureCollection'
                            intFeatCol[:type] = hFeatCol['type']
                         else
-                           responseObj[:readerExecutionMessages] <<
-                              'ERROR: mdJson reader: GeoJson feature collection type must be FeatureCollection'
-                           responseObj[:readerExecutionPass] = false
-                           return nil
+                           @MessagePath.issueError(281, responseObj)
                         end
                      end
                   end
                   if intFeatCol[:type].nil? || intFeatCol[:type] == ''
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: GeoJson feature collection type is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(282, responseObj)
                   end
 
                   # feature collection - bounding box
@@ -63,9 +60,7 @@ module ADIWG
                         end
                      end
                   else
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: GeoJson feature collection features are missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(283, responseObj)
                   end
 
                   # geometry feature - computed bounding box for extent

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_format.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-19 refactored error and warning messaging
 #  Stan Smith 2018-02-05 add 'technicalPrerequisite'
 # 	Stan Smith 2016-10-20 original script
 
@@ -15,11 +15,13 @@ module ADIWG
 
             module Format
 
-               def self.unpack(hFormat, responseObj)
+               def self.unpack(hFormat, responseObj, inContext = nil)
+
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
 
                   # return nil object if input is empty
                   if hFormat.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: distribution media format object is empty'
+                     @MessagePath.issueWarning(290, responseObj, inContext)
                      return nil
                   end
 
@@ -27,20 +29,21 @@ module ADIWG
                   intMetadataClass = InternalMetadata.new
                   intFormat = intMetadataClass.newResourceFormat
 
+                  outContext = 'medium format'
+                  outContext = inContext + ' > ' + outContext unless inContext.nil?
+
                   # format - format specification {citation} (required)
                   if hFormat.has_key?('formatSpecification')
                      hObject = hFormat['formatSpecification']
                      unless hObject.empty?
-                        hReturn = Citation.unpack(hObject, responseObj)
+                        hReturn = Citation.unpack(hObject, responseObj, outContext)
                         unless hReturn.nil?
                            intFormat[:formatSpecification] = hReturn
                         end
                      end
                   end
                   if intFormat[:formatSpecification].empty?
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: distribution media format specification is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(291, responseObj, inContext)
                   end
 
                   # format - amendment number

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_funding.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-19 refactored error and warning messaging
 #  Stan Smith 2017-08-30 refactored for mdJson schema 2.3
 #  Stan Smith 2016-10-30 original script
 
@@ -18,9 +18,11 @@ module ADIWG
 
                def self.unpack(hFunding, responseObj)
 
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
+
                   # return nil object if input is empty
                   if hFunding.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: funding object is empty'
+                     @MessagePath.issueWarning(300, responseObj)
                      return nil
                   end
 
@@ -28,6 +30,8 @@ module ADIWG
                   intMetadataClass = InternalMetadata.new
                   intFunding = intMetadataClass.newFunding
 
+                  outContext = 'funding'
+
                   # funding - description
                   if hFunding.has_key?('description')
                      unless hFunding['description'] == ''
@@ -39,7 +43,7 @@ module ADIWG
                   if hFunding.has_key?('timePeriod')
                      hObject = hFunding['timePeriod']
                      unless hObject.empty?
-                        hReturn = TimePeriod.unpack(hObject, responseObj)
+                        hReturn = TimePeriod.unpack(hObject, responseObj, outContext)
                         unless hReturn.nil?
                            intFunding[:timePeriod] = hReturn
                         end
@@ -59,9 +63,7 @@ module ADIWG
 
                   # error messages
                   if intFunding[:allocations].empty? && intFunding[:timePeriod].empty?
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: funding must have either allocation or timePeriod'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(301, responseObj)
                   end
 
                   return intFunding