adiwg-mdtranslator 2.9.2 → 2.10.0

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

@@ -1,113 +1,128 @@
+#  Stan Smith 2018-02-18 refactored error and warning messaging
 # unpack georectified representation
 # Reader - ADIwg JSON to internal data structure
 
 # History:
+#  Stan Smith 2018-02-18 refactored error and warning messaging
 # 	Stan Smith 2016-10-19 original script
 
 require_relative 'module_gridRepresentation'
 
 module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
-
-                module GeorectifiedRepresentation
-
-                    def self.unpack(hGeoRec, responseObj)
-
-                        # return nil object if input is empty
-                        if hGeoRec.empty?
-                            responseObj[:readerExecutionMessages] << 'Georectified Representation object is empty'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intGeoRec = intMetadataClass.newGeorectifiedInfo
-
-                        # georectified representation - grid representation (required)
-                        if hGeoRec.has_key?('gridRepresentation')
-                            hObject = hGeoRec['gridRepresentation']
-                            unless hObject.empty?
-                                hReturn = GridRepresentation.unpack(hObject, responseObj)
-                                unless hReturn.nil?
-                                    intGeoRec[:gridRepresentation] = hReturn
-                                end
-                            end
-                        end
-                        if intGeoRec[:gridRepresentation].empty?
-                            responseObj[:readerExecutionMessages] << 'Georectified Representation is missing GridRepresentation object'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        # georectified representation - check point availability (required)
-                        if hGeoRec.has_key?('checkPointAvailable')
-                            if hGeoRec['checkPointAvailable'] === true
-                                intGeoRec[:checkPointAvailable] = hGeoRec['checkPointAvailable']
-                            end
-                        end
-
-                        # georectified representation - check point description
-                        if hGeoRec.has_key?('checkPointDescription')
-                            if hGeoRec['checkPointDescription'] != ''
-                                intGeoRec[:checkPointDescription] = hGeoRec['checkPointDescription']
-                            end
-                        end
-
-                        # georectified representation - corner points [2 or 4] (required)
-                        if hGeoRec.has_key?('cornerPoints')
-                            unless hGeoRec['cornerPoints'].empty?
-                                intGeoRec[:cornerPoints] = hGeoRec['cornerPoints']
-                            end
-                        end
-                        unless intGeoRec[:cornerPoints].length == 2 || intGeoRec[:cornerPoints].length == 4
-                            responseObj[:readerExecutionMessages] << 'Georectified Representation has invalid cornerPoints array'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
+   module Mdtranslator
+      module Readers
+         module MdJson
+
+            module GeorectifiedRepresentation
+
+               def self.unpack(hGeoRec, responseObj)
+
+                  # return nil object if input is empty
+                  if hGeoRec.empty?
+                     responseObj[:readerExecutionMessages] <<
+                        'WARNING: mdJson reader: georectified spatial representation object is empty'
+                     return nil
+                  end
+
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intGeoRec = intMetadataClass.newGeorectifiedInfo
+
+                  # georectified representation - grid representation (required)
+                  if hGeoRec.has_key?('gridRepresentation')
+                     hObject = hGeoRec['gridRepresentation']
+                     unless hObject.empty?
+                        hReturn = GridRepresentation.unpack(hObject, responseObj)
+                        unless hReturn.nil?
+                           intGeoRec[:gridRepresentation] = hReturn
                         end
