adiwg-mdtranslator 2.2.0 → 2.3.0

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

@@ -0,0 +1,45 @@
+# Reader - fgdc to internal data structure
+# unpack fgdc entity and attribute overview
+
+# History:
+#  Stan Smith 2017-09-06 original script
+
+require 'uuidtools'
+require 'nokogiri'
+require 'adiwg/mdtranslator/internal/internal_metadata_obj'
+
+module ADIWG
+   module Mdtranslator
+      module Readers
+         module Fgdc
+
+            module EntityOverview
+
+               def self.unpack(xOverview, hResponseObj)
+
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  hEntity = intMetadataClass.newEntity
+                  hEntity[:entityId] = UUIDTools::UUID.random_create.to_s
+                  hEntity[:entityCode] = 'overview'
+
+                  # entity attribute 5.2.1 (eaover) - entity attribute overview
+                  # -> dataDictionary.entities.entityDefinition
+                  definition = xOverview.xpath('./eaover').text
+                  unless definition.empty?
+                     hEntity[:entityDefinition] = definition
+                  end
+
+                  # entity attribute 5.2.2 (eadetcit) - entity attribute detail citation []
+                  # -> not mapped
+
+                  return hEntity
+
+               end
+
+            end
+
+         end
+      end
+   end
+end

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

@@ -0,0 +1,50 @@
+# Reader - fgdc to internal data structure
+# unpack fgdc entity enumerated domain
+
+# History:
+#  Stan Smith 2017-09-06 original script
+
+require 'nokogiri'
+require 'adiwg/mdtranslator/internal/internal_metadata_obj'
+
+module ADIWG
+   module Mdtranslator
+      module Readers
+         module Fgdc
+
+            module Enumerated
+
+               def self.unpack(xEnumeration, hResponseObj)
+
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  hItem = intMetadataClass.newDomainItem
+
+                  # entity attribute 5.1.2.4.1.1 (edomv) - enumerated domain value
+                  # -> dataDictionary.domainItems.itemValue
+                  value = xEnumeration.xpath('./edomv').text
+                  unless value.empty?
+                     hItem[:itemName] = value
+                     hItem[:itemValue] = value
+                  end
+
+                  # entity attribute 5.1.2.4.1.2 (edomvd) - enumerated domain value definition
+                  # -> dataDictionary.domainItems.itemDefinition
+                  definition = xEnumeration.xpath('./edomvd').text
+                  unless definition.empty?
+                     hItem[:itemDefinition] = definition
+                  end
+
+                  # entity attribute 5.1.2.4.1.3 (edomvds) - enumerated domain value definition source
+                  # -> not mapped
+
+                  return hItem
+
+               end
+
+            end
+
+         end
+      end
+   end
+end

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

@@ -7,6 +7,7 @@
 require 'nokogiri'
 require 'uuidtools'
 require 'adiwg/mdtranslator/internal/internal_metadata_obj'
+require_relative '../version'
 require_relative 'module_identification'
 require_relative 'module_quality'
 require_relative 'module_spatialOrganization'
@@ -34,14 +35,18 @@ module ADIWG
 
                   # build basic mdTranslator internal object
                   hMetadata = intMetadataClass.newMetadata
-                  hMetadataInfo = intMetadataClass.newMetadataInfo
                   hResourceInfo = intMetadataClass.newResourceInfo
-                  hMetadata[:metadataInfo] = hMetadataInfo
                   hMetadata[:resourceInfo] = hResourceInfo
                   intObj[:metadata] = hMetadata
 
                   xMetadata = xDoc.xpath('./metadata')
 
+                  # schema
+                  hSchema = intMetadataClass.newSchema
+                  hSchema[:name] = 'fgdc'
+                  hSchema[:version] = ADIWG::Mdtranslator::Readers::Fgdc::VERSION
+                  @intObj[:schema] = hSchema
+
                   # metadata (idinfo 1) - identification information (required)
                   xIdInfo = xMetadata.xpath('./idinfo')
                   unless xIdInfo.empty?
@@ -60,31 +65,42 @@ module ADIWG
                   # metadata (spdoinfo 3) - spatial data organization
                   xSpatialOrg = xMetadata.xpath('./spdoinfo')
                   unless xSpatialOrg.empty?
-                     SpatialOrganization.unpack(xSpatialOrg, hResponseObj)
+                     SpatialOrganization.unpack(xSpatialOrg, hResourceInfo, hResponseObj)
                   end
 
                   # metadata (spref 4) - spatial reference
