adiwg-mdtranslator 1.4.0 → 2.0.0rc2

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

@@ -1,65 +0,0 @@
-# unpack a data dictionary
-# Reader - ADIwg JSON V1 to internal data structure
-
-# 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 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
-        module Readers
-            module MdJson
-
-                module DataDictionary
-
-                    def self.unpack(hDictionary, responseObj)
-
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intDict = intMetadataClass.newDataDictionary
-
-                        unless hDictionary.empty?
-
-                            # data dictionary - dictionary information
-                            if hDictionary.has_key?('dictionaryInfo')
-                                hDictInfo = hDictionary['dictionaryInfo']
-                                intDict[:dictionaryInfo] = DictionaryInfo.unpack(hDictInfo, responseObj)
-                            end
-
-                            # data dictionary - domains
-                            if hDictionary.has_key?('domain')
-                                aDomains = hDictionary['domain']
-                                aDomains.each do |hDomain|
-                                    unless hDomain.empty?
-                                        intDict[:domains] << Domain.unpack(hDomain, responseObj)
-                                    end
-                                end
-                            end
-
-                            # data dictionary - entity
-                            if hDictionary.has_key?('entity')
-                                aEntities = hDictionary['entity']
-                                aEntities.each do |hEntity|
-                                    unless hEntity.empty?
-                                        intDict[:entities] << Entity.unpack(hEntity, responseObj)
-                                    end
-                                end
-                            end
-
-                            return intDict
-
-                        end
-
-                    end
-
-                end
-            end
-        end
-    end
-end

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

@@ -1,65 +0,0 @@
-# unpack data quality
-# Reader - ADIwg JSON V1 to internal data structure
-
-# History:
-# 	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 ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_lineage')
-
-module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
-
-                module DataQuality
-
-                    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
-                        intDataQual = intMetadataClass.newDataQuality
-
-                        # data quality - scope
-                        if hDataQual.has_key?('scope')
-                            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
-                        # on hold
-
-                        # data quality - lineage
-                        if hDataQual.has_key?('lineage')
-                            hLineage = hDataQual['lineage']
-                            unless hLineage.empty?
-                                intDataQual[:dataLineage] = Lineage.unpack(hLineage, responseObj)
-                            end
-                        end
-
-                        return intDataQual
-                    end
-
-                end
-
-            end
-        end
-    end
-end

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

