adiwg-mdtranslator 2.6.1 → 2.7.0

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

@@ -2,7 +2,7 @@
 # FGDC CSDGM writer output in XML
 
 # History:
-#   Stan Smith 2017-11-21 original script
+#  Stan Smith 2017-11-21 original script
 
 module ADIWG
    module Mdtranslator

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

@@ -0,0 +1,124 @@
+# FGDC <<Class>> Source
+# FGDC CSDGM writer output in XML
+
+# History:
+#  Stan Smith 2017-12-18 original script
+
+require_relative 'class_citation'
+require_relative 'class_timePeriod'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Fgdc
+
+            class Source
+
+               def initialize(xml, hResponseObj)
+                  @xml = xml
+                  @hResponseObj = hResponseObj
+               end
+
+               def writeXML(hSource, aSourceCollection)
+
+                  # skip if this source is already identified
+                  unless hSource[:sourceId].nil?
+                     return if aSourceCollection.include?(hSource[:sourceId])
+                     aSourceCollection << hSource[:sourceId]
+                  end
+                  if hSource[:sourceId].nil?
+                     @hResponseObj[:writerPass] = false
+                     @hResponseObj[:writerMessages] << 'Source is missing source abbreviation (source id)'
+                  end
+
+                  @xml.tag!('srcinfo') do
+
+                     # classes used
+                     citationClass = Citation.new(@xml, @hResponseObj)
+                     timePeriodClass = TimePeriod.new(@xml, @hResponseObj)
+
+                     # source 2.5.1.1 (srccite) - source citation (required)
+                     # <- resourceLineage.source.sourceCitation
+                     unless hSource[:sourceCitation].empty?
+                        @xml.tag!('srccite') do
+                           citationClass.writeXML(hSource[:sourceCitation], [])
+                        end
+                     end
+                     if hSource[:sourceCitation].empty?
+                        @hResponseObj[:writerPass] = false
+                        @hResponseObj[:writerMessages] << 'Source is missing citation'
+                     end
+
+                     # source 2.5.1.2 (srcscale) - source scale denominator
+                     # <- resourceLineage.source.spatialResolution.scaleFactor
+                     haveResolution = false
+                     unless hSource[:spatialResolution].empty?
+                        unless hSource[:spatialResolution].nil?
+                           haveResolution = true
+                           @xml.tag!('srcscale', hSource[:spatialResolution][:scaleFactor].to_s)
+                        end
+                     end
+                     if !haveResolution && @hResponseObj[:writerShowTags]
+                        @xml.tag!('srcscale')
+                     end
+
+                     # source 2.5.1.3 (typesrc) - type of source media (required)
+                     # <- resourceLineage.source.description
+                     unless hSource[:description].nil?
+                        @xml.tag!('typesrc', hSource[:description])
+                     end
+                     if hSource[:description].nil?
+                        @hResponseObj[:writerPass] = false
+                        @hResponseObj[:writerMessages] << 'Source is missing media type (description)'
+                     end
+
+                     # source 2.5.1.4 (srctime) - source time period (required)
+                     # <- resourceLineage.source.scope.extents[0].temporalExtent[0].timePeriod
+                     haveTime = false
+                     unless hSource[:scope].empty?
+                        unless hSource[:scope][:extents].empty?
+                           unless hSource[:scope][:extents][0][:temporalExtents].empty?
+                              unless hSource[:scope][:extents][0][:temporalExtents][0][:timePeriod].empty?
+                                 haveTime = true
+                                 hTimePeriod = hSource[:scope][:extents][0][:temporalExtents][0][:timePeriod]
+                                 @xml.tag!('srctime') do
+                                    timePeriodClass.writeXML(hTimePeriod, 'srccurr')
+                                 end
+                              end
+                           end
+                        end
+                     end
+                     unless haveTime
+                        @hResponseObj[:writerPass] = false
+                        @hResponseObj[:writerMessages] << 'Source is missing time period'
+                     end
+
+                     # source 2.5.1.5 (srccitea) - source citation abbreviation (required)
+                     # <- resourceLineage.source.sourceId
+                     unless hSource[:sourceId].nil?
+                        @xml.tag!('srccitea', hSource[:sourceId])
+                     end
+                     if hSource[:sourceId].nil?
+                        @hResponseObj[:writerPass] = false
+                        @hResponseObj[:writerMessages] << 'Source is missing citation abbreviation (id)'
+                     end
+
+                     # source 2.5.1.6 (srccontr) - source contribution (required)
+                     # <- resourceLineage.source.description
+                     unless hSource[:description].nil?
+                        @xml.tag!('srccontr', hSource[:description])
+                     end
+                     if hSource[:sourceId].nil?
+                        @hResponseObj[:writerPass] = false
+                        @hResponseObj[:writerMessages] << 'Source is missing contribution (description)'
+                     end
+
+                  end
+
+               end # writeXML
+            end # Source
+
+         end
+      end
+   end
+end

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

