adiwg-mdtranslator 0.10.2 → 0.12.0

data/lib/adiwg/mdtranslator/readers/mdJson/modules_0.9/module_contacts.rb

@@ -0,0 +1,150 @@
+# unpack contacts
+# Reader - ADIwg JSON V1 to internal data structure
+
+# History:
+# 	Stan Smith 2013-08-20 original script
+# 	Stan Smith 2013-09-25 moved onlineResource to new module
+# 	Stan Smith 2013-10-21 moved address to new module
+#	Stan Smith 2014-04-23 modify for json schema version 0.3.0
+#   Stan Smith 2014-04-24 split default contacts to a separate method
+#   Stan Smith 2014-05-14 combine phone service types
+#   Stan Smith 2014-07-03 added module_path method to support versioning
+#   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+#   Stan Smith 2014-12-19 modified to return nil for empty hContact
+#   Stan Smith 2014-12-19 added testing and messages for '' and missing contactId
+#   Stan Smith 2014-12-19 added testing to not place nil address into internal object
+#   Stan Smith 2014-12-30 refactored
+
+require $ReaderNS.readerModule('module_address')
+require $ReaderNS.readerModule('module_onlineResource')
+require $ReaderNS.readerModule('module_phone')
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module Contact
+
+                    def self.unpack(hContact)
+
+                        # return nil object if input is empty
+                        intAddDoc = nil
+                        return if hContact.empty?
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intCont = intMetadataClass.newContact
+
+                        # contact ID - required
+                        # return nil contact if contactId is '' or missing
+                        if hContact.has_key?('contactId')
+                            s = hContact['contactId']
+                            if s != ''
+                                intCont[:contactId] = s
+                            else
+                                $response[:readerExecutionPass] =  false
+                                $response[:readerExecutionMessages] << 'Contact ID is blank.'
+                                return nil
+                            end
+                        else
+                            $response[:readerExecutionPass] =  false
+                            $response[:readerExecutionMessages] << 'Contact ID is missing.'
+                            return nil
+                        end
+
+                        # individual name
+                        if hContact.has_key?('individualName')
+                            s = hContact['individualName']
+                            if s != ''
+                                intCont[:indName] = s
+                            end
+                        end
+
+                        # organization name
+                        if hContact.has_key?('organizationName')
+                            s = hContact['organizationName']
+                            if s != ''
+                                intCont[:orgName] = s
+                            end
+                        end
+
+                        # position name
+                        if hContact.has_key?('positionName')
+                            s = hContact['positionName']
+                            if s != ''
+                                intCont[:position] = s
+                            end
+                        end
+
+                        # online resources
+                        if hContact.has_key?('onlineResource')
+                            aOlRes = hContact['onlineResource']
+                            aOlRes.each do |hOlRes|
+                                unless hOlRes.empty?
+                                    intCont[:onlineRes] << $ReaderNS::OnlineResource.unpack(hOlRes)
+                                end
+                            end
+                        end
+
+                        # contact instructions
+                        if hContact.has_key?('contactInstructions')
+                            s = hContact['contactInstructions']
+                            if s != ''
+                                intCont[:contactInstructions] = s
+                            end
+                        end
+
+                        # phones - all service types
+                        if hContact.has_key?('phoneBook')
+                            aPhones = hContact['phoneBook']
+                            aPhones.each do |hPhone|
+                                intCont[:phones].concat($ReaderNS::Phone.unpack(hPhone))
+                            end
+                        end
+
+                        # address
+                        if hContact.has_key?('address')
+                            conAddress = hContact['address']
+                            hAddress = $ReaderNS::Address.unpack(conAddress)
+                            unless hAddress.nil?
+                                intCont[:address] = hAddress
+                            end
+                        end
+
+                        return intCont
+                    end
+
+                    def self.setDefaultContacts()
+
+                        # add default contacts
+                        intMetadataClass = InternalMetadata.new
+                        aDefContacts = Array.new
+
+                        # contact to support biological extensions
+                        intCont = intMetadataClass.newContact
+                        intCont[:contactId] = 'ADIwgBio'
+                        intCont[:orgName] = 'National Biological Information Infrastructure (NBII)'
+                        aDefContacts << intCont
+
+                        # contact to support doi (digital object identifier)
+                        intCont = intMetadataClass.newContact
+                        intCont[:contactId] = 'ADIwgDOI'
+                        intCont[:orgName] = 'International DOI Foundation (IDF)'
+
+                        intOlRes = intMetadataClass.newOnlineResource
+                        intOlRes[:olResURI] = 'http://www.doi.org'
+                        intCont[:onlineRes] << intOlRes
+
+                        aDefContacts << intCont
+
+                        return aDefContacts
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end

data/lib/adiwg/mdtranslator/readers/mdJson/modules_0.9/module_coordinates.rb

