adiwg-mdtranslator 1.4.0 → 2.0.0rc2

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

@@ -1,374 +0,0 @@
-# unpack data identification
-# Reader - ADIwg JSON V1 to internal data structure
-
-# History:
-# 	Stan Smith 2013-08-22 original script
-# 	Stan Smith 2013-11-04 extents
-# 	Stan Smith 2013-11-14 legal constraints
-# 	Stan Smith 2013-11-20 taxonomy
-# 	Stan Smith 2013-11-25 resource specific usage
-# 	Stan Smith 2013-11-26 spatial resolution
-#   Stan Smith 2014-04-25 revised to support json schema version 0.3.0
-#   Stan Smith 2014-05-28 added resource identifier to citation json schema 0.5.0
-#   Stan Smith 2014-07-03 resolve require statements using Mdtranslator.reader_module
-#   Stan Smith 2014-08-18 moved resourceIdentifier to citation module schema 0.6.0
-#   Stan Smith 2014-09-03 added spatial reference system module for 0.7.0
-#   Stan Smith 2014-10-29 added support for resource time period
-#   Stan Smith 2014-11-06 added resourceType for 0.9.0
-#   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
-#   Stan Smith 2015-06-12 added support for resource characterSets
-#   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-29 added support for locale
-#   Stan Smith 2015-07-30 added support for grid descriptions
-#   Stan Smith 2015-08-19 added support for coverage information
-
-require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_citation')
-require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_responsibleParty')
-require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_resourceFormat')
-require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_descriptiveKeyword')
-require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_resourceMaintenance')
-require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_resourceSpecificUsage')
-require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_browseGraphic')
-require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_legalConstraint')
-require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_securityConstraint')
-require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_taxonomy')
-require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_resolution')
-require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_extent')
-require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_dataQuality')
-require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_spatialReference')
-require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_timePeriod')
-require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_locale')
-require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_gridInfo')
-require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_coverageInfo')
-
-module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
-
-                module ResourceInfo
-
-                    def self.unpack(hResourceInfo, responseObj)
-
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intResInfo = intMetadataClass.newResourceInfo
-
-                        # resource information - resource type
-                        if hResourceInfo.has_key?('resourceType')
-                            s = hResourceInfo['resourceType']
-                            if s != ''
-                                intResInfo[:resourceType] = s
-                            end
-                        end
-
-                        # resource information - citation
-                        if hResourceInfo.has_key?('citation')
-                            hCitation = hResourceInfo['citation']
-                            unless hCitation.empty?
-                                intResInfo[:citation] = Citation.unpack(hCitation, responseObj)
-                            end
-                        end
-
-                        # resource information - resource time period
-                        if hResourceInfo.has_key?('resourceTimePeriod')
-                            hResPeriod = hResourceInfo['resourceTimePeriod']
-                            unless hResPeriod.empty?
-                                intResInfo[:timePeriod] = TimePeriod.unpack(hResPeriod, responseObj)
-                            end
-                        end
-
-                        # resource information - point of contact
-                        if hResourceInfo.has_key?('pointOfContact')
-                            aPOC = hResourceInfo['pointOfContact']
-                            unless aPOC.empty?
-                                aPOC.each do |rParty|
-                                    intResInfo[:pointsOfContact] << ResponsibleParty.unpack(rParty, responseObj)
-                                end
-                            end
-                        end
-
-                        # resource information - abstract
-                        if hResourceInfo.has_key?('abstract')
-                            s = hResourceInfo['abstract']
-                            if s != ''
-                                intResInfo[:abstract] = s
-                            end
-                        end
-
-                        # resource information - short abstract
-                        if hResourceInfo.has_key?('shortAbstract')
-                            s = hResourceInfo['shortAbstract']
-                            if s != ''
-                                intResInfo[:shortAbstract] = s
-                            end
-                        end
-
-                        # resource information - status
-                        if hResourceInfo.has_key?('status')
-                            s = hResourceInfo['status']
-                            if s != ''
-                                intResInfo[:status] = s
-                            end
-                        end
-
-                        # resource information - has mappable location
-                        if hResourceInfo.has_key?('hasMapLocation')
-                            s = hResourceInfo['hasMapLocation']
-                            if s != ''
-                                intResInfo[:hasMapLocation?] = s
-                            end
-                        end
-
-                        # resource information - has data available
-                        if hResourceInfo.has_key?('hasDataAvailable')
-                            s = hResourceInfo['hasDataAvailable']
-                            if s != ''
-                                intResInfo[:hasDataAvailable?] = s
-                            end
-                        end
-
-                        # resource information - language
-                        if hResourceInfo.has_key?('language')
-                            aLanguage = hResourceInfo['language']
-                            unless aLanguage.empty?
-                                aLanguage.each do |language|
-                                    intResInfo[:resourceLanguages] << language
-                                end
-                            end
-                        end
-
-                        # resource information - characterSet [] - default 'utf8'
-                        if hResourceInfo.has_key?('characterSet')
-                            aCharSet = hResourceInfo['characterSet']
-                            aCharSet.each do |charSet|
-                                intResInfo[:resourceCharacterSets] << charSet
-                            end
-                        end
-
-                        # metadata - locale
-                        if hResourceInfo.has_key?('locale')
-                            aLocale = hResourceInfo['locale']
-                            unless aLocale.empty?
-                                aLocale.each do |hLocale|
-                                    intResInfo[:resourceLocales] << Locale.unpack(hLocale, responseObj)
-                                end
-                            end
-                        end
-
-                        # resource information - purpose
-                        if hResourceInfo.has_key?('purpose')
-                            s = hResourceInfo['purpose']
-                            if s != ''
-                                intResInfo[:purpose] = s
-                            end
-                        end
-
-                        # resource information - credit
-                        if hResourceInfo.has_key?('credit')
-                            aCredits = hResourceInfo['credit']
-                            unless aCredits.empty?
-                                aCredits.each do |credit|
-                                    intResInfo[:credits] << credit
-                                end
-                            end
-                        end
-
-                        # resource information - topic category
-                        if hResourceInfo.has_key?('topicCategory')
-                            aTopics = hResourceInfo['topicCategory']
-                            unless aTopics.empty?
-                                aTopics.each do |topic|
-                                    intResInfo[:topicCategories] << topic
-                                end
-                            end
-                        end
-
-                        # resource information - environment description
-                        if hResourceInfo.has_key?('environmentDescription')
-                            s = hResourceInfo['environmentDescription']
-                            if s != ''
-                                intResInfo[:environmentDescription] = s
-                            end
-                        end
-
-                        # resource information - resource format
-                        if hResourceInfo.has_key?('resourceNativeFormat')
-                            aResFormat = hResourceInfo['resourceNativeFormat']
-                            unless aResFormat.empty?
-                                aResFormat.each do |hResFormat|
-                                    intResInfo[:resourceFormats] << ResourceFormat.unpack(hResFormat, responseObj)
-                                end
-                            end
-                        end
-
-                        # resource information - descriptive keywords
-                        if hResourceInfo.has_key?('keyword')
-                            aDesKeywords = hResourceInfo['keyword']
-                            unless aDesKeywords.empty?
-                                aDesKeywords.each do |hDesKeyword|
-                                    intResInfo[:descriptiveKeywords] << DescriptiveKeyword.unpack(hDesKeyword, responseObj)
-                                end
-                            end
-                        end
-
-                        # resource information - resource maintenance
-                        if hResourceInfo.has_key?('resourceMaintenance')
-                            aResMaint = hResourceInfo['resourceMaintenance']
-                            unless aResMaint.empty?
-                                aResMaint.each do |hResource|
-                                    intResInfo[:resourceMaint] << ResourceMaintenance.unpack(hResource, responseObj)
-                                end
-                            end
-                        end
-
-                        # resource information - resource specific usage
-                        if hResourceInfo.has_key?('resourceSpecificUsage')
-                            aResUses = hResourceInfo['resourceSpecificUsage']
-                            unless aResUses.empty?
-                                aResUses.each do |hUsage|
-                                    intResInfo[:resourceUses] << ResourceSpecificUsage.unpack(hUsage, responseObj)
-                                end
-                            end
-                        end
-
-                        # resource information - graphic overview
-                        if hResourceInfo.has_key?('graphicOverview')
-                            aBrowseGraph = hResourceInfo['graphicOverview']
-                            unless aBrowseGraph.empty?
-                                aBrowseGraph.each do |hBGraphic|
-                                    intResInfo[:graphicOverview] << BrowseGraphic.unpack(hBGraphic, responseObj)
-                                end
-                            end
-                        end
-
-                        # resource information - use constraints
-                        if hResourceInfo.has_key?('constraint')
-                            hConstraint = hResourceInfo['constraint']
-
-                            # resource information - resource constraints - use
-                            if hConstraint.has_key?('useLimitation')
-                                aUseLimits = hConstraint['useLimitation']
-                                unless aUseLimits.empty?
-                                    aUseLimits.each do |useLimit|
-                                        intResInfo[:useConstraints] << useLimit
-                                    end
-                                end
-                            end
-
-                            # resource information - resource constraints - legal
-                            if hConstraint.has_key?('legalConstraint')
-                                aLegalCons = hConstraint['legalConstraint']
-                                unless aLegalCons.empty?
-                                    aLegalCons.each do |hLegalCon|
-                                        intResInfo[:legalConstraints] << LegalConstraints.unpack(hLegalCon, responseObj)
-                                    end
-                                end
-                            end
-
-                            # resource information - resource constraints - security
-                            if hConstraint.has_key?('securityConstraint')
-                                aSecurityCons = hConstraint['securityConstraint']
-                                unless aSecurityCons.empty?
-                                    aSecurityCons.each do |hSecurityCon|
-                                        intResInfo[:securityConstraints] << SecurityConstraints.unpack(hSecurityCon, responseObj)
-                                    end
-                                end
-                            end
-
-                        end
-
-                        # resource information - taxonomy
-                        if hResourceInfo.has_key?('taxonomy')
-                            hTaxonomy = hResourceInfo['taxonomy']
-                            unless hTaxonomy.empty?
-                                intResInfo[:taxonomy] = Taxonomy.unpack(hTaxonomy, responseObj)
-                            end
-                        end
-
-                        # resource information - spatial reference systems
-                        if hResourceInfo.has_key?('spatialReferenceSystem')
-                            hSpatialRef = hResourceInfo['spatialReferenceSystem']
-                            unless hSpatialRef.empty?
-                                intResInfo[:spatialReferenceSystem] = SpatialReferenceSystem.unpack(hSpatialRef, responseObj)
-                            end
-                        end
-
-                        # resource information - spatial representation type
-                        if hResourceInfo.has_key?('spatialRepresentation')
-                            aSpatialType = hResourceInfo['spatialRepresentation']
-                            unless aSpatialType.empty?
-                                aSpatialType.each do |spType|
-                                    intResInfo[:spatialRepresentationTypes] << spType
-                                end
-                            end
-                        end
-
-                        # resource information - spatial resolution
-                        if hResourceInfo.has_key?('spatialResolution')
-                            aSpRes = hResourceInfo['spatialResolution']
-                            unless aSpRes.empty?
-                                aSpRes.each do |hResolution|
-                                    intResInfo[:spatialResolutions] << Resolution.unpack(hResolution, responseObj)
-                                end
-                            end
-                        end
-
-                        # resource information - extent
-                        if hResourceInfo.has_key?('extent')
-                            aExtents = hResourceInfo['extent']
-                            unless aExtents.empty?
-                                aExtents.each do |hExtent|
-                                    intResInfo[:extents] << Extent.unpack(hExtent, responseObj)
-                                end
-                            end
-                        end
-
-                        # resource information - grid information
-                        if hResourceInfo.has_key?('gridInfo')
-                            aGrids = hResourceInfo['gridInfo']
-                            unless aGrids.empty?
-                                aGrids.each do |hGrid|
-                                    intResInfo[:gridInfo] << GridInfo.unpack(hGrid, responseObj)
-                                end
-                            end
-                        end
-
-                        # resource information - coverage information
-                        if hResourceInfo.has_key?('coverageInfo')
-                            aCoverage = hResourceInfo['coverageInfo']
-                            unless aCoverage.empty?
-                                aCoverage.each do |hCoverage|
-                                    intResInfo[:coverageInfo] << CoverageInfo.unpack(hCoverage, responseObj)
-                                end
-                            end
-                        end
-
-                        # resource information - data quality information
-                        if hResourceInfo.has_key?('dataQualityInfo')
-                            aDataQual = hResourceInfo['dataQualityInfo']
-                            unless aDataQual.empty?
-                                aDataQual.each do |hDQ|
-                                    intResInfo[:dataQualityInfo] << DataQuality.unpack(hDQ, responseObj)
-                                end
-                            end
-                        end
-
-                        # resource information - supplemental info
-                        if hResourceInfo.has_key?('supplementalInfo')
-                            s = hResourceInfo['supplementalInfo']
-                            if s != ''
-                                intResInfo[:supplementalInfo] = s
-                            end
-                        end
-
-                        return intResInfo
-                    end
-
-                end
-
-            end
-        end
-    end
-end

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