-                  xSpatialRef = xMetadata.xpath('./spref')
-                  unless xSpatialRef.empty?
-                     SpatialReference.unpack(xSpatialRef, hResponseObj)
-                  end
+                  # xSpatialRef = xMetadata.xpath('./spref')
+                  # unless xSpatialRef.empty?
+                  #    SpatialReference.unpack(xSpatialRef, hResponseObj)
+                  # end
 
                   # metadata (eainfo 5) - entity and attribute
                   xEntity = xMetadata.xpath('./eainfo')
                   unless xEntity.empty?
-                     EntityAttribute.unpack(xEntity, hResponseObj)
+                     hDictionary = EntityAttribute.unpack(xEntity, hResponseObj)
+                     unless hDictionary.nil?
+                        @intObj[:dataDictionaries] << hDictionary
+                     end
                   end
 
-                  # metadata (distinfo 6) - distribution information
-                  xDistribution = xMetadata.xpath('./distinfo')
-                  unless xDistribution.empty?
-                     Distribution.unpack(xDistribution, hResponseObj)
+                  # metadata (distinfo 6) - distribution information []
+                  axDistribution = xMetadata.xpath('./distinfo')
+                  unless axDistribution.empty?
+                     axDistribution.each do |xDistribution|
+                        hDistribution = Distribution.unpack(xDistribution, hResourceInfo, hResponseObj)
+                        unless hDistribution.nil?
+                           hMetadata[:distributorInfo] << hDistribution
+                        end
+                     end
                   end
 
                   # metadata (metainfo 7) - metadata reference (required)
                   xMetaInfo = xMetadata.xpath('./metainfo')
                   unless xMetaInfo.empty?
-                     MetadataInformation.unpack(xMetaInfo, hResponseObj)
+                     hMetadataInfo = MetadataInformation.unpack(xMetaInfo, hResourceInfo, hResponseObj)
+                     unless hMetadataInfo.nil?
+                        hMetadata[:metadataInfo] = hMetadataInfo
+                     end
                   end
                   if xMetaInfo.empty?
                      hResponseObj[:readerExecutionMessages] << 'FGDC is missing metadata information section (metainfo)'

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

@@ -131,7 +131,7 @@ module ADIWG
                      hResourceInfo[:constraints] << hConstraint
                   end
 
-                  # identification information 1.9 (ptcontac) - point of contact
+                  # identification information 1.9 (ptcontac) - point of contact {contact}
                   xContact = xIdInfo.xpath('./ptcontac')
                   unless xContact.empty?
                      hResponsibility = Contact.unpack(xContact, hResponseObj)

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

@@ -6,6 +6,8 @@
 
 require 'nokogiri'
 require 'adiwg/mdtranslator/internal/internal_metadata_obj'
+require_relative 'module_date'
+require_relative 'module_contact'
 
 module ADIWG
    module Mdtranslator
@@ -14,9 +16,131 @@ module ADIWG
 
             module MetadataInformation
 
-               def self.unpack(xMetaInfo, hResponseObj)
+               def self.unpack(xMetaInfo, hResourceInfo, hResponseObj)
 
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  hMetadataInfo = intMetadataClass.newMetadataInfo
+                  hLegal = intMetadataClass.newLegalConstraint
 
