adiwg-mdtranslator 2.8.0 → 2.9.0

data/lib/adiwg/mdtranslator/writers/fgdc/classes/class_distribution.rb

@@ -0,0 +1,156 @@
+# FGDC <<Class>> Distribution
+# FGDC CSDGM writer output in XML
+
+# History:
+#  Stan Smith 2018-01-28 original script
+
+require 'adiwg/mdtranslator/internal/internal_metadata_obj'
+require_relative 'class_contact'
+require_relative 'class_orderProcess'
+require_relative 'class_timePeriod'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Fgdc
+
+            class Distribution
+
+               def initialize(xml, hResponseObj)
+                  @xml = xml
+                  @hResponseObj = hResponseObj
+               end
+
+               def writeXML(hDistribution)
+
+                  # classes used
+                  intMetadataClass = InternalMetadata.new
+                  contactClass = Contact.new(@xml, @hResponseObj)
+                  orderClass = OrderProcess.new(@xml, @hResponseObj)
+                  timePeriodClass = TimePeriod.new(@xml, @hResponseObj)
+
+                  # in FGDC each distribution can have only one distributor
+                  # the passed in mdJson hDistribution may contain multiple distributors
+                  # therefore, create a separate FGDC distribution record for each distributor
+                  # and repeat the distribution information
+
+                  hDistribution[:distributor].each do |hDistributor|
+
+                     @xml.tag!('distinfo') do
+
+                        # distribution 6.1 (distrib) - distributor {contact} (required)
+                        # <- distribution.distributor.contact{}.responsibility.roleName = 'distributor'
+                        haveContact = false
+                        unless hDistributor.empty?
+                           unless hDistributor[:contact].empty?
+                              contactId = hDistributor[:contact][:parties][0][:contactId]
+                              hContact = ADIWG::Mdtranslator::Writers::Fgdc.get_contact(contactId)
+                              unless hContact.empty?
+                                 @xml.tag!('distrib') do
+                                    contactClass.writeXML(hContact)
+                                 end
+                                 haveContact = true
+                              end
+                           end
+                        end
+                        unless haveContact
+                           @hResponseObj[:writerPass] = false
+                           @hResponseObj[:writerMessages] << 'Distributor is missing contact information'
+                        end
+
+                        # distribution 6.2 (resdesc) - resource description
+                        # <- distribution.description
+                        unless hDistribution[:description].nil?
+                           @xml.tag!('resdesc', hDistribution[:description])
+                        end
+                        if hDistribution[:description].nil?
+                           @xml.tag!('resdesc')
+                        end
+
+                        # distribution 6.3 (distliab) - liability (required)
+                        # <- distribution.liabilityStatement
+                        unless hDistribution[:liabilityStatement].nil?
+                           @xml.tag!('distliab', hDistribution[:liabilityStatement])
+                        end
+                        if hDistribution[:liabilityStatement].nil?
+                           @hResponseObj[:writerPass] = false
+                           @hResponseObj[:writerMessages] << 'Distributor is missing liability statement'
+                        end
+
+                        # distribution 6.4 (stdorder) - standard order [] {standardOrder}
+                        # <- distribution.distributor.orderProcess
+                        # in FGDC transferOptions are children of orderProcess
+                        # pass the entire distribution object
+                        haveOrder = false
+                        unless hDistributor.empty?
+                           unless hDistributor[:orderProcess].empty?
+                              @xml.tag!('stdorder') do
+                                 orderClass.writeXML(hDistributor)
+                              end
+                              haveOrder = true
+                           end
+                        end
+                        if !haveOrder && @hResponseObj[:writerShowTags]
+                           @xml.tag!('custom')
+                        end
+
+                        # distribution 6.5 (custom) - custom order process
+                        # <- where transferOptions[] is empty
+                        # <- distribution.distributor.orderProcess[0].orderingInstructions
+                        haveCustom = false
+                        unless hDistributor.empty?
+                           if hDistributor[:transferOptions].empty?
+                              unless hDistributor[:orderProcess].empty?
+                                 unless hDistributor[:orderProcess][0].empty?
+                                    unless hDistributor[:orderProcess][0][:orderingInstructions].nil?
+                                       @xml.tag!('custom', hDistributor[:orderProcess][0][:orderingInstructions])
+                                    end
+                                 end
+                                 haveCustom = true
+                              end
+                           end
+                        end
+                        if !haveCustom && @hResponseObj[:writerShowTags]
+                           @xml.tag!('custom')
+                        end
+
+                        # distribution 6.6 (techpreq) - technical prerequisites
+                        # <- distribution.technicalPrerequisite
+                        unless hDistribution[:technicalPrerequisite].nil?
+                           @xml.tag!('techpreq', hDistribution[:technicalPrerequisite])
+                        end
+                        if hDistribution[:technicalPrerequisite].nil?
+                           @xml.tag!('techpreq')
+                        end
+
+                        # distribution 6.7 (availabl) - available timePeriod  {timePeriod}
+                        # <- distribution.distributor[0].orderProcess[0].plannedAvailability
+                        # for FGDC only the first orderProcess can be accepted
+                        haveTime = false
+                        unless hDistributor.empty?
+                           unless hDistributor[:orderProcess].empty?
+                              unless hDistributor[:orderProcess][0][:plannedAvailability].empty?
+                                 hAvailDate = hDistributor[:orderProcess][0][:plannedAvailability]
+                                 hTimePeriod = intMetadataClass.newTimePeriod
+                                 hTimePeriod[:startDateTime] = hAvailDate
+                                 @xml.tag!('availabl') do
+                                    timePeriodClass.writeXML(hTimePeriod, nil)
+                                 end
+                                 haveTime = true
+                              end
+                           end
+                        end
+                        if !haveTime && @hResponseObj[:writerShowTags]
+                           @xml.tag!('availabl')
+                        end
+                     end
+
+                  end
+
+               end # writeXML
+            end # Distribution
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/writers/fgdc/classes/class_entityDetail.rb