@@ -1,63 +0,0 @@
-# unpack resource maintenance
-# Reader - ADIwg JSON V1 to internal data structure
-
-# History:
-# 	Stan Smith 2013-10-31 original script
-# 	Stan Smith 2013-12-18 made note an array
-# 	Stan Smith 2013-12-18 added contact
-#   Stan Smith 2014-04-24 modified for json schema 0.3.0
-#   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_responsibleParty')
-
-module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
-
-                module ResourceMaintenance
-
-                    def self.unpack(hResource, responseObj)
-
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intResMaint = intMetadataClass.newResourceMaint
-
-                        # resource maintenance - frequency code
-                        if hResource.has_key?('maintenanceFrequency')
-                            s = hResource['maintenanceFrequency']
-                            if s != ''
-                                intResMaint[:maintFreq] = s
-                            end
-                        end
-
-                        # resource maintenance - maintenance note
-                        if hResource.has_key?('maintenanceNote')
-                            aNotes = hResource['maintenanceNote']
-                            unless aNotes.empty?
-                                intResMaint[:maintNotes] = aNotes
-                            end
-                        end
-
-                        # resource maintenance - contact
-                        if hResource.has_key?('maintenanceContact')
-                            aContact = hResource['maintenanceContact']
-                            unless aContact.empty?
-                                aContact.each do |hContact|
-                                    intResMaint[:maintContacts] << ResponsibleParty.unpack(hContact, responseObj)
-                                end
-                            end
-                        end
-
-                        return intResMaint
-                    end
-
-                end
-
-            end
-        end
-    end
-end

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