@@ -1,77 +0,0 @@
-# unpack descriptive keyword
-# Reader - ADIwg JSON V1 to internal data structure
-
-# History:
-# 	Stan Smith 2013-09-18 original script
-# 	Stan Smith 2013-11-27 modified to process single keyword collection
-#   Stan Smith 2014-07-03 resolve require statements using Mdtranslator.reader_module
-#   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 ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_citation')
-
-module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
-
-                module DescriptiveKeyword
-
-                    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
-                        intKeyword = intMetadataClass.newKeyword
-
-                        # descriptive keyword - keyword array
-                        if hDesKeyword.has_key?('keyword')
-                            aKeywords = hDesKeyword['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
-                        if hDesKeyword.has_key?('keywordType')
-                            s = hDesKeyword['keywordType']
-                            if s != ''
-                                intKeyword[:keywordType] = s
-                            end
-                        end
-
-                        # descriptive keyword - thesaurus
-                        if hDesKeyword.has_key?('thesaurus')
-                            hCitation = hDesKeyword['thesaurus']
-                            unless hCitation.empty?
-                                intKeyword[:keyTheCitation] = Citation.unpack(hCitation, responseObj)
-                            end
-
-                        end
-
-                        return intKeyword
-                    end
-
-                end
-
-            end
-        end
-    end
-end

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

@@ -1,82 +0,0 @@
-# unpack data dictionary information section
-# Reader - ADIwg JSON V1 to internal data structure
-
-# 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 ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_citation')
-
-module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
-
-                module DictionaryInfo
-
-                    def self.unpack(hDictInfo, responseObj)
-
-                        # return nil object if input is empty
-                        intDictInfo = nil
-                        return if hDictInfo.empty?
-
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intDictInfo = intMetadataClass.newDictionaryInfo
-
-                        # dictionary info - citation
-                        if hDictInfo.has_key?('citation')
-                            hCitation = hDictInfo['citation']
-                            unless hCitation.empty?
-                                intDictInfo[:dictCitation] = Citation.unpack(hCitation, responseObj)
-                            else
-                                responseObj[:readerExecutionMessages] << 'Data Dictionary citation is missing'
-                                responseObj[:readerExecutionPass] = false
-                                return nil
-                            end
-                        end
-
-                        # dictionary info - description
-                        if hDictInfo.has_key?('description')
-                            s = hDictInfo['description']
-                            if s != ''
-                                intDictInfo[:dictDescription] = s
-                            else
-                                responseObj[:readerExecutionMessages] << 'Data Dictionary description is missing'
-                                responseObj[:readerExecutionPass] = false
-                                return nil
-                            end
-                        end
-
-                        # dictionary info - resource type
-                        if hDictInfo.has_key?('resourceType')
-                            s = hDictInfo['resourceType']
-                            if s != ''
-                                intDictInfo[:dictResourceType] = s
-                            else
-                                responseObj[:readerExecutionMessages] << 'Data Dictionary resource type is missing'
-                                responseObj[:readerExecutionPass] = false
-                                return nil
-                            end
-                        end
-
-                        # dictionary info - language
-                        if hDictInfo.has_key?('language')
-                            s = hDictInfo['language']
-                            if s != ''
-                                intDictInfo[:dictLanguage] = s
-                            end
-                        end
-
-                        return intDictInfo
-                    end
-
-                end
-
-            end
-        end
-    end
-end

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

@@ -1,80 +0,0 @@
-# unpack digital transfer option
-# Reader - ADIwg JSON V1 to internal data structure
-
-# History:
-# 	Stan Smith 2015-08-24 original script
-#   Stan Smith 2015-09-18 added distribution formats, transfer size
-
-require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_onlineResource')
-require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_medium')
-require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_resourceFormat')
-
-module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
-
-                module DigitalTransOption
-
-                    def self.unpack(hDigTranOpt, responseObj)
-
-                        # return nil object if input is empty
-                        intDigitalTran = nil
-                        return if hDigTranOpt.empty?
-
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intDigitalTran = intMetadataClass.newDigitalTransOption
-
-                        # distribution transfer options - distribution format []
-                        if hDigTranOpt.has_key?('distributorFormat')
-                            aDistFormat = hDigTranOpt['distributorFormat']
-                            unless aDistFormat.empty?
-                                aDistFormat.each do |hResFormat|
-                                    intDigitalTran[:distFormats] << ResourceFormat.unpack(hResFormat, responseObj)
-                                end
-                            end
-                        end
-
-                        # distribution transfer options - transfer size
-                        if hDigTranOpt.has_key?('transferSize')
-                            s = hDigTranOpt['transferSize']
-                            if s != ''
-                                intDigitalTran[:transferSize] = s
-                            end
-                        end
-
-                        # distribution transfer options - transfer size units
-                        if hDigTranOpt.has_key?('transferSizeUnits')
-                            s = hDigTranOpt['transferSizeUnits']
-                            if s != ''
-                                intDigitalTran[:transferSizeUnits] = s
-                            end
-                        end
-
-                        # distribution transfer options - online []
-                        if hDigTranOpt.has_key?('online')
-                            aOnlineOption = hDigTranOpt['online']
-                            aOnlineOption.each do |hOlOption|
-                                intDigitalTran[:online] << OnlineResource.unpack(hOlOption, responseObj)
-                            end
-                        end
-
-                        # distribution transfer options - offline
-                        if hDigTranOpt.has_key?('offline')
-                            hOfflOption = hDigTranOpt['offline']
-                            if !hOfflOption.empty?
-                                intDigitalTran[:offline] = Medium.unpack(hOfflOption, responseObj)
-
-                            end
-                        end
-
-                        return intDigitalTran
-                    end
-
-                end
-
-            end
-        end
-    end
-end

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

@@ -1,81 +0,0 @@
-# unpack dimension
-# Reader - ADIwg JSON V1 to internal data structure
-
-# History:
-# 	Stan Smith 2015-07-30 original script
-
-module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
-
-                module Dimension
-
-                    def self.unpack(hDimInfo, responseObj)
-
-                        # return nil object if input is empty
-                        intDim = nil
-                        return if hDimInfo.empty?
-
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intDim = intMetadataClass.newDimensionInfo
-
-                        # dimension information - type of dimension - required
-                        if hDimInfo.has_key?('dimensionType')
-                            s = hDimInfo['dimensionType']
-                            if s != ''
-                                intDim[:dimensionType] = s
-                            end
-                        end
-
-                        # dimension information - number of elements along the axis - required
-                        if hDimInfo.has_key?('dimensionSize')
-                            s = hDimInfo['dimensionSize']
-                            if s != ''
-                                intDim[:dimensionSize] = s
-                            end
-                        end
-
-                        # dimension information - degree of detail in the grid
-                        if hDimInfo.has_key?('resolution')
-                            s = hDimInfo['resolution']
-                            if s != ''
-                                intDim[:resolution] = s
-                            end
-                        end
-
-                        # dimension information - units for resolution
-                        if hDimInfo.has_key?('resolutionUnit')
-                            s = hDimInfo['resolutionUnit']
-                            if s != ''
-                                intDim[:resolutionUnits] = s
-                            end
-                        end
-
-                        # dimension information - title for the axis
-                        if hDimInfo.has_key?('dimensionTitle')
-                            s = hDimInfo['dimensionTitle']
-                            if s != ''
-                                intDim[:dimensionTitle] = s
-                            end
-                        end
-
-                        # dimension information - definition of the title
-                        if hDimInfo.has_key?('dimensionDescription')
-                            s = hDimInfo['dimensionDescription']
-                            if s != ''
-                                intDim[:dimensionDescription] = s
-                            end
-                        end
-
-                        return intDim
-
-                    end
-
-                end
-
-            end
-        end
-    end
-end

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

@@ -1,89 +0,0 @@
-# unpack distribution info
-# Reader - ADIwg JSON V1 to internal data structure
-
-# History:
-# 	Stan Smith 2013-09-23 original script
-# 	Stan Smith 2013-11-27 changed to receive single distributor rather than array
-# 	Stan Smith 2013-12-18 changed to unpack contact using responsible party
-#   Stan Smith 2014-05-02 changed to support responsible party as hash, not array
-#   Stan Smith 2014-07-08 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
-#   Stan Smith 2015-08-24 refactored to normalize module; created new modules for
-#   ... distributionOrder, digitalTransferOption, and medium
-
-require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_responsibleParty')
-require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_distributionOrder')
-require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_resourceFormat')
-require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_digitalTransferOption')
-
-module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
-
-                module DistributionInfo
-
-                    def self.unpack(hDistributor, responseObj)
-
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intDistributor = intMetadataClass.newDistributor
-
-
-                        # distributor - distribution contact - required
-                        if hDistributor.has_key?('distributorContact')
-                            hContact = hDistributor['distributorContact']
-                            unless hContact.empty?
-                                intDistributor[:distContact] = ResponsibleParty.unpack(hContact, responseObj)
-                            else
-                                responseObj[:readerExecutionMessages] << 'Distributor contact is empty'
-                                responseObj[:readerExecutionPass] = false
-                                return nil
-                            end
-                        else
-                            responseObj[:readerExecutionMessages] << 'Distributor contact is missing'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        # distributor - distribution order process
-                        if hDistributor.has_key?('distributionOrderProcess')
-                            aDistOrder = hDistributor['distributionOrderProcess']
-                            unless aDistOrder.empty?
-                                aDistOrder.each do |hDistOrder|
-                                    intDistributor[:distOrderProcs] << DistributionOrder.unpack(hDistOrder, responseObj)
-                                end
-                            end
-                        end
-
-                        # distributor - distribution format
-                        if hDistributor.has_key?('distributorFormat')
-                            aDistFormat = hDistributor['distributorFormat']
-                            unless aDistFormat.empty?
-                                aDistFormat.each do |hResFormat|
-                                    intDistributor[:distFormats] << ResourceFormat.unpack(hResFormat, responseObj)
-                                end
-                            end
-                        end
-
-                        # distributor - distribution transfer options
-                        if hDistributor.has_key?('distributorTransferOptions')
-                            aDistTransOpt = hDistributor['distributorTransferOptions']
-                            unless aDistTransOpt.empty?
-                                aDistTransOpt.each do |hDigTranOpt|
-                                    intDistributor[:distTransOptions] << DigitalTransOption.unpack(hDigTranOpt, responseObj)
-                                end
-                            end
-                        end
-
-                        return intDistributor
-                    end
-
-                end
-
-            end
-        end
-    end
-end

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

@@ -1,62 +0,0 @@
-# unpack distribution order process
-# Reader - ADIwg JSON V1 to internal data structure
-
-# History:
-# 	Stan Smith 2015-08-24 original script
-
-require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_dateTime')
-
-module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
-
-                module DistributionOrder
-
-                    def self.unpack(hDistOrder, responseObj)
-
-                        # return nil object if input is empty
-                        intDistOrder = nil
-                        return if hDistOrder.empty?
-
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intDistOrder = intMetadataClass.newDistOrder
-
-                        if hDistOrder.has_key?('fees')
-                            s = hDistOrder['fees']
-                            if s != ''
-                                intDistOrder[:fees] = s
-                            end
-                        end
-
-                        if hDistOrder.has_key?('plannedAvailabilityDateTime')
-                            s = hDistOrder['plannedAvailabilityDateTime']
-                            if s != ''
-                                intDistOrder[:plannedDateTime] = DateTime.unpack(s, responseObj)
-                            end
-                        end
-
-                        if hDistOrder.has_key?('orderingInstructions')
-                            s = hDistOrder['orderingInstructions']
-                            if s != ''
-                                intDistOrder[:orderInstructions] = s
-                            end
-                        end
-
-                        if hDistOrder.has_key?('turnaround')
-                            s = hDistOrder['turnaround']
-                            if s != ''
-                                intDistOrder[:turnaround] = s
-                            end
-                        end
-
-                        return intDistOrder
-                    end
-
-                end
-
-            end
-        end
-    end
-end