adiwg-mdtranslator 2.13.0 → 2.13.1

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_geometryProperties.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-20 refactored error and warning messaging
 #  Stan Smith 2016-10-25 original script
 
 require_relative 'module_identifier'
@@ -16,9 +16,11 @@ module ADIWG
 
                def self.unpack(hGeoProp, responseObj)
 
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
+
                   # return nil object if input is empty
                   if hGeoProp.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: GeoJSON geometry properties object is empty'
+                     @MessagePath.issueWarning(390, responseObj)
                      return nil
                   end
 

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

@@ -3,7 +3,7 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
-#  Stan Smith 2018-02-18 refactored error and warning messaging
+#  Stan Smith 2018-06-20 refactored error and warning messaging
 # 	Stan Smith 2016-10-19 original script
 
 require_relative 'module_gridRepresentation'
@@ -15,12 +15,13 @@ module ADIWG
 
             module GeorectifiedRepresentation
 
-               def self.unpack(hGeoRec, responseObj)
+               def self.unpack(hGeoRec, responseObj, inContext = nil)
+
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
 
                   # return nil object if input is empty
                   if hGeoRec.empty?
-                     responseObj[:readerExecutionMessages] <<
-                        'WARNING: mdJson reader: georectified spatial representation object is empty'
+                     @MessagePath.issueWarning(400, responseObj, inContext)
                      return nil
                   end
 
@@ -28,21 +29,21 @@ module ADIWG
                   intMetadataClass = InternalMetadata.new
                   intGeoRec = intMetadataClass.newGeorectifiedInfo
 
+                  outContext = 'georectified representation'
+                  outContext = inContext + ' > ' + outContext unless inContext.nil?
+
                   # georectified representation - grid representation (required)
                   if hGeoRec.has_key?('gridRepresentation')
                      hObject = hGeoRec['gridRepresentation']
                      unless hObject.empty?
-                        hReturn = GridRepresentation.unpack(hObject, responseObj)
+                        hReturn = GridRepresentation.unpack(hObject, responseObj, outContext)
                         unless hReturn.nil?
                            intGeoRec[:gridRepresentation] = hReturn
                         end
                      end
                   end
                   if intGeoRec[:gridRepresentation].empty?
-                     responseObj[:readerExecutionMessages] <<
-                        'ERROR: mdJson reader: georectified spatial representation grid representation is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(401, responseObj, inContext)
                   end
 
                   # georectified representation - check point availability (required)
@@ -66,10 +67,7 @@ module ADIWG
                      end
                   end
                   unless intGeoRec[:cornerPoints].length == 2 || intGeoRec[:cornerPoints].length == 4
-                     responseObj[:readerExecutionMessages] <<
-                        'ERROR: mdJson reader: georectified spatial representation must have either 2 or 4 corner points'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(402, responseObj, inContext)
                   end
 
                   # georectified representation - center points
@@ -78,10 +76,7 @@ module ADIWG
                         intGeoRec[:centerPoint] = hGeoRec['centerPoint']
                      end
                      unless intGeoRec[:centerPoint].length == 2
-                        responseObj[:readerExecutionMessages] <<
-                           'ERROR: mdJson reader: georectified spatial representation center point must be single 2D coordinate'
-                        responseObj[:readerExecutionPass] = false
-                        return nil
+                        @MessagePath.issueError(403, responseObj, inContext)
                      end
                   end
 
@@ -92,9 +87,7 @@ module ADIWG
                      end
                   end
                   if intGeoRec[:pointInPixel].nil?
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: georectified spatial representation point-in-pixel is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(404, responseObj, inContext)
                   end
 
                   # georectified representation - transformation dimension description

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_georeferenceableRepresentation.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-20 refactored error and warning messaging
 # 	Stan Smith 2016-10-19 original script
 
 require_relative 'module_gridRepresentation'
@@ -15,12 +15,13 @@ module ADIWG
 
             module GeoreferenceableRepresentation
 
-               def self.unpack(hGeoRef, responseObj)
+               def self.unpack(hGeoRef, responseObj, inContext = nil)
+
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
 
                   # return nil object if input is empty
                   if hGeoRef.empty?
-                     responseObj[:readerExecutionMessages] <<
-                        'WARNING: mdJson reader: georeferenceable spatial representation object is empty'
+                     @MessagePath.issueWarning(410, responseObj, inContext)
                      return nil
                   end
 
@@ -28,21 +29,21 @@ module ADIWG
                   intMetadataClass = InternalMetadata.new
                   intGeoRef = intMetadataClass.newGeoreferenceableInfo
 
+                  outContext = 'georeferenceable representation'
+                  outContext = inContext + ' > ' + outContext unless inContext.nil?
+
                   # georeferenceable representation - grid representation (required)
                   if hGeoRef.has_key?('gridRepresentation')
                      hObject = hGeoRef['gridRepresentation']
                      unless hObject.empty?