@@ -1,63 +0,0 @@
-# unpack resource specific usage
-# Reader - ADIwg JSON V1 to internal data structure
-
-# History:
-# 	Stan Smith 2013-11-25 original script
-# 	Stan Smith 2013-11-27 modified to process a single resource usage
-#   Stan Smith 2014-04-28 modified attribute names to match json schema 0.3.0
-#   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_responsibleParty')
-
-module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
-
-                module ResourceSpecificUsage
-
-                    def self.unpack(hUsage, responseObj)
-
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intUsage = intMetadataClass.newDataUsage
-
-                        # resource specific usage - specific usage
-                        if hUsage.has_key?('specificUsage')
-                            s = hUsage['specificUsage']
-                            if s != ''
-                                intUsage[:specificUsage] = s
-                            end
-                        end
-
-                        # resource specific usage - user determined limitations
-                        if hUsage.has_key?('userDeterminedLimitation')
-                            s = hUsage['userDeterminedLimitation']
-                            if s != ''
-                                intUsage[:userLimits] = s
-                            end
-                        end
-
-                        # taxonomy - repository - responsible party
-                        if hUsage.has_key?('userContactInfo')
-                            aContacts = hUsage['userContactInfo']
-                            unless aContacts.empty?
-                                aContacts.each do |hContact|
-                                    intUsage[:userContacts] << ResponsibleParty.unpack(hContact, responseObj)
-                                end
-                            end
-                        end
-
-                        return intUsage
-
-                    end
-
-                end
-
-            end
-        end
-    end
-end

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