-
-                        # georectified representation - center point
-                        if hGeoRec.has_key?('centerPoint')
-                            unless hGeoRec['centerPoint'].empty?
-                                intGeoRec[:centerPoint] = hGeoRec['centerPoint']
-                            end
-                        end
-
-                        # georectified representation - point in pixel (required)
-                        if hGeoRec.has_key?('pointInPixel')
-                            if hGeoRec['pointInPixel'] != ''
-                                intGeoRec[:pointInPixel] = hGeoRec['pointInPixel']
-                            end
-                        end
-                        if intGeoRec[:pointInPixel].nil?
-                            responseObj[:readerExecutionMessages] << 'Georectified Representation is missing pointInPixel attribute'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        # georectified representation - transformation dimension description
-                        if hGeoRec.has_key?('transformationDimensionDescription')
-                            if hGeoRec['transformationDimensionDescription'] != ''
-                                intGeoRec[:transformationDimensionDescription] = hGeoRec['transformationDimensionDescription']
-                            end
-                        end
-
-                        # georectified representation - transformation dimension mapping
-                        if hGeoRec.has_key?('transformationDimensionMapping')
-                            if hGeoRec['transformationDimensionMapping'] != ''
-                                intGeoRec[:transformationDimensionMapping] = hGeoRec['transformationDimensionMapping']
-                            end
-                        end
-
-                        return intGeoRec
-
-                    end
-
-                end
+                     end
+                  end
+                  if intGeoRec[:gridRepresentation].empty?
+                     responseObj[:readerExecutionMessages] <<
+                        'ERROR: mdJson reader: georectified spatial representation grid representation is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
+                  # georectified representation - check point availability (required)
+                  if hGeoRec.has_key?('checkPointAvailable')
+                     if hGeoRec['checkPointAvailable'] === true
+                        intGeoRec[:checkPointAvailable] = hGeoRec['checkPointAvailable']
+                     end
+                  end
+
+                  # georectified representation - check point description
+                  if hGeoRec.has_key?('checkPointDescription')
+                     if hGeoRec['checkPointDescription'] != ''
+                        intGeoRec[:checkPointDescription] = hGeoRec['checkPointDescription']
+                     end
+                  end
+
+                  # georectified representation - corner points [2 or 4] (required)
+                  if hGeoRec.has_key?('cornerPoints')
+                     unless hGeoRec['cornerPoints'].empty?
+                        intGeoRec[:cornerPoints] = hGeoRec['cornerPoints']
+                     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
+                  end
+
+                  # georectified representation - center points (required)
+                  if hGeoRec.has_key?('centerPoint')
+                     unless hGeoRec['centerPoint'].empty?
+                        intGeoRec[:centerPoint] = hGeoRec['centerPoint']
+                     end
+                  end
+                  if intGeoRec[:centerPoint].empty?
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: georectified spatial representation center point is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  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
+                  end
+
+                  # georectified representation - point in pixel (required)
+                  if hGeoRec.has_key?('pointInPixel')
+                     if hGeoRec['pointInPixel'] != ''
+                        intGeoRec[:pointInPixel] = hGeoRec['pointInPixel']
+                     end
+                  end
+                  if intGeoRec[:pointInPixel].nil?
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: georectified spatial representation point-in-pixel is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
+                  # georectified representation - transformation dimension description
+                  if hGeoRec.has_key?('transformationDimensionDescription')
+                     if hGeoRec['transformationDimensionDescription'] != ''
+                        intGeoRec[:transformationDimensionDescription] = hGeoRec['transformationDimensionDescription']
+                     end
+                  end
+
+                  # georectified representation - transformation dimension mapping
+                  if hGeoRec.has_key?('transformationDimensionMapping')
+                     if hGeoRec['transformationDimensionMapping'] != ''
+                        intGeoRec[:transformationDimensionMapping] = hGeoRec['transformationDimensionMapping']
+                     end
+                  end
+
+                  return intGeoRec
+
+               end
 
             end
-        end
-    end
+
+         end
+      end
+   end
 end

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

@@ -2,98 +2,101 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
+#  Stan Smith 2018-02-18 refactored error and warning messaging
 # 	Stan Smith 2016-10-19 original script
 
 require_relative 'module_gridRepresentation'
 require_relative 'module_citation'
 
 module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
