adiwg-mdtranslator 2.1.0 → 2.1.1

data/lib/adiwg/mdtranslator/readers/fgdc/modules/module_identification.rb

@@ -0,0 +1,136 @@
+# Reader - fgdc to internal data structure
+# unpack fgdc metadata identification
+
+# History:
+#  Stan Smith 2017-08-15 original script
+
+require 'nokogiri'
+require 'adiwg/mdtranslator/internal/internal_metadata_obj'
+require_relative 'module_citation'
+require_relative 'module_timePeriod'
+require_relative 'module_timeInstant'
+require_relative 'module_spatialDomain'
+
+module ADIWG
+   module Mdtranslator
+      module Readers
+         module Fgdc
+
+            module Identification
+
+               def self.unpack(xIdInfo, intObj, hResponseObj)
+
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+
+                  # useful parts
+                  hMetadata = intObj[:metadata]
+                  hMetadataInfo = hMetadata[:metadataInfo]
+                  hResourceInfo = hMetadata[:resourceInfo]
+
+                  # identification information 1.1 (citation) - citation (required)
+                  xCitation = xIdInfo.xpath('./citation')
+                  unless xCitation.empty?
+                     hCitation = Citation.unpack(xCitation, hResponseObj)
+                     unless hCitation.nil?
+                        hResourceInfo[:citation] = hCitation
+                     end
+                  end
+
+                  # identification information 1.2 (descript) - description (required)
+                  xDescription = xIdInfo.xpath('./descript')
+                  unless xDescription.empty?
+
+                     # description 1.2.1 (abstract) - abstract
+                     abstract = xDescription.xpath('./abstract').text
+                     unless abstract.empty?
+                        hResourceInfo[:abstract] = abstract
+                     end
+
+                     # description 1.2.2 (purpose) - purpose
+                     purpose = xDescription.xpath('./purpose').text
+                     unless purpose.empty?
+                        hResourceInfo[:purpose] = purpose
+                     end
+
+                     # description 1.2.3 (supplinf) - supplemental information
+                     supplemental = xDescription.xpath('./supplinf').text
+                     unless supplemental.empty?
+                        hResourceInfo[:supplementalInfo] = supplemental
+                     end
+
+                  end
+
+                  # identification information 1.3 (timeperd) - time period of content
+                  xTimePeriod = xIdInfo.xpath('./timeperd')
+                  unless xTimePeriod.empty?
+
+                     # time period for single date and date range
+                     hTimePeriod = TimePeriod.unpack(xTimePeriod, hResponseObj)
+                     unless hTimePeriod.nil?
+                        hResourceInfo[:timePeriod] = hTimePeriod
+                     end
+
+                     # time period multiple date time pairs 9.1.2 (mdattim)
+                     axMultiple = xTimePeriod.xpath('./timeinfo/mdattim/sngdate')
+                     unless axMultiple.empty?
+                        current = xTimePeriod.xpath('./current').text
+                        hExtent = intMetadataClass.newExtent
+                        hExtent[:description] = 'FGDC resource time period multiple date/times'
+                        axMultiple.each do |xDateTime|
+                           date = xDateTime.xpath('./caldate').text
+                           time = xDateTime.xpath('./time').text
+                           hInstant = TimeInstant.unpack(date, time, hResponseObj)
+                           unless hInstant.nil?
+                              hTempExtent = intMetadataClass.newTemporalExtent
+                              hInstant[:description] = current
+                              hTempExtent[:timeInstant] = hInstant
+                              hExtent[:temporalExtents] << hTempExtent
+                           end
+                        end
+                        unless hExtent[:temporalExtents].empty?
+                           hResourceInfo[:extents] << hExtent
+                        end
+                     end
+
+                  end
+
+                  # identification information 1.4 (status) - status and maintenance
+                  xStatus = xIdInfo.xpath('./status')
+                  unless xStatus.empty?
+
+                     # status 1.4.1 (progress) - state of resource
+                     progress = xStatus.xpath('./progress').text
+                     unless progress.empty?
+                        hResourceInfo[:status] << progress
+                     end
+
+                     # status 1.4.2 (update) - maintenance frequency
+                     update = xStatus.xpath('./update').text
+                     unless update.empty?
+                        hMaintenance = intMetadataClass.newMaintenance
+                        hMaintenance[:frequency] = update
+                        hResourceInfo[:resourceMaintenance] << hMaintenance
+                     end
+
+                  end
+
+                  # identification information 1.5 (spdom) - spatial domain
+                  xDomain = xIdInfo.xpath('./spdom')
+                  unless xDomain.empty?
+                     hExtent = SpatialDomain.unpack(xDomain, hResponseObj)
+                     unless hExtent.nil?
+                        hResourceInfo[:extents] << hExtent
+                     end
+                  end
+
+                  # identification information 1.6 (keywords) - keywords
+
+               end
+
+            end
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/readers/fgdc/modules/module_metadataInfo.rb

