adiwg-mdtranslator 1.4.0 → 2.0.0rc2

data/lib/adiwg/mdtranslator/internal/module_geoFormat.rb

@@ -1,219 +0,0 @@
-# methods for converting geographic formats
-# for ADIwg readers and writers
-
-# History:
-# 	Stan Smith 2015-04-01 original script
-#   Stan Smith 2015-04-10 mapped bounding box as geojson feature and wkt polygon
-
-module AdiwgGeoFormat
-  def self.internal_to_geoJson(hGeoEle, geojson = true)
-    geoType = hGeoEle[:elementGeometry][:geoType]
-    hGeometry = hGeoEle[:elementGeometry][:geometry]
-    hSRS = hGeoEle[:elementSrs]
-
-    # GeoJson structure as hash
-    hGeoJson = {}
-
-    # add type
-    hGeoJson[:type] = geoType
-
-    # add bounding box
-    if geoType == 'BoundingBox'
-      hGeoJson[:type] = 'Feature'
-      hGeoJson[:bbox] = [hGeometry[:westLong], hGeometry[:southLat],
-                         hGeometry[:eastLong], hGeometry[:northLat]]
-      hGeoJson[:geometry] = nil
-      hGeoJson[:properties] = nil
-    end
-
-    # add point, multi-point, linestring, multi-linestring
-    if geoType == 'Point' ||
-       geoType == 'MultiPoint' ||
-       geoType == 'LineString' ||
-       geoType == 'MultiLineString'
-      hGeoJson[:coordinates] = hGeometry
-    end
-
-    # add polygon
-    if geoType == 'Polygon'
-      hGeoJson[:coordinates] = polygon_to_coords(hGeometry)
-    end
-
-    # add multi-polygon
-    if geoType == 'MultiPolygon'
-      hGeoJson[:coordinates] = []
-      hGeometry.each do |hPolygon|
-        hGeoJson[:coordinates] << polygon_to_coords(hPolygon)
-      end
-    end
-
-    # add coordinate reference system
-    unless hSRS.empty?
-      hGeoJson[:crs] = {}
-
-      # if srs name is provided use crs name format
-      sName = hSRS[:srsName]
-      sLink = hSRS[:srsHref]
-      if !sName.nil?
-        hGeoJson[:crs][:type] = 'name'
-        hGeoJson[:crs][:properties] = {}
-        hGeoJson[:crs][:properties][:name] = sName
-      elsif !sLink.nil?
-        hGeoJson[:crs][:type] = 'link'
-        hGeoJson[:crs][:properties] = {}
-        hGeoJson[:crs][:properties][:href] = sLink
-        sType = hSRS[:srsType]
-        hGeoJson[:crs][:properties][:type] = sType unless sType.nil?
-      end
-
-    end
-
-    # return GeoJSON
-    geojson ? hGeoJson.to_json : hGeoJson
-  end
-
-  # convert internal object polygon format to coordinates
-  def self.polygon_to_coords(hPolygon)
-    aCoordinates = []
-
-    # add exterior ring
-    aCoordinates << hPolygon[:exteriorRing]
-
-    # add exclusion rings
-    hPolygon[:exclusionRings].each do |aExRing|
-      aCoordinates << aExRing
-    end
-
-    aCoordinates
-  end
-
-  def self.internal_to_wkt(hGeoEle)
-    geoType = hGeoEle[:geoType]
-    hGeometry = hGeoEle[:geometry]
-    dimension = hGeoEle[:dimension]
-    wktString = ''
-
-    if geoType == 'BoundingBox'
-      wktString = 'POLYGON ('
-      wktString += '(' + hGeometry[:westLong].to_s + ' ' + hGeometry[:northLat].to_s + '), '
-      wktString += '(' + hGeometry[:eastLong].to_s + ' ' + hGeometry[:northLat].to_s + '), '
-      wktString += '(' + hGeometry[:eastLong].to_s + ' ' + hGeometry[:southLat].to_s + '), '
-      wktString += '(' + hGeometry[:westLong].to_s + ' ' + hGeometry[:southLat].to_s + '), '
-      wktString += '(' + hGeometry[:westLong].to_s + ' ' + hGeometry[:northLat].to_s + ')'
-      wktString += ')'
-    end
-
-    if geoType == 'Point'
-      wktString = 'POINT ' + wkt_dimension(dimension) + '('
-      wktString += point_string(hGeometry)
-      wktString += ')'
-    end
-
-    if geoType == 'LineString'
-      wktString = 'LINESTRING ' + wkt_dimension(dimension) + '('
-      hGeometry.each do |point|
-        wktString += point_string(point) + ', '
-      end
-      wktString.chomp!(', ')
-      wktString += ')'
-    end
-
-    if geoType == 'Polygon'
-      wktString = 'POLYGON ' + wkt_dimension(dimension) + '('
-
-      # add exterior ring - required
-      wktString += '('
-      aExtRing = hGeometry[:exteriorRing]
-      aExtRing.each do |point|
-        wktString += point_string(point) + ', '
-      end
-      wktString.chomp!(', ')
-      wktString += ')'
-
-      # add any exclusion rings
-      aExcRings = hGeometry[:exclusionRings]
-      aExcRings.each do |excPolygon|
-        wktString += ', ('
-        excPolygon.each do |point|
-          wktString += point_string(point) + ', '
-        end
-        wktString.chomp!(', ')
-        wktString += ')'
-      end
-
-      wktString += ')'
-    end
-
-    if geoType == 'MultiPoint'
-      wktString = 'MULTIPOINT ' + wkt_dimension(dimension) + '('
-      hGeometry.each do |point|
-        wktString += '('
-        wktString += point_string(point) + '), '
-      end
-      wktString.chomp!(', ')
-      wktString += ')'
-    end
-
-    if geoType == 'MultiLineString'
-      wktString = 'MULTILINESTRING ' + wkt_dimension(dimension) + '('
-      hGeometry.each do |line|
-        wktString += '('
-        line.each do |point|
-          wktString += point_string(point) + ', '
-        end
-        wktString.chomp!(', ')
-        wktString += '), '
-      end
-      wktString.chomp!(', ')
-      wktString += ')'
-    end
-
-    if geoType == 'MultiPolygon'
-      wktString = 'MULTIPOLYGON ' + wkt_dimension(dimension) + '('
-      hGeometry.each do |polygon|
-        wktString += '('
-
-        # add exterior ring - required
-        wktString += '('
-        aExtRing = polygon[:exteriorRing]
-        aExtRing.each do |point|
-          wktString += point_string(point) + ', '
-        end
-        wktString.chomp!(', ')
-        wktString += ')'
-
-        # add any exclusion rings
-        aExcRings = polygon[:exclusionRings]
-        aExcRings.each do |excPolygon|
-          wktString += ', ('
-          excPolygon.each do |point|
-            wktString += point_string(point) + ', '
-          end
-          wktString.chomp!(', ')
-          wktString += ')'
-        end
-
-        wktString += '), '
-      end
-      wktString.chomp!(', ')
-      wktString += ')'
-    end
-
-    wktString
-  end
-
-  def self.point_string(aTuple)
-    sTuple = ''
-    aTuple.each do |element|
-      sTuple += element.to_s + ' '
-    end
-    sTuple.chomp(' ')
-  end
-
-  def self.wkt_dimension(dim)
-    sDim = ''
-    sDim += 'Z ' if dim == 3
-    sDim += 'ZM ' if dim == 4
-    sDim
-  end
-end

