adiwg-mdtranslator 2.9.2 → 2.10.0

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

@@ -2,8 +2,9 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
-#   Stan Smith 2016-11-10 added computedBbox computation
-#   Stan Smith 2016-10-25 original script
+#  Stan Smith 2018-02-18 refactored error and warning messaging
+#  Stan Smith 2016-11-10 added computedBbox computation
+#  Stan Smith 2016-10-25 original script
 
 require_relative 'module_geometryObject'
 require_relative 'module_geometryProperties'
@@ -11,102 +12,101 @@ require_relative 'module_geometryCollection'
 require 'adiwg/mdtranslator/internal/module_coordinates'
 
 module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
+   module Mdtranslator
+      module Readers
+         module MdJson
 
-                module GeometryFeature
+            module GeometryFeature
 
-                    def self.unpack(hFeature, responseObj)
+               def self.unpack(hFeature, responseObj)
 
-                        # return nil object if input is empty
-                        if hFeature.empty?
-                            responseObj[:readerExecutionMessages] << 'Geometry Feature object is empty'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
+                  # return nil object if input is empty
+                  if hFeature.empty?
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: GeoJSON geometry feature object is empty'
+                     return nil
+                  end
 
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intFeature = intMetadataClass.newGeometryFeature
-
-                        # geometry feature - type (required)
-                        if hFeature.has_key?('type')
-                            if hFeature['type'] != ''
-                                if hFeature['type'] == 'Feature'
-                                    intFeature[:type] = hFeature['type']
-                                else
-                                    responseObj[:readerExecutionMessages] << 'Feature type must be Feature'
-                                    responseObj[:readerExecutionPass] = false
-                                    return nil
-                                end
-                            end
-                        end
-                        if intFeature[:type].nil? || intFeature[:type] == ''
-                            responseObj[:readerExecutionMessages] << 'Feature is missing type'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        # geometry feature - id
-                        if hFeature.has_key?('id')
-                            unless hFeature['id'] == ''
-                                intFeature[:id] = hFeature['id']
-                            end
-                        end
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intFeature = intMetadataClass.newGeometryFeature
 
-                        # geometry feature - bounding box
-                        if hFeature.has_key?('bbox')
-                            unless hFeature['bbox'].empty?
-                                intFeature[:bbox] = hFeature['bbox']
-                            end
+                  # geometry feature - type (required)
+                  if hFeature.has_key?('type')
+                     unless hFeature['type'] == ''
+                        if hFeature['type'] == 'Feature'
+                           intFeature[:type] = hFeature['type']
+                        else
+                           responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: GeoJSON geometry feature type must be Feature'
+                           responseObj[:readerExecutionPass] = false
+                           return nil
                         end
-
-                        # geometry feature - geometry (required, but may be JSON null)
-                        if hFeature.has_key?('geometry')
-                            unless hFeature['geometry'].empty?
-                                hGeometry =  hFeature['geometry']
-                                if hGeometry['type'] == 'GeometryCollection'
-                                    hReturn = GeometryCollection.unpack(hGeometry, responseObj)
-                                else
-                                    hReturn = GeometryObject.unpack(hGeometry, responseObj)
-                                end
-                                unless hReturn.nil?
-                                    intFeature[:geometryObject] = hReturn
-                                end
-                            end
+                     end
+                  end
+                  if intFeature[:type].nil? || intFeature[:type] == ''
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: GeoJSON geometry feature type is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
+                  # geometry feature - id
+                  if hFeature.has_key?('id')
+                     unless hFeature['id'] == ''
+                        intFeature[:id] = hFeature['id']
+                     end
+                  end
+
+                  # geometry feature - bounding box
+                  if hFeature.has_key?('bbox')
+                     unless hFeature['bbox'].empty?
+                        intFeature[:bbox] = hFeature['bbox']
+                     end
+                  end
+
+                  # geometry feature - geometry (required, but may be JSON null)
+                  if hFeature.has_key?('geometry')
+                     unless hFeature['geometry'].empty?
+                        hGeometry = hFeature['geometry']
+                        if hGeometry['type'] == 'GeometryCollection'
+                           hReturn = GeometryCollection.unpack(hGeometry, responseObj)
                         else
-                            responseObj[:readerExecutionMessages] << 'Feature is missing geometry'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
+                           hReturn = GeometryObject.unpack(hGeometry, responseObj)
                         end