@@ -0,0 +1,28 @@
+# Reader - fgdc to internal data structure
+# unpack fgdc metadata information
+
+# History:
+#  Stan Smith 2017-08-15 original script
+
+require 'nokogiri'
+require 'adiwg/mdtranslator/internal/internal_metadata_obj'
+
+module ADIWG
+   module Mdtranslator
+      module Readers
+         module Fgdc
+
+            module MetadataInformation
+
+               def self.unpack(xMetaInfo, hResponseObj)
+
+
+
+               end
+
+            end
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/readers/fgdc/modules/module_onlineResource.rb

@@ -0,0 +1,35 @@
+# Reader - fgdc to internal data structure
+# unpack fgdc online resource
+
+# History:
+#  Stan Smith 2017-08-17 original script
+
+require 'nokogiri'
+require 'adiwg/mdtranslator/internal/internal_metadata_obj'
+
+module ADIWG
+   module Mdtranslator
+      module Readers
+         module Fgdc
+
+            module OnlineResource
+
+               def self.unpack(onLink, description, hResponseObj)
+
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  hURI = intMetadataClass.newOnlineResource
+
+                  hURI[:olResURI] = onLink
+                  hURI[:olResDesc] = description
+
+                  return hURI
+
+               end
+
+            end
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/readers/fgdc/modules/module_publication.rb

@@ -0,0 +1,63 @@
+# Reader - fgdc to internal data structure
+# unpack fgdc publication
+
+# History:
+#  Stan Smith 2017-08-17 original script
+
+require 'nokogiri'
+require 'adiwg/mdtranslator/internal/internal_metadata_obj'
+require_relative 'module_fgdc'
+
+module ADIWG
+   module Mdtranslator
+      module Readers
+         module Fgdc
+
+            module Publication
+
+               def self.unpack(xPublication, hResponseObj)
+
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  hResponsibility = nil
+                  contactId = nil
+
+                  # publication information 8.2 (publish) - publisher {contact}
+                  publisher = xPublication.xpath('./publish').text
+                  unless publisher.empty?
+                     contactId = Fgdc.find_contact_by_name(publisher)
+                     if contactId.nil?
+                        contactId = Fgdc.add_contact(publisher, true)
+                     end
+                     hResponsibility = Responsibility.unpack([contactId], 'publisher', hResponseObj)
+                  end
+
+                  # publication information 8.1 (pubplace) - place of publication
+                  place = xPublication.xpath('./pubplace').text
+                  unless place.empty?
+                     unless contactId.nil?
+                        hContact = Fgdc.get_contact_by_id(contactId)
+                        unless hContact.nil?
+                           if hContact[:addresses].empty?
+                              hAddress = intMetadataClass.newAddress
+                              hContact[:addresses] << hAddress
+                           else
+                              hAddress = hContact[:addresses][0]
+                           end
+                           hAddress[:addressTypes] << 'mailing'
+                           hAddress[:description] = place
+                           Fgdc.set_contact(hContact)
+                        end
+                     end
+                  end
+
+                  return hResponsibility
+
+               end
+
+            end
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/readers/fgdc/modules/module_quality.rb

