adiwg-mdtranslator 2.6.0 → 2.6.1

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

@@ -0,0 +1,164 @@
+# FGDC <<Class>> Contact
+# FGDC CSDGM writer output in XML
+
+# History:
+#  Stan Smith 2017-11-27 original script
+
+require_relative 'class_address'
+require_relative 'class_phone'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Fgdc
+
+            class Contact
+
+               def initialize(xml, hResponseObj)
+                  @xml = xml
+                  @hResponseObj = hResponseObj
+               end
+
+               def writeXML(hContact)
+
+                  # classes used
+                  addressClass = Address.new(@xml, @hResponseObj)
+                  phoneClass = Phone.new(@xml, @hResponseObj)
+
+                  # set contact type and names
+                  contactType = nil
+                  personName = nil
+                  orgName = nil
+                  if hContact[:isOrganization]
+                     contactType = 'organization'
+                     orgName = hContact[:name]
+                     if orgName.nil?
+                        @hResponseObj[:writerPass] = false
+                        @hResponseObj[:writerMessages] << 'Organization Contact is missing name'
+                     end
+                  else
+                     contactType = 'person'
+                     personName = hContact[:name]
+                     if personName.nil?
+                        @hResponseObj[:writerPass] = false
+                        @hResponseObj[:writerMessages] << 'Person Contact is missing name'
+                     end
+                     unless hContact[:memberOfOrgs].empty?
+                        hOrgContact = ADIWG::Mdtranslator::Writers::Fgdc.get_contact(hContact[:memberOfOrgs][0])
+                        unless hOrgContact.empty?
+                           orgName = hOrgContact[:name]
+                        end
+                     end
+                  end
+                  if contactType.nil?
+                     @hResponseObj[:writerPass] = false
+                     @hResponseObj[:writerMessages] << 'Contact is missing contact type'
+                  end
+
+                  # contact 10 (cntinfo) - contact information
+                  @xml.tag!('cntinfo') do
+
+                     # contact 10.1 (cntperp) - contact person primary
+                     if contactType == 'person'
+                        @xml.tag!('cntperp') do
+
+                           # contact 10.1.1 (cntper) - contact person name
+                           unless personName.nil?
+                              @xml.tag!('cntper', personName)
+                           end
+                           if personName == ''
+                              @hResponseObj[:writerPass] = false
+                              @hResponseObj[:writerMessages] << 'Person Contact is missing name'
+                           end
+
+                           # contact 10.1.1 (cntorg) - contact organization name
+                           unless orgName.nil?
+                              @xml.tag!('cntorg', orgName)
+                           end
+                           if orgName.nil? && @hResponseObj[:writerShowTags]
+                              @xml.tag!('cntorg')
+                           end
+
+                        end
+                     end
+
+                     # contact 10.2 (cntorgp) - contact organization primary
+                     if contactType == 'organization'
+                        @xml.tag!('cntorgp') do
+
+                           # contact 10.2.1 (cntper) - contact person name
+                           unless personName.nil?
+                              @xml.tag!('cntper', personName)
+                           end
+
+                           # contact 10.2.1 (cntorg) - contact organization name
+                           unless orgName == ''
+                              @xml.tag!('cntorg', orgName)
+                           end
+                           if orgName.nil?
+                              @hResponseObj[:writerPass] = false
+                              @hResponseObj[:writerMessages] << 'Organization Contact is missing name'
+                           end
+
+                        end
+                     end
+
+                     # contact 10.3 (cntpos) - contact position name
+                     unless hContact[:positionName].nil?
+                        @xml.tag!('cntpos', hContact[:positionName])
+                     end
+                     if hContact[:positionName].nil? && @hResponseObj[:writerShowTags]
+                        @xml.tag!('cntpos')
+                     end
+
+                     # contact 10.4 (cntaddr) - contact address (required)
+                     hContact[:addresses].each do |hAddress|
+                        unless hAddress.empty?
+                           @xml.tag!('cntaddr') do
+                              addressClass.writeXML(hAddress)
+                           end
+                        end
+                     end
+                     if hContact[:addresses].empty?
+                        @hResponseObj[:writerPass] = false
+                        @hResponseObj[:writerMessages] << 'Contact is missing address'
+                     end
+
+                     # contact 10.5..7 - phone (voice phone required)
+                     # requirement testing is done in phoneClass
+                     phoneClass.writeXML(hContact[:phones])
+
+                     # contact 10.8 - email addresses []
+                     hContact[:eMailList].each do |email|
+                        @xml.tag!('cntemail', email)
+                     end
+                     if hContact[:eMailList].empty? && @hResponseObj[:writerShowTags]
+                        @xml.tag!('cntemail')
+                     end
+
+                     # contact 10.9 - hours of service
+                     # <- hContact[:hoursOfService][0]
+                     unless hContact[:hoursOfService].empty?
+                        @xml.tag!('hours', hContact[:hoursOfService][0])
+                     end
+                     if hContact[:hoursOfService].empty? && @hResponseObj[:writerShowTags]
+                        @xml.tag!('hours')
+                     end
+
+                     # contact 10.10 (cntinst) - contact instructions
+                     unless hContact[:contactInstructions].nil?
+                        @xml.tag!('cntinst', hContact[:contactInstructions])
+                     end
+                     if hContact[:contactInstructions].nil? && @hResponseObj[:writerShowTags]
+                        @xml.tag!('cntinst')
+                     end
+
+                  end
+
+               end # writeXML
+            end # Contact
+
+         end
+      end
+   end
+end

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