-
-                module GeoreferenceableRepresentation
-
-                    def self.unpack(hGeoRef, responseObj)
-
-                        # return nil object if input is empty
-                        if hGeoRef.empty?
-                            responseObj[:readerExecutionMessages] << 'Georeferenceable Representation object is empty'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intGeoRef = intMetadataClass.newGeoreferenceableInfo
-
-                        # georeferenceable representation - grid representation (required)
-                        if hGeoRef.has_key?('gridRepresentation')
-                            hObject = hGeoRef['gridRepresentation']
-                            unless hObject.empty?
-                                hReturn = GridRepresentation.unpack(hObject, responseObj)
-                                unless hReturn.nil?
-                                    intGeoRef[:gridRepresentation] = hReturn
-                                end
-                            end
-                        end
-                        if intGeoRef[:gridRepresentation].empty?
-                            responseObj[:readerExecutionMessages] << 'Georeferenceable Representation is missing GridRepresentation object'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        # georeferenceable representation - control point availability (required)
-                        if hGeoRef.has_key?('controlPointAvailable')
-                            if hGeoRef['controlPointAvailable'] === true
-                                intGeoRef[:controlPointAvailable] = hGeoRef['controlPointAvailable']
-                            end
-                        end
-
-                        # georeferenceable representation - orientation parameter availability (required)
-                        if hGeoRef.has_key?('orientationParameterAvailable')
-                            if hGeoRef['orientationParameterAvailable'] === true
-                                intGeoRef[:orientationParameterAvailable] = hGeoRef['orientationParameterAvailable']
-                            end
+   module Mdtranslator
+      module Readers
+         module MdJson
+
+            module GeoreferenceableRepresentation
+
+               def self.unpack(hGeoRef, responseObj)
+
+                  # return nil object if input is empty
+                  if hGeoRef.empty?
+                     responseObj[:readerExecutionMessages] <<
+                        'WARNING: mdJson reader: georeferenceable spatial representation object is empty'
+                     return nil
+                  end
+
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intGeoRef = intMetadataClass.newGeoreferenceableInfo
+
+                  # georeferenceable representation - grid representation (required)
+                  if hGeoRef.has_key?('gridRepresentation')
+                     hObject = hGeoRef['gridRepresentation']
+                     unless hObject.empty?
+                        hReturn = GridRepresentation.unpack(hObject, responseObj)
+                        unless hReturn.nil?
+                           intGeoRef[:gridRepresentation] = hReturn
                         end
-
-                        # georeferenceable representation - orientation parameter description
-                        if hGeoRef.has_key?('orientationParameterDescription')
-                            if hGeoRef['orientationParameterDescription'] != ''
-                                intGeoRef[:orientationParameterDescription] = hGeoRef['orientationParameterDescription']
-                            end
+                     end
+                  end
+                  if intGeoRef[:gridRepresentation].empty?
+                     responseObj[:readerExecutionMessages] <<
+                        'ERROR: mdJson reader: georeferenceable spatial representation grid representation is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
+                  # georeferenceable representation - control point availability (required)
+                  if hGeoRef.has_key?('controlPointAvailable')
+                     if hGeoRef['controlPointAvailable'] === true
+                        intGeoRef[:controlPointAvailable] = hGeoRef['controlPointAvailable']
+                     end
+                  end
+
+                  # georeferenceable representation - orientation parameter availability (required)
+                  if hGeoRef.has_key?('orientationParameterAvailable')
+                     if hGeoRef['orientationParameterAvailable'] === true
+                        intGeoRef[:orientationParameterAvailable] = hGeoRef['orientationParameterAvailable']
+                     end
+                  end
+
+                  # georeferenceable representation - orientation parameter description
+                  if hGeoRef.has_key?('orientationParameterDescription')
+                     unless hGeoRef['orientationParameterDescription'] == ''
+                        intGeoRef[:orientationParameterDescription] = hGeoRef['orientationParameterDescription']
+                     end
+                  end
+
+                  # georeferenceable representation - georeferenced parameter (required)
+                  if hGeoRef.has_key?('georeferencedParameter')
+                     unless hGeoRef['georeferencedParameter'] == ''
+                        intGeoRef[:georeferencedParameter] = hGeoRef['georeferencedParameter']
+                     end
+                  end
+                  if intGeoRef[:georeferencedParameter].nil?
+                     responseObj[:readerExecutionMessages] <<
+                        'ERROR: mdJson reader: georeferenceable spatial representation georeferenced parameters are missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
+                  # georeferenceable representation - parameter citation [citation]
+                  if hGeoRef.has_key?('parameterCitation')
+                     aCitation = hGeoRef['parameterCitation']
+                     aCitation.each do |item|
+                        hCitation = Citation.unpack(item, responseObj)
+                        unless hCitation.nil?
+                           intGeoRef[:parameterCitation] << hCitation
                         end