@@ -0,0 +1,63 @@
+# repack coordinates
+# Reader - ADIwg JSON V1 to internal data structure
+
+# History:
+# 	Stan Smith 2013-11-07 original script
+# 	Stan Smith 2013-11-13 added getDimension
+#   Stan Smith 2014-05-23 added getLevels
+#   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module Coordinates
+
+                    # repack coordinate array into single string for ISO
+                    def self.unpack(aCoords)
+                        s = ''
+                        i = 0
+                        coordCount = aCoords.length
+                        aCoords.each do |coord|
+                            if coord.kind_of?(Array)
+                                s = s + unpack(coord)
+                            else
+                                i += 1
+                                s = s + coord.to_s
+                                if i < coordCount
+                                    s = s + ','
+                                end
+                                s = s + ' '
+                            end
+                        end
+
+                        return s
+                    end
+
+                    # get the number of dimensions in a coordinate array
+                    def self.getDimension(aCoords)
+                        if aCoords[0].kind_of?(Array)
+                            coordDim = getDimension(aCoords[0])
+                        else
+                            coordDim = aCoords.length
+                        end
+
+                        return coordDim
+                    end
+
+                    # get the number of levels in the coordinate array
+                    def self.getLevels(aCoords)
+                        i = 1
+                        if aCoords[0].kind_of?(Array)
+                            i = i + getLevels(aCoords[0])
+                        end
+                        return i
+                    end
+
+                end
+
+            end
+        end
+    end
+end

data/lib/adiwg/mdtranslator/readers/mdJson/modules_0.9/module_dataDictionary.rb

@@ -0,0 +1,63 @@
+# 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
+
+require $ReaderNS.readerModule('module_dictionaryInfo')
+require $ReaderNS.readerModule('module_domain')
+require $ReaderNS.readerModule('module_entity')
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module DataDictionary
+
+                    def self.unpack(hDictionary)
+
+                        # 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] = $ReaderNS::DictionaryInfo.unpack(hDictInfo)
+                            end
+
+                            # data dictionary - domains
+                            if hDictionary.has_key?('domain')
+                                aDomains = hDictionary['domain']
+                                aDomains.each do |hDomain|
+                                    unless hDomain.empty?
+                                        intDict[:domains] << $ReaderNS::Domain.unpack(hDomain)
+                                    end
+                                end
+                            end
+
+                            # data dictionary - entity
+                            if hDictionary.has_key?('entity')
+                                aEntities = hDictionary['entity']
+                                aEntities.each do |hEntity|
+                                    unless hEntity.empty?
+                                        intDict[:entities] << $ReaderNS::Entity.unpack(hEntity)
+                                    end
+                                end
+                            end
+
+                            return intDict
+
+                        end
+
+                    end
+
+                end
+            end
+        end
+    end
+end

data/lib/adiwg/mdtranslator/readers/mdJson/modules_0.9/module_dataQuality.rb

@@ -0,0 +1,51 @@
+# 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
+
+require $ReaderNS.readerModule('module_lineage')
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module DataQuality
+
+                    def self.unpack(hDataQual)
+
+                        # 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
+                            end
+                        end
+
+                        # data quality - report
+                        # on hold
+
+                        # data quality - lineage
+                        if hDataQual.has_key?('lineage')
+                            hLineage = hDataQual['lineage']
+                            unless hLineage.empty?
+                                intDataQual[:dataLineage] = $ReaderNS::Lineage.unpack(hLineage)
+                            end
+                        end
+
+                        return intDataQual
+                    end
+
+                end
+
+            end
+        end
+    end
+end

data/lib/adiwg/mdtranslator/readers/mdJson/modules_0.9/module_dateTime.rb

@@ -0,0 +1,38 @@
+# unpack dateTime
+# Reader - ADIwg JSON V1 to internal data structure
+
+# History:
+# 	Stan Smith 2013-12-11 original script
+#   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+
+require 'adiwg/mdtranslator/internal/module_dateTimeFun'
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module DateTime
+
+                    def self.unpack(sDateTime)
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+
+                        # dateTime
+                        intDateTime = intMetadataClass.newDateTime
+
+                        aDateTimeReturn = AdiwgDateTimeFun.dateTimeFromString(sDateTime)
+                        intDateTime[:dateTime] = aDateTimeReturn[0]
+                        intDateTime[:dateResolution] = aDateTimeReturn[1]
+
+                        return intDateTime
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end

data/lib/adiwg/mdtranslator/readers/mdJson/modules_0.9/module_descriptiveKeyword.rb

@@ -0,0 +1,60 @@
+# 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
+
+require $ReaderNS.readerModule('module_citation')
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module DescriptiveKeyword
+
+                    def self.unpack(hDesKeyword)
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intKeyword = intMetadataClass.newKeyword
+
+                        # descriptive keyword - keyword array
+                        if hDesKeyword.has_key?('keyword')
+                            aKeywords = hDesKeyword['keyword']
+                            aKeywords.each do |keyword|
+                                intKeyword[:keyword] << keyword
+                            end
+                        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] = $ReaderNS::Citation.unpack(hCitation)
+                            end
+
+                        end
+
+                        return intKeyword
+                    end
+
+                end
+
+            end
+        end
+    end
+end

data/lib/adiwg/mdtranslator/readers/mdJson/modules_0.9/module_dictionaryInfo.rb

@@ -0,0 +1,63 @@
+# 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
+
+require $ReaderNS.readerModule('module_citation')
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module DictionaryInfo
+
+                    def self.unpack(hDictInfo)
+
+                        # 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] = $ReaderNS::Citation.unpack(hCitation)
+                            end
+                        end
+
+                        # dictionary info - description
+                        if hDictInfo.has_key?('description')
+                            s = hDictInfo['description']
+                            if s != ''
+                                intDictInfo[:dictDescription] = s
+                            end
+                        end
+
+                        # dictionary info - resource type
+                        if hDictInfo.has_key?('resourceType')
+                            s = hDictInfo['resourceType']
+                            if s != ''
+                                intDictInfo[:dictResourceType] = s
+                            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