data/lib/adiwg/mdtranslator/internal/module_lineString.rb

@@ -1,18 +0,0 @@
-# unpack line string
-# line string is coded in GeoJSON
-module ADIWG
-    module Mdtranslator
-        module LineString
-            def self.unpack(aCoords, geoType, _responseObj)
-                intMetadataClass = InternalMetadata.new
-                intLine = intMetadataClass.newGeometry
-
-                intLine[:geoType] = geoType
-                intLine[:geometry] = aCoords
-                intLine[:dimension] = AdiwgCoordinates.getDimension(aCoords)
-
-                intLine
-            end
-        end
-    end
-end

data/lib/adiwg/mdtranslator/internal/module_point.rb

@@ -1,18 +0,0 @@
-# unpack point
-# point is coded in GeoJSON
-module ADIWG
-    module Mdtranslator
-        module Point
-            def self.unpack(aCoords, geoType, _responseObj)
-                intMetadataClass = InternalMetadata.new
-                intPoint = intMetadataClass.newGeometry
-
-                intPoint[:geoType] = geoType
-                intPoint[:geometry] = aCoords
-                intPoint[:dimension] = AdiwgCoordinates.getDimension(aCoords)
-
-                intPoint
-            end
-        end
-    end
-end

data/lib/adiwg/mdtranslator/readers/mdJson/modules_v1/module_additionalDocumentation.rb

