adiwg-mdtranslator 2.15.0 → 2.16.1

data/lib/adiwg/mdtranslator/internal/qualityReport.json

@@ -0,0 +1,64 @@
+{
+   "dataQuality": [
+      {
+         "scope": {},
+         "standaloneQualityReport": {
+            "reportReference": {},
+            "abstract": "stand alone abstract",
+            "elementReport": []
+         },
+         "report": [
+            {
+               "type": "quality report type - enumerated",
+               "dateTime": ["2019-06-11T08:10:00"],
+               "standaloneQualityReportDetails": "standalone details",
+               "qualityMeasure": {
+                  "identifier": {},
+                  "name": ["name of measure"],
+                  "description": "measure description"
+               },
+               "evaluationMethod": {
+                  "type": "evaluation method type - enumerated",
+                  "dateTime": ["2019-06-11T08:35:00"],
+                  "methodDescription": "evaluation method description",
+                  "evaluationProcedure": {},
+                  "referenceDocument": [],
+                  "evaluationMethodType": "DQ_EvaluationMethodTypeCode",
+                  "deductiveSource": "deductive source",
+                  "samplingScheme": "sampling scheme",
+                  "lotDescription": "lot description",
+                  "samplingRatio": "sampling ratio"
+               },
+               "quantitativeResult": [
+                  {
+                     "dateTime": "2019-06-11T09:00:00",
+                     "scope": {},
+                     "value": [9.99, 9.0],
+                     "valueUnits": "value units",
+                     "valueRecordType": "value record type"
+                  }
+               ],
+               "descriptiveResult": [
+                  {
+                     "dateTime": "2019-06-11T09:00:00",
+                     "scope": {},
+                     "statement": "descriptive result statement"
+                  }
+               ],
+               "conformanceResult": [
+                  {
+                     "dateTime": "2019-06-11T09:00:00",
+                     "scope": {},
+                     "specification": {},
+                     "explanation": "conformance result explanation",
+                     "pass": false
+                  }
+               ],
+               "coverageResult": ["drop this class"],
+               "derivedElementReport": [],
+               "relatedElementReport": []
+            }
+         ]
+      }
+   ]
+}

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

@@ -2,6 +2,7 @@
 # unpack fgdc entity and attribute
 
 # History:
+#  Stan Smith 2019-09-19 add citation title to dictionary name
 #  Stan Smith 2017-08-15 original script
 
 require 'nokogiri'
@@ -16,15 +17,17 @@ module ADIWG
 
             module EntityAttribute
 
-               def self.unpack(xEntity, hResponseObj)
+               def self.unpack(xEntity, title, hResponseObj)
 
                   # instance classes needed in script
                   intMetadataClass = InternalMetadata.new
                   hDictionary = intMetadataClass.newDataDictionary
                   hCitation = intMetadataClass.newCitation
-                  hCitation[:title] = 'FGDC EntityAttribute Section 5'
                   hDictionary[:citation] = hCitation
 
+                  # add dictionary title
+                  hCitation[:title] = 'Data Dictionary for: ' + title
+
                   # entity attribute 5.1 (detailed) - entity attribute detailed description
                   axDetail = xEntity.xpath('./detailed')
                   unless axDetail.empty?

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

@@ -2,6 +2,7 @@
 # unpack fgdc metadata
 
 # History:
+#  Stan Smith 2019-09-19 add citation title to dictionary name
 #  Stan Smith 2017-08-10 original script
 
 require 'nokogiri'
@@ -48,9 +49,18 @@ module ADIWG
                   @intObj[:schema] = hSchema
 
                   # metadata (idinfo 1) - identification information (required)
+                  title = ''
                   xIdInfo = xMetadata.xpath('./idinfo')
                   unless xIdInfo.empty?
                      Identification.unpack(xIdInfo, intObj, hResponseObj)
+                     xCitation = xIdInfo.xpath('./citation')
+                     unless xCitation.empty?
+                        xCiteInfo = xCitation.xpath('./citeinfo')
+                        unless xCiteInfo.empty?
+                           title = xCiteInfo.xpath('./title').text
+                        end
+                     end
+
                   end
                   if xIdInfo.empty?
                      hResponseObj[:readerExecutionMessages] << 'WARNING: FGDC reader: identification information section (idinfo) missing'
