adiwg-mdtranslator 2.9.2 → 2.10.0

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

@@ -2,119 +2,118 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
+#  Stan Smith 2018-02-18 refactored error and warning messaging
 # 	Stan Smith 2016-10-18 original script
 
 require_relative 'module_identifier'
 
 module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
-
-                module ImageDescription
-
-                    def self.unpack(hImageInfo, responseObj)
-
-                        # return nil object if input is empty
-                        if hImageInfo.empty?
-                            responseObj[:readerExecutionMessages] << 'Image Description object is empty'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        hImage = intMetadataClass.newImageDescription
-
-                        # image description - elevation angle of illumination
-                        if hImageInfo.has_key?('illuminationElevationAngle')
-                            if hImageInfo['illuminationElevationAngle'] != ''
-                                hImage[:illuminationElevationAngle] = hImageInfo['illuminationElevationAngle']
-                            end
-                        end
-
-                        # image description - azimuth of illumination
-                        if hImageInfo.has_key?('illuminationAzimuthAngle')
-                            if hImageInfo['illuminationAzimuthAngle'] != ''
-                                hImage[:illuminationAzimuthAngle] = hImageInfo['illuminationAzimuthAngle']
-                            end
+   module Mdtranslator
+      module Readers
+         module MdJson
+
+            module ImageDescription
+
+               def self.unpack(hImageInfo, responseObj)
+
+                  # return nil object if input is empty
+                  if hImageInfo.empty?
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: image description object is empty'
+                     return nil
+                  end
+
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  hImage = intMetadataClass.newImageDescription
+
+                  # image description - elevation angle of illumination
+                  if hImageInfo.has_key?('illuminationElevationAngle')
+                     unless hImageInfo['illuminationElevationAngle'] == ''
+                        hImage[:illuminationElevationAngle] = hImageInfo['illuminationElevationAngle']
+                     end
+                  end
+
+                  # image description - azimuth of illumination
+                  if hImageInfo.has_key?('illuminationAzimuthAngle')
+                     unless hImageInfo['illuminationAzimuthAngle'] == ''
+                        hImage[:illuminationAzimuthAngle] = hImageInfo['illuminationAzimuthAngle']
+                     end
+                  end
+
+                  # image description - image condition
+                  if hImageInfo.has_key?('imagingCondition')
+                     unless hImageInfo['imagingCondition'] == ''
+                        hImage[:imagingCondition] = hImageInfo['imagingCondition']
+                     end
+                  end
+
+                  # image description - image quality - identifier
+                  if hImageInfo.has_key?('imageQualityCode')
+                     hObject = hImageInfo['imageQualityCode']
+                     unless hObject.empty?
+                        hReturn = Identifier.unpack(hObject, responseObj)
+                        unless hReturn.nil?
+                           hImage[:imageQualityCode] = hReturn
                         end
