adiwg-mdtranslator 2.10.0 → 2.12.0.pre

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

@@ -2,8 +2,10 @@
 # FGDC CSDGM writer output in XML
 
 # History:
+#  Stan Smith 2018-03-17 refactored error and warning messaging
 #  Stan Smith 2018-01-22 original script
 
+require_relative '../fgdc_writer'
 require_relative 'class_attribute'
 
 module ADIWG
@@ -16,34 +18,37 @@ module ADIWG
                def initialize(xml, hResponseObj)
                   @xml = xml
                   @hResponseObj = hResponseObj
+                  @NameSpace = ADIWG::Mdtranslator::Writers::Fgdc
                end
 
-               def writeXML(hEntity)
-
+               def writeXML(hEntity, inContext = nil)
+                  
                   # classes used
                   attrClass = Attribute.new(@xml, @hResponseObj)
 
+                  # set context
+                  outContext = hEntity[:entityCode]
+                  outContext = 'entity code ' + outContext unless outContext.nil?
+
                   # 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?
+                     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'
+                        @NameSpace.issueWarning(90, 'enttypl', inContext)
                      end
 
                      # entity type 5.1.1.2 (enttypd) - entity type definition (required)
                      # <- entity.entityDefinition
-                  unless hEntity[:entityDefinition].nil?
+                     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'
+                        @NameSpace.issueWarning(91, 'enttypd', inContext)
                      end
 
                      # entity type 5.1.1.3 (enttypds) - entity definition source (required)
@@ -54,8 +59,7 @@ module ADIWG
                         end
                      end
                      if hEntity[:entityReferences].empty?
-                        @hResponseObj[:writerPass] = false
-                        @hResponseObj[:writerMessages] << 'Entity Attribute Detail missing entity definition citation'
+                        @NameSpace.issueWarning(92, 'enttypds', inContext)
                      end
 
                   end
@@ -64,7 +68,7 @@ module ADIWG
                   hEntity[:attributes].each do |hAttribute|
                      unless hAttribute.empty?
                         @xml.tag!('attr') do
-                           attrClass.writeXML(hAttribute)
+                           attrClass.writeXML(hAttribute, outContext)
                         end
                      end
                   end

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

@@ -2,8 +2,11 @@
 # FGDC CSDGM writer output in XML
 
 # History:
+#  Stan Smith 2018-02-26 refactored error and warning messaging
 #  Stan Smith 2018-01-22 original script
 
+require_relative '../fgdc_writer'
+
 module ADIWG
    module Mdtranslator
       module Writers
@@ -14,18 +17,18 @@ module ADIWG
                def initialize(xml, hResponseObj)
                   @xml = xml
                   @hResponseObj = hResponseObj
+                  @NameSpace = ADIWG::Mdtranslator::Writers::Fgdc
                end
 
-               def writeXML(hEntity)
-
+               def writeXML(hEntity, inContext = nil)
+                  
                   # 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'
+                     @NameSpace.issueWarning(100, 'eaover', inContext)
                   end
 
                   # entity overview 5.2.2 (eadetcit) - entity and attribute detail citation []

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

@@ -43,7 +43,7 @@ module ADIWG
                   # document head
                   metadata = @xml.instruct! :xml, encoding: 'UTF-8'
                   @xml.comment!('FGDC METADATA (FGDC-STD-001-1998)')
-                  @xml.comment!('This file conforms to the Biological Data Profile (FGDC-STD-001.1-1999)')
+                  @xml.comment!('This metadata record conforms to the 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')

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

@@ -2,8 +2,11 @@
 # FGDC CSDGM writer output in XML
 
 # History:
+#  Stan Smith 2018-03-18 refactored error and warning messaging
 #  Stan Smith 2018-01-15 original script
 
+require_relative '../fgdc_writer'
+
 module ADIWG
    module Mdtranslator
       module Writers
@@ -14,6 +17,7 @@ module ADIWG
                def initialize(xml, hResponseObj)
                   @xml = xml
                   @hResponseObj = hResponseObj
+                  @NameSpace = ADIWG::Mdtranslator::Writers::Fgdc
                end
 
                def writeXML(hGeodetic)
@@ -31,8 +35,7 @@ module ADIWG
                      @xml.tag!('ellips', hGeodetic[:ellipsoidName])
                   end
                   if hGeodetic[:ellipsoidName].nil?