@@ -0,0 +1,78 @@
+# FGDC <<Class>> EntityDetail
+# FGDC CSDGM writer output in XML
+
+# History:
+#  Stan Smith 2018-01-22 original script
+
+require_relative 'class_attribute'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Fgdc
+
+            class EntityDetail
+
+               def initialize(xml, hResponseObj)
+                  @xml = xml
+                  @hResponseObj = hResponseObj
+               end
+
+               def writeXML(hEntity)
+
+                  # classes used
+                  attrClass = Attribute.new(@xml, @hResponseObj)
+
+                  # entity detail 5.1.1 (enttype) - entity type
+                  @xml.tag!('enttype') do
+
+                     # entity type 5.1.1.1 (enttypl) - entity type label (required)
+                     # <- entity.entityCode
+                  unless hEntity[:entityCode].nil?
+                        @xml.tag!('enttypl', hEntity[:entityCode])
+                     end
+                     if hEntity[:entityCode].nil?
+                        @hResponseObj[:writerPass] = false
+                        @hResponseObj[:writerMessages] << 'Entity Attribute Detail missing entity type label'
+                     end
+
+                     # entity type 5.1.1.2 (enttypd) - entity type definition (required)
+                     # <- entity.entityDefinition
+                  unless hEntity[:entityDefinition].nil?
+                        @xml.tag!('enttypd', hEntity[:entityDefinition])
+                     end
+                     if hEntity[:entityDefinition].nil?
+                        @hResponseObj[:writerPass] = false
+                        @hResponseObj[:writerMessages] << 'Entity Attribute Detail missing entity definition'
+                     end
+
+                     # entity type 5.1.1.3 (enttypds) - entity definition source (required)
+                     # <- take title from first entityReference {citation}
+                     unless hEntity[:entityReferences].empty?
+                        unless hEntity[:entityReferences][0].empty?
+                           @xml.tag!('enttypds', hEntity[:entityReferences][0][:title])
+                        end
+                     end
+                     if hEntity[:entityReferences].empty?
+                        @hResponseObj[:writerPass] = false
+                        @hResponseObj[:writerMessages] << 'Entity Attribute Detail missing entity definition citation'
+                     end
+
+                  end
+
+                  # attribute 5.1.2 (attr) - attribute
+                  hEntity[:attributes].each do |hAttribute|
+                     unless hAttribute.empty?
+                        @xml.tag!('attr') do
+                           attrClass.writeXML(hAttribute)
+                        end
+                     end
+                  end
+
+               end # writeXML
+            end # EntityOverview
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/writers/fgdc/classes/class_entityOverview.rb

