adiwg-mdtranslator 1.2.1 → 1.3.0

data/lib/adiwg/mdtranslator/readers/mdJson/modules_v1/module_coverageInfo.rb

@@ -0,0 +1,83 @@
+# unpack coverage information
+# Reader - ADIwg JSON V1 to internal data structure
+
+# History:
+# 	Stan Smith 2015-08-19 original script
+
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_resourceIdentifier')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_coverageItem')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_imageInfo')
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module CoverageInfo
+
+                    def self.unpack(hCoverage, responseObj)
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        hCover = intMetadataClass.newCoverageInfo
+
+                        # coverage information - coverage type
+                        if hCoverage.has_key?('coverageType')
+                            s = hCoverage['coverageType']
+                            if s != ''
+                                hCover[:coverageType] = s
+                            end
+                        end
+
+                        # coverage information - coverage name
+                        if hCoverage.has_key?('coverageName')
+                            s = hCoverage['coverageName']
+                            if s != ''
+                                hCover[:coverageName] = s
+                            end
+                        end
+
+                        # coverage information - coverage description
+                        if hCoverage.has_key?('coverageDescription')
+                            s = hCoverage['coverageDescription']
+                            if s != ''
+                                hCover[:coverageDescription] = s
+                            end
+                        end
+
+                        # coverage information - processing level - identifier
+                        if hCoverage.has_key?('processingLevel')
+                            hProcess = hCoverage['processingLevel']
+                            if !hProcess.empty?
+                                hCover[:processingLevel] = ResourceIdentifier.unpack(hProcess, responseObj)
+                            end
+                        end
+
+                        # coverage information - coverage items
+                        if hCoverage.has_key?('coverageItem')
+                            aCoverItems = hCoverage['coverageItem']
+                            aCoverItems.each do |hCoverItem|
+                                if !hCoverItem.empty?
+                                    hCover[:coverageItems] << CoverageItem.unpack(hCoverItem, responseObj)
+                                end
+                            end
+                        end
+
+                        # coverage information - image information
+                        if hCoverage.has_key?('imageInfo')
+                            hImageInfo = hCoverage['imageInfo']
+                            if !hImageInfo.empty?
+                                hCover[:imageInfo] = ImageInfo.unpack(hImageInfo, responseObj)
+                            end
+                        end
+
+                        return hCover
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end

data/lib/adiwg/mdtranslator/readers/mdJson/modules_v1/module_coverageItem.rb

@@ -0,0 +1,136 @@
+# unpack coverage item
+# Reader - ADIwg JSON V1 to internal data structure
+
+# History:
+# 	Stan Smith 2015-08-19 original script
+
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_sensorInfo')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_classedData')
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module CoverageItem
+
+                    def self.unpack(hCoverItem, responseObj)
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        hCovItem = intMetadataClass.newCoverageItem
+
+                        # coverage item - item name
+                        if hCoverItem.has_key?('itemName')
+                            s = hCoverItem['itemName']
+                            if s != ''
+                                hCovItem[:itemName] = s
+                            end
+                        end
+
+                        # coverage item - item type
+                        if hCoverItem.has_key?('itemType')
+                            s = hCoverItem['itemType']
+                            if s != ''
+                                hCovItem[:itemType] = s
+                            end
+                        end
+
+                        # coverage item - item description
+                        if hCoverItem.has_key?('itemDescription')
+                            s = hCoverItem['itemDescription']
+                            if s != ''
+                                hCovItem[:itemDescription] = s
+                            end
+                        end
+
+                        # coverage item - minimum value
+                        if hCoverItem.has_key?('minValue')
+                            s = hCoverItem['minValue']
+                            if s != ''
+                                hCovItem[:minValue] = s
+                            end
+                        end
+
+                        # coverage item - maximum value
+                        if hCoverItem.has_key?('maxValue')
+                            s = hCoverItem['maxValue']
+                            if s != ''
+                                hCovItem[:maxValue] = s
+                            end
+                        end
+
+                        # coverage item - value units
+                        if hCoverItem.has_key?('units')
+                            s = hCoverItem['units']
+                            if s != ''
+                                hCovItem[:units] = s
+                            end
+                        end
+
+                        # coverage item - scale factor
+                        if hCoverItem.has_key?('scaleFactor')
+                            s = hCoverItem['scaleFactor']
+                            if s != ''
+                                hCovItem[:scaleFactor] = s
+                            end
+                        end
+
+                        # coverage item - offset
+                        if hCoverItem.has_key?('offset')
+                            s = hCoverItem['offset']
+                            if s != ''
+                                hCovItem[:offset] = s
+                            end
+                        end
+
+                        # coverage item - mean value
+                        if hCoverItem.has_key?('meanValue')
+                            s = hCoverItem['meanValue']
+                            if s != ''
+                                hCovItem[:meanValue] = s
+                            end
+                        end
+
+                        # coverage item - standard deviation
+                        if hCoverItem.has_key?('standardDeviation')
+                            s = hCoverItem['standardDeviation']
+                            if s != ''
+                                hCovItem[:standardDeviation] = s
+                            end
+                        end
+
+                        # coverage item - bits per value
+                        if hCoverItem.has_key?('bitsPerValue')
+                            s = hCoverItem['bitsPerValue']
+                            if s != ''
+                                hCovItem[:bitsPerValue] = s
+                            end
+                        end
+
+                        # coverage item - classified data
+                        if hCoverItem.has_key?('classifiedData')
+                            hClassData = hCoverItem['classifiedData']
+                            if !hClassData.empty?
+                                hCovItem[:classedData] = ClassedData.unpack(hClassData, responseObj)
+                            end
+                        end
+
+                        # coverage item - sensor info
+                        if hCoverItem.has_key?('sensorInfo')
+                            hSensorInfo = hCoverItem['sensorInfo']
+                            if !hSensorInfo.empty?
+                                hCovItem[:sensorInfo] = SensorInfo.unpack(hSensorInfo, responseObj)
+                            end
+                        end
+
+                        return hCovItem
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end