@@ -0,0 +1,28 @@
+# Reader - fgdc to internal data structure
+# unpack fgdc data quality
+
+# History:
+#  Stan Smith 2017-08-15 original script
+
+require 'nokogiri'
+require 'adiwg/mdtranslator/internal/internal_metadata_obj'
+
+module ADIWG
+   module Mdtranslator
+      module Readers
+         module Fgdc
+
+            module Quality
+
+               def self.unpack(xDataQual, hResponseObj)
+
+
+
+               end
+
+            end
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/readers/fgdc/modules/module_responsibility.rb

@@ -0,0 +1,46 @@
+# Reader - fgdc to internal data structure
+# unpack fgdc metadata responsibility
+
+# History:
+#  Stan Smith 2017-08-18 original script
+
+require 'adiwg/mdtranslator/internal/internal_metadata_obj'
+require_relative 'module_fgdc'
+
+module ADIWG
+   module Mdtranslator
+      module Readers
+         module Fgdc
+
+            module Responsibility
+
+               def self.unpack(aContacts, role, hResponseObj)
+
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  hResponsibility = intMetadataClass.newResponsibility
+
+                  hResponsibility[:roleName] = role
+
+                  # add contacts to responsibility party []
+                  aContacts.each do |contactId|
+                     hContactInfo = Fgdc.find_contact_by_id(contactId)
+                     unless hContactInfo[0].nil?
+                        hParty = intMetadataClass.newParty
+                        hParty[:contactId] = contactId
+                        hParty[:contactIndex] = hContactInfo[0]
+                        hParty[:contactType] = hContactInfo[1]
+                        hResponsibility[:parties] << hParty
+                     end
+                  end
+
+                  return hResponsibility
+
+               end
+
+            end
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/readers/fgdc/modules/module_series.rb

@@ -0,0 +1,44 @@
+# Reader - fgdc to internal data structure
+# unpack fgdc series
+
+# History:
+#  Stan Smith 2017-08-17 original script
+
+require 'nokogiri'
+require 'adiwg/mdtranslator/internal/internal_metadata_obj'
+
+module ADIWG
+   module Mdtranslator
+      module Readers
+         module Fgdc
+
+            module Series
+
+               def self.unpack(xSerInfo, hResponseObj)
+
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  hSeries = intMetadataClass.newSeries
+
+                  # series 8.7.1 (sername) - series name
+                  name = xSerInfo.xpath('./sername').text
+                  unless name.empty?
+                     hSeries[:seriesName] = name
+                  end
+
+                  # series 8.7.2 (issue) - series issue
+                  issue = xSerInfo.xpath('./issue').text
+                  unless issue.empty?
+                     hSeries[:seriesIssue] = issue
+                  end
+
+                  return hSeries
+
+               end
+
+            end
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/readers/fgdc/modules/module_spatialDomain.rb