+                     end
+                  end
 
-                        # georeferenceable representation - georeferenced parameter (required)
-                        if hGeoRef.has_key?('georeferencedParameter')
-                            if hGeoRef['georeferencedParameter'] != ''
-                                intGeoRef[:georeferencedParameter] = hGeoRef['georeferencedParameter']
-                            end
-                        end
-                        if intGeoRef[:georeferencedParameter].nil?
-                            responseObj[:readerExecutionMessages] << 'Georeferenceable Representation is missing georeferencedParameter'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
+                  return intGeoRef
 
-                        # georeferenceable representation - parameter citation [citation]
-                        if hGeoRef.has_key?('parameterCitation')
-                            aCitation = hGeoRef['parameterCitation']
-                            aCitation.each do |item|
-                                hCitation = Citation.unpack(item, responseObj)
-                                unless hCitation.nil?
-                                    intGeoRef[:parameterCitation] << hCitation
-                                end
-                            end
-                        end
-
-                        return intGeoRef
-
-                    end
-
-                end
+               end
 
             end
-        end
-    end
+
+         end
+      end
+   end
 end

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

@@ -2,54 +2,54 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
+#  Stan Smith 2018-02-18 refactored error and warning messaging
 # 	Stan Smith 2016-11-30 original script
 
 module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
-
-                module GMLIdentifier
-
-                    def self.unpack(hIdentifier, responseObj)
-
-                        # return nil object if input is empty
-                        if hIdentifier.empty?
-                            responseObj[:readerExecutionMessages] << 'GML Identifier object is empty'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intIdentifier = intMetadataClass.newGMLIdentifier
-
-                        # gml identifier - identifier (required)
-                        if hIdentifier.has_key?('identifier')
-                            intIdentifier[:identifier] = hIdentifier['identifier']
-                        end
-                        if intIdentifier[:identifier].nil? || intIdentifier[:identifier] == ''
-                            responseObj[:readerExecutionMessages] << 'GML Identifier attribute identifier is missing'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        # gml identifier - namespace (required)
-                        if hIdentifier.has_key?('namespace')
-                            intIdentifier[:namespace] = hIdentifier['namespace']
-                        end
-                        if intIdentifier[:namespace].nil? || intIdentifier[:namespace] == ''
-                            responseObj[:readerExecutionMessages] << 'GML Identifier attribute namespace is missing'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        return intIdentifier
-
-                    end
-                end
-
+   module Mdtranslator
+      module Readers
+         module MdJson
+
+            module GMLIdentifier
+
+               def self.unpack(hIdentifier, responseObj)
+
+                  # return nil object if input is empty
+                  if hIdentifier.empty?
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: GML Identifier object is empty'
+                     return nil
+                  end
+
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intIdentifier = intMetadataClass.newIdentifier
+
+                  # gml identifier - identifier (required)
+                  if hIdentifier.has_key?('identifier')
+                     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
+                  end
+
+                  # gml identifier - namespace (required)
+                  if hIdentifier.has_key?('namespace')
+                     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
+                  end
+
+                  return intIdentifier
+
+               end
             end
-        end
-    end
+
+         end
+      end
+   end
 end