@@ -77,7 +87,7 @@ module ADIWG
                   # metadata (eainfo 5) - entity and attribute
                   xEntity = xMetadata.xpath('./eainfo')
                   unless xEntity.empty?
-                     hDictionary = EntityAttribute.unpack(xEntity, hResponseObj)
+                     hDictionary = EntityAttribute.unpack(xEntity, title, hResponseObj)
                      unless hDictionary.nil?
                         @intObj[:dataDictionaries] << hDictionary
                      end

data/lib/adiwg/mdtranslator/readers/mdJson/mdJson_reader_messages_eng.yml

@@ -390,3 +390,18 @@ messageList:
    - {id: 942, message: "voucher repository is missing"}
 
    - {id: 950, message: "local projection object is empty"}
+
+   - {id: 960, message: "nominal resolution object is empty"}
+   - {id: 961, message: "nominal resolution object is missing required elements"}
+   - {id: 962, message: "nominal resolution cannot be both scanning and ground resolutions"}
+
+   - {id: 970, message: "algorithm object is empty"}
+   - {id: 971, message: "algorithm citation is missing"}
+   - {id: 972, message: "algorithm description is missing"}
+
+   - {id: 980, message: "process step report object is empty"}
+   - {id: 981, message: "process step report name is missing"}
+
+   - {id: 990, message: "processing object is empty"}
+   - {id: 991, message: "processing identifier is missing"}
+

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_algorithm.rb

@@ -0,0 +1,65 @@
+# unpack algorithm
+# Reader - ADIwg JSON to internal data structure
+
+# History:
+#  Stan Smith 2019-09-23 original script
+
+require_relative 'module_citation'
+
+module ADIWG
+   module Mdtranslator
+      module Readers
+         module MdJson
+
+            module Algorithm
+
+               def self.unpack(hAlgorithm, responseObj, inContext = nil)
+
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
+
+                  # return nil object if input is empty
+                  if hAlgorithm.empty?
+                     @MessagePath.issueWarning(970, responseObj, inContext)
+                     return nil
+                  end
+
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intAlgorithm = intMetadataClass.newAlgorithm
+
+                  outContext = 'algorithm'
+                  outContext = inContext + ' > ' + outContext unless inContext.nil?
+
+                  # algorithm - citation (required)
+                  if hAlgorithm.has_key?('citation')
+                     unless hAlgorithm['citation'].empty?
+                        hReturn = Citation.unpack(hAlgorithm['citation'], responseObj, outContext)
+                        unless hReturn.nil?
+                           intAlgorithm[:citation] = hReturn
+                        end
+                     end
+                  end
+                  if intAlgorithm[:citation].empty?
+                     @MessagePath.issueWarning(971, responseObj, inContext)
+                  end
+
+                  # algorithm - description (required)
+                  if hAlgorithm.has_key?('description')
+                     unless hAlgorithm['description'] == ''
+                        intAlgorithm[:description] = hAlgorithm['description']
+                     end
+                  end
+                  if intAlgorithm[:description].nil?
+                     @MessagePath.issueWarning(972, responseObj, inContext)
+                  end
+
+                  return intAlgorithm
+
+               end
+
+            end
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_nominalResolution.rb

@@ -0,0 +1,78 @@
+# unpack nominal resolution
+# Reader - ADIwg JSON to internal data structure
+
+# History:
+#  Stan Smith 2019-09-22 original script
+
+require_relative 'module_measure'
+
+module ADIWG
+   module Mdtranslator
+      module Readers
+         module MdJson
+
+            module NominalResolution
+
+               def self.unpack(hResolution, responseObj, inContext = nil)
+
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
+
+                  # return nil object if input is empty
+                  if hResolution.empty?
+                     @MessagePath.issueWarning(960, responseObj, inContext)
+                     return nil
+                  end
+
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intResolution = intMetadataClass.newNominalResolution
+
+                  outContext = 'nominal resolution'
+                  outContext = inContext + ' > ' + outContext unless inContext.nil?
+
+                  haveRequired = 0
+
+                  # nominal resolution - scanning resolution (required if)
+                  if hResolution.has_key?('scanningResolution')
+                     hMeasure = hResolution['scanningResolution']
+                     unless hMeasure.empty?
+                        hMeasure['type'] = 'distance'
+                        hReturn = Measure.unpack(hMeasure, responseObj, outContext)
+                        unless hReturn.nil?
+                           intResolution[:scanningResolution] = hReturn
+                           haveRequired += 1
+                        end
+                     end
+                  end
+
+                  # nominal resolution - ground resolution (required if)
+                  if hResolution.has_key?('groundResolution')
+                     hMeasure = hResolution['groundResolution']
+                     unless hMeasure.empty?
+                        hMeasure['type'] = 'distance'
+                        hReturn = Measure.unpack(hMeasure, responseObj, outContext)
+                        unless hReturn.nil?
+                           intResolution[:groundResolution] = hReturn
+                           haveRequired += 1
+                        end
+                     end
+                  end
+
+                  unless haveRequired > 0
+                     @MessagePath.issueError(961, responseObj, inContext)
+                  end
+
+                  if haveRequired == 2
+                     @MessagePath.issueError(962, responseObj, inContext)
+                  end
+
+                  return intResolution
+
+               end
+
+            end
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_onlineResource.rb