@@ -0,0 +1,73 @@
+# FGDC <<Class>> DateRange
+# FGDC CSDGM writer output in XML
+
+# History:
+#   Stan Smith 2017-11-23 original script
+
+require 'adiwg/mdtranslator/internal/module_dateTimeFun'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Fgdc
+
+            class DateRange
+
+               def initialize(xml, hResponseObj)
+                  @xml = xml
+                  @hResponseObj = hResponseObj
+               end
+
+               def writeXML(hStartDT, hEndDT)
+
+                  sSDate = AdiwgDateTimeFun.stringDateFromDateTime(hStartDT[:dateTime], hStartDT[:dateResolution])
+                  sSTime = AdiwgDateTimeFun.stringTimeFromDateTime(hStartDT[:dateTime], hStartDT[:dateResolution])
+                  sEDate = AdiwgDateTimeFun.stringDateFromDateTime(hEndDT[:dateTime], hEndDT[:dateResolution])
+                  sETime = AdiwgDateTimeFun.stringTimeFromDateTime(hEndDT[:dateTime], hEndDT[:dateResolution])
+
+                  # single date 9.3 (rngdates) - date range
+                  @xml.tag!('rngdates') do
+
+                     # range date 9.3.1 (begdate) - range start date (required)
+                     unless sSDate == 'ERROR'
+                        @xml.tag!('begdate', sSDate)
+                     end
+                     if sSDate == 'ERROR'
+                        @hResponseObj[:writerPass] = false
+                        @hResponseObj[:writerMessages] << 'Date Range start date is missing or invalid'
+                     end
+
+                     # range date 9.3.2 (begtime) - range start date
+                     unless sSTime == 'ERROR'
+                        @xml.tag!('begtime', sSTime)
+                     end
+                     if sSTime == 'ERROR' && @hResponseObj[:writerShowTags]
+                        @xml.tag!('begtime')
+                     end
+
+                     # range date 9.3.3 (enddate) - range end date (required)
+                     unless sEDate == 'ERROR'
+                        @xml.tag!('enddate', sEDate)
+                     end
+                     if sEDate == 'ERROR'
+                        @hResponseObj[:writerPass] = false
+                        @hResponseObj[:writerMessages] << 'Date Range end date is missing or invalid'
+                     end
+
+                     # range date 9.3.4 (endtime) - range end date
+                     unless sETime == 'ERROR'
+                        @xml.tag!('endtime', sETime)
+                     end
+                     if sETime == 'ERROR' && @hResponseObj[:writerShowTags]
+                        @xml.tag!('endtime')
+                     end
+
+                  end
+
+               end # writeXML
+            end # DateRange
+
+         end
+      end
+   end
+end

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