-
-                        # geometry feature - properties
-                        if hFeature.has_key?('properties')
-                            hObject = hFeature['properties']
-                            unless hObject.empty?
-                                hReturn = GeometryProperties.unpack(hObject, responseObj)
-                                unless hReturn.nil?
-                                    intFeature[:properties] = hReturn
-                                end
-                            end
+                        unless hReturn.nil?
+                           intFeature[:geometryObject] = hReturn
                         end
-
-                        # geometry feature - computed bounding box for feature
-                        unless intFeature[:geometryObject].empty?
-                            intFeature[:computedBbox] = AdiwgCoordinates.computeBbox([intFeature[:geometryObject]])
+                     end
+                  else
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: GeoJSON geometry feature geometry is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
+                  # geometry feature - properties
+                  if hFeature.has_key?('properties')
+                     hObject = hFeature['properties']
+                     unless hObject.empty?
+                        hReturn = GeometryProperties.unpack(hObject, responseObj)
+                        unless hReturn.nil?
+                           intFeature[:properties] = hReturn
                         end
+                     end
+                  end
 
-                        # geometry feature - save native GeoJSON for feature
-                        intFeature[:nativeGeoJson] = hFeature
+                  # geometry feature - computed bounding box for feature
+                  unless intFeature[:geometryObject].empty?
+                     intFeature[:computedBbox] = AdiwgCoordinates.computeBbox([intFeature[:geometryObject]])
+                  end
 
-                        return intFeature
+                  # geometry feature - save native GeoJSON for feature
+                  intFeature[:nativeGeoJson] = hFeature
 
-                    end
+                  return intFeature
 
-                end
+               end
 
             end
-        end
-    end
+
+         end
+      end
+   end
 end

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

@@ -2,69 +2,70 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
-#   Stan Smith 2016-10-24 original script
+#  Stan Smith 2018-02-18 refactored error and warning messaging
+#  Stan Smith 2016-10-24 original script
 
 require_relative 'module_geometryCollection'
 
 module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
+   module Mdtranslator
+      module Readers
+         module MdJson
 
-                module GeometryObject
+            module GeometryObject
 
-                    def self.unpack(hGeoObject, responseObj)
+               def self.unpack(hGeoObject, responseObj)
 
-                        # return nil object if input is empty
-                        if hGeoObject.empty?
-                            responseObj[:readerExecutionMessages] << 'Associated Resource object is empty'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intGeoObject = intMetadataClass.newGeometryObject
+                  # return nil object if input is empty
+                  if hGeoObject.empty?
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: GeoJSON geometry object is empty'
+                     return nil
+                  end
 
-                        # geometry object - type (required)
-                        if hGeoObject.has_key?('type')
-                            if hGeoObject['type'] != ''
-                                type = hGeoObject['type']
-                                if %w{ Point LineString Polygon MultiPoint MultiLineString MultiPolygon }.one? { |word| word == type }
-                                    intGeoObject[:type] = hGeoObject['type']
-                                else
-                                    responseObj[:readerExecutionMessages] << 'Geometry Object type must be Point, LineString, Polygon, MultiPoint, MultiLineString, or MultiPolygon'
-                                    responseObj[:readerExecutionPass] = false
-                                    return nil
-                                end
-                            end
-                        end
-                        if intGeoObject[:type].nil? || intGeoObject[:type] == ''
-                            responseObj[:readerExecutionMessages] << 'Geometry Object is missing type'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intGeoObject = intMetadataClass.newGeometryObject
 
-                        # geometry object - coordinates (required)
-                        if hGeoObject.has_key?('coordinates')
-                            intGeoObject[:coordinates] = hGeoObject['coordinates']
-                        end
-                        if intGeoObject[:coordinates].empty?
-                            responseObj[:readerExecutionMessages] << 'Geometry Object is missing coordinates'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
+                  # geometry object - type (required)
+                  if hGeoObject.has_key?('type')
+                     unless hGeoObject['type'] == ''
+                        type = hGeoObject['type']
+                        if %w{ Point LineString Polygon MultiPoint MultiLineString MultiPolygon }.one? {|word| word == type}
+                           intGeoObject[:type] = hGeoObject['type']
+                        else
+                           responseObj[:readerExecutionMessages] <<
+                              'ERROR: mdJson reader: GeoJSON geometry object type must be Point, LineString, Polygon, MultiPoint, MultiLineString, or MultiPolygon'
+                           responseObj[:readerExecutionPass] = false
+                           return nil
                         end
+                     end
+                  end
+                  if intGeoObject[:type].nil? || intGeoObject[:type] == ''
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: GeoJSON geometry object type is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
 