@@ -2,6 +2,7 @@
 # Reader - ADIwg JSON V1 to internal data structure
 
 # History:
+#  Stan Smith 2018-09-18 add applicationProfile and protocolRequest
 #  Stan Smith 2018-06-22 refactored error and warning messaging
 # 	Stan Smith 2016-10-03 original script
 #  Stan Smith 2015-07-14 refactored to remove global namespace constants
@@ -42,34 +43,48 @@ module ADIWG
                      @MessagePath.issueError(601, responseObj, inContext)
                   end
 
-                  # resource - web link protocol
-                  if hOnlineRes.has_key?('protocol')
-                     unless hOnlineRes['protocol'] == ''
-                        intOLRes[:olResProtocol] = hOnlineRes['protocol']
-                     end
-                  end
-
-                  # resource - web link name
+                  # resource - name
                   if hOnlineRes.has_key?('name')
                      unless hOnlineRes['name'] == ''
                         intOLRes[:olResName] = hOnlineRes['name']
                      end
                   end
 
-                  # resource - web link description
+                  # resource - description
                   if hOnlineRes.has_key?('description')
                      unless hOnlineRes['description'] == ''
                         intOLRes[:olResDesc] = hOnlineRes['description']
                      end
                   end
 
-                  # resource - web link function
+                  # resource - unction
                   if hOnlineRes.has_key?('function')
                      unless hOnlineRes['function'] == ''
                         intOLRes[:olResFunction] = hOnlineRes['function']
                      end
                   end
 
+                  # resource - application profile
+                  if hOnlineRes.has_key?('applicationProfile')
+                     unless hOnlineRes['applicationProfile'] == ''
+                        intOLRes[:olResApplicationProfile] = hOnlineRes['applicationProfile']
+                     end
+                  end
+
+                  # resource - protocol
+                  if hOnlineRes.has_key?('protocol')
+                     unless hOnlineRes['protocol'] == ''
+                        intOLRes[:olResProtocol] = hOnlineRes['protocol']
+                     end
+                  end
+
+                  # resource - protocol request
+                  if hOnlineRes.has_key?('protocolRequest')
+                     unless hOnlineRes['protocolRequest'] == ''
+                        intOLRes[:olResProtocolRequest] = hOnlineRes['protocolRequest']
+                     end
+                  end
+
                   return intOLRes
                end
 

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_processReport.rb

@@ -0,0 +1,66 @@
+# unpack process step report
+# Reader - ADIwg JSON to internal data structure
+
+# History:
+#  Stan Smith 2019-09-23 original script
+
+require_relative 'module_citation'
+
+module ADIWG
+   module Mdtranslator
+      module Readers
+         module MdJson
+
+            module ProcessStepReport
+
+               def self.unpack(hReport, responseObj, inContext = nil)
+
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
+
+                  # return nil object if input is empty
+                  if hReport.empty?
+                     @MessagePath.issueWarning(980, responseObj, inContext)
+                     return nil
+                  end
+
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intProcessReport = intMetadataClass.newProcessStepReport
+
+                  outContext = 'process step report'
+                  outContext = inContext + ' > ' + outContext unless inContext.nil?
+
+                  # process step report - name (required)
+                  if hReport.has_key?('name')
+                     unless hReport['name'] == ''
+                        intProcessReport[:name] = hReport['name']
+                     end
+                  end
+                  if intProcessReport[:name].nil?
+                     @MessagePath.issueWarning(981, responseObj, inContext)
+                  end
+
+                  # process step report - description
+                  if hReport.has_key?('description')
+                     unless hReport['description'] == ''
+                        intProcessReport[:description] = hReport['description']
+                     end
+                  end
+
+                  # process step report - file type
+                  if hReport.has_key?('fileType')
+                     unless hReport['fileType'] == ''
+                        intProcessReport[:fileType] = hReport['fileType']
+                     end
+                  end
+
+                  return intProcessReport
+
+               end
+
+            end
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_processStep.rb