@@ -0,0 +1,48 @@
+# FGDC <<Class>> EntityOverview
+# FGDC CSDGM writer output in XML
+
+# History:
+#  Stan Smith 2018-01-22 original script
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Fgdc
+
+            class EntityOverview
+
+               def initialize(xml, hResponseObj)
+                  @xml = xml
+                  @hResponseObj = hResponseObj
+               end
+
+               def writeXML(hEntity)
+
+                  # entity overview 5.2.1 (eaover) - entity and attribute overview (required)
+                  # <- entity.definition
+                  unless hEntity[:entityDefinition].nil?
+                     @xml.tag!('eaover', hEntity[:entityDefinition])
+                  end
+                  if hEntity[:entityDefinition].nil?
+                     @hResponseObj[:writerPass] = false
+                     @hResponseObj[:writerMessages] << 'Entity Attribute Overview missing definition'
+                  end
+
+                  # entity overview 5.2.2 (eadetcit) - entity and attribute detail citation []
+                  # <- entity.entityReferences[]
+                  hEntity[:entityReferences].each do |hCitation|
+                     unless hCitation.empty?
+                        @xml.tag!('eadetcit', hCitation[:title])
+                     end
+                  end
+                  if hEntity[:entityReferences].empty? && @hResponseObj[:writerShowTags]
+                     @xml.tag!('eadetcit')
+                  end
+
+               end # writeXML
+            end # EntityOverview
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/writers/fgdc/classes/class_fgdc.rb

@@ -8,6 +8,9 @@ require_relative 'class_identification'
 require_relative 'class_quality'
 require_relative 'class_spatialOrganization'
 require_relative 'class_spatialReference'
+require_relative 'class_dictionary'
+require_relative 'class_distribution'
+require_relative 'class_metadataInfo'
 
 module ADIWG
    module Mdtranslator
@@ -25,12 +28,17 @@ module ADIWG
 
                   version = @hResponseObj[:translatorVersion]
                   hResourceInfo = intObj[:metadata][:resourceInfo]
+                  aDistributorInfo = intObj[:metadata][:distributorInfo]
+                  hMetadataInfo = intObj[:metadata][:metadataInfo]
 
                   # classes used
                   idClass = Identification.new(@xml, @hResponseObj)
                   qualityClass = Quality.new(@xml, @hResponseObj)
                   spaceOrgClass = SpatialOrganization.new(@xml, @hResponseObj)
                   spaceRefClass = SpatialReference.new(@xml, @hResponseObj)
+                  dictionaryClass = DataDictionary.new(@xml, @hResponseObj)
+                  distributorClass = Distribution.new(@xml, @hResponseObj)
+                  metaInfoClass = MetadataInformation.new(@xml, @hResponseObj)
 
                   # document head
                   metadata = @xml.instruct! :xml, encoding: 'UTF-8'
@@ -45,7 +53,7 @@ module ADIWG
                   # metadata
                   @xml.tag!('metadata') do
 
-                     # metadata 1 (idinfo) - identification information
+                     # metadata 1 (idinfo) - identification information (required)
                      @xml.tag!('idinfo') do
                         idClass.writeXML(intObj)
                      end
@@ -57,7 +65,7 @@ module ADIWG
                            qualityClass.writeXML(intObj)
                         end
                      end
-                     if intObj[:metadata][:lineageInfo].empty?
+                     if intObj[:metadata][:lineageInfo].empty? && @hResponseObj[:writerShowTags]
                         @xml.tag!('dataqual')
                      end
 
@@ -93,8 +101,37 @@ module ADIWG
                      end
 
                      # metadata 5 (eainfo) - entity attribute information
-                     # metadata 6 (distinfo) - distribution information
-                     # metadata 7 (metainfo) - metadata information
+                     # <- dataDictionaries[0]
+                     haveDict = false
+                     unless intObj[:dataDictionaries].empty?
+                        hDictionary = intObj[:dataDictionaries][0]
+                        unless hDictionary.empty?
+                           @xml.tag!('eainfo') do
+                              dictionaryClass.writeXML(hDictionary)
+                           end
+                           haveDict = true
+                        end
+                     end
+                     if !haveDict && @hResponseObj[:writerShowTags]
+                        @xml.tag!('eainfo')
+                     end
+
+                     # metadata 6 (distinfo) - distributor information []
+                     # <- metadata.distributionInfo[]
+                     aDistributorInfo.each do |hDistribution|
+                        unless hDistribution.empty?
+                           distributorClass.writeXML(hDistribution)
+                        end
+                     end
+                     if aDistributorInfo.empty? && @hResponseObj[:writerShowTags]
+                        @xml.tag!('distinfo')
+                     end
+
+                     # metadata 7 (metainfo) - metadata information (required)
+                     # <- metadata.metadataInfo
+                     @xml.tag!('metainfo') do
+                        metaInfoClass.writeXML(hMetadataInfo)
+                     end
 
                      return metadata
                   end

