adiwg-mdtranslator 1.4.0 → 2.0.0rc2

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

@@ -1,141 +0,0 @@
-# unpack citation
-# Reader - ADIwg JSON V1 to internal data structure
-
-# History:
-# 	Stan Smith 2013-08-26 original script
-#   Stan Smith 2014-04-25 modified to support json schema 0.3.0
-#   Stan Smith 2014-07-03 resolve require statements using Mdtranslator.reader_module
-#   Stan Smith 2014-08-18 changed additionalIdentifier section to identifier schema 0.6.0
-#   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
-#   Stan Smith 2014-12-19 refactored to return nil when hCitation is empty
-#   Stan Smith 2014-12-30 refactored
-#   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-28 added alternate title
-
-require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_dateTime')
-require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_responsibleParty')
-require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_onlineResource')
-require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_resourceIdentifier')
-
-module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
-
-                module Citation
-
-                    def self.unpack(hCitation, responseObj)
-
-                        # return nil object if input is empty
-                        intCitation = nil
-                        return if hCitation.empty?
-
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intCitation = intMetadataClass.newCitation
-
-                        # citation - title
-                        if hCitation.has_key?('title')
-                            s = hCitation['title']
-                            if s != ''
-                                intCitation[:citTitle] = s
-                            else
-                                responseObj[:readerExecutionMessages] << 'Citation title is empty'
-                                responseObj[:readerExecutionPass] = false
-                                return nil
-                            end
-                        else
-                            responseObj[:readerExecutionMessages] << 'Citation title is missing'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        # citation - alternate title
-                        if hCitation.has_key?('alternateTitle')
-                            s = hCitation['alternateTitle']
-                            if s != ''
-                                intCitation[:citAltTitle] = s
-                            end
-                        end
-
-                        # citation - date
-                        if hCitation.has_key?('date')
-                            aCitDates = hCitation['date']
-                            unless aCitDates.empty?
-                                aCitDates.each do |hCitDate|
-                                    if hCitDate.has_key?('date')
-                                        s = hCitDate['date']
-                                        if s != ''
-                                            intDateTime = DateTime.unpack(s, responseObj)
-                                            if hCitDate.has_key?('dateType')
-                                                s = hCitDate['dateType']
-                                                if s != ''
-                                                    intDateTime[:dateType] = s
-                                                end
-                                            end
-                                            intCitation[:citDate] << intDateTime
-                                        end
-                                    end
-                                end
-                            end
-                        end
-
-                        # citation - edition
-                        if hCitation.has_key?('edition')
-                            s = hCitation['edition']
-                            if s != ''
-                                intCitation[:citEdition] = s
-                            end
-                        end
-
-                        # citation - responsible party
-                        if hCitation.has_key?('responsibleParty')
-                            aRParty = hCitation['responsibleParty']
-                            unless aRParty.empty?
-                                aRParty.each do |hRParty|
-                                    intCitation[:citResponsibleParty] << ResponsibleParty.unpack(hRParty, responseObj)
-                                end
-                            end
-                        end
-
-                        # citation - presentation form
-                        if hCitation.has_key?('presentationForm')
-                            aPForms = hCitation['presentationForm']
-                            unless aPForms.empty?
-                                aPForms.each do |pForm|
-                                    intCitation[:citResourceForms] << pForm
-                                end
-                            end
-                        end
-
-                        # citation - resource identifiers
-                        if hCitation.has_key?('identifier')
-                            aResIds = hCitation['identifier']
-                            aResIds.each do |hIdentifier|
-                                unless hIdentifier.empty?
-                                    intCitation[:citResourceIds] << ResourceIdentifier.unpack(hIdentifier, responseObj)
-                                end
-                            end
-                        end
-
-                        # citation - online resources
-                        if hCitation.has_key?('onlineResource')
-                            aOlRes = hCitation['onlineResource']
-                            aOlRes.each do |hOlRes|
-                                unless hOlRes.empty?
-                                    intCitation[:citOlResources] << OnlineResource.unpack(hOlRes, responseObj)
-                                end
-                            end
-                        end
-
-                        return intCitation
-                    end
-
-                end
-
-            end
-        end
-    end
-end
-

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