-                        hReturn = GridRepresentation.unpack(hObject, responseObj)
+                        hReturn = GridRepresentation.unpack(hObject, responseObj, outContext)
                         unless hReturn.nil?
                            intGeoRef[:gridRepresentation] = hReturn
                         end
                      end
                   end
                   if intGeoRef[:gridRepresentation].empty?
-                     responseObj[:readerExecutionMessages] <<
-                        'ERROR: mdJson reader: georeferenceable spatial representation grid representation is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(411, responseObj, inContext)
                   end
 
                   # georeferenceable representation - control point availability (required)
@@ -73,17 +74,14 @@ module ADIWG
                      end
                   end
                   if intGeoRef[:georeferencedParameter].nil?
-                     responseObj[:readerExecutionMessages] <<
-                        'ERROR: mdJson reader: georeferenceable spatial representation georeferenced parameters are missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(412, responseObj, inContext)
                   end
 
                   # georeferenceable representation - parameter citation [citation]
                   if hGeoRef.has_key?('parameterCitation')
                      aCitation = hGeoRef['parameterCitation']
                      aCitation.each do |item|
-                        hCitation = Citation.unpack(item, responseObj)
+                        hCitation = Citation.unpack(item, responseObj, outContext)
                         unless hCitation.nil?
                            intGeoRef[:parameterCitation] << hCitation
                         end

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

@@ -2,9 +2,11 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
-#  Stan Smith 2018-02-18 refactored error and warning messaging
+#  Stan Smith 2018-06-20 refactored error and warning messaging
 # 	Stan Smith 2016-11-30 original script
 
+# TODO verify this method is not used
+
 module ADIWG
    module Mdtranslator
       module Readers
@@ -14,9 +16,11 @@ module ADIWG
 
                def self.unpack(hIdentifier, responseObj)
 
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
+
                   # return nil object if input is empty
                   if hIdentifier.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: GML Identifier object is empty'
+                     @MessagePath.issueWarning(420, responseObj)
                      return nil
                   end
 
@@ -29,9 +33,7 @@ module ADIWG
                      intIdentifier[:identifier] = hIdentifier['identifier']
                   end
                   if intIdentifier[:identifier].nil? || intIdentifier[:identifier] == ''
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: GML Identifier identifier is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(421, responseObj)
                   end
 
                   # gml identifier - namespace (required)
@@ -39,9 +41,7 @@ module ADIWG
                      intIdentifier[:namespace] = hIdentifier['namespace']
                   end
                   if intIdentifier[:namespace].nil? || intIdentifier[:namespace] == ''
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: GML Identifier namespace is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(422, responseObj)
                   end
 
                   return intIdentifier

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_graphic.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-20 refactored error and warning messaging
 #  Stan Smith 2016-10-12 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 Graphic
 
-               def self.unpack(hGraphic, responseObj)
+               def self.unpack(hGraphic, responseObj, inContext = nil)
+
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
 
                   # return nil object if input is empty
                   if hGraphic.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: graphic overview object is empty'
+                     @MessagePath.issueWarning(430, responseObj, inContext)
                      return nil
                   end
 
@@ -40,9 +42,7 @@ module ADIWG
                      intGraphic[:graphicName] = hGraphic['fileName']
                   end
                   if intGraphic[:graphicName].nil? || intGraphic[:graphicName] == ''
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: graphic overview file name is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(431, responseObj, inContext)
                   end
 
                   # graphic - file description

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_gridRepresentation.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-20 refactored error and warning messaging
 # 	Stan Smith 2016-10-19 original script
 
 require_relative 'module_dimension'
@@ -14,11 +14,13 @@ module ADIWG
 
             module GridRepresentation
 
-               def self.unpack(hGrid, responseObj)
+               def self.unpack(hGrid, responseObj, inContext = nil)
+
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
 
                   # return nil object if input is empty
                   if hGrid.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: grid representation object is empty'
+                     @MessagePath.issueWarning(440, responseObj, inContext)
                      return nil
                   end
 
@@ -26,6 +28,9 @@ module ADIWG
                   intMetadataClass = InternalMetadata.new
                   intGrid = intMetadataClass.newGridInfo
 
+                  outContext = 'grid representation'
+                  outContext = inContext + ' > ' + outContext unless inContext.nil?
+
                   # grid representation - number of dimensions (required)
                   if hGrid.has_key?('numberOfDimensions')
                      unless hGrid['numberOfDimensions'] == ''
@@ -33,24 +38,20 @@ module ADIWG
                      end
                   end
                   if intGrid[:numberOfDimensions].nil?
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: grid representation number-of-dimensions is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(441, responseObj, inContext)
                   end
 
                   # grid representation - dimensions [] (required)
                   if hGrid.has_key?('dimension')
                      hGrid['dimension'].each do |item|
-                        hDim = Dimension.unpack(item, responseObj)
+                        hDim = Dimension.unpack(item, responseObj, outContext)
                         unless hDim.nil?
                            intGrid[:dimension] << hDim
                         end
                      end
                   end
                   if intGrid[:dimension].empty?
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: grid representation dimensions are missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(442, responseObj, inContext)
                   end
 
                   # grid representation - cell geometry (required)