data/lib/adiwg/mdtranslator/writers/fgdc/classes/class_metadataInfo.rb

@@ -0,0 +1,215 @@
+# FGDC <<Class>> MetadataInformation
+# FGDC CSDGM writer output in XML
+
+# History:
+#  Stan Smith 2018-01-26 original script
+
+require_relative '../fgdc_writer'
+require_relative 'class_contact'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Fgdc
+
+            class MetadataInformation
+
+               def initialize(xml, hResponseObj)
+                  @xml = xml
+                  @hResponseObj = hResponseObj
+               end
+
+               def writeXML(hMetadataInfo)
+
+                  # classes used
+                  contactClass = Contact.new(@xml, @hResponseObj)
+
+                  # metadata information 7.1 (metd) - metadata date (required)
+                  # <- metadataInfo.metadataDates[] type = 'creation' (required)
+                  # take first
+                  haveCreation = false
+                  hMetadataInfo[:metadataDates].each do |hDate|
+                     unless hDate.empty?
+                        unless hDate[:dateType].nil?
+                           if hDate[:dateType] == 'creation'
+                              createDate = AdiwgDateTimeFun.stringDateFromDateTime(hDate[:date], hDate[:dateResolution])
+                              createDate.gsub!(/[-]/,'')
+                              unless createDate == 'ERROR'
+                                 @xml.tag!('metd', createDate)
+                                 haveCreation = true
+                              end
+                              break
+                           end
+                        end
+                     end
+                  end
+                  unless haveCreation
+                     @hResponseObj[:writerPass] = false
+                     @hResponseObj[:writerMessages] << 'Metadata Information section is missing creation date'
+                  end
+
+                  # metadata information 7.2 (metrd) - metadata review date
+                  # <- metadataInfo.metadataDates[] type = 'review'
+                  # take first
+                  haveReview = false
+                  hMetadataInfo[:metadataDates].each do |hDate|
+                     unless hDate.empty?
+                        unless hDate[:dateType].nil?
+                           if hDate[:dateType] == 'review'
+                              reviewDate = AdiwgDateTimeFun.stringDateFromDateTime(hDate[:date], hDate[:dateResolution])
+                              reviewDate.gsub!(/[-]/,'')
+                              unless reviewDate == 'ERROR'
+                                 @xml.tag!('metrd', reviewDate)
+                                 haveReview = true
+                              end
+                              break
+                           end
+                        end
+                     end
+                  end
+                  if !haveReview && @hResponseObj[:writerShowTags]
+                     @xml.tag!('metrd')
+                  end
+
+                  # metadata information 7.3 (metfrd) - metadata future review date
+                  # <- metadataInfo.metadataDates[] type = 'nextReview'
+                  # take first
+                  haveNext = false
+                  hMetadataInfo[:metadataDates].each do |hDate|
+                     unless hDate.empty?
+                        unless hDate[:dateType].nil?
+                           if hDate[:dateType] == 'nextReview'
+                              nextDate = AdiwgDateTimeFun.stringDateFromDateTime(hDate[:date], hDate[:dateResolution])
+                              nextDate.gsub!(/[-]/,'')
+                              unless nextDate == 'ERROR'
+                                 @xml.tag!('metfrd', nextDate)
+                                 haveNext = true
+                              end
+                              break
+                           end
+                        end
+                     end
+                  end
+                  if !haveNext && @hResponseObj[:writerShowTags]
+                     @xml.tag!('metfrd')
+                  end
+
+                  # metadata information 7.4 (metc) - metadata contact {contact} (required)
+                  # <- metadataInfo.metadataContacts[] role = 'pointOfContact'
+                  unless hMetadataInfo[:metadataContacts].empty?
+                     aRParties = hMetadataInfo[:metadataContacts]
+                     aParties = ADIWG::Mdtranslator::Writers::Fgdc.find_responsibility(aRParties, 'pointOfContact')
+                     unless aParties.empty?
+                        hContact = ADIWG::Mdtranslator::Writers::Fgdc.get_contact(aParties[0])
+                        unless hContact.empty?
+                           @xml.tag!('metc') do
+                              contactClass.writeXML(hContact)
+                           end
+                        end
+                     end
+                  end
+                  if hMetadataInfo[:metadataContacts].empty?
+                     @hResponseObj[:writerPass] = false
+                     @hResponseObj[:writerMessages] << 'Metadata Information section is missing metadata contact'
+                  end
+
+                  # metadata information 7.5 (metstdn) - metadata standard name (required)
+                  @xml.tag!('metstdn', 'Content Standard for Digital Geospatial Metadata with Biological Data Profile')
+
+                  # metadata information 7.6 (metstdv) - metadata standard version (required)
+                  @xml.tag!('metstdv', 'FGDC-STD-001.1-1999')
+
+                  # metadata information 7.7 (mettc) - metadata time conversion (required)
+                  # required if time elements are present in metadata
+                  # don't know how to handle this, leaving it out
+
+                  # metadata information 7.8 (metac) - metadata access constraint
+                  # <- metadataInfo.metadataConstraints.type=legal.accessCode[0]
+                  haveAccess = false
+                  hMetadataInfo[:metadataConstraints].each do |hConstraint|
+                     if hConstraint[:type] == 'legal'
+                        unless hConstraint[:legalConstraint].empty?
+                           unless hConstraint[:legalConstraint][:accessCodes].empty?
+                              @xml.tag!('metac', hConstraint[:legalConstraint][:accessCodes][0])
+                              haveAccess = true
+                           end
+                        end
+                     end
+                  end
+                  if !haveAccess && @hResponseObj[:witerShowTags]
+                     @xml.tag!('metac')
+                  end
+
+                  # metadata information 7.9 (metuc) - metadata user constraint
+                  # <- metadataInfo.metadataConstraints.type=legal.useCode[0]
+                  haveUse = false
+                  hMetadataInfo[:metadataConstraints].each do |hConstraint|
+                     if hConstraint[:type] == 'legal'
+                        unless hConstraint[:legalConstraint].empty?
+                           unless hConstraint[:legalConstraint][:useCodes].empty?
+                              @xml.tag!('metuc', hConstraint[:legalConstraint][:useCodes][0])
+                              haveUse = true
+                           end
+                        end
+                     end
+                  end
+                  if !haveUse && @hResponseObj[:witerShowTags]
+                     @xml.tag!('metuc')
+                  end
+
+                  # metadata information 7.10 (metsi) - metadata user constraint
+                  # <- metadataInfo.metadataConstraints.type=security
+                  haveSecurity = false
+                  hMetadataInfo[:metadataConstraints].each do |hConstraint|
+                     if hConstraint[:type] == 'security'
+                        unless hConstraint[:securityConstraint].empty?
+                           @xml.tag!('metsi') do
+
+                              haveSecurity = true
+                              hSecurity = hConstraint[:securityConstraint]
+
+                              # security information 10.7.1 (metscs) - metadata security classification system (required)
+                              # <- securityConstraint.classSystem
+                              unless hSecurity[:classSystem].nil?
+                                 @xml.tag!('metscs', hSecurity[:classSystem])
+                              end
+                              if hSecurity[:classSystem].nil?
+                                 @hResponseObj[:writerPass] = false
+                                 @hResponseObj[:writerMessages] << 'Metadata Security Information section is missing classification system'
+                              end
+
+                              # security information 10.7.2 (metsc) - metadata security classification (required)
+                              # <- securityConstraint.classCode
+                              unless hSecurity[:classCode].nil?
+                                 @xml.tag!('metsc', hSecurity[:classCode])
+                              end
+                              if hSecurity[:classCode].nil?
+                                 @hResponseObj[:writerPass] = false
+                                 @hResponseObj[:writerMessages] << 'Metadata Security Information section is missing classification'
+                              end
+
+                              # security information 10.7.3 (metshd) - metadata security classification (required)
+                              # <- securityConstraint.handling
+                              unless hSecurity[:handling].nil?
+                                 @xml.tag!('metshd', hSecurity[:handling])
+                              end
+                              if hSecurity[:handling].nil?
+                                 @hResponseObj[:writerPass] = false
+                                 @hResponseObj[:writerMessages] << 'Metadata Security Information section is missing handling instructions'
+                              end
+
+                           end
+                        end
+                     end
+                  end
+                  if !haveSecurity && @hResponseObj[:writerShowTags]
+                     @xml.tag!('metsi')
+                  end
+
+               end # writeXML
+            end # MetadataInformation
+
+         end
+      end
+   end
+end