-                        # geometry object - save native GeoJSON
-                        intGeoObject[:nativeGeoJson] = hGeoObject
+                  # geometry object - coordinates (required)
+                  if hGeoObject.has_key?('coordinates')
+                     intGeoObject[:coordinates] = hGeoObject['coordinates']
+                  end
+                  if intGeoObject[:coordinates].empty?
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: GeoJSON geometry object coordinates are missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
 
-                        return intGeoObject
+                  # geometry object - save native GeoJSON
+                  intGeoObject[:nativeGeoJson] = hGeoObject
 
-                    end
+                  return intGeoObject
 
-                end
+               end
 
             end
-        end
-    end
+
+         end
+      end
+   end
 end

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

@@ -2,78 +2,78 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
-#   Stan Smith 2016-10-25 original script
+#  Stan Smith 2018-02-18 refactored error and warning messaging
+#  Stan Smith 2016-10-25 original script
 
 require_relative 'module_identifier'
 
 module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
+   module Mdtranslator
+      module Readers
+         module MdJson
 
-                module GeometryProperties
+            module GeometryProperties
 
-                    def self.unpack(hGeoProp, responseObj)
+               def self.unpack(hGeoProp, responseObj)
 
-                        # return nil object if input is empty
-                        if hGeoProp.empty?
-                            responseObj[:readerExecutionMessages] << 'Geometry Properties object is empty'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
+                  # return nil object if input is empty
+                  if hGeoProp.empty?
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: GeoJSON geometry properties object is empty'
+                     return nil
+                  end
 
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intGeoProp = intMetadataClass.newGeometryProperties
-
-                        # geometry properties - feature name []
-                        if hGeoProp.has_key?('featureName')
-                            hGeoProp['featureName'].each do |item|
-                                if item != ''
-                                    intGeoProp[:featureNames] << item
-                                end
-                            end
-                        end
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intGeoProp = intMetadataClass.newGeometryProperties
 
-                        # geometry properties - description
-                        if hGeoProp.has_key?('description')
-                            if hGeoProp['description'] != ''
-                                intGeoProp[:description] = hGeoProp['description']
-                            end
+                  # geometry properties - feature name []
+                  if hGeoProp.has_key?('featureName')
+                     hGeoProp['featureName'].each do |item|
+                        if item != ''
+                           intGeoProp[:featureNames] << item
                         end
-
-                        # geometry properties - [{Identifier}]
-                        if hGeoProp.has_key?('identifier')
-                            aItems = hGeoProp['identifier']
-                            aItems.each do |item|
-                                hReturn = Identifier.unpack(item, responseObj)
-                                unless hReturn.nil?
-                                    intGeoProp[:identifiers] << hReturn
-                                end
-                            end
+                     end
+                  end
+
+                  # geometry properties - description
+                  if hGeoProp.has_key?('description')
+                     unless hGeoProp['description'] == ''
+                        intGeoProp[:description] = hGeoProp['description']
+                     end
+                  end
+
+                  # geometry properties - [{Identifier}]
+                  if hGeoProp.has_key?('identifier')
+                     aItems = hGeoProp['identifier']
+                     aItems.each do |item|
+                        hReturn = Identifier.unpack(item, responseObj)
+                        unless hReturn.nil?
+                           intGeoProp[:identifiers] << hReturn
                         end
+                     end
+                  end
 
-                        # geometry properties - feature scope
-                        if hGeoProp.has_key?('featureScope')
-                            if hGeoProp['featureScope'] != ''
-                                intGeoProp[:featureScope] = hGeoProp['featureScope']
-                            end
-                        end
+                  # geometry properties - feature scope
+                  if hGeoProp.has_key?('featureScope')
+                     unless hGeoProp['featureScope'] == ''
+                        intGeoProp[:featureScope] = hGeoProp['featureScope']
+                     end
+                  end
 
-                        # geometry properties - acquisition method
-                        if hGeoProp.has_key?('acquisitionMethod')
-                            if hGeoProp['acquisitionMethod'] != ''
-                                intGeoProp[:acquisitionMethod] = hGeoProp['acquisitionMethod']
-                            end
-                        end
-
-                        return intGeoProp
+                  # geometry properties - acquisition method
+                  if hGeoProp.has_key?('acquisitionMethod')
+                     unless hGeoProp['acquisitionMethod'] == ''
+                        intGeoProp[:acquisitionMethod] = hGeoProp['acquisitionMethod']
+                     end
+                  end
 
-                    end
+                  return intGeoProp
 
-                end
+               end
 
             end
-        end
-    end
+
+         end
+      end
+   end
 end