@@ -60,9 +61,7 @@ module ADIWG
                      end
                   end
                   if intGrid[:cellGeometry].nil?
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: grid representation cell geometry is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(443, responseObj, inContext)
                   end
 
                   # grid representation - transformation parameter available {Boolean} (required)

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_identifier.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-20 refactored error and warning messaging
 #  Stan Smith 2016-10-13 refactored for mdJson 2.0
 #  Stan Smith 2015-07-31 added support for fields added by ISO 19115-1 (RS_Identifier)
 #  Stan Smith 2015-07-14 refactored to remove global namespace constants
@@ -21,14 +21,19 @@ module ADIWG
 
             module Identifier
 
-               def self.unpack(hIdentifier, responseObj)
+               def self.unpack(hIdentifier, responseObj, inContext = nil)
+
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
 
                   # return nil object if input is empty
                   if hIdentifier.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: identifier object is empty'
+                     @MessagePath.issueWarning(450, responseObj, inContext)
                      return nil
                   end
 
+                  outContext = 'identifier'
+                  outContext = inContext + ' > ' + outContext unless inContext.nil?
+
                   # instance classes needed in script
                   intMetadataClass = InternalMetadata.new
                   intIdent = intMetadataClass.newIdentifier
@@ -38,9 +43,7 @@ module ADIWG
                      intIdent[:identifier] = hIdentifier['identifier']
                   end
                   if intIdent[:identifier].nil? || intIdent[:identifier] == ''
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: identifier object identifier is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(451, responseObj, inContext)
                   end
 
                   # identifier - namespace
@@ -68,7 +71,7 @@ module ADIWG
                   if hIdentifier.has_key?('authority')
                      hObject = hIdentifier['authority']
                      unless hObject.empty?
-                        hReturn = Citation.unpack(hObject, responseObj)
+                        hReturn = Citation.unpack(hObject, responseObj, outContext)
                         unless hReturn.nil?
                            intIdent[:citation] = hReturn
                         end

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_imageDescription.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-21 refactored error and warning messaging
 # 	Stan Smith 2016-10-18 original script
 
 require_relative 'module_identifier'
@@ -16,9 +16,13 @@ module ADIWG
 
                def self.unpack(hImageInfo, responseObj)
 
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
+
+                  inContext = 'coverage description'
+
                   # return nil object if input is empty
                   if hImageInfo.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: image description object is empty'
+                     @MessagePath.issueWarning(460, responseObj, inContext)
                      return nil
                   end
 
@@ -26,6 +30,8 @@ module ADIWG
                   intMetadataClass = InternalMetadata.new
                   hImage = intMetadataClass.newImageDescription
 
+                  outContext = inContext + ' image description'
+
                   # image description - elevation angle of illumination
                   if hImageInfo.has_key?('illuminationElevationAngle')
                      unless hImageInfo['illuminationElevationAngle'] == ''
@@ -51,7 +57,7 @@ module ADIWG
                   if hImageInfo.has_key?('imageQualityCode')
                      hObject = hImageInfo['imageQualityCode']
                      unless hObject.empty?
-                        hReturn = Identifier.unpack(hObject, responseObj)
+                        hReturn = Identifier.unpack(hObject, responseObj, outContext)
                         unless hReturn.nil?
                            hImage[:imageQualityCode] = hReturn
                         end

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_keyword.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-21 refactored error and warning messaging
 #  Stan Smith 2016-10-23 refactored for mdJson 2.0
 #  Stan Smith 2015-08-24 added return if input hash is empty
 #  Stan Smith 2015-07-14 refactored to remove global namespace constants
@@ -26,9 +26,11 @@ module ADIWG
 
                def self.unpack(hKeyword, responseObj)
 
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
+
                   # return nil object if input is empty
                   if hKeyword.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: keyword object is empty'
+                     @MessagePath.issueWarning(470, responseObj)
                      return nil
                   end
 
@@ -36,6 +38,8 @@ module ADIWG
                   intMetadataClass = InternalMetadata.new
                   intKeyword = intMetadataClass.newKeyword
 
+                  outContext = 'keywords'
+
                   # keyword - keyword [] (required)
                   if hKeyword.has_key?('keyword')
                      hKeyword['keyword'].each do |hItem|
@@ -48,9 +52,7 @@ module ADIWG
                      end
                   end
                   if intKeyword[:keywords].empty?
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: keyword keyword list is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(471, responseObj)
                   end
 
                   # keyword - keyType
@@ -64,7 +66,7 @@ module ADIWG
                   if hKeyword.has_key?('thesaurus')
                      hObject = hKeyword['thesaurus']
                      unless hObject.empty?
-                        hReturn = Citation.unpack(hObject, responseObj)
+                        hReturn = Citation.unpack(hObject, responseObj, outContext)
                         unless hReturn.nil?
                            intKeyword[:thesaurus] = hReturn
                         end