@@ -90,7 +90,7 @@ module ADIWG
                         end
                         if geoDescription.empty?
                            @hResponseObj[:writerPass] = false
-                           @hResponseObj[:writerMessages] << 'Spatial Domain section is missing geographic description'
+                           @hResponseObj[:writerMessages] << 'Spatial Domain is missing geographic description'
                         end
 
                         # spatial domain 1.5.1 (bounding) - bounding box (required)
@@ -149,7 +149,7 @@ module ADIWG
                         end
                         if hBBox.empty?
                            @hResponseObj[:writerPass] = false
-                           @hResponseObj[:writerMessages] << 'Spatial Domain section is missing bounding box'
+                           @hResponseObj[:writerMessages] << 'Spatial Domain is missing bounding box'
                         end
 
                         # spatial domain 1.5.2 (dsgpoly) - bounding polygon [] (required)

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

@@ -0,0 +1,177 @@
+# FGDC <<Class>> SpatialOrganization
+# FGDC CSDGM writer output in XML
+
+# History:
+#  Stan Smith 2017-12-21 original script
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Fgdc
+
+            class SpatialOrganization
+
+               def initialize(xml, hResponseObj)
+                  @xml = xml
+                  @hResponseObj = hResponseObj
+               end
+
+               def writeXML(hResourceInfo)
+
+                  # spatial organization 3.1 (indspref) - Indirect Spatial Reference
+                  # <- hResourceInfo.spatialReferenceSystems.systemIdentifier.identifier = 'indirect' (first)
+                  haveIndirect = false
+                  hResourceInfo[:spatialReferenceSystems].each do |hSystem|
+                     unless hSystem[:systemIdentifier].empty?
+                        if hSystem[:systemIdentifier][:identifier] == 'indirect'
+                           unless hSystem[:systemIdentifier][:description].empty?
+                              @xml.tag!('indspref', hSystem[:systemIdentifier][:description])
+                              haveIndirect = true
+                              break
+                           end
+                        end
+                     end
+                  end
+                  if !haveIndirect && @hResponseObj[:writerShowTags]
+                     @xml.tag!('indspref')
+                  end
+
+                  # spatial organization 3.2 (direct) - Direct Spatial Reference Method
+                  # <- resourceInfo.spatialRepresentationTypes
+                  # take first that match ['point' | 'vector' | 'grid']
+                  direct = nil
+                  hResourceInfo[:spatialRepresentationTypes].each do |type|
+                     direct = 'Point' if type == 'point'
+                     direct = 'Vector' if type == 'vector'
+                     direct = 'Raster' if type == 'grid'
+                    unless direct.nil?
+                       @xml.tag!('direct', direct)
+                       break
+                    end
+                  end
+                  if direct.nil? && @hResponseObj[:writerShowTags]
+                     @xml.tag!('direct')
+                  end
+
+                  # spatial organization 3.3 (ptvctinf) - point and vector object information
+                  # <- resourceInfo.spatialRepresentations.vectorRepresentation (first)
+                  if direct == 'Point' || direct == 'Vector'
+                     hResourceInfo[:spatialRepresentations].each do |hSpaceRep|
+                        unless hSpaceRep[:vectorRepresentation].empty?
+                           hVectorRep = hSpaceRep[:vectorRepresentation]
+                           unless hVectorRep.empty?
+                              @xml.tag!('ptvctinf') do
+                                 if hVectorRep[:topologyLevel].nil?
+
+                                    # spatial organization point and vector object 3.3.1 (sdtsterm) - SDTS term []
+                                    hVectorRep[:vectorObject].each do |hVecObj|
+                                       @xml.tag!('sdtsterm') do
+
+                                          # spatial organization point and vector object 3.3.1.1 (sdtstype) - SDTS object type (requied)
+                                          @xml.tag!('sdtstype', hVecObj[:objectType])
+
+                                          # spatial organization point and vector object 3.3.1.2 (ptvctcnt) - SDTS count
+                                          unless hVecObj[:objectCount].nil?
+                                             @xml.tag!('ptvctcnt', hVecObj[:objectCount])
+                                          end
+                                          if hVecObj[:objectCount].nil?
+                                             @xml.tag!('ptvctcnt')
+                                          end
+
+                                       end
+                                    end
+
+                                 else
+
+                                    # point and vector object 3.3.2 (vpfterm) - VPF terms description
+                                    @xml.tag!('vpfterm') do
+
+                                       # VPF term 3.3.2.1 (vpflevel) - VPF topology level
+                                       @xml.tag!('vpflevel', hVectorRep[:topologyLevel])
+
+                                       # VPF term 3.3.2.2 (vpfinfo) - VPF point and vector object information []
+                                       hVectorRep[:vectorObject].each do |hVecObj|
+                                          @xml.tag!('vpfinfo') do
+
+                                             # spatial organization point and vector object 3.3.2.2.1 (vpftype) - VPF object type (requied)
+                                             @xml.tag!('vpftype', hVecObj[:objectType])
+
+                                             # spatial organization point and vector object 3.3.2.2.2 (ptvctcnt) - VPF object type
+                                             unless hVecObj[:objectCount].nil?
+                                                @xml.tag!('ptvctcnt', hVecObj[:objectCount])
+                                             end
+                                             if hVecObj[:objectCount].nil?
+                                                @xml.tag!('ptvctcnt')
+                                             end
+
+                                          end
+                                       end
+
+                                    end
+
+                                 end
+                              end
+                              break
+                           end
+
+                        end
+                     end
+                  end
+
+                  # spatial organization 3.4 (rastinfo) - point and vector object information
+                  # <- resourceInfo.spatialRepresentations.gridRepresentation (first)
+                  if direct == 'Raster'
+                     hResourceInfo[:spatialRepresentations].each do |hSpaceRep|
+                        if hSpaceRep[:gridRepresentation]
+                           hGridRep = hSpaceRep[:gridRepresentation]
+                           @xml.tag!('rastinfo') do
+
+                              # spatial organization raster 3.4.1 (rasttype) - raster type (required)
+                              unless hGridRep[:cellGeometry].empty?
+                                 @xml.tag!('rasttype', hGridRep[:cellGeometry])
+                              end
+                              if hGridRep[:cellGeometry].empty?
+                                 @hResponseObj[:writerPass] = false
+                                 @hResponseObj[:writerMessages] << 'Raster Spatial Organization is missing raster type'
+                              end
+
+                              # spatial organization raster 3.4.2 (rowcount) - row count
+                              hGridRep[:dimension].each do |hDimension|
+                                 if hDimension[:dimensionType] == 'row'
+                                    unless hDimension[:dimensionSize].nil?
+                                       @xml.tag!('rowcount', hDimension[:dimensionSize])
+                                    end
+                                 end
+                              end
+
+                              # spatial organization raster 3.4.2 (colcount) - column count
+                              hGridRep[:dimension].each do |hDimension|
+                                 if hDimension[:dimensionType] == 'column'
+                                    unless hDimension[:dimensionSize].nil?
+                                       @xml.tag!('colcount', hDimension[:dimensionSize])
+                                    end
+                                 end
+                              end
+
+                              # spatial organization raster 3.4.2 (vrtcount) - depth count
+                              hGridRep[:dimension].each do |hDimension|
+                                 if hDimension[:dimensionType] == 'vertical'
+                                    unless hDimension[:dimensionSize].nil?
+                                       @xml.tag!('vrtcount', hDimension[:dimensionSize])
+                                    end
+                                 end
+                              end
+
+                           end
+                           break
+                        end
+                     end
+                  end
+
+               end # writeXML
+            end # SpatialOrganization
+
+         end
+      end
+   end
+end

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