@@ -0,0 +1,184 @@
+# Reader - fgdc to internal data structure
+# unpack fgdc spatial domain
+
+# History:
+#  Stan Smith 2017-08-22 original script
+
+require 'nokogiri'
+require 'json'
+require 'adiwg/mdtranslator/internal/internal_metadata_obj'
+require 'adiwg/mdtranslator/internal/module_coordinates'
+
+module ADIWG
+   module Mdtranslator
+      module Readers
+         module Fgdc
+
+            module SpatialDomain
+
+               def self.process_polygon(xPolygon)
+                  aCoords = []
+
+                  # polygon coordinates (grngpoin) - g ring points []
+                  axPoints = xPolygon.xpath('./grngpoin')
+                  unless axPoints.empty?
+                     aCoords = coords_from_points(axPoints)
+                  end
+
+                  # polygon coordinates (gring) - g ring
+                  xRing = xPolygon.xpath('./gring')
+                  unless xRing.empty?
+                     aCoords = coords_from_ring(xRing)
+                  end
+
+                  return aCoords
+               end
+
+               def self.coords_from_points(axPoints)
+                  aCoords = []
+                  axPoints.each do |xPoint|
+                     lon = xPoint.xpath('./grnglon').text.to_f
+                     lat = xPoint.xpath('./grnglat').text.to_f
+                     aCoords << [lon, lat]
+                  end
+                  return aCoords
+               end
+
+               def self.coords_from_ring(xRing)
+                  aCoords = []
+                  sRing = xRing.text
+                  aPoints = sRing.split(', ')
+                  aPoints.each do |point|
+                     aCoord = point.split(' ')
+                     aCoords << [aCoord[0].to_f, aCoord[1].to_f]
+                  end
+                  return aCoords
+               end
+
+               def self.unpack(xDomain, hResponseObj)
+
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  hExtent = intMetadataClass.newExtent
+                  hGeoExtent = intMetadataClass.newGeographicExtent
+
+                  # spatial domain 1.5.1 (bounding) - bounding box
+                  xBbox = xDomain.xpath('./bounding')
+                  unless xBbox.empty?
+                     hBbox = intMetadataClass.newBoundingBox
+
+                     # bounding box 1.5.1.1 (westbc) - west coordinate
+                     hBbox[:westLongitude] = xBbox.xpath('./westbc').text.to_f
+
+                     # bounding box 1.5.1.2 (eastbc) - east coordinate
+                     hBbox[:eastLongitude] = xBbox.xpath('./eastbc').text.to_f
+
+                     # bounding box 1.5.1.3 (northbc) - north coordinate
+                     hBbox[:northLatitude] = xBbox.xpath('./northbc').text.to_f
+
+                     # bounding box 1.5.1.4 (southbc) - south coordinate
+                     hBbox[:southLatitude] = xBbox.xpath('./southbc').text.to_f
+
+                     hGeoExtent[:boundingBox] = hBbox
+                  end
+
+                  # spatial domain 1.5.2 (dsgpoly) - data set geographic polygon
+                  xPoly = xDomain.xpath('./dsgpoly')
+                  unless xPoly.empty?
+
+                     polygon = []
+
+                     # polygon 1.5.2.1 (dsgpolyo) - polygon outer ring
+                     xOring = xPoly.xpath('./dsgpolyo')
+                     unless xOring.empty?
+
+                        # outer ring 1.5.2.1.1 (grngpoin) - g ring point
+                        # outer ring 1.5.2.1.2 (gring) - g ring
+                        # outer ring must be counterclockwise
+                        aOutCoords = process_polygon(xOring)
+                        unless aOutCoords.empty?
+                           if AdiwgCoordinates.is_polygon_clockwise(aOutCoords)
+                              aOutCoords.reverse!
+                           end
+                           polygon << aOutCoords
+                        end
+
+                        # first ring must be outer
+                        # only process if already have outer ring
+                        # polygon 1.5.2.2 (dsgpolyx) - polygon exclusion ring []
+                        axXring = xPoly.xpath('./dsgpolyx')
+                        axXring.each do |xRing|
+
+                           # exclusion ring 1.5.2.2.1 (grngpoin) - g ring point
+                           # exclusion ring 1.5.2.2.2 (gring) - g ring
+                           # exclusion ring must be clockwise
+                           aInCoords = process_polygon(xRing)
+                           unless aInCoords.empty?
+                              unless AdiwgCoordinates.is_polygon_clockwise(aInCoords)
+                                 aInCoords.reverse!
+                              end
+                              polygon << aInCoords
+                           end
+
+                        end
+                     end
+
+                     unless polygon.empty?
+
+                        # make geoJson FeatureCollection from polygon
+                        hGeometry = {
+                           type: 'Polygon',
+                           coordinates: polygon
+                        }
+                        hFeature = {
+                           type: 'Feature',
+                           geometry: hGeometry,
+                           properties: {
+                              description: 'FGDC bounding polygon'
+                           }
+                        }
+                        hCollection = {
+                           type: 'FeatureCollection',
+                           features: [hFeature]
+                        }
+                        geoJson = hCollection.to_json
+
+                        # make internal geometries from polygon
+                        hIntGeo = intMetadataClass.newGeometryObject
+                        hIntGeo[:type] = 'Polygon'
+                        hIntGeo[:coordinates] = polygon
+                        hIntGeo[:nativeGeoJson] = hGeometry.to_json
+
+                        hIntProps = intMetadataClass.newGeometryProperties
+                        hIntProps[:description] = 'FGDC bounding polygon'
+
+                        hIntFeature = intMetadataClass.newGeometryFeature
+                        hIntFeature[:type] = 'Feature'
+                        hIntFeature[:geometryObject] = hIntGeo
+                        hIntFeature[:nativeGeoJson] = hFeature.to_json
+                        hIntFeature[:properties] = hIntProps
+
+                        hIntCollect = intMetadataClass.newFeatureCollection
+                        hIntCollect[:type] = 'FeatureCollection'
+                        hIntCollect[:features] << hIntFeature
+                        hIntCollect[:nativeGeoJson] = hCollection.to_json
+
+                        hGeoExtent[:geographicElements] << hIntCollect
+                        hGeoExtent[:nativeGeoJson] = geoJson
+
+                        hExtent[:geographicExtents] << hGeoExtent
+                        hExtent[:description] = 'FGDC spatial domain'
+
+                     end
+                  end
+
+                  return hExtent
+
+               end
+
+            end
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/readers/fgdc/modules/module_spatialOrganization.rb