-                     @hResponseObj[:writerPass] = false
-                     @hResponseObj[:writerMessages] << 'Geodetic Coordinate System is missing ellipsoid name'
+                     @NameSpace.issueWarning(150, 'ellips')
                   end
 
                   # geodetic reference system 4.1.4.3 (semiaxis) - ellipsoid semi-major axis (required)
@@ -40,8 +43,7 @@ module ADIWG
                      @xml.tag!('semiaxis', hGeodetic[:semiMajorAxis])
                   end
                   if hGeodetic[:semiMajorAxis].nil?
-                     @hResponseObj[:writerPass] = false
-                     @hResponseObj[:writerMessages] << 'Geodetic Coordinate System is missing semi-major axis'
+                     @NameSpace.issueWarning(151, 'semiaxis')
                   end
 
                   # geodetic reference system 4.1.4.4 (denflat) - ellipsoid denominator of flattening ratio (required)
@@ -49,8 +51,7 @@ module ADIWG
                      @xml.tag!('denflat', hGeodetic[:denominatorOfFlatteningRatio])
                   end
                   if hGeodetic[:denominatorOfFlatteningRatio].nil?
-                     @hResponseObj[:writerPass] = false
-                     @hResponseObj[:writerMessages] << 'Geodetic Coordinate System is missing denominator of flattening ratio'
+                     @NameSpace.issueWarning(152, 'denflat')
                   end
 
                end # writeXML

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

@@ -2,8 +2,11 @@
 # FGDC CSDGM writer output in XML
 
 # History:
+#  Stan Smith 2018-03-19 refactored error and warning messaging
 #  Stan Smith 2017-12-29 original script
 
+require_relative '../fgdc_writer'
+
 module ADIWG
    module Mdtranslator
       module Writers
@@ -14,10 +17,11 @@ module ADIWG
                def initialize(xml, hResponseObj)
                   @xml = xml
                   @hResponseObj = hResponseObj
+                  @NameSpace = ADIWG::Mdtranslator::Writers::Fgdc
                end
 
                def writeXML(hGeoRes)
-
+                  
                   # horizontal reference 4.1.1 (geograph) - geographic resolution
 
                   # geographic resolution 4.1.1.1 (latres) - latitude resolution (required)
@@ -25,8 +29,7 @@ module ADIWG
                      @xml.tag!('latres', hGeoRes[:latitudeResolution]).to_s
                   end
                   if hGeoRes[:latitudeResolution].nil?
-                     @hResponseObj[:writerPass] = false
-                     @hResponseObj[:writerMessages] << 'Geographic Resolution is missing latitude resolution'
+                     @NameSpace.issueWarning(160, 'latres')
                   end
 
                   # geographic resolution 4.1.1.2 (longres) - longitude resolution (required)
@@ -34,8 +37,7 @@ module ADIWG
                      @xml.tag!('longres', hGeoRes[:longitudeResolution]).to_s
                   end
                   if hGeoRes[:longitudeResolution].nil?
-                     @hResponseObj[:writerPass] = false
-                     @hResponseObj[:writerMessages] << 'Geographic Resolution is missing longitude resolution'
+                     @NameSpace.issueWarning(161, 'longres')
                   end
 
                   # geographic resolution 4.1.1.3 (geogunit) - longitude resolution (required)
@@ -43,8 +45,7 @@ module ADIWG
                      @xml.tag!('geogunit', hGeoRes[:unitOfMeasure])
                   end
                   if hGeoRes[:unitOfMeasure].nil?
-                     @hResponseObj[:writerPass] = false
-                     @hResponseObj[:writerMessages] << 'Geographic Resolution is missing unit of measure'
+                     @NameSpace.issueWarning(162, 'geogunit')
                   end
 
                end # writeXML

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

@@ -2,8 +2,10 @@
 # FGDC CSDGM writer output in XML
 
 # History:
+#  Stan Smith 2018-03-19 refactored error and warning messaging
 #  Stan Smith 2017-11-24 original script
 
+require_relative '../fgdc_writer'
 require_relative 'class_citation'
 
 module ADIWG
@@ -16,6 +18,7 @@ module ADIWG
                def initialize(xml, hResponseObj)
                   @xml = xml
                   @hResponseObj = hResponseObj
+                  @NameSpace = ADIWG::Mdtranslator::Writers::Fgdc
                end
 
                def writeXML(hGeoAge)
@@ -28,8 +31,7 @@ module ADIWG
                      @xml.tag!('geolscal', hGeoAge[:ageTimeScale])
                   end
                   if hGeoAge[:ageTimeScale].nil?