@@ -0,0 +1,54 @@
+# FGDC <<Class>> DateSingle
+# FGDC CSDGM writer output in XML
+
+# History:
+#   Stan Smith 2017-11-23 original script
+
+require 'adiwg/mdtranslator/internal/module_dateTimeFun'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Fgdc
+
+            class DateSingle
+
+               def initialize(xml, hResponseObj)
+                  @xml = xml
+                  @hResponseObj = hResponseObj
+               end
+
+               def writeXML(hDate)
+
+                  sDate = AdiwgDateTimeFun.stringDateFromDateTime(hDate[:dateTime], hDate[:dateResolution])
+                  sTime = AdiwgDateTimeFun.stringTimeFromDateTime(hDate[:dateTime], hDate[:dateResolution])
+
+                  # single date 9.1 (sngdate) - single date (required)
+                  @xml.tag!('sngdate') do
+
+                     # single date 9.1.1 (caldate) - calendar date
+                     unless sDate == 'ERROR'
+                        @xml.tag!('caldate', sDate)
+                     end
+                     if sDate == 'ERROR'
+                        @hResponseObj[:writerPass] = false
+                        @hResponseObj[:writerMessages] << 'single date is missing or invalid'
+                     end
+
+                     # single date 9.1.2 (time) - time
+                     unless sTime == 'ERROR'
+                        @xml.tag!('time', sTime)
+                     end
+                     if sTime == 'ERROR' && @hResponseObj[:writerShowTags]
+                        @xml.tag!('time')
+                     end
+
+                  end
+
+               end # writeXML
+            end # SingleDate
+
+         end
+      end
+   end
+end

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

@@ -0,0 +1,49 @@
+# FGDC <<Class>> Description
+# FGDC CSDGM writer output in XML
+
+# History:
+#   Stan Smith 2017-11-22 original script
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Fgdc
+
+            class Description
+
+               def initialize(xml, hResponseObj)
+                  @xml = xml
+                  @hResponseObj = hResponseObj
+               end
+
+               def writeXML(hResourceInfo)
+
+                  # description 1.2.1 (abstract) - abstract (required)
+                  # <- hResourceInfo[:abstract] (required)
+                  unless hResourceInfo[:abstract].nil?
+                     @xml.tag!('abstract', hResourceInfo[:abstract])
+                  end
+
+                  # description 1.2.2 (purpose) - purpose (required)
+                  # <- hResourceInfo[:purpose] (required)
+                  unless hResourceInfo[:purpose].nil?
+                     @xml.tag!('purpose', hResourceInfo[:purpose])
+                  end
+                  if hResourceInfo[:purpose].nil?
+                     @hResponseObj[:writerPass] = false
+                     @hResponseObj[:writerMessages] << 'Description is missing purpose'
+                  end
+
+                  # description 1.2.3 (supplinf) - supplemental information (required)
+                  # <- hResourceInfo[:supplementalInfo]
+                  unless hResourceInfo[:supplementalInfo].nil?
+                     @xml.tag!('supplinf', hResourceInfo[:supplementalInfo])
+                  end
+
+               end # writeXML
+            end # Description
+
+         end
+      end
+   end
+end

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