@@ -0,0 +1,28 @@
+# Reader - fgdc to internal data structure
+# unpack fgdc spatial data organization
+
+# History:
+#  Stan Smith 2017-08-15 original script
+
+require 'nokogiri'
+require 'adiwg/mdtranslator/internal/internal_metadata_obj'
+
+module ADIWG
+   module Mdtranslator
+      module Readers
+         module Fgdc
+
+            module SpatialOrganization
+
+               def self.unpack(xSpatialOrg, hResponseObj)
+
+
+
+               end
+
+            end
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/readers/fgdc/modules/module_spatialReference.rb

@@ -0,0 +1,28 @@
+# Reader - fgdc to internal data structure
+# unpack fgdc spatial data reference
+
+# History:
+#  Stan Smith 2017-08-15 original script
+
+require 'nokogiri'
+require 'adiwg/mdtranslator/internal/internal_metadata_obj'
+
+module ADIWG
+   module Mdtranslator
+      module Readers
+         module Fgdc
+
+            module SpatialReference
+
+               def self.unpack(xSpatialRef, hResponseObj)
+
+
+
+               end
+
+            end
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/readers/fgdc/modules/module_timeInstant.rb

@@ -0,0 +1,40 @@
+# Reader - fgdc to internal data structure
+# unpack fgdc time instant
+
+# History:
+#  Stan Smith 2017-08-21 original script
+
+require 'nokogiri'
+require 'adiwg/mdtranslator/internal/internal_metadata_obj'
+require_relative 'module_dateTime'
+
+module ADIWG
+   module Mdtranslator
+      module Readers
+         module Fgdc
+
+            module TimeInstant
+
+               def self.unpack(date, time, hResponseObj)
+
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  hTimeInstant = intMetadataClass.newTimeInstant
+
+                  # time instant
+                  hDateTime = DateTime.unpack(date, time, hResponseObj)
+                  unless hDateTime.nil?
+                     hTimeInstant[:timeInstant] = hDateTime
+                     return hTimeInstant
+                  end
+
+                  return nil
+
+               end
+
+            end
+
+         end
+      end
+   end
+end