@@ -2,7 +2,7 @@
 # FGDC CSDGM writer output in XML
 
 # History:
-#   Stan Smith 2017-11-25 original script
+#  Stan Smith 2017-11-25 original script
 
 module ADIWG
    module Mdtranslator

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

@@ -0,0 +1,70 @@
+# FGDC <<Class>> Taxonomy
+# FGDC CSDGM writer output in XML
+
+# History:
+#  Stan Smith 2017-12-12 original script
+
+require_relative 'class_taxonomyKeywords'
+require_relative 'class_taxonomySystem'
+require_relative 'class_taxonomyClassification'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Fgdc
+
+            class Taxonomy
+
+               def initialize(xml, hResponseObj)
+                  @xml = xml
+                  @hResponseObj = hResponseObj
+               end
+
+               def writeXML(hTaxonomy, aKeywords)
+
+                  # classes used
+                  keywordClass = TaxonomyKeyword.new(@xml, @hResponseObj)
+                  taxSystemClass = TaxonomySystem.new(@xml, @hResponseObj)
+                  taxClassClass = TaxonomyClassification.new(@xml, @hResponseObj)
+
+                  # taxonomy bio (keywtax) - taxonomic keywords (required)
+                  unless aKeywords.empty?
+                     keywordClass.writeXML(aKeywords)
+                  end
+                  if aKeywords.empty? && @hResponseObj[:writerShowTags]
+                     @xml.tag!('keywtax')
+                  end
+
+                  # taxonomy bio (taxonsys) - taxonomic system
+                  # section is not required for fgdc, but is required by mdJson
+                  # so section will always be present
+                  @xml.tag!('taxonsys') do
+                     taxSystemClass.writeXML(hTaxonomy)
+                  end
+
+                  # taxonomy (taxongen) - general scope
+                  unless hTaxonomy[:generalScope].nil?
+                     @xml.tag!('taxongen', hTaxonomy[:generalScope])
+                  end
+                  if hTaxonomy[:generalScope].nil? && @hResponseObj[:writerShowTags]
+                     @xml.tag!('taxongen')
+                  end
+
+                  # taxonomy bio (taxoncl) - taxonomic classification {required}
+                  unless hTaxonomy[:taxonClass].empty?
+                     @xml.tag!('taxoncl') do
+                        taxClassClass.writeXML(hTaxonomy[:taxonClass])
+                     end
+                  end
+                  if hTaxonomy[:taxonClass].empty?
+                     @hResponseObj[:writerPass] = false
+                     @hResponseObj[:writerMessages] << 'Taxonomy is missing taxonomic classification'
+                  end
+
+               end # writeXML
+            end # Taxonomy
+
+         end
+      end
+   end
+end

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