@@ -0,0 +1,60 @@
+# ISO 19110 <<Class>> FGDC
+# writer output in XML
+
+# History:
+#  Stan Smith 2017-11-16 original script
+
+require_relative 'class_identification'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Fgdc
+
+            class Fgdc
+
+               def initialize(xml, responseObj)
+                  @xml = xml
+                  @hResponseObj = responseObj
+               end
+
+               def writeXML(intObj)
+
+                  # classes used
+                  idClass = Identification.new(@xml, @hResponseObj)
+                  version = @hResponseObj[:translatorVersion]
+
+                  # document head
+                  metadata = @xml.instruct! :xml, encoding: 'UTF-8'
+                  @xml.comment!('FGDC METADATA (FGDC-STD-001-1998)')
+                  @xml.comment!('Includes Biological Data Profile (FGDC-STD-001.1-1999)')
+                  @xml.comment!('The following metadata file was constructed using the ADIwg mdTranslator, http://mdtranslator.adiwg.org')
+                  @xml.comment!('mdTranslator software is an open-source project of the Alaska Data Integration working group (ADIwg)')
+                  @xml.comment!('mdTranslator and other metadata tools are available at https://github.com/adiwg')
+                  @xml.comment!('ADIwg is not responsible for the content of this metadata record')
+                  @xml.comment!('This metadata record was generated by mdTranslator ' + version + ' at ' + Time.now.to_s)
+
+                  # metadata
+                  @xml.tag!('metadata') do
+
+                     # metadata 1 (idinfo) - identification information
+                     idClass.writeXML(intObj)
+
+                     # metadata 2 (dataqual) - data quality information
+                     # metadata 3 (spdoinfo) - spatial domain information
+                     # metadata 4 (spref) - spatial reference systems
+                     # metadata 5 (eainfo) - entity attribute information
+                     # metadata 6 (distinfo) - distribution information
+                     # metadata 7 (metainfo) - metadata information
+
+                     return metadata
+                  end
+
+               end
+
+            end
+
+         end
+      end
+   end
+end

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

@@ -0,0 +1,78 @@
+# FGDC <<Class>> GeologicAge
+# FGDC CSDGM writer output in XML
+
+# History:
+#   Stan Smith 2017-11-24 original script
+
+require_relative 'class_citation'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Fgdc
+
+            class GeologicAge
+
+               def initialize(xml, hResponseObj)
+                  @xml = xml
+                  @hResponseObj = hResponseObj
+               end
+
+               def writeXML(hGeoAge)
+
+                  # classes used
+                  citationClass = Citation.new(@xml, @hResponseObj)
+
+                  # geologic age (geolscal) - geologic scale (required)
+                  unless hGeoAge[:ageTimeScale].nil?
+                     @xml.tag!('geolscal', hGeoAge[:ageTimeScale])
+                  end
+                  if hGeoAge[:ageTimeScale].nil?
+                     @hResponseObj[:writerPass] = false
+                     @hResponseObj[:writerMessages] << 'Geologic Age is missing time scale'
+                  end
+
+                  # geologic age (geolest) - age estimate (required)
+                  unless hGeoAge[:ageEstimate].nil?
+                     @xml.tag!('geolest', hGeoAge[:ageEstimate])
+                  end
+                  if hGeoAge[:ageEstimate].nil?
+                     @hResponseObj[:writerPass] = false
+                     @hResponseObj[:writerMessages] << 'Geologic Age is missing age estimate'
+                  end
+
+                  # geologic age (geolun) - age uncertainty
+                  unless hGeoAge[:ageUncertainty].nil?
+                     @xml.tag!('geolun', hGeoAge[:ageUncertainty])
+                  end
+                  if hGeoAge[:ageUncertainty].nil? && @hResponseObj[:writerShowTags]
+                     @xml.tag!('geolun')
+                  end
+
+                  # geologic age (geolexpl) - age determination methodology
+                  unless hGeoAge[:ageExplanation].nil?
+                     @xml.tag!('geolexpl', hGeoAge[:ageExplanation])
+                  end
+                  if hGeoAge[:ageExplanation].nil? && @hResponseObj[:writerShowTags]
+                     @xml.tag!('geolexpl')
+                  end
+
+                  # geologic age (geolcit) - age references [{citation}]
+                  hGeoAge[:ageReferences].each do |hCitation|
+                     unless hCitation.empty?
+                        @xml.tag!('geolcit') do
+                           citationClass.writeXML(hCitation, {})
+                        end
+                     end
+                  end
+                  if hGeoAge[:ageReferences].empty? && @hResponseObj[:writerShowTags]
+                     @xml.tag!('geolcit')
+                  end
+
+               end # writeXML
+            end # GeologicAge
+
+         end
+      end
+   end
+end

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