@@ -2,6 +2,7 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
+#  Stan Smith 2019-09-23 add LE_Source elements
 #  Stan Smith 2018-06-22 refactored error and warning messaging
 #  Stan Smith 2017-08-30 added support for process step sources
 #  Stan Smith 2016-10-15 refactored for mdJson 2.0
@@ -14,6 +15,9 @@ require_relative 'module_timePeriod'
 require_relative 'module_responsibleParty'
 require_relative 'module_citation'
 require_relative 'module_scope'
+require_relative 'module_source'
+require_relative 'module_processing'
+require_relative 'module_processReport'
 
 module ADIWG
    module Mdtranslator
@@ -48,9 +52,11 @@ module ADIWG
 
                   # process step - description - (required)
                   if hProcStep.has_key?('description')
-                     intProcStep[:description] = hProcStep['description']
+                     unless hProcStep['description'] == ''
+                        intProcStep[:description] = hProcStep['description']
+                     end
                   end
-                  if intProcStep[:description].nil? || intProcStep[:description] == ''
+                  if intProcStep[:description].nil?
                      @MessagePath.issueError(641, responseObj, inContext)
                   end
 
@@ -63,16 +69,15 @@ module ADIWG
 
                   # process step - time period
                   if hProcStep.has_key?('timePeriod')
-                     hObject = hProcStep['timePeriod']
-                     unless hObject.empty?
-                        hReturn = TimePeriod.unpack(hObject, responseObj, outContext)
+                     unless hProcStep['timePeriod'].empty?
+                        hReturn = TimePeriod.unpack(hProcStep['timePeriod'], responseObj, outContext)
                         unless hReturn.nil?
                            intProcStep[:timePeriod] = hReturn
                         end
                      end
                   end
 
-                  # process step - step processors [responsible party]
+                  # process step - step processors [] {responsibility}
                   if hProcStep.has_key?('processor')
                      aProc = hProcStep['processor']
                      aProc.each do |item|
@@ -83,7 +88,7 @@ module ADIWG
                      end
                   end
 
-                  # process step - reference [citation]
+                  # process step - reference [] {citation}
                   if hProcStep.has_key?('reference')
                      aReference = hProcStep['reference']
                      aReference.each do |item|
@@ -94,7 +99,7 @@ module ADIWG
                      end
                   end
 
-                  # process step - step sources [source]
+                  # process step - step sources [] {source}
                   if hProcStep.has_key?('stepSource')
                      aSources = hProcStep['stepSource']
                      aSources.each do |item|
@@ -105,7 +110,7 @@ module ADIWG
                      end
                   end
 
-                  # process step - step products [source]
+                  # process step - step products [] {source}
                   if hProcStep.has_key?('stepProduct')
                      aSources = hProcStep['stepProduct']
                      aSources.each do |item|
@@ -127,6 +132,38 @@ module ADIWG
                      end
                   end
 
+                  # process step - output [] {source}
+                  if hProcStep.has_key?('output')
+                     aSources = hProcStep['output']
+                     aSources.each do |item|
+                        hSource = Source.unpack(item, responseObj, outContext)
+                        unless hSource.nil?
+                           intProcStep[:output] << hSource
+                        end
+                     end
+                  end
+
+                  # process step - processing information {processing}
+                  if hProcStep.has_key?('processingInformation')
+                     unless hProcStep['processingInformation'].empty?
+                        hReturn = Processing.unpack(hProcStep['processingInformation'], responseObj, outContext)
+                        unless hReturn.nil?
+                           intProcStep[:processingInformation] = hReturn
+                        end
+                     end
+                  end
+
+                  # process step - report [] {processReport}
+                  if hProcStep.has_key?('report')
+                     aReports = hProcStep['report']
+                     aReports.each do |item|
+                        hReport = ProcessStepReport.unpack(item, responseObj, outContext)
+                        unless hReport.nil?
+                           intProcStep[:reports] << hReport
+                        end
+                     end
+                  end
+
                   return intProcStep
 
                end