@@ -0,0 +1,65 @@
+# FGDC <<Class>> TaxonomyClassification
+# FGDC CSDGM writer output in XML
+
+# History:
+#  Stan Smith 2017-12-13 original script
+
+require_relative 'class_taxonomyClassification'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Fgdc
+
+            class TaxonomyClassification
+
+               def initialize(xml, hResponseObj)
+                  @xml = xml
+                  @hResponseObj = hResponseObj
+               end
+
+               def writeXML(hClass)
+
+                  # classes used
+                  taxClassClass = TaxonomyClassification.new(@xml, @hResponseObj)
+
+                  # taxonomy bio (taxonrn) - taxon rank (required)
+                  unless hClass[:taxonRank].nil?
+                     @xml.tag!('taxonrn', hClass[:taxonRank])
+                  end
+                  if hClass[:taxonRank].nil?
+                     @hResponseObj[:writerPass] = false
+                     @hResponseObj[:writerMessages] << 'Taxonomic Classification is missing taxon rank'
+                  end
+
+                  # taxonomy bio (taxonrv) - taxon value (required)
+                  unless hClass[:taxonValue].nil?
+                     @xml.tag!('taxonrv', hClass[:taxonValue])
+                  end
+                  if hClass[:taxonValue].nil?
+                     @hResponseObj[:writerPass] = false
+                     @hResponseObj[:writerMessages] << 'Taxonomic Classification is missing latin name'
+                  end
+
+                  # taxonomy bio (common) - taxon value common names []
+                  hClass[:commonNames].each do |hName|
+                     @xml.tag!('common', hName)
+                  end
+                  if hClass[:commonNames].empty? && @hResponseObj[:writerShowTags]
+                     @xml.tag!('common')
+                  end
+
+                  # taxonomy bio (taxoncl) - taxonomic sub-classification []
+                  hClass[:subClasses].each do |hSubClass|
+                     @xml.tag!('taxoncl') do
+                        taxClassClass.writeXML(hSubClass)
+                     end
+                  end
+
+               end # writeXML
+            end # TaxonomyClassification
+
+         end
+      end
+   end
+end