-                     @hResponseObj[:writerPass] = false
-                     @hResponseObj[:writerMessages] << 'Geologic Age is missing time scale'
+                     @NameSpace.issueWarning(170, 'geolscal')
                   end
 
                   # geologic age (geolest) - age estimate (required)
@@ -37,8 +39,7 @@ module ADIWG
                      @xml.tag!('geolest', hGeoAge[:ageEstimate])
                   end
                   if hGeoAge[:ageEstimate].nil?
-                     @hResponseObj[:writerPass] = false
-                     @hResponseObj[:writerMessages] << 'Geologic Age is missing age estimate'
+                     @NameSpace.issueWarning(171, 'geolest')
                   end
 
                   # geologic age (geolun) - age uncertainty

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

@@ -2,8 +2,10 @@
 # FGDC CSDGM writer output in XML
 
 # History:
-#   Stan Smith 2017-11-24 original script
+#  Stan Smith 2018-03-19 refactored error and warning messaging
+#  Stan Smith 2017-11-24 original script
 
+require_relative '../fgdc_writer'
 require_relative 'class_geologicAge'
 
 module ADIWG
@@ -16,6 +18,7 @@ module ADIWG
                def initialize(xml, hResponseObj)
                   @xml = xml
                   @hResponseObj = hResponseObj
+                  @NameSpace = ADIWG::Mdtranslator::Writers::Fgdc
                end
 
                def writeXML(hAgeStart, hAgeEnd)
@@ -30,8 +33,7 @@ module ADIWG
                      end
                   end
                   if hAgeStart.empty?
-                     @hResponseObj[:writerPass] = false
-                     @hResponseObj[:writerMessages] << 'Geologic Age Range is missing starting age'
+                     @NameSpace.issueWarning(172, nil)
                   end
 
                   # geologic age range (endgeol) - ending geologic age (required)
@@ -41,8 +43,7 @@ module ADIWG
                      end
                   end
                   if hAgeEnd.empty?
-                     @hResponseObj[:writerPass] = false
-                     @hResponseObj[:writerMessages] << 'Geologic Age Range is missing ending age'
+                     @NameSpace.issueWarning(173, nil)
                   end
 
                end # writeXML

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

@@ -2,6 +2,7 @@
 # FGDC CSDGM writer output in XML
 
 # History:
+#  Stan Smith 2018-03-19 refactored error and warning messaging
 #  Stan Smith 2017-11-17 original script
 
 require_relative '../fgdc_writer'
@@ -27,6 +28,7 @@ module ADIWG
                def initialize(xml, hResponseObj)
                   @xml = xml
                   @hResponseObj = hResponseObj
+                  @NameSpace = ADIWG::Mdtranslator::Writers::Fgdc
                end
 
                def writeXML(intObj)
@@ -47,33 +49,33 @@ module ADIWG
                   hResourceInfo = intObj[:metadata][:resourceInfo]
                   aAssocResource = intObj[:metadata][:associatedResources]
 
+                  outContext = 'identification section'
+
                   # identification information 1.1 (citation) - citation (required)
                   # <- hResourceInfo[:citation]
                   hCitation = hResourceInfo[:citation]
                   unless hCitation.empty?
                      @xml.tag!('citation') do
-                        citationClass.writeXML(hCitation, aAssocResource)
+                        citationClass.writeXML(hCitation, aAssocResource, 'main resource citation')
                      end
                   end
                   if hCitation.empty?
-                     @hResponseObj[:writerPass] = false
-                     @hResponseObj[:writerMessages] << 'Identification section is missing citation'
+                     @NameSpace.issueWarning(180, nil, outContext)
                   end
 
                   # identification information 1.2 (descript) - description (required)
                   # <- hResourceInfo[:abstract,:purpose,:supplementalInfo] (required)
-                  unless hResourceInfo[:abstract].nil? && hResourceInfo[:purpose].nil? && hResourceInfo[:supplementalInfo].nil?
+                  haveDescription = false
+                  haveDescription = true unless hResourceInfo[:abstract].nil?
+                  haveDescription = true unless hResourceInfo[:purpose].nil?
+                  haveDescription = true unless hResourceInfo[:supplementalInfo].nil?
+                  if haveDescription
                      @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'
+                  unless haveDescription
+                     @NameSpace.issueWarning(181, nil, outContext)
                   end
 
                   # identification information 1.3 (timeperd) - time period of content (required)
@@ -84,8 +86,7 @@ module ADIWG
                      end
                   end
                   if hResourceInfo[:timePeriod].empty?