@@ -0,0 +1,54 @@
+# FGDC <<Class>> GeologicRange
+# FGDC CSDGM writer output in XML
+
+# History:
+#   Stan Smith 2017-11-24 original script
+
+require_relative 'class_geologicAge'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Fgdc
+
+            class GeologicRange
+
+               def initialize(xml, hResponseObj)
+                  @xml = xml
+                  @hResponseObj = hResponseObj
+               end
+
+               def writeXML(hAgeStart, hAgeEnd)
+
+                  # classes used
+                  ageClass = GeologicAge.new(@xml, @hResponseObj)
+
+                  # geologic age range (beggeol) - starting geologic age (required)
+                  unless hAgeStart.empty?
+                     @xml.tag!('beggeol') do
+                        ageClass.writeXML(hAgeStart)
+                     end
+                  end
+                  if hAgeStart.empty?
+                     @hResponseObj[:writerPass] = false
+                     @hResponseObj[:writerMessages] << 'Geologic Age Range is missing starting age'
+                  end
+
+                  # geologic age range (endgeol) - ending geologic age (required)
+                  unless hAgeStart.empty?
+                     @xml.tag!('endgeol') do
+                        ageClass.writeXML(hAgeEnd)
+                     end
+                  end
+                  if hAgeEnd.empty?
+                     @hResponseObj[:writerPass] = false
+                     @hResponseObj[:writerMessages] << 'Geologic Age Range is missing ending age'
+                  end
+
+               end # writeXML
+            end # GeologicAge
+
+         end
+      end
+   end
+end

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