data/lib/adiwg/mdtranslator/readers/mdJson/{modules_1.0 → modules_v1}/module_dataDictionary.rb

@@ -4,10 +4,12 @@
 # History:
 # 	Stan Smith 2014-12-01 original script
 #   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
+#   Stan Smith 2015-07-14 refactored to remove global namespace constants
 
-require $ReaderNS.readerModule('module_dictionaryInfo')
-require $ReaderNS.readerModule('module_domain')
-require $ReaderNS.readerModule('module_entity')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_dictionaryInfo')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_domain')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_entity')
 
 module ADIWG
     module Mdtranslator
@@ -16,7 +18,7 @@ module ADIWG
 
                 module DataDictionary
 
-                    def self.unpack(hDictionary)
+                    def self.unpack(hDictionary, responseObj)
 
                         # instance classes needed in script
                         intMetadataClass = InternalMetadata.new
@@ -27,7 +29,7 @@ module ADIWG
                             # data dictionary - dictionary information
                             if hDictionary.has_key?('dictionaryInfo')
                                 hDictInfo = hDictionary['dictionaryInfo']
-                                intDict[:dictionaryInfo] = $ReaderNS::DictionaryInfo.unpack(hDictInfo)
+                                intDict[:dictionaryInfo] = DictionaryInfo.unpack(hDictInfo, responseObj)
                             end
 
                             # data dictionary - domains
@@ -35,7 +37,7 @@ module ADIWG
                                 aDomains = hDictionary['domain']
                                 aDomains.each do |hDomain|
                                     unless hDomain.empty?
-                                        intDict[:domains] << $ReaderNS::Domain.unpack(hDomain)
+                                        intDict[:domains] << Domain.unpack(hDomain, responseObj)
                                     end
                                 end
                             end
@@ -45,7 +47,7 @@ module ADIWG
                                 aEntities = hDictionary['entity']
                                 aEntities.each do |hEntity|
                                     unless hEntity.empty?
-                                        intDict[:entities] << $ReaderNS::Entity.unpack(hEntity)
+                                        intDict[:entities] << Entity.unpack(hEntity, responseObj)
                                     end
                                 end
                             end

data/lib/adiwg/mdtranslator/readers/mdJson/{modules_1.0 → modules_v1}/module_dataQuality.rb

@@ -5,8 +5,10 @@
 # 	Stan Smith 2013-11-26 original script
 #   Stan Smith 2014-07-03 resolve require statements using Mdtranslator.reader_module
 #   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
+#   Stan Smith 2015-07-14 refactored to remove global namespace constants
 
-require $ReaderNS.readerModule('module_lineage')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_lineage')
 
 module ADIWG
     module Mdtranslator
@@ -15,7 +17,11 @@ module ADIWG
 
                 module DataQuality
 
-                    def self.unpack(hDataQual)
+                    def self.unpack(hDataQual, responseObj)
+
+                        # return nil object if input is empty
+                        intDataQual = nil
+                        return if hDataQual.empty?
 
                         # instance classes needed in script
                         intMetadataClass = InternalMetadata.new
@@ -26,7 +32,15 @@ module ADIWG
                             s = hDataQual['scope']
                             if s != ''
                                 intDataQual[:dataScope] = s
+                            else
+                                responseObj[:readerExecutionPass] =  false
+                                responseObj[:readerExecutionMessages] << 'dataQuality: {scope: } is blank.'
+                                return nil
                             end
+                        else
+                            responseObj[:readerExecutionPass] =  false
+                            responseObj[:readerExecutionMessages] << 'dataQuality: {scope: } is missing.'
+                            return nil
                         end
 
                         # data quality - report
@@ -36,7 +50,7 @@ module ADIWG
                         if hDataQual.has_key?('lineage')
                             hLineage = hDataQual['lineage']
                             unless hLineage.empty?
-                                intDataQual[:dataLineage] = $ReaderNS::Lineage.unpack(hLineage)
+                                intDataQual[:dataLineage] = Lineage.unpack(hLineage, responseObj)
                             end
                         end
 