-                     @hResponseObj[:writerPass] = false
-                     @hResponseObj[:writerMessages] << 'Identification section is missing time period'
+                     @NameSpace.issueWarning(182, nil, outContext)
                   end
 
                   # identification information 1.4 (status) - status
@@ -104,16 +105,19 @@ module ADIWG
                      end
                   end
                   if hResourceInfo[:keywords].empty?
-                     @hResponseObj[:writerPass] = false
-                     @hResponseObj[:writerMessages] << 'Identification section is missing keywords'
+                     @NameSpace.issueWarning(183, nil, outContext)
                   end
 
                   # identification information bio (taxonomy) - taxonomy
                   unless hResourceInfo[:taxonomy].empty?
                      @xml.tag!('taxonomy') do
-                        taxonomyClass.writeXML(hResourceInfo[:taxonomy], hResourceInfo[:keywords])
+                        taxonomyClass.writeXML(hResourceInfo[:taxonomy][0], hResourceInfo[:keywords])
                      end
                   end
+                  if hResourceInfo[:taxonomy].length > 1
+                     @NameSpace.issueNotice(186)
+                     @NameSpace.issueNotice(187)
+                  end
                   if hResourceInfo[:taxonomy].empty? && @hResponseObj[:writerShowTags]
                      @xml.tag!('taxonomy')
                   end
@@ -124,8 +128,8 @@ module ADIWG
                      constraintClass.writeXML(hResourceInfo[:constraints])
                   end
                   if hResourceInfo[:constraints].empty?
-                     @hResponseObj[:writerPass] = false
-                     @hResponseObj[:writerMessages] << 'Identification section is missing access and use constraints'
+                     @NameSpace.issueWarning(184,'accconst', outContext)
+                     @NameSpace.issueWarning(185,'useconst', outContext)
                   end
 
                   # identification information 1.9 (ptcontac) - point of contact

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

@@ -2,7 +2,10 @@
 # FGDC CSDGM writer output in XML
 
 # History:
-#   Stan Smith 2017-11-26 original script
+#  Stan Smith 2018-03-19 refactored error and warning messaging
+#  Stan Smith 2017-11-26 original script
+
+require_relative '../fgdc_writer'
 
 module ADIWG
    module Mdtranslator
@@ -14,6 +17,7 @@ module ADIWG
                def initialize(xml, hResponseObj)
                   @xml = xml
                   @hResponseObj = hResponseObj
+                  @NameSpace = ADIWG::Mdtranslator::Writers::Fgdc
                end
 
                def writeXML(aKeywords)
@@ -24,21 +28,22 @@ module ADIWG
                      # find the keyword set parts
                      type = hKeySet[:keywordType]
                      aKeywords = hKeySet[:keywords]
-                     thesaurus = hKeySet[:thesaurus]
+                     hThesaurus = hKeySet[:thesaurus]
                      thesaurusName = nil
-                     unless thesaurus.empty?
-                        thesaurusName = thesaurus[:title]
-                     end
-                     if thesaurus.empty?
-                        @hResponseObj[:writerPass] = false
-                        @hResponseObj[:writerMessages] << 'Keyword Set is missing thesaurus'
+                     unless hThesaurus.empty?
+                        thesaurusName = hThesaurus[:title]
                      end
 
                      # keyword 1.6.1 (theme) - theme keywords
                      if type == 'theme' || type == 'isoTopicCategory'
                         @xml.tag!('theme') do
                            thesaurusName = 'ISO 19115 Topic Category' if type == 'isoTopicCategory'
-                           @xml.tag!('themekt', thesaurusName)
+                           unless thesaurusName.nil?
+                              @xml.tag!('themekt', thesaurusName)
+                           end
+                           if thesaurusName.nil?
+                              @NameSpace.issueWarning(190, 'themekt', 'thematic keywords')
+                           end
                            aKeywords.each do |hKeyword|
                               keyword = hKeyword[:keyword]
                               unless keyword.nil?
@@ -51,7 +56,12 @@ module ADIWG
                      # keyword 1.6.2 (place) - place keywords
                      if type == 'place'
                         @xml.tag!('place') do
-                           @xml.tag!('placekt', thesaurusName)
+                           unless thesaurusName.nil?
+                              @xml.tag!('placekt', thesaurusName)
+                           end
+                           if thesaurusName.nil?
+                              @NameSpace.issueWarning(190, 'placekt', 'place keywords')
+                           end
                            aKeywords.each do |hKeyword|
                               keyword = hKeyword[:keyword]
                               unless keyword.nil?
