adiwg-mdtranslator 1.4.0 → 2.0.0rc2

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

@@ -0,0 +1,151 @@
+# unpack a data dictionary
+# Reader - ADIwg JSON to internal data structure
+
+# History:
+#   Stan Smith 2017-01-20 refactored for mdJson/mdTranslator 2.0
+#   Stan Smith 2015-07-14 refactored to remove global namespace constants
+#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
+#   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+# 	Stan Smith 2014-12-01 original script
+
+require_relative 'module_citation'
+require_relative 'module_domain'
+require_relative 'module_entity'
+require_relative 'module_locale'
+require_relative 'module_responsibleParty'
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module DataDictionary
+
+                    def self.unpack(hDictionary, responseObj)
+
+                        # return nil object if input is empty
+                        if hDictionary.empty?
+                            responseObj[:readerExecutionMessages] << 'Data Dictionary object is empty'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intDictionary = intMetadataClass.newDataDictionary
+
+                        # dictionary - citation (required by mdJson) {citation}
+                        if hDictionary.has_key?('citation')
+                            hCitation = hDictionary['citation']
+                            unless hCitation.empty?
+                                hReturn = Citation.unpack(hCitation, responseObj)
+                                unless hReturn.nil?
+                                    intDictionary[:citation] = hReturn
+                                end
+                            end
+                        end
+                        if intDictionary[:citation].empty?
+                            responseObj[:readerExecutionMessages] << 'Data Dictionary citation is empty'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # dictionary - subject [] (required)
+                        if hDictionary.has_key?('subject')
+                            aSubjects = hDictionary['subject']
+                            aSubjects.each do |item|
+                                if item != ''
+                                    intDictionary[:subjects] << item
+                                end
+                            end
+                        end
+                        if intDictionary[:subjects].empty?
+                            responseObj[:readerExecutionMessages] << 'Data Dictionary subject is missing'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # dictionary - recommended use []
+                        if hDictionary.has_key?('recommendedUse')
+                            aUses = hDictionary['recommendedUse']
+                            aUses.each do |item|
+                                if item != ''
+                                    intDictionary[:recommendedUses] << item
+                                end
+                            end
+                        end
+
+                        # dictionary - locale [] {locale}
+                        if hDictionary.has_key?('locale')
+                            aLocales = hDictionary['locale']
+                            aLocales.each do |hItem|
+                                hReturn = Locale.unpack(hItem, responseObj)
+                                unless hReturn.nil?
+                                    intDictionary[:locales] << hReturn
+                                end
+                            end
+                        end
+
+                        # dictionary - responsible party (required) {responsibleParty}
+                        if hDictionary.has_key?('responsibleParty')
+                            hRParty = hDictionary['responsibleParty']
+                            unless hRParty.empty?
+                                hReturn = ResponsibleParty.unpack(hRParty, responseObj)
+                                unless hReturn.nil?
+                                    intDictionary[:responsibleParty] = hReturn
+                                end
+                            end
+                        end
+                        if intDictionary[:responsibleParty].empty?
+                            responseObj[:readerExecutionMessages] << 'Data Dictionary responsible party is empty'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # dictionary - dictionary format
+                        if hDictionary.has_key?('dictionaryFormat')
+                            s = hDictionary['dictionaryFormat']
+                            unless s == ''
+                                intDictionary[:dictionaryFormat] = s
+                            end
+                        end
+
+                        # dictionary - dictionary included with resource
+                        if hDictionary.has_key?('dictionaryIncludedWithResource')
+                            if hDictionary['dictionaryIncludedWithResource'] === true
+                                intDictionary[:includedWithDataset] = hDictionary['dictionaryIncludedWithResource']
+                            end
+                        end
+
+                        # dictionary - domains [] {domain}
+                        if hDictionary.has_key?('domain')
+                            aDomains = hDictionary['domain']
+                            aDomains.each do |hItem|
+                                hReturn = Domain.unpack(hItem, responseObj)
+                                unless hReturn.nil?
+                                    intDictionary[:domains] << hReturn
+                                end
+                            end
+                        end
+
+                        # dictionary - entity [] {entity}
+                        if hDictionary.has_key?('entity')
+                            aEntities = hDictionary['entity']
+                            aEntities.each do |hItem|
+                                hReturn = Entity.unpack(hItem, responseObj)
+                                unless hReturn.nil?
+                                    intDictionary[:entities] << hReturn
+                                end
+                            end
+                        end
+
+                        return intDictionary
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,74 @@
+# unpack date
+# Reader - ADIwg JSON data structure
+
+# History:
+#   Stan Smith 2016-10-12 original script
+
+require 'adiwg/mdtranslator/internal/module_dateTimeFun'
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module Date
+
+                    def self.unpack(hDate, responseObj)
+
+                        # return nil object if input is empty
+                        if hDate.empty?
+                            responseObj[:readerExecutionMessages] << 'Date object is empty'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intDate = intMetadataClass.newDate
+
+                        # date - date (required)
+                        # if dateTimeFromString fails, [0] = nil; [1] = 'ERROR'
+                        if hDate.has_key?('date') && hDate['date'] != ''
+                            aDateTimeReturn = AdiwgDateTimeFun.dateTimeFromString(hDate['date'])
+                            if aDateTimeReturn[1] == 'ERROR'
+                                responseObj[:readerExecutionMessages] << 'Date string is invalid'
+                                responseObj[:readerExecutionPass] = false
+                                return nil
+                            else
+                                intDate[:date] = aDateTimeReturn[0]
+                                intDate[:dateResolution] = aDateTimeReturn[1]
+                            end
+                        else
+                            responseObj[:readerExecutionMessages] << 'Date string is missing'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # date - date type (required)
+                        if hDate.has_key?('dateType')
+                            intDate[:dateType] = hDate['dateType']
+                        end
+                        if intDate[:dateType].nil? || intDate[:dateType] == ''
+                            responseObj[:readerExecutionMessages] << 'Date attribute dateType is missing'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # date - description
+                        if hDate.has_key?('description')
+                            s = hDate['description']
+                            unless s == ''
+                                intDate[:description] = s
+                            end
+                        end
+
+                        return intDate
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end

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