data/lib/adiwg/mdtranslator/readers/mdJson/{modules_1.0 → modules_v1}/module_dateTime.rb

@@ -4,6 +4,8 @@
 # History:
 # 	Stan Smith 2013-12-11 original script
 #   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
+#   Stan Smith 2015-07-14 refactored to remove global namespace constants
 
 require 'adiwg/mdtranslator/internal/module_dateTimeFun'
 
@@ -14,7 +16,7 @@ module ADIWG
 
                 module DateTime
 
-                    def self.unpack(sDateTime)
+                    def self.unpack(sDateTime, responseObj)
 
                         # instance classes needed in script
                         intMetadataClass = InternalMetadata.new

data/lib/adiwg/mdtranslator/readers/mdJson/{modules_1.0 → modules_v1}/module_descriptiveKeyword.rb

@@ -8,8 +8,11 @@
 #   Stan Smith 2014-08-21 removed thesaurus link; replaced by onlineResource to citation
 #   Stan Smith 2014-08-21 removed extra level of encapsulation "citation" under "thesaurus"
 #   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
+#   Stan Smith 2015-07-14 refactored to remove global namespace constants
+#   Stan Smith 2015-08-24 added return if input hash is empty
 
-require $ReaderNS.readerModule('module_citation')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_citation')
 
 module ADIWG
     module Mdtranslator
@@ -18,7 +21,11 @@ module ADIWG
 
                 module DescriptiveKeyword
 
-                    def self.unpack(hDesKeyword)
+                    def self.unpack(hDesKeyword, responseObj)
+
+                        # return nil object if input is empty
+                        intKeyword = nil
+                        return if hDesKeyword.empty?
 
                         # instance classes needed in script
                         intMetadataClass = InternalMetadata.new
@@ -27,9 +34,19 @@ module ADIWG
                         # descriptive keyword - keyword array
                         if hDesKeyword.has_key?('keyword')
                             aKeywords = hDesKeyword['keyword']
-                            aKeywords.each do |keyword|
-                                intKeyword[:keyword] << keyword
+                            if aKeywords.length > 0
+                                aKeywords.each do |keyword|
+                                    intKeyword[:keyword] << keyword
+                                end
+                            else
+                                responseObj[:readerExecutionMessages] << 'Keyword list is empty'
+                                responseObj[:readerExecutionPass] = false
+                                return nil
                             end
+                        else
+                            responseObj[:readerExecutionMessages] << 'Keyword list is missing'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
                         end
 
                         # descriptive keyword - keyType
@@ -44,7 +61,7 @@ module ADIWG
                         if hDesKeyword.has_key?('thesaurus')
                             hCitation = hDesKeyword['thesaurus']
                             unless hCitation.empty?
-                                intKeyword[:keyTheCitation] = $ReaderNS::Citation.unpack(hCitation)
+                                intKeyword[:keyTheCitation] = Citation.unpack(hCitation, responseObj)
                             end
 
                         end

data/lib/adiwg/mdtranslator/readers/mdJson/{modules_1.0 → modules_v1}/module_dictionaryInfo.rb

@@ -4,8 +4,11 @@
 # History:
 # 	Stan Smith 2013-12-01 original script
 #   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
+#   Stan Smith 2015-07-14 refactored to remove global namespace constants
+#   Stan Smith 2015-07-24 added error reporting of missing items
 
-require $ReaderNS.readerModule('module_citation')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_citation')
 
 module ADIWG
     module Mdtranslator
@@ -14,7 +17,7 @@ module ADIWG
 
                 module DictionaryInfo
 
-                    def self.unpack(hDictInfo)
+                    def self.unpack(hDictInfo, responseObj)
 
                         # return nil object if input is empty
                         intDictInfo = nil
@@ -28,7 +31,11 @@ module ADIWG
                         if hDictInfo.has_key?('citation')
                             hCitation = hDictInfo['citation']
                             unless hCitation.empty?
-                                intDictInfo[:dictCitation] = $ReaderNS::Citation.unpack(hCitation)
+                                intDictInfo[:dictCitation] = Citation.unpack(hCitation, responseObj)
+                            else
+                                responseObj[:readerExecutionMessages] << 'Data Dictionary citation is missing'
+                                responseObj[:readerExecutionPass] = false
+                                return nil
                             end
                         end
 
@@ -37,6 +44,10 @@ module ADIWG
                             s = hDictInfo['description']
                             if s != ''
                                 intDictInfo[:dictDescription] = s
+                            else
+                                responseObj[:readerExecutionMessages] << 'Data Dictionary description is missing'
+                                responseObj[:readerExecutionPass] = false
+                                return nil
                             end
                         end
 
@@ -45,6 +56,10 @@ module ADIWG
                             s = hDictInfo['resourceType']
                             if s != ''
                                 intDictInfo[:dictResourceType] = s
+                            else
+                                responseObj[:readerExecutionMessages] << 'Data Dictionary resource type is missing'
+                                responseObj[:readerExecutionPass] = false
+                                return nil
                             end
                         end