@@ -1,68 +0,0 @@
-# unpack responsible party
-# Reader - ADIwg JSON V1 to internal data structure
-
-# History:
-# 	Stan Smith 2013-08-26 original script
-#   Stan Smith 2014-05-28 modified to support JSON schema 0.5.0
-#   ... removed resource IDs associated with contact
-#   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
-#   Stan Smith 2015-01-18 added nil return if hRParty empty
-#   Stan Smith 2015-06-12 added check that contactId for responsibleParty
-#   ... matches an actual contact in the contact array
-#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
-#   Stan Smith 2015-07-14 refactored to remove global namespace constants
-
-module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
-
-                module ResponsibleParty
-
-                    def self.unpack(hRParty, responseObj)
-
-                        # return nil object if input is empty
-                        intResById = nil
-                        return if hRParty.empty?
-
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intResById = intMetadataClass.newRespParty
-
-                        # responsible party - contact
-                        if hRParty.has_key?('contactId')
-                            s = hRParty['contactId']
-                        end
-                        if s && s != ''
-                            intResById[:contactId] = s
-                            contact = ADIWG::Mdtranslator::Readers::MdJson.findContact(s)
-                            if (!contact)
-                                responseObj[:readerExecutionPass] = false
-                                responseObj[:readerExecutionMessages] << "Responsible Party contact ID #{s} does not match with any contact provided\n"
-                            end
-                        else
-                            responseObj[:readerExecutionPass] = false
-                            responseObj[:readerExecutionMessages] << 'Responsible Party is missing the contact ID\n'
-                        end
-
-                        # responsible party - role - required
-                        if hRParty.has_key?('role')
-                            rl = hRParty['role'] || contact[:primaryRole]
-                        end
-                        if rl && rl != ''
-                            intResById[:roleName] = rl
-                        else
-                            responseObj[:readerExecutionPass] = false
-                            responseObj[:readerExecutionMessages] << 'Responsible Party is missing the contact role\n'
-                        end
-
-                        return intResById
-
-                    end
-
-                end
-
-            end
-        end
-    end
-end

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