@@ -2,10 +2,11 @@
 # Reader - ADIwg JSON V1 to internal data structure
 
 # History:
-# 	Stan Smith 2013-12-11 original script
+#   Stan Smith 2016-10-05 refactored for mdJson 2.0
 #   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 2013-12-11 original script
 
 require 'adiwg/mdtranslator/internal/module_dateTimeFun'
 
@@ -18,15 +19,28 @@ module ADIWG
 
                     def self.unpack(sDateTime, responseObj)
 
+                        # return nil object if input is empty
+                        if sDateTime == ''
+                            responseObj[:readerExecutionMessages] << 'DateTime string is empty'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
                         # instance classes needed in script
                         intMetadataClass = InternalMetadata.new
-
-                        # dateTime
                         intDateTime = intMetadataClass.newDateTime
 
+                        # dateTime - dateTime (required)
+                        # if dateTimeFromString fails, [0] = nil; [1] = 'ERROR'
                         aDateTimeReturn = AdiwgDateTimeFun.dateTimeFromString(sDateTime)
-                        intDateTime[:dateTime] = aDateTimeReturn[0]
-                        intDateTime[:dateResolution] = aDateTimeReturn[1]
+                        if aDateTimeReturn[1] == 'ERROR'
+                            responseObj[:readerExecutionMessages] << 'DateTime string is invalid'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        else
+                            intDateTime[:dateTime] = aDateTimeReturn[0]
+                            intDateTime[:dateResolution] = aDateTimeReturn[1]
+                        end
 
                         return intDateTime
 

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