@@ -1,64 +0,0 @@
-# unpack additional documentation
-# Reader - ADIwg JSON V1 to internal data structure
-
-# History:
-# 	Stan Smith 2014-11-06 original script
-#   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
-#   Stan Smith 2014-12-30 added return if empty input
-#   ... found & fixed error of method using associatedResource object instead of
-#   ... additionalDocumentation object
-#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
-#   Stan Smith 2015-07-14 refactored to remove global namespace constants
-
-require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_citation')
-
-module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
-
-                module AdditionalDocumentation
-
-                    def self.unpack(hAddDoc, responseObj)
-
-                        # return nil object if input is empty
-                        intAddDoc = nil
-                        return if hAddDoc.empty?
-
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intAddDoc = intMetadataClass.newAdditionalDocumentation
-
-                        # additional documentation - resource type
-                        if hAddDoc.has_key?('resourceType')
-                            s = hAddDoc['resourceType']
-                            if s != ''
-                                intAddDoc[:resourceType] = s
-                            end
-                        end
-
-                        # additional documentation - resource citation
-                        if hAddDoc.has_key?('citation')
-                            hCitation = hAddDoc['citation']
-                            unless hCitation.empty?
-                                intAddDoc[:citation] = Citation.unpack(hCitation, responseObj)
-                            else
-                                responseObj[:readerExecutionMessages] << 'Additional documentation citation is empty'
-                                responseObj[:readerExecutionPass] = false
-                                return nil
-                            end
-                        else
-                            responseObj[:readerExecutionMessages] << 'Additional documentation citation is missing'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        return intAddDoc
-                    end
-
-                end
-
-            end
-        end
-    end
-end

data/lib/adiwg/mdtranslator/readers/mdJson/modules_v1/module_address.rb

@@ -1,91 +0,0 @@
-# unpack address
-# Reader - ADIwg JSON V1 to internal data structure
-
-# History:
-# 	Stan Smith 2013-10-21 original script
-#   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
-#   Stan Smith 2014-12-19 prevented passing blank deliveryPoints and
-#   ... electronicMailAddresses into internal object
-#   Stan Smith 2014-12-30 refactored
-#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
-#   Stan Smith 2015-07-14 refactored to remove global namespace constants
-
-module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
-
-                module Address
-
-                    def self.unpack(hConAddress, responseObj)
-
-                        # return nil object if input is empty
-                        intAdd = nil
-                        return if hConAddress.empty?
-
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intAdd = intMetadataClass.newAddress
-
-                        # address - delivery point
-                        if hConAddress.has_key?('deliveryPoint')
-                            aDevPoint = hConAddress['deliveryPoint']
-                            aDevPoint.each do |addLine|
-                                if addLine != ''
-                                    intAdd[:deliveryPoints] << addLine
-                                end
-                            end
-                        end
-
-                        # address - city
-                        if hConAddress.has_key?('city')
-                            s = hConAddress['city']
-                            if s != ''
-                                intAdd[:city] = s
-                            end
-                        end
-
-                        # address - admin area
-                        if hConAddress.has_key?('administrativeArea')
-                            s = hConAddress['administrativeArea']
-                            if s != ''
-                                intAdd[:adminArea] = s
-                            end
-                        end
-
-                        # address - postal code
-                        if hConAddress.has_key?('postalCode')
-                            s = hConAddress['postalCode']
-                            if s != ''
-                                intAdd[:postalCode] = s
-                            end
-                        end
-
-                        # address - country
-                        if hConAddress.has_key?('country')
-                            s = hConAddress['country']
-                            if s != ''
-                                intAdd[:country] = s
-                            end
-                        end
-
-                        # address - email
-                        if hConAddress.has_key?('electronicMailAddress')
-                            eMailList = hConAddress['electronicMailAddress']
-                            eMailList.each do |email|
-                                if email != ''
-                                    intAdd[:eMailList] << email
-                                end
-                            end
-                        end
-
-                        return intAdd
-                    end
-
-                end
-
-            end
-        end
-    end
-end
-