@@ -64,7 +74,12 @@ module ADIWG
                      # keyword 1.6.3 (stratum) - stratum keywords
                      if type == 'stratum'
                         @xml.tag!('stratum') do
-                           @xml.tag!('stratkt', thesaurusName)
+                           unless thesaurusName.nil?
+                              @xml.tag!('stratkt', thesaurusName)
+                           end
+                           if thesaurusName.nil?
+                              @NameSpace.issueWarning(190, 'stratkt', 'stratigraphic keywords')
+                           end
                            aKeywords.each do |hKeyword|
                               keyword = hKeyword[:keyword]
                               unless keyword.nil?
@@ -77,7 +92,12 @@ module ADIWG
                      # keyword 1.6.4 (temporal) - temporal keywords
                      if type == 'temporal'
                         @xml.tag!('temporal') do
-                           @xml.tag!('tempkt', thesaurusName)
+                           unless thesaurusName.nil?
+                              @xml.tag!('tempkt', thesaurusName)
+                           end
+                           if thesaurusName.nil?
+                              @NameSpace.issueWarning(190, 'tempkt', 'temporal keywords')
+                           end
                            aKeywords.each do |hKeyword|
                               keyword = hKeyword[:keyword]
                               unless keyword.nil?

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

@@ -2,8 +2,10 @@
 # FGDC CSDGM writer output in XML
 
 # History:
+#  Stan Smith 2018-03-19 refactored error and warning messaging
 #  Stan Smith 2017-12-15 original script
 
+require_relative '../fgdc_writer'
 require_relative 'class_method'
 require_relative 'class_source'
 require_relative 'class_process'
@@ -18,6 +20,7 @@ module ADIWG
                def initialize(xml, hResponseObj)
                   @xml = xml
                   @hResponseObj = hResponseObj
+                  @NameSpace = ADIWG::Mdtranslator::Writers::Fgdc
                end
 
                def writeXML(aLineage)
@@ -76,8 +79,7 @@ module ADIWG
                      end
                   end
                   unless haveStep
-                     @hResponseObj[:writerPass] = false
-                     @hResponseObj[:writerMessages] << 'Lineage Source is missing process steps'
+                     @NameSpace.issueWarning(200, 'procstep')
                   end
 
                   # the search for process steps is circular, I'm stopping here.

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

@@ -2,8 +2,11 @@
 # FGDC CSDGM writer output in XML
 
 # History:
+#  Stan Smith 2018-03-20 refactored error and warning messaging
 #  Stan Smith 2018-01-15 original script
 
+require_relative '../fgdc_writer'
+
 module ADIWG
    module Mdtranslator
       module Writers
@@ -14,26 +17,34 @@ module ADIWG
                def initialize(xml, hResponseObj)
                   @xml = xml
                   @hResponseObj = hResponseObj
+                  @NameSpace = ADIWG::Mdtranslator::Writers::Fgdc
                end
 
                def writeXML(hProjection)
 
-                  # local system (local) - local coordinate system description (required)
+                  # localSYSTEM is not the same as localPLANAR in fgdc
+                  # however the same projection parameters are used in mdJson to save info
+                  # local system sets projection = 'localSystem'
+                  # local planar sets projection = 'localPlanar'
+
+                  if hProjection[:projectionName].nil?
+                     hProjection[:projectionName] = 'local coordinate system not aligned with surface of earth'
+                  end
+
+                  # local system 4.1.3.1 (localdes) - local coordinate system description (required)
                   unless hProjection[:localPlanarDescription].nil?
                      @xml.tag!('localdes', hProjection[:localPlanarDescription])
                   end
                   if hProjection[:localPlanarDescription].nil?
-                     @hResponseObj[:writerPass] = false
-                     @hResponseObj[:writerMessages] << 'Local Coordinate System is missing description'
+                     @NameSpace.issueError(250, hProjection[:projectionName])
                   end
 
-                  # local system (local) - local coordinate system georeference information (required)
+                  # local system 4.1.3.2 (localgeo) - local coordinate system georeference information (required)
                   unless hProjection[:localPlanarGeoreference].nil?
                      @xml.tag!('localgeo', hProjection[:localPlanarGeoreference])
                   end
                   if hProjection[:localPlanarGeoreference].nil?
-                     @hResponseObj[:writerPass] = false
-                     @hResponseObj[:writerMessages] << 'Local Coordinate System is missing georeference information'
+                     @NameSpace.issueError(251, hProjection[:projectionName])
                   end
 
                end # writeXML