@@ -1,65 +0,0 @@
-# unpack security constraint
-# Reader - ADIwg JSON V1 to internal data structure
-
-# History:
-# 	Stan Smith 2013-11-15 original script
-# 	Stan Smith 2013-11-27 modified to process a single security constraint
-#   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
-
-module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
-
-                module SecurityConstraints
-
-                    def self.unpack(hSecurityCon, responseObj)
-
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        hIntCon = intMetadataClass.newSecurityConstraint
-
-                        # security constraint - classification code - required
-                        if hSecurityCon.has_key?('classification')
-                            s = hSecurityCon['classification']
-                            if s != ''
-                                hIntCon[:classCode] = s
-                            end
-                        end
-
-                        # security constraint - user note
-                        if hSecurityCon.has_key?('userNote')
-                            s = hSecurityCon['userNote']
-                            if s != ''
-                                hIntCon[:userNote] = s
-                            end
-                        end
-
-                        # security constraint - classification system
-                        if hSecurityCon.has_key?('classificationSystem')
-                            s = hSecurityCon['classificationSystem']
-                            if s != ''
-                                hIntCon[:classSystem] = s
-                            end
-                        end
-
-                        # security constraint - handling description
-                        if hSecurityCon.has_key?('handlingDescription')
-                            s = hSecurityCon['handlingDescription']
-                            if s != ''
-                                hIntCon[:handlingDesc] = s
-                            end
-                        end
-
-                        return hIntCon
-
-                    end
-
-                end
-
-            end
-        end
-    end
-end