data/lib/adiwg/mdtranslator/readers/mdJson/modules_v1/module_associatedResource.rb

@@ -1,100 +0,0 @@
-# unpack associated resource
-# Reader - ADIwg JSON V1 to internal data structure
-
-# History:
-# 	Stan Smith 2014-05-02 original script
-# 	Stan Smith 2014-05-28 added resource identifier section
-# 	Stan Smith 2014-06-02 added resource metadata citation section
-#   Stan Smith 2014-07-08 resolve require statements using Mdtranslator.reader_module
-#   Stan Smith 2014-08-18 moved resourceIdentifier to citation module schema 0.6.0
-#   Stan Smith 2014-11-06 changed resourceType to initiative type for 0.9.0
-#   Stan Smith 2014-11-06 added resourceType for 0.9.0
-#   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
-#   Stan Smith 2014-12-30 added return if empty input
-#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
-#   Stan Smith 2015-07-14 refactored to remove global namespace constants
-
-require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_citation')
-
-module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
-
-                module AssociatedResource
-
-                    def self.unpack(hAssocRes, responseObj)
-
-                        # return nil object if input is empty
-                        intAssocRes = nil
-                        return if hAssocRes.empty?
-
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intAssocRes = intMetadataClass.newAssociatedResource
-
-                        # associated resource - association type
-                        if hAssocRes.has_key?('associationType')
-                            s = hAssocRes['associationType']
-                            if s != ''
-                                intAssocRes[:associationType] = s
-                            else
-                                responseObj[:readerExecutionMessages] << 'Associated resource association type is empty'
-                                responseObj[:readerExecutionPass] = false
-                                return nil
-                            end
-                        else
-                            responseObj[:readerExecutionMessages] << 'Associated resource association type is missing'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        # associated resource - initiative type
-                        if hAssocRes.has_key?('initiativeType')
-                            s = hAssocRes['initiativeType']
-                            if s != ''
-                                intAssocRes[:initiativeType] = s
-                            end
-                        end
-
-                        # associated resource - resource type
-                        if hAssocRes.has_key?('resourceType')
-                            s = hAssocRes['resourceType']
-                            if s != ''
-                                intAssocRes[:resourceType] = s
-                            else
-                                responseObj[:readerExecutionMessages] << 'Associated resource resource type is empty'
-                                responseObj[:readerExecutionPass] = false
-                                return nil
-                            end
-                        else
-                            responseObj[:readerExecutionMessages] << 'Associated resource resource type is missing'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        # associated resource - resource citation
-                        if hAssocRes.has_key?('resourceCitation')
-                            hCitation = hAssocRes['resourceCitation']
-                            unless hCitation.empty?
-                                intAssocRes[:resourceCitation] = Citation.unpack(hCitation, responseObj)
-                            end
-                        end
-
-                        # associated resource - metadata citation
-                        if hAssocRes.has_key?('metadataCitation')
-                            hCitation = hAssocRes['metadataCitation']
-                            unless hCitation.empty?
-                                intAssocRes[:metadataCitation] = Citation.unpack(hCitation, responseObj)
-                            end
-                        end
-
-                        return intAssocRes
-                    end
-
-                end
-
-            end
-        end
-    end
-end