-
-                        # image description - image condition
-                        if hImageInfo.has_key?('imagingCondition')
-                            if hImageInfo['imagingCondition'] != ''
-                                hImage[:imagingCondition] = hImageInfo['imagingCondition']
-                            end
-                        end
-
-                        # image description - image quality - identifier
-                        if hImageInfo.has_key?('imageQualityCode')
-                            hObject = hImageInfo['imageQualityCode']
-                            unless hObject.empty?
-                                hReturn = Identifier.unpack(hObject, responseObj)
-                                unless hReturn.nil?
-                                    hImage[:imageQualityCode] = hReturn
-                                end
-                            end
-                        end
-
-
-                        # image description - cloud cover percentage
-                        if hImageInfo.has_key?('cloudCoverPercent')
-                            if hImageInfo['cloudCoverPercent'] != ''
-                                hImage[:cloudCoverPercent] = hImageInfo['cloudCoverPercent']
-                            end
-                        end
-
-                        # image description - compression quality
-                        if hImageInfo.has_key?('compressionQuantity')
-                            if hImageInfo['compressionQuantity'] != ''
-                                hImage[:compressionQuantity] = hImageInfo['compressionQuantity']
-                            end
-                        end
-
-                        # image description - triangulation information available {Boolean}
-                        if hImageInfo.has_key?('triangulationIndicator')
-                            if hImageInfo['triangulationIndicator'] === true
-                                hImage[:triangulationIndicator] = hImageInfo['triangulationIndicator']
-                            end
-                        end
-
-                        # image description - radiometric calibration information available {Boolean}
-                        if hImageInfo.has_key?('radiometricCalibrationAvailable')
-                            if hImageInfo['radiometricCalibrationAvailable'] === true
-                                hImage[:radiometricCalibrationAvailable] = hImageInfo['radiometricCalibrationAvailable']
-                            end
-                        end
-
-                        # image description - camera calibration information available {Boolean}
-                        if hImageInfo.has_key?('cameraCalibrationAvailable')
-                            if hImageInfo['cameraCalibrationAvailable'] === true
-                                hImage[:cameraCalibrationAvailable] = hImageInfo['cameraCalibrationAvailable']
-                            end
-                        end
-
-                        # image description - film distortion information available {Boolean}
-                        if hImageInfo.has_key?('filmDistortionAvailable')
-                            if hImageInfo['filmDistortionAvailable'] === true
-                                hImage[:filmDistortionAvailable] = hImageInfo['filmDistortionAvailable']
-                            end
-                        end
-
-                        # image description - lens distortion information available {Boolean}
-                        if hImageInfo.has_key?('lensDistortionAvailable')
-                            if hImageInfo['lensDistortionAvailable'] === true
-                                hImage[:lensDistortionAvailable] = hImageInfo['lensDistortionAvailable']
-                            end
-                        end
-
-                        return hImage
-
-                    end
-
-                end
+                     end
+                  end
+
+                  # image description - cloud cover percentage
+                  if hImageInfo.has_key?('cloudCoverPercent')
+                     unless hImageInfo['cloudCoverPercent'] == ''
+                        hImage[:cloudCoverPercent] = hImageInfo['cloudCoverPercent']
+                     end
+                  end
+
+                  # image description - compression quality
+                  if hImageInfo.has_key?('compressionQuantity')
+                     unless hImageInfo['compressionQuantity'] == ''
+                        hImage[:compressionQuantity] = hImageInfo['compressionQuantity']
+                     end
+                  end
+
+                  # image description - triangulation information available {Boolean}
+                  if hImageInfo.has_key?('triangulationIndicator')
+                     if hImageInfo['triangulationIndicator'] === true
+                        hImage[:triangulationIndicator] = hImageInfo['triangulationIndicator']
+                     end
+                  end
+
+                  # image description - radiometric calibration information available {Boolean}
+                  if hImageInfo.has_key?('radiometricCalibrationAvailable')
+                     if hImageInfo['radiometricCalibrationAvailable'] === true
+                        hImage[:radiometricCalibrationAvailable] = hImageInfo['radiometricCalibrationAvailable']
+                     end
+                  end
+
+                  # image description - camera calibration information available {Boolean}
+                  if hImageInfo.has_key?('cameraCalibrationAvailable')
+                     if hImageInfo['cameraCalibrationAvailable'] === true
+                        hImage[:cameraCalibrationAvailable] = hImageInfo['cameraCalibrationAvailable']
+                     end
+                  end
+
+                  # image description - film distortion information available {Boolean}
+                  if hImageInfo.has_key?('filmDistortionAvailable')
+                     if hImageInfo['filmDistortionAvailable'] === true
+                        hImage[:filmDistortionAvailable] = hImageInfo['filmDistortionAvailable']
+                     end
+                  end
+
+                  # image description - lens distortion information available {Boolean}
+                  if hImageInfo.has_key?('lensDistortionAvailable')
+                     if hImageInfo['lensDistortionAvailable'] === true
+                        hImage[:lensDistortionAvailable] = hImageInfo['lensDistortionAvailable']
+                     end
+                  end
+
+                  return hImage
+
+               end
 
             end
-        end
-    end
+
+         end
+      end
+   end
 end

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

@@ -2,6 +2,7 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
+#  Stan Smith 2018-02-18 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
@@ -27,8 +28,7 @@ module ADIWG
 
                   # return nil object if input is empty
                   if hKeyword.empty?
-                     responseObj[:readerExecutionMessages] << 'Keyword is empty'
-                     responseObj[:readerExecutionPass] = false
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: keyword object is empty'
                      return nil
                   end
 
@@ -48,14 +48,14 @@ module ADIWG
                      end
                   end
                   if intKeyword[:keywords].empty?
-                     responseObj[:readerExecutionMessages] << 'Keyword is missing keywords'
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: keyword keyword list is missing'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end
 
                   # keyword - keyType
                   if hKeyword.has_key?('keywordType')
-                     if hKeyword['keywordType'] != ''
+                     unless hKeyword['keywordType'] == ''
                         intKeyword[:keywordType] = hKeyword['keywordType']
                      end
                   end

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

@@ -2,54 +2,54 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
-#   Stan Smith 2016-12-09 original script
+#  Stan Smith 2018-02-18 refactored error and warning messaging
+#  Stan Smith 2016-12-09 original script
 
 module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