@@ -0,0 +1,87 @@
+# unpack additional documentation
+# Reader - ADIwg JSON to internal dimension
+
+# History:
+# 	Stan Smith 2016-10-18 original script
+
+require_relative 'module_measure'
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module Dimension
+
+                    def self.unpack(hDimension, responseObj)
+
+                        # return nil object if input is empty
+                        if hDimension.empty?
+                            responseObj[:readerExecutionMessages] << 'Dimension object is empty'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intDimension = intMetadataClass.newDimension
+
+                        # dimension - dimension type (required)
+                        if hDimension.has_key?('dimensionType')
+                            if hDimension['dimensionType'] != ''
+                                intDimension[:dimensionType] = hDimension['dimensionType']
+                            end
+                        end
+                        if intDimension[:dimensionType].nil?
+                            responseObj[:readerExecutionMessages] << 'Dimension is missing dimensionType'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # dimension - dimension size (required)
+                        if hDimension.has_key?('dimensionSize')
+                            if hDimension['dimensionSize'] != ''
+                                intDimension[:dimensionSize] = hDimension['dimensionSize']
+                            end
+                        end
+                        if intDimension[:dimensionSize].nil?
+                            responseObj[:readerExecutionMessages] << 'Dimension is missing dimensionSize'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # dimension - resolution {measure}
+                        if hDimension.has_key?('resolution')
+                            hObject = hDimension['resolution']
+                            unless hObject.empty?
+                                hReturn = Measure.unpack(hObject, responseObj)
+                                unless hReturn.nil?
+                                    intDimension[:resolution] = hReturn
+                                end
+                            end
+                        end
+
+                        # dimension - dimension title
+                        if hDimension.has_key?('dimensionTitle')
+                            if hDimension['dimensionTitle'] != ''
+                                intDimension[:dimensionTitle] = hDimension['dimensionTitle']
+                            end
+                        end
+
+                        # dimension - dimension description
+                        if hDimension.has_key?('dimensionDescription')
+                            if hDimension['dimensionDescription'] != ''
+                                intDimension[:dimensionDescription] = hDimension['dimensionDescription']
+                            end
+                        end
+
+                        return intDimension
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,56 @@
+# unpack distribution
+# Reader - ADIwg JSON to internal data structure
+
+# History:
+#   Stan Smith 2016-10-21 original script
+
+require_relative 'module_distributor'
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module Distribution
+
+                    def self.unpack(hDistribution, responseObj)
+
+                        # return nil object if input is empty
+                        if hDistribution.empty?
+                            responseObj[:readerExecutionMessages] << 'Distribution object is empty'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intDistribution = intMetadataClass.newDistribution
+
+                        # distribution - description
+                        if hDistribution.has_key?('description')
+                            if hDistribution['description'] != ''
+                                intDistribution[:description] = hDistribution['description']
+                            end
+                        end
+
+                        # distribution - distributor [distributor]
+                        if hDistribution.has_key?('distributor')
+                            aItems = hDistribution['distributor']
+                            aItems.each do |item|
+                                hReturn = Distributor.unpack(item, responseObj)
+                                unless hReturn.nil?
+                                    intDistribution[:distributor] << hReturn
+                                end
+                            end
+                        end
+
+                        return intDistribution
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,78 @@
+# unpack distributor
+# Reader - ADIwg JSON to internal data structure
+
+# History:
+#   Stan Smith 2016-10-21 original script
+
+require_relative 'module_responsibleParty'
+require_relative 'module_orderProcess'
+require_relative 'module_transferOption'
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module Distributor
+
+                    def self.unpack(hDistrib, responseObj)
+
+                        # return nil object if input is empty
+                        if hDistrib.empty?
+                            responseObj[:readerExecutionMessages] << 'Distributor object is empty'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intDistrib = intMetadataClass.newDistributor
+
+                        # distributor - contact {responsibleParty} (required)
+                        if hDistrib.has_key?('contact')
+                            hObject = hDistrib['contact']
+                            unless hObject.empty?
+                                hReturn = ResponsibleParty.unpack(hObject, responseObj)
+                                unless hReturn.nil?
+                                    intDistrib[:contact] = hReturn
+                                end
+                            end
+                        end
+                        if intDistrib[:contact].empty?
+                            responseObj[:readerExecutionMessages] << 'Distributor object is missing contact'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # distributor - order process [orderProcess]
+                        if hDistrib.has_key?('orderProcess')
+                            aItems = hDistrib['orderProcess']
+                            aItems.each do |item|
+                                hReturn = OrderProcess.unpack(item, responseObj)
+                                unless hReturn.nil?
+                                    intDistrib[:orderProcess] << hReturn
+                                end
+                            end
+                        end
+
+                        # distributor - transfer options [transferOption]
+                        if hDistrib.has_key?('transferOption')
+                            aItemss = hDistrib['transferOption']
+                            aItemss.each do |item|
+                                hReturn = TransferOption.unpack(item, responseObj)
+                                unless hReturn.nil?
+                                    intDistrib[:transferOptions] << hReturn
+                                end
+                            end
+                        end
+
+                        return intDistrib
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,95 @@
+# unpack a data dictionary domain
+# Reader - ADIwg JSON V1 to internal data structure
+
+# History:
+#   Stan Smith 2016-10-07 refactored for mdJson 2.0
+#   Stan Smith 2015-07-23 added error reporting of missing items
+#   Stan Smith 2015-07-14 refactored to remove global namespace constants
+#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
+#   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+# 	Stan Smith 2013-12-01 original script
+
+require_relative 'module_domainItem'
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module Domain
+
+                    def self.unpack(hDomain, responseObj)
+
+                        # return nil object if input is empty
+                        if hDomain.empty?
+                            responseObj[:readerExecutionMessages] << 'Domain Member object is empty'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intDomain = intMetadataClass.newDictionaryDomain
+
+                        # data dictionary domain - id (required)
+                        if hDomain.has_key?('domainId')
+                            intDomain[:domainId] = hDomain['domainId']
+                        end
+                        if intDomain[:domainId].nil? || intDomain[:domainId] == ''
+                            responseObj[:readerExecutionMessages] << 'Data Dictionary domain ID is missing'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # data dictionary domain - name
+                        if hDomain.has_key?('commonName')
+                            if hDomain['commonName'] != ''
+                                intDomain[:domainName] = hDomain['commonName']
+                            end
+                        end
+
+                        # data dictionary domain - code (required)
+                        if hDomain.has_key?('codeName')
+                            intDomain[:domainCode] = hDomain['codeName']
+                        end
+                        if intDomain[:domainCode].nil? || intDomain[:domainCode] == ''
+                            responseObj[:readerExecutionMessages] << 'Data Dictionary domain code name is missing'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # data dictionary domain - description (required)
+                        if hDomain.has_key?('description')
+                            intDomain[:domainDescription] = hDomain['description']
+                        end
+                        if intDomain[:domainDescription].nil? || intDomain[:domainDescription] == ''
+                            responseObj[:readerExecutionMessages] << 'Data Dictionary domain description is missing'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # data dictionary domain - items [] (required)
+                        if hDomain.has_key?('domainItem')
+                            hDomain['domainItem'].each do |item|
+                                hDom = DomainItem.unpack(item, responseObj)
+                                unless hDom.nil?
+                                    intDomain[:domainItems] << hDom
+                                end
+                            end
+                        end
+                        if intDomain[:domainItems].empty?
+                            responseObj[:readerExecutionMessages] << 'Data Dictionary domain has no domain items'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        return intDomain
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,70 @@
+# unpack a data dictionary domain item
+# Reader - ADIwg JSON V1 to internal data structure
+
+# History:
+#   Stan Smith 2016-10-07 refactored for mdJson 2.0
+#   Stan Smith 2015-07-23 added error reporting of missing items
+#   Stan Smith 2015-07-14 refactored to remove global namespace constants
+#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
+#   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+# 	Stan Smith 2013-12-01 original script
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module DomainItem
+
+                    def self.unpack(hDomItem, responseObj)
+
+                        # return nil object if input is empty
+                        if hDomItem.empty?
+                            responseObj[:readerExecutionMessages] << 'Domain Member object is empty'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intItem = intMetadataClass.newDomainItem
+
+                        # data dictionary domain item - name (required)
+                        if hDomItem.has_key?('name')
+                            intItem[:itemName] = hDomItem['name']
+                        end
+                        if intItem[:itemName].nil? || intItem[:itemName] == ''
+                            responseObj[:readerExecutionMessages] << 'Data Dictionary domain item name is missing'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # data dictionary domain item - value (required)
+                        if hDomItem.has_key?('value')
+                            intItem[:itemValue] = hDomItem['value']
+                        end
+                        if intItem[:itemValue].nil? || intItem[:itemValue] == ''
+                            responseObj[:readerExecutionMessages] << 'Data Dictionary domain item value is missing'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # data dictionary domain item - definition (required)
+                        if hDomItem.has_key?('definition')
+                            intItem[:itemDefinition] = hDomItem['definition']
+                        end
+                        if intItem[:itemDefinition].nil? || intItem[:itemDefinition] == ''
+                            responseObj[:readerExecutionMessages] << 'Data Dictionary domain item definition is missing'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        return intItem
+                    end
+
+                end
+
+            end
+        end
+    end
+end