data/lib/adiwg/mdtranslator/readers/mdJson/modules_v1/module_boundingBox.rb

@@ -1,64 +0,0 @@
-# unpack bounding box
-# Reader - ADIwg JSON V1 to internal data structure
-
-# History:
-# 	Stan Smith 2013-11-07 original script
-#   Stan Smith 2014-04-28 reorganized for json schema 0.3.0
-#   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
-#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
-#   Stan Smith 2015-07-14 refactored to remove global namespace constants
-
-module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
-
-                module BoundingBox
-
-                    def self.unpack(aBBox, responseObj)
-
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intGeometry = intMetadataClass.newGeometry
-                        intGeometry[:geoType] = 'BoundingBox'
-
-                        # unpack GeoJSON bounding box elements
-                        intBBox = intMetadataClass.newBoundingBox
-                        west = aBBox[0]
-                        south = aBBox[1]
-                        east = aBBox[2]
-                        north = aBBox[3]
-
-                        # validate coordinates if easting +/-180 and northing +/-90
-                        valid = false
-                        if (180 >= west) && (west >= -180)
-                            if (90 >= south) && (south >= -90)
-                                if (180 >= east) && (east >= -180)
-                                    if (90 >= north) &&(north >= -90)
-                                        valid = true
-                                    end
-                                end
-                            end
-                        end
-
-                        # build internal geo element if valid
-                        if valid
-                            intBBox[:westLong] = west
-                            intBBox[:eastLong] = east
-                            intBBox[:southLat] = south
-                            intBBox[:northLat] = north
-                            intGeometry[:geometry] = intBBox
-
-                            return intGeometry
-                        else
-                            return nil
-                        end
-
-                    end
-
-                end
-
-            end
-        end
-    end
-end

data/lib/adiwg/mdtranslator/readers/mdJson/modules_v1/module_browseGraphic.rb

@@ -1,79 +0,0 @@
-# unpack browse graphic
-# Reader - ADIwg JSON V1 to internal data structure
-
-# History:
-# 	Stan Smith 2013-10-17 original script
-# 	Stan Smith 2013-11-27 modified to process single browse graphic rather than array
-#   Stan Smith 2014-04-28 modified attribute names to match json schema 0.3.0
-#   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
-#   Stan Smith 2014-12-24 added return if input hash is empty
-#   Stan Smith 2014-12-30 refactored
-#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
-#   Stan Smith 2015-07-14 refactored to remove global namespace constants
-
-module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
-
-                module BrowseGraphic
-
-                    def self.unpack(hBgraphic, responseObj)
-
-                        # return nil object if input is empty
-                        intBGraphic = nil
-                        return if hBgraphic.empty?
-
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intBGraphic = intMetadataClass.newBrowseGraphic
-
-                        # graphic - file name
-                        if hBgraphic.has_key?('fileName')
-                            s = hBgraphic['fileName']
-                            if s != ''
-                                intBGraphic[:bGName] = s
-                            else
-                                responseObj[:readerExecutionMessages] << 'Graphic overview name is empty'
-                                responseObj[:readerExecutionPass] = false
-                                return nil
-                            end
-                        else
-                            responseObj[:readerExecutionMessages] << 'Graphic overview name is missing'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        # graphic - file description
-                        if hBgraphic.has_key?('fileDescription')
-                            s = hBgraphic['fileDescription']
-                            if s != ''
-                                intBGraphic[:bGDescription] = s
-                            end
-                        end
-
-                        # graphic - file  type
-                        if hBgraphic.has_key?('fileType')
-                            s = hBgraphic['fileType']
-                            if s != ''
-                                intBGraphic[:bGType] = s
-                            end
-                        end
-
-                        # graphic - web link
-                        if hBgraphic.has_key?('fileUri')
-                            s = hBgraphic['fileUri']
-                            if s != ''
-                                intBGraphic[:bGURI] = s
-                            end
-                        end
-
-                        return intBGraphic
-                    end
-
-                end
-
-            end
-        end
-    end
-end