@@ -0,0 +1,152 @@
+# FGDC <<Class>> Identification Information
+# FGDC CSDGM writer output in XML
+
+# History:
+#   Stan Smith 2017-11-17 original script
+
+require_relative '../fgdc_writer'
+require_relative 'class_citation'
+require_relative 'class_description'
+require_relative 'class_timePeriod'
+require_relative 'class_status'
+require_relative 'class_spatialDomain'
+require_relative 'class_keyword'
+require_relative 'class_contact'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Fgdc
+
+            class Identification
+
+               def initialize(xml, hResponseObj)
+                  @xml = xml
+                  @hResponseObj = hResponseObj
+               end
+
+               def find_responsibility(aResponsibility, roleName)
+                  aParties = []
+                  aResponsibility.each do |hRParty|
+                     if hRParty[:roleName] == roleName
+                        hRParty[:parties].each do |hParty|
+                           aParties << hParty[:contactId]
+                        end
+                     end
+                  end
+                  aParties = aParties.uniq
+                  return aParties
+               end
+
+               def writeXML(intObj)
+
+                  # classes used
+                  citationClass = Citation.new(@xml, @hResponseObj)
+                  descriptionClass = Description.new(@xml, @hResponseObj)
+                  timePeriodClass = TimePeriod.new(@xml, @hResponseObj)
+                  statusClass = Status.new(@xml, @hResponseObj)
+                  spDomainClass = SpatialDomain.new(@xml, @hResponseObj)
+                  keywordClass = Keyword.new(@xml, @hResponseObj)
+                  contactClass = Contact.new(@xml, @hResponseObj)
+
+                  hResourceInfo = intObj[:metadata][:resourceInfo]
+
+                  @xml.tag!('idinfo') do
+
+                     # identification information 1.1 (citation) - citation (required)
+                     # <- hResourceInfo[:citation]
+                     hCitation = hResourceInfo[:citation]
+                     aAssocResource = intObj[:metadata][:associatedResources]
+                     unless hCitation.empty?
+                        @xml.tag!('citation') do
+                           citationClass.writeXML(hCitation, aAssocResource)
+                        end
+                     end
+                     if hCitation.empty?
+                        @hResponseObj[:writerPass] = false
+                        @hResponseObj[:writerMessages] << 'Identification section is missing citation'
+                     end
+
+                     # identification information 1.2 (descript) - description (required)
+                     # <- hResourceInfo[:abstract,:purpose,:supplementalInfo] (required)
+                     unless hResourceInfo[:abstract].nil? && hResourceInfo[:purpose].nil? && hResourceInfo[:supplementalInfo].nil?
+                        @xml.tag!('descript') do
+                           descriptionClass.writeXML(hResourceInfo)
+                        end
+                     end
+                     if hResourceInfo[:abstract].nil?
+                        @hResponseObj[:writerPass] = false
+                        @hResponseObj[:writerMessages] << 'Identification section is missing abstract'
+                     end
+                     if hResourceInfo[:purpose].nil?
+                        @hResponseObj[:writerPass] = false
+                        @hResponseObj[:writerMessages] << 'Identification section is missing purpose'
+                     end
+
+                     # identification information 1.3 (timeperd) - time period of content (required)
+                     # <- hResourceInfo[:timePeriod]
+                     unless hResourceInfo[:timePeriod].empty?
+                        @xml.tag!('timeperd') do
+                           timePeriodClass.writeXML(hResourceInfo[:timePeriod])
+                        end
+                     end
+                     if hResourceInfo[:timePeriod].empty?
+                        @hResponseObj[:writerPass] = false
+                        @hResponseObj[:writerMessages] << 'Identification section is missing time period'
+                     end
+
+                     # identification information 1.4 (status) - status
+                     statusClass.writeXML(hResourceInfo)
+
+                     # identification information 1.5 (spdom) - spatial domain
+                     # not required under biological extension rules
+                     unless hResourceInfo[:extents].empty?
+                        spDomainClass.writeXML(hResourceInfo[:extents])
+                     end
+
+                     # identification information 1.6 (keywords) - keywords [] (required)
+                     unless hResourceInfo[:keywords].empty?
+                        @xml.tag!('keywords') do
+                           keywordClass.writeXML(hResourceInfo[:keywords])
+                        end
+                     end
+                     if hResourceInfo[:keywords].empty?
+                        @hResponseObj[:writerPass] = false
+                        @hResponseObj[:writerMessages] << 'Identification section is missing keywords'
+                     end
+
+                     # identification information bio (taxonomy) - taxonomy
+                     # identification information 1.7 (accconst) - access constraint (required)
+                     # identification information 1.8 (useconst) - use constraint (required)
+
+                     # identification information 1.9 (ptcontac) - point of contact
+                     unless hResourceInfo[:pointOfContacts].empty?
+                        aParties = find_responsibility(hResourceInfo[:pointOfContacts], 'pointOfContact')
+                        unless aParties.empty?
+                           hContact = ADIWG::Mdtranslator::Writers::Fgdc.get_contact(aParties[0])
+                           unless hContact.empty?
+                              @xml.tag!('ptcontac') do
+                                 contactClass.writeXML(hContact)
+                              end
+                           end
+                        end
+                     end
+                     if hResourceInfo[:pointOfContacts].empty? && @hResponseObj[:writerShowTags]
+                        @xml.tag!('ptcontac')
+                     end
+
+                     # identification information 1.10 (browse) - browse graphic []
+                     # identification information 1.11 (datacred) - dataset credit
+                     # identification information 1.12 (secinfo) - security information
+                     # identification information 1.13 (native) - native dataset environment
+                     # identification information 1.14 (crossref) - cross reference []
+                     # identification information bio (tool) - analytical tool [] (not supported)
+
+                  end # idinfo tag
+               end # writeXML
+            end # Identification
+
+         end
+      end
+   end
+end