-
-                module KeywordObject
-
-                    def self.unpack(hKeyObj, responseObj)
-
-                        # return nil object if input is empty
-                        if hKeyObj.empty?
-                            responseObj[:readerExecutionMessages] << 'Keyword object is empty'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intKeyObj = intMetadataClass.newKeywordObject
-
-                        # keyword object - keyword (required)
-                        if hKeyObj.has_key?('keyword')
-                            if hKeyObj['keyword'] != ''
-                                intKeyObj[:keyword] = hKeyObj['keyword']
-                            end
-                        end
-                        if intKeyObj[:keyword].nil?
-                            responseObj[:readerExecutionMessages] << 'Keyword object is missing keyword'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        # keyword object - keyword id
-                        if hKeyObj.has_key?('keywordId')
-                            if hKeyObj['keywordId'] != ''
-                                intKeyObj[:keywordId] = hKeyObj['keywordId']
-                            end
-                        end
-
-                        return intKeyObj
-
-                    end
-
-                end
+   module Mdtranslator
+      module Readers
+         module MdJson
+
+            module KeywordObject
+
+               def self.unpack(hKeyObj, responseObj)
+
+                  # return nil object if input is empty
+                  if hKeyObj.empty?
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: keyword object is empty'
+                     return nil
+                  end
+
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intKeyObj = intMetadataClass.newKeywordObject
+
+                  # keyword object - keyword (required)
+                  if hKeyObj.has_key?('keyword')
+                     unless hKeyObj['keyword'] == ''
+                        intKeyObj[:keyword] = hKeyObj['keyword']
+                     end
+                  end
+                  if intKeyObj[:keyword].nil?
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: keyword object is missing keyword'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
+                  # keyword object - keyword id
+                  if hKeyObj.has_key?('keywordId')
+                     unless hKeyObj['keywordId'] == ''
+                        intKeyObj[:keywordId] = hKeyObj['keywordId']
+                     end
+                  end
+
+                  return intKeyObj
+
+               end
 
             end
-        end
-    end
+
+         end
+      end
+   end
 end

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

@@ -2,76 +2,80 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
+#  Stan Smith 2018-02-19 refactored error and warning messaging
 # 	Stan Smith 2016-10-15 refactored for mdJson 2.0
-#   Stan Smith 2015-07-14 refactored to remove global namespace constants
-#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
-#   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
-#   Stan Smith 2014-04-28 modified attribute names to match json schema 0.3.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)
+#  Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+#  Stan Smith 2014-04-28 modified attribute names to match json schema 0.3.0
 # 	Stan Smith 2013-11-27 modified to process a single legal constraint
 # 	Stan Smith 2013-11-14 original script
 
 module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
+   module Mdtranslator
+      module Readers
+         module MdJson
 
-                module LegalConstraint
+            module LegalConstraint
 
-                    def self.unpack(hLegalCon, responseObj)
+               def self.unpack(hLegalCon, responseObj)
 
-                        # return nil object if input is empty
-                        if hLegalCon.empty?
-                            responseObj[:readerExecutionMessages] << 'Legal Constraint object is empty'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
+                  # return nil object if input is empty
+                  if hLegalCon.empty?
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: legal constraint object is empty'
+                     return nil
+                  end
 
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intLegalCon= intMetadataClass.newLegalConstraint
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intLegalCon = intMetadataClass.newLegalConstraint
 
-                        # legal constraint - use constraint []
-                        if hLegalCon.has_key?('useConstraint')
-                            hLegalCon['useConstraint'].each do |item|
-                                if item != ''
-                                    intLegalCon[:useCodes] << item
-                                end
-                            end
-                        end
+                  haveLegal = false
 
-                        # legal constraint - access constraint []
-                        if hLegalCon.has_key?('accessConstraint')
-                            hLegalCon['accessConstraint'].each do |item|
-                                if item != ''
-                                    intLegalCon[:accessCodes] << item
-                                end
-                            end
+                  # legal constraint - use constraint []
+                  if hLegalCon.has_key?('useConstraint')
+                     hLegalCon['useConstraint'].each do |item|
+                        unless item == ''
+                           intLegalCon[:useCodes] << item
+                           haveLegal = true
                         end
+                     end
+                  end
 
-                        # legal constraint - other constraint []
-                        if hLegalCon.has_key?('otherConstraint')
-                            hLegalCon['otherConstraint'].each do |item|
-                                if item != ''
-                                    intLegalCon[:otherCons] << item
-                                end
-                            end
+                  # legal constraint - access constraint []
+                  if hLegalCon.has_key?('accessConstraint')
+                     hLegalCon['accessConstraint'].each do |item|
+                        unless item == ''
+                           intLegalCon[:accessCodes] << item
+                           haveLegal = true
                         end
+                     end
+                  end
 
-                        if  intLegalCon[:useCodes].empty? &&
-                            intLegalCon[:accessCodes].empty? &&
-                            intLegalCon[:otherCons].empty?
-                            responseObj[:readerExecutionMessages] << 'Legal Constraint was not declared'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
+                  # legal constraint - other constraint []
+                  if hLegalCon.has_key?('otherConstraint')
+                     hLegalCon['otherConstraint'].each do |item|
+                        unless item == ''
+                           intLegalCon[:otherCons] << item
+                           haveLegal = true
                         end
+                     end
+                  end
 
-                        return intLegalCon
+                  # error messages
+                  unless haveLegal
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: legal constraint was not defined'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
 
-                    end
+                  return intLegalCon
 
-                end
+               end
 
             end
-        end
-    end
+
+         end
+      end
+   end
 end