@@ -1,49 +0,0 @@
-# unpack classed data
-# Reader - ADIwg JSON V1 to internal data structure
-
-# History:
-# 	Stan Smith 2015-08-20 original script
-
-require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_classedDataItem')
-
-module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
-
-                module ClassedData
-
-                    def self.unpack(hClassData, responseObj)
-
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        hClass = intMetadataClass.newClassedData
-
-                        # classed data - number of classed items
-                        if hClassData.has_key?('numberOfClasses')
-                            s = hClassData['numberOfClasses']
-                            if s != ''
-                                hClass[:numberOfClasses] = s
-                            end
-                        end
-
-                        # classed data - classed data items
-                        if hClassData.has_key?('classifiedDataItem')
-                            aClassItems = hClassData['classifiedDataItem']
-                            aClassItems.each do |hClassItem|
-                                if !hClassItem.empty?
-                                    hClass[:classedDataItems] << ClassedDataItem.unpack(hClassItem, responseObj)
-                                end
-                            end
-                        end
-
-                        return hClass
-
-                    end
-
-                end
-
-            end
-        end
-    end
-end

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

@@ -1,53 +0,0 @@
-# unpack classed data item
-# Reader - ADIwg JSON V1 to internal data structure
-
-# History:
-# 	Stan Smith 2015-08-20 original script
-
-module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
-
-                module ClassedDataItem
-
-                    def self.unpack(hClassData, responseObj)
-
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        hClassItem = intMetadataClass.newClassedDataItem
-
-                        # classed data item - name
-                        if hClassData.has_key?('className')
-                            s = hClassData['className']
-                            if s != ''
-                                hClassItem[:className] = s
-                            end
-                        end
-
-                        # classed data item - description
-                        if hClassData.has_key?('classDescription')
-                            s = hClassData['classDescription']
-                            if s != ''
-                                hClassItem[:classDescription] = s
-                            end
-                        end
-
-                        # classed data item - value
-                        if hClassData.has_key?('classValue')
-                            s = hClassData['classValue']
-                            if s != ''
-                                hClassItem[:classValue] = s
-                            end
-                        end
-
-                        return hClassItem
-
-                    end
-
-                end
-
-            end
-        end
-    end
-end

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

@@ -1,164 +0,0 @@
-# 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
-#   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_address')
-require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_onlineResource')
-require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_phone')
-
-module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
-
-                module Contact
-
-                    def self.unpack(hContact, responseObj)
-
-                        # return nil object if input is empty
-                        intCont = nil
-                        return if hContact.empty?
-
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intCont = intMetadataClass.newContact
-
-                        # contact ID - required
-                        # each contact must have a 'contactId' provided by the user
-                        # ... the contactId is used by responsibleParty to reference a contact
-                        # ... return nil contact if contactId is '' or missing
-                        if hContact.has_key?('contactId')
-                            s = hContact['contactId']
-                            if s != ''
-                                intCont[:contactId] = s
-                            else
-                                responseObj[:readerExecutionPass] =  false
-                                responseObj[:readerExecutionMessages] << 'contact: {contactId: } is blank.'
-                                return nil
-                            end
-                        else
-                            responseObj[:readerExecutionPass] =  false
-                            responseObj[:readerExecutionMessages] << 'contact: {contactId: } 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
-
-                        # primary role
-                        if hContact.has_key?('primaryRole')
-                            s = hContact['primaryRole']
-                            if s != ''
-                                intCont[:primaryRole] = s
-                            end
-                        end
-
-                        # online resources
-                        if hContact.has_key?('onlineResource')
-                            aOlRes = hContact['onlineResource']
-                            aOlRes.each do |hOlRes|
-                                unless hOlRes.empty?
-                                    intCont[:onlineRes] << OnlineResource.unpack(hOlRes, responseObj)
-                                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(Phone.unpack(hPhone, responseObj))
-                            end
-                        end
-
-                        # address
-                        if hContact.has_key?('address')
-                            conAddress = hContact['address']
-                            hAddress = Address.unpack(conAddress, responseObj)
-                            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)'
-                        intCont[:internal] = true
-                        aDefContacts << intCont
-
-                        # contact to support doi (digital object identifier)
-                        intCont = intMetadataClass.newContact
-                        intCont[:contactId] = 'ADIwgDOI'
-                        intCont[:orgName] = 'International DOI Foundation (IDF)'
-                        intCont[:internal] = true
-
-                        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_v1/module_coverageInfo.rb

@@ -1,83 +0,0 @@
-# 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

@@ -1,136 +0,0 @@
-# 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