+                  # metadata information 7.1 (metd) - metadata date
+                  # -> metadataInfo.metadataDates.date{type=creation}
+                  date = xMetaInfo.xpath('./metd').text
+                  unless date.empty?
+                     hDate = Date.unpack(date, '', 'creation', hResponseObj)
+                     unless hDate.nil?
+                        hMetadataInfo[:metadataDates] << hDate
+                     end
+                  end
+
+                  # metadata information 7.2 (metrd) - metadata review date
+                  # -> metadataInfo.metadataDates.date{type=review}
+                  date = xMetaInfo.xpath('./metrd').text
+                  unless date.empty?
+                     hDate = Date.unpack(date, '', 'review', hResponseObj)
+                     unless hDate.nil?
+                        hMetadataInfo[:metadataDates] << hDate
+                     end
+                  end
+
+                  # metadata information 7.3 (metfrd) - metadata future review date
+                  # -> metadataInfo.metadataDates.date{type=nextReview}
+                  date = xMetaInfo.xpath('./metfrd').text
+                  unless date.empty?
+                     hDate = Date.unpack(date, '', 'nextReview', hResponseObj)
+                     unless hDate.nil?
+                        hMetadataInfo[:metadataDates] << hDate
+                     end
+                  end
+
+                  # metadata information 7.4 (metc) - metadata contact
+                  # -> metadataInfo.metadataContacts.responsibility{roleType=pointOfContact}
+                  xContact = xMetaInfo.xpath('./metc')
+                  unless xContact.empty?
+                     hResponsibility = Contact.unpack(xContact, hResponseObj)
+                     unless hResponsibility.nil?
+                        hResponsibility[:roleName] = 'pointOfContact'
+                        hMetadataInfo[:metadataContacts] << hResponsibility
+                     end
+                  end
+
+                  # metadata information 7.5 (metstdn) - metadata standard name
+                  # -> set by writer
+
+                  # metadata information 7.6 (metstdv) - metadata standard version
+                  # -> set by writer
+
+                  # metadata information 7.7 (mettc) - metadata time convention
+                  # -> read by date/time modules
+
+                  # metadata information 7.8 (metac) - metadata access constraint
+                  # -> resourceInfo.constraints.legalConstraint.accessCodes
+                  accessCode = xMetaInfo.xpath('metac').text
+                  unless accessCode.empty?
+                     hLegal[:accessCodes] << accessCode
+                  end
+
+                  # metadata information 7.9 (metuc) - metadata use constraint
+                  # -> resourceInfo.constraints.legalConstraint.useCodes
+                  useCode = xMetaInfo.xpath('metuc').text
+                  unless useCode.empty?
+                     hLegal[:useCodes] << useCode
+                  end
+
+                  legal = accessCode + useCode
+                  if legal != ''
+                     hConstraint = intMetadataClass.newConstraint
+                     hConstraint[:type] = 'legal'
+                     hConstraint[:legalConstraint] = hLegal
+                     hResourceInfo[:constraints] << hConstraint
+                  end
+
+                  # metadata information 7.10 (metsi) - metadata security information
+                  xSecurity = xMetaInfo.xpath('./metsi')
+                  unless xSecurity.empty?
+
+                     hSecurity = intMetadataClass.newSecurityConstraint
+
+                     # metadata information 7.10.1 (metscs) - metadata security classification system
+                     # -> resourceInfo.constraints.securityConstraint.classificationSystem
+                     system = xSecurity.xpath('./metscs').text
+                     unless system.empty?
+                        hSecurity[:classSystem] = system
+                     end
+
+                     # metadata information 7.10.2 (metsc) - metadata security classification
+                     # -> resourceInfo.constraints.securityConstraint.classification
+                     classCode = xSecurity.xpath('./metsc').text
+                     unless classCode.empty?
+                        hSecurity[:classCode] = classCode
+                     end
+
+                     # metadata information 7.10.3 (metshd) - metadata security handling description
+                     # -> resourceInfo.constraints.securityConstraint.handlingDescription
+                     handling = xSecurity.xpath('./metshd').text
+                     unless handling.empty?
+                        hSecurity[:handling] = handling
+                     end
+
+                     security = system + classCode + handling
+                     if security != ''
+                        hConstraint = intMetadataClass.newConstraint
+                        hConstraint[:type] = 'security'
+                        hConstraint[:securityConstraint] = hSecurity
+                        hResourceInfo[:constraints] << hConstraint
+                     end
+
+                  end
+
+                  # metadata information 7.11 (metextns) - metadata extension []
+
+                  # metadata information 7.11.1 (onlink) - online linkage []
+                  # -> set by writer, reader assumes NBII biological extension is present
+
+                  # metadata information 7.11.2 (metprof) - profile name
+                  # -> set by writer, reader assumes NBII biological extension is present
+
+                  return hMetadataInfo
 
                end
 

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

@@ -0,0 +1,98 @@
+# Reader - fgdc to internal data structure
+# unpack fgdc distribution digital offline transfer
+
+# History:
+#  Stan Smith 2017-09-09 original script
+
+require 'nokogiri'
+require 'adiwg/mdtranslator/internal/internal_metadata_obj'
+require_relative 'module_date'
+
+module ADIWG
+   module Mdtranslator
+      module Readers
+         module Fgdc
+
+            module OfflineOption
+
+               def self.unpack(xOffline, hResponseObj)
+
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  hOffline = intMetadataClass.newMedium
+                  aDensity = []
+                  aOfflines = []
+
+                  # distribution 6.4.2.2.2.1 (offmedia) - offline media
+                  # -> distribution.distributor.offlineOption.mediumSpecification.title
+                  title = xOffline.xpath('./offmedia').text
+                  unless title.empty?
+                     hSpecification = intMetadataClass.newCitation
+                     hSpecification[:title] = title
+                     hOffline[:mediumSpecification] = hSpecification
+                  end
+
+                  # distribution 6.4.2.2.2.2 (reccap) - recording capacity
+                  xCapacity = xOffline.xpath('./reccap')
+                  unless xCapacity.empty?
+
+                     # distribution 6.4.2.2.2.2.1 (recden) - recording density []
+                     # -> distribution.distributor.offlineOption.density
+                     axDensity = xCapacity.xpath('./recden')
+                     unless axDensity.empty?
+                        axDensity.each do |xDensity|
+                           density = xDensity.text
+                           unless density.empty?
+                              aDensity << density.to_i
+                           end
+                        end
+                     end
+
+                     # distribution 6.4.2.2.2.2.2 (recdenu) - recording density units
+                     # -> distribution.distributor.offlineOption.units
+                     units = xCapacity.xpath('./recdenu').text
+                     unless units.empty?
+                        hOffline[:units] = units
+                     end
+
+                  end
+
+                  # distribution 6.4.2.2.2.3 (recfmt) - recording format []
+                  # -> distribution.distributor.offlineOption.mediumFormat
+                  axFormat = xOffline.xpath('./recfmt')
+                  unless axFormat.empty?
+                     axFormat.each do |xFormat|
+                        format = xFormat.text
+                        unless format.empty?
+                           hOffline[:mediumFormat] << format
+                        end
+                     end
+                  end
+
+                  # distribution 6.4.2.2.2.4 (compat) - compatibility information
+                  # -> distribution.distributor.offlineOption.note
+                  note = xOffline.xpath('./compat').text
+                  unless note.empty?
+                     hOffline[:note] = note
+                  end
+
+                  # create an offline object for each density
+                  if aDensity.empty?
+                     aOfflines << hOffline
+                  else
+                     aDensity.each do |density|
+                        hClone = hOffline.clone
+                        hClone[:density] = density
+                        aOfflines << hClone
+                     end
+                  end
+
+                  return aOfflines
+
+               end
+            end
+
+         end
+      end
+   end
+end

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

@@ -0,0 +1,81 @@
+# Reader - fgdc to internal data structure
+# unpack fgdc distribution digital online transfer
+
+# History:
+#  Stan Smith 2017-09-09 original script
+
+require 'nokogiri'
+require 'adiwg/mdtranslator/internal/internal_metadata_obj'
+require_relative 'module_date'
+
+module ADIWG
+   module Mdtranslator
+      module Readers
+         module Fgdc
+
+            module OnlineOption
+
+               def self.unpack(xOnline, hResponseObj)
+
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  aOnlines = []
+
+                  # distribution 6.4.2.2.1.2 (accinstr) - access instructions
+                  # -> distribution.distributor.onlineOption.protocol
+                  protocol = xOnline.xpath('./accinstr').text
+
+                  # distribution 6.4.2.2.1.3 (oncomp) - online computer and operating system
+                  # -> distribution.distributor.onlineOption.description
+                  description = xOnline.xpath('./oncomp').text
+
+                  # distribution 6.4.2.2.1.1 (computer) - computer contact information []
+                  axComputers = xOnline.xpath('./computer')
+                  unless axComputers.empty?
+                     axComputers.each do |xComputer|
+
+                        # distribution 6.4.2.2.1.1.1 (networka) - network address
+                        xNetwork = xComputer.xpath('./networka')
+                        unless xNetwork.empty?
+
+                           # distribution 6.4.2.2.1.1.1.1 (networkr) - network resource name []
+                           # -> distribution.distributor.onlineOption.uri
+                           axURI = xNetwork.xpath('./networkr')
+                           unless axURI.empty?
+                              axURI.each do |network|
+                                 uri = network.text
+                                 unless uri.empty?
+                                    hOnlineRes = intMetadataClass.newOnlineResource
+                                    hOnlineRes[:olResURI] = uri
+                                    hOnlineRes[:olResProtocol] = protocol unless protocol.empty?
+                                    hOnlineRes[:olResDesc] = description unless description.empty?
+                                    aOnlines << hOnlineRes
+                                 end
+                              end
+                           end
+
+                        end
+
+                        # dialup section is deprecated and will not be supported in ADIwg toolkit
+                        # distribution 6.4.2.2.1.1.2 (dialinst) - dialup instructions
+                        # distribution 6.4.2.2.1.1.2.1 (lowbps) - lowest bits per second
+                        # distribution 6.4.2.2.1.1.2.2 (highbps) - highest bits per second
+                        # distribution 6.4.2.2.1.1.2.3 (numdata) - number of data bits per character {7|8}
+                        # distribution 6.4.2.2.1.1.2.4 (numstop) - number of stop bits per exchange {1|2}
+                        # distribution 6.4.2.2.1.1.2.5 (parity) - parity {none | odd | even | mark | space}
+                        # distribution 6.4.2.2.1.1.2.6 (compress) - compression support
+                        # distribution 6.4.2.2.1.1.2.7 (dialtel) - dialup telephone
+                        # distribution 6.4.2.2.1.1.2.8 (dialfile) - dialup file name []
+
+                     end
+                  end
+
+                  return aOnlines
+
+               end
+            end
+
+         end
+      end
+   end
+end