adiwg-mdtranslator 1.4.0 → 2.0.0rc2

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

@@ -0,0 +1,87 @@
+# unpack feature collection
+# Reader - ADIwg JSON to internal data structure
+
+# History:
+#   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'
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module FeatureCollection
+
+                    def self.unpack(hFeatCol, responseObj)
+
+                        # return nil object if input is empty
+                        if hFeatCol.empty?
+                            responseObj[:readerExecutionMessages] << 'Feature Collection object is empty'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intFeatCol = intMetadataClass.newFeatureCollection
+
+                        # feature collection - type (required)
+                        if hFeatCol.has_key?('type')
+                            if hFeatCol['type'] != ''
+                                if hFeatCol['type'] == 'FeatureCollection'
+                                    intFeatCol[:type] = hFeatCol['type']
+                                else
+                                    responseObj[:readerExecutionMessages] << 'Feature Collection type must be GeometryCollection'
+                                    responseObj[:readerExecutionPass] = false
+                                    return nil
+                                end
+                            end
+                        end
+                        if intFeatCol[:type].nil? || intFeatCol[:type] == ''
+                            responseObj[:readerExecutionMessages] << 'Feature Collection is missing type'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # feature collection - bounding box
+                        if hFeatCol.has_key?('bbox')
+                            unless hFeatCol['bbox'].empty?
+                                intFeatCol[:bbox] = hFeatCol['bbox']
+                            end
+                        end
+
+                        # feature collection - features (required, but can be empty)
+                        if hFeatCol.has_key?('features')
+                            hFeatCol['features'].each do |hFeature|
+                                hReturn = GeoJson.unpack(hFeature, responseObj)
+                                unless hReturn.nil?
+                                    intFeatCol[:features] << hReturn
+                                end
+                            end
+                        else
+                            responseObj[:readerExecutionMessages] << 'Features Collection is missing features'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # geometry feature - computed bounding box for extent
+                        unless intFeatCol[:features].empty?
+                            intFeatCol[:computedBbox] = AdiwgCoordinates.computeBbox(intFeatCol[:features])
+                        end
+
+                        # geometry feature - save native GeoJSON for feature
+                        intFeatCol[:nativeGeoJson] = hFeatCol
+
+                        return intFeatCol
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,68 @@
+# unpack format
+# Reader - ADIwg JSON to internal data structure
+
+# History:
+# 	Stan Smith 2016-10-20 original script
+
+require_relative 'module_citation'
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module Format
+
+                    def self.unpack(hFormat, responseObj)
+
+                        # return nil object if input is empty
+                        if hFormat.empty?
+                            responseObj[:readerExecutionMessages] << 'Format object is empty'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intFormat = intMetadataClass.newResourceFormat
+
+                        # format - format specification {citation} (required)
+                        if hFormat.has_key?('formatSpecification')
+                            hObject = hFormat['formatSpecification']
+                            unless hObject.empty?
+                                hReturn = Citation.unpack(hObject, responseObj)
+                                unless hReturn.nil?
+                                    intFormat[:formatSpecification] = hReturn
+                                end
+                            end
+                        end
+                        if intFormat[:formatSpecification].empty?
+                            responseObj[:readerExecutionMessages] << 'Format is missing formatSpecification'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # format - amendment number
+                        if hFormat.has_key?('amendmentNumber')
+                            if hFormat['amendmentNumber'] != ''
+                                intFormat[:amendmentNumber] = hFormat['amendmentNumber']
+                            end
+                        end
+
+                        # format - compression method
+                        if hFormat.has_key?('compressionMethod')
+                            if hFormat['compressionMethod'] != ''
+                                intFormat[:compressionMethod] = hFormat['compressionMethod']
+                            end
+                        end
+
+                        return intFormat
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,67 @@
+# unpack funding
+# Reader - ADIwg JSON to internal data structure
+
+# History:
+#   Stan Smith 2016-10-30 original script
+
+require_relative 'module_allocation'
+require_relative 'module_timePeriod'
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module Funding
+
+                    def self.unpack(hFunding, responseObj)
+
+                        # return nil object if input is empty
+                        if hFunding.empty?
+                            responseObj[:readerExecutionMessages] << 'Funding object is empty'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intFunding = intMetadataClass.newFunding
+
+                        # funding - allocation []
+                        if hFunding.has_key?('allocation')
+                            aItems = hFunding['allocation']
+                            aItems.each do |item|
+                                hReturn = Allocation.unpack(item, responseObj)
+                                unless hReturn.nil?
+                                    intFunding[:allocations] << hReturn
+                                end
+                            end
+                        end
+
+                        # funding - timePeriod
+                        if hFunding.has_key?('timePeriod')
+                            hObject = hFunding['timePeriod']
+                            unless hObject.empty?
+                                hReturn = TimePeriod.unpack(hObject, responseObj)
+                                unless hReturn.nil?
+                                    intFunding[:timePeriod] = hReturn
+                                end
+                            end
+                        end
+
+                        if intFunding[:allocations].empty? && intFunding[:timePeriod].empty?
+                            responseObj[:readerExecutionMessages] << 'Funding must have either an allocation or timePeriod'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        return intFunding
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,70 @@
+# unpack geoJson
+# Reader - ADIwg JSON to internal data structure
+
+# History:
+#   Stan Smith 2016-10-25 original script
+
+require_relative 'module_geometryObject'
+require_relative 'module_geometryCollection'
+require_relative 'module_geometryFeature'
+require_relative 'module_featureCollection'
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module GeoJson
+
+                    def self.unpack(hGeoJson, responseObj)
+
+                        # return nil object if input is empty
+                        if hGeoJson.empty?
+                            responseObj[:readerExecutionMessages] << 'GeoJson object is empty'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        intGeoEle = {}
+
+                        if hGeoJson.has_key?('type')
+                            if hGeoJson['type'] != ''
+                                type = hGeoJson['type']
+                                if %w{ Point LineString Polygon MultiPoint MultiLineString MultiPolygon }.one? { |word| word == type }
+                                    hReturn = GeometryObject.unpack(hGeoJson, responseObj)
+                                    unless hReturn.nil?
+                                        intGeoEle = hReturn
+                                    end
+                                end
+                                if type == 'GeometryCollection'
+                                    hReturn = GeometryCollection.unpack(hGeoJson, responseObj)
+                                    unless hReturn.nil?
+                                        intGeoEle = hReturn
+                                    end
+                                end
+                                if type == 'Feature'
+                                    hReturn = GeometryFeature.unpack(hGeoJson, responseObj)
+                                    unless hReturn.nil?
+                                        intGeoEle = hReturn
+                                    end
+                                end
+                                if type == 'FeatureCollection'
+                                    hReturn = FeatureCollection.unpack(hGeoJson, responseObj)
+                                    unless hReturn.nil?
+                                        intGeoEle = hReturn
+                                    end
+                                end
+
+                            end
+                        end
+
+                        return intGeoEle
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,98 @@
+# unpack geoJson
+# Reader - ADIwg JSON to internal data structure
+
+# History:
+#   Stan Smith 2016-12-01 original script
+
+require_relative 'module_identifier'
+require_relative 'module_boundingBox'
+require_relative 'module_geoJson'
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module GeographicExtent
+
+                    def self.unpack(hGeoExt, responseObj)
+
+                        # return nil object if input is empty
+                        if hGeoExt.empty?
+                            responseObj[:readerExecutionMessages] << 'geographicExtent object is empty'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intGeoExt = intMetadataClass.newGeographicExtent
+
+                        # geographic extent - contains data
+                        if hGeoExt.has_key?('containsData')
+                            if hGeoExt['containsData'] === false
+                                intGeoExt[:containsData] = hGeoExt['containsData']
+                            end
+                        end
+
+                        # geographic extent - identifier
+                        if hGeoExt.has_key?('identifier')
+                            unless hGeoExt['identifier'].empty?
+                                hReturn = Identifier.unpack(hGeoExt['identifier'], responseObj)
+                                unless hReturn.nil?
+                                    intGeoExt[:identifier] = hReturn
+                                end
+                            end
+                        end
+
+                        # geographic extent - bounding box
+                        if hGeoExt.has_key?('boundingBox')
+                            unless hGeoExt['boundingBox'].empty?
+                                hReturn = BoundingBox.unpack(hGeoExt['boundingBox'], responseObj)
+                                unless hReturn.nil?
+                                    intGeoExt[:boundingBox] = hReturn
+                                end
+                            end
+                        end
+
+                        # geographic extent - geographic elements
+                        if hGeoExt.has_key?('geographicElement')
+                            hGeoExt['geographicElement'].each do |hElement|
+                                hReturn = GeoJson.unpack(hElement, responseObj)
+                                unless hReturn.nil?
+                                    intGeoExt[:geographicElements] << hReturn
+                                end
+                            end
+                        end
+
+                        # save native GeoJson
+                        if hGeoExt.has_key?('geographicElement')
+                            unless hGeoExt['geographicElement'].empty?
+                                intGeoExt[:nativeGeoJson] = hGeoExt['geographicElement']
+                            end
+                        end
+
+                        # compute bbox for extent
+                        unless intGeoExt[:geographicElements].empty?
+                            intGeoExt[:computedBbox] = AdiwgCoordinates.computeBbox(intGeoExt[:geographicElements])
+                        end
+
+                        # test for completeness
+                        if intGeoExt[:identifier].empty? &&
+                            intGeoExt[:boundingBox].empty? &&
+                            intGeoExt[:geographicElements].empty?
+                            responseObj[:readerExecutionMessages] <<
+                                'geographicExtent must have at least one identifier, boundingBox, or geographic element'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        return intGeoExt
+
+                    end
+                end
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,87 @@
+# unpack geometry collection
+# Reader - ADIwg JSON to internal data structure
+
+# History:
+#   Stan Smith 2016-11-11 added computedBbox computation
+#   Stan Smith 2016-10-25 original script
+
+require_relative 'module_geoJson'
+require 'adiwg/mdtranslator/internal/module_coordinates'
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module GeometryCollection
+
+                    def self.unpack(hGeoCol, responseObj)
+
+                        # return nil object if input is empty
+                        if hGeoCol.empty?
+                            responseObj[:readerExecutionMessages] << 'Geometry Collection object is empty'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intGeoCol = intMetadataClass.newGeometryCollection
+
+                        # geometry collection - type (required)
+                        if hGeoCol.has_key?('type')
+                            if hGeoCol['type'] != ''
+                                if hGeoCol['type'] == 'GeometryCollection'
+                                    intGeoCol[:type] = hGeoCol['type']
+                                else
+                                    responseObj[:readerExecutionMessages] << 'Geometry Collection type must be GeometryCollection'
+                                    responseObj[:readerExecutionPass] = false
+                                    return nil
+                                end
+                            end
+                        end
+                        if intGeoCol[:type].nil? || intGeoCol[:type] == ''
+                            responseObj[:readerExecutionMessages] << 'Geometry Collection is missing type'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # geometry collection - bounding box
+                        if hGeoCol.has_key?('bbox')
+                            unless hGeoCol['bbox'].empty?
+                                intGeoCol[:bbox] = hGeoCol['bbox']
+                            end
+                        end
+
+                        # geometry collection - geometries (required, but can be empty)
+                        if hGeoCol.has_key?('geometries')
+                            hGeoCol['geometries'].each do |hGeometry|
+                                hReturn = GeoJson.unpack(hGeometry, responseObj)
+                                unless hReturn.nil?
+                                    intGeoCol[:geometryObjects] << hReturn
+                                end
+                            end
+                        else
+                            responseObj[:readerExecutionMessages] << 'Geometry Collection is missing geometries'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # geometry collection - compute bbox for geometry collection
+                        unless intGeoCol[:geometryObjects].empty?
+                            intGeoCol[:computedBbox] = AdiwgCoordinates.computeBbox(intGeoCol[:geometryObjects])
+                        end
+
+                        # geometry collection - save GeoJSON for the collection
+                        intGeoCol[:nativeGeoJson] = hGeoCol
+
+                        return intGeoCol
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,112 @@
+# unpack geometry feature
+# Reader - ADIwg JSON to internal data structure
+
+# History:
+#   Stan Smith 2016-11-10 added computedBbox computation
+#   Stan Smith 2016-10-25 original script
+
+require_relative 'module_geometryObject'
+require_relative 'module_geometryProperties'
+require_relative 'module_geometryCollection'
+require 'adiwg/mdtranslator/internal/module_coordinates'
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module GeometryFeature
+
+                    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
+
+                        # 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
+
+                        # 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
+                                    hReturn = GeometryObject.unpack(hGeometry, responseObj)
+                                end
+                                unless hReturn.nil?
+                                    intFeature[:geometryObject] = hReturn
+                                end
+                            end
+                        else
+                            responseObj[:readerExecutionMessages] << 'Feature is missing geometry'
+                            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 - computed bounding box for feature
+                        unless intFeature[:geometryObject].empty?
+                            intFeature[:computedBbox] = AdiwgCoordinates.computeBbox([intFeature[:geometryObject]])
+                        end
+
+                        # geometry feature - save native GeoJSON for feature
+                        intFeature[:nativeGeoJson] = hFeature
+
+                        return intFeature
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,70 @@
+# unpack geometry object
+# Reader - ADIwg JSON to internal data structure
+
+# History:
+#   Stan Smith 2016-10-24 original script
+
+require_relative 'module_geometryCollection'
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module GeometryObject
+
+                    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
+
+                        # 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
+
+                        # 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
+                        end
+
+                        # geometry object - save native GeoJSON
+                        intGeoObject[:nativeGeoJson] = hGeoObject
+
+                        return intGeoObject
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end