adiwg-mdtranslator 1.4.0 → 2.0.0rc2

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

@@ -0,0 +1,72 @@
+# unpack scope
+# Reader - ADIwg JSON to internal data structure
+
+# History:
+# 	Stan Smith 2016-10-14 original script
+
+require_relative 'module_scopeDescription'
+require_relative 'module_timePeriod'
+require_relative 'module_extent'
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module Scope
+
+                    def self.unpack(hScope, responseObj)
+
+                        # return nil object if input is empty
+                        if hScope.empty?
+                            responseObj[:readerExecutionMessages] << 'Scope object is empty'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intScope = intMetadataClass.newScope
+
+                        # scope - scope code (required)
+                        if hScope.has_key?('scopeCode')
+                            intScope[:scopeCode] = hScope['scopeCode']
+                        end
+                        if intScope[:scopeCode].nil? || intScope[:scopeCode] == ''
+                            responseObj[:readerExecutionMessages] << 'Scope attribute scopeCode is missing'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # scope - scope description [] {MD_ScopeDescription}
+                        if hScope.has_key?('scopeDescription')
+                            aScopeDes = hScope['scopeDescription']
+                            aScopeDes.each do |item|
+                                hScopeDes = ScopeDescription.unpack(item, responseObj)
+                                unless hScopeDes.nil?
+                                    intScope[:scopeDescriptions] << hScopeDes
+                                end
+                            end
+                        end
+
+                        # scope - extent [] {EX_Extent}
+                        if hScope.has_key?('scopeExtent')
+                            aExtents = hScope['scopeExtent']
+                            aExtents.each do |item|
+                                hExtent = Extent.unpack(item, responseObj)
+                                unless hExtent.nil?
+                                    intScope[:extents] << hExtent
+                                end
+                            end
+                        end
+
+                        return intScope
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,73 @@
+# unpack scope description
+# Reader - ADIwg JSON to internal data structure
+
+# History:
+# 	Stan Smith 2016-10-13 original script
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module ScopeDescription
+
+                    def self.unpack(hScopeDes, responseObj)
+
+                        # return nil object if input is empty
+                        if hScopeDes.empty?
+                            responseObj[:readerExecutionMessages] << 'Scope Description object is empty'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intScopeDes = intMetadataClass.newScopeDescription
+
+                        # scope description - dataset
+                        if hScopeDes.has_key?('dataset')
+                            if hScopeDes['dataset'] != ''
+                                intScopeDes[:dataset] = hScopeDes['dataset']
+                            end
+                        end
+
+                        # scope description - attributes
+                        if hScopeDes.has_key?('attributes')
+                            if hScopeDes['attributes'] != ''
+                                intScopeDes[:attributes] = hScopeDes['attributes']
+                            end
+                        end
+
+                        # scope description - features
+                        if hScopeDes.has_key?('features')
+                            if hScopeDes['features'] != ''
+                                intScopeDes[:features] = hScopeDes['features']
+                            end
+                        end
+
+                        # scope description - other
+                        if hScopeDes.has_key?('other')
+                            if hScopeDes['other'] != ''
+                                intScopeDes[:other] = hScopeDes['other']
+                            end
+                        end
+
+                        if intScopeDes[:dataset].nil? &&
+                            intScopeDes[:attributes].nil? &&
+                            intScopeDes[:features].nil? &&
+                            intScopeDes[:other].nil?
+                            responseObj[:readerExecutionMessages] << 'Scope Description needs at least one description'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        return intScopeDes
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,72 @@
+# unpack security constraint
+# Reader - ADIwg JSON to internal data structure
+
+# History:
+# 	Stan Smith 2016-10-15 refactored for mdJson 2.0
+#   Stan Smith 2015-07-14 refactored to remove global namespace constants
+#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
+#   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+# 	Stan Smith 2013-11-27 modified to process a single security constraint
+# 	Stan Smith 2013-11-15 original script
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module SecurityConstraint
+
+                    def self.unpack(hSecurityCon, responseObj)
+
+                        # return nil object if input is empty
+                        if hSecurityCon.empty?
+                            responseObj[:readerExecutionMessages] << 'Security Constraint object is empty'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intSecCon= intMetadataClass.newSecurityConstraint
+
+                        # security constraint - classification (required)
+                        if hSecurityCon.has_key?('classification')
+                            intSecCon[:classCode] = hSecurityCon['classification']
+                        end
+                        if intSecCon[:classCode].nil? || intSecCon[:classCode] == ''
+                            responseObj[:readerExecutionMessages] << 'Security Constraint attribute classification is missing'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # security constraint - user note
+                        if hSecurityCon.has_key?('userNote')
+                            if hSecurityCon['userNote'] != ''
+                                intSecCon[:userNote] = hSecurityCon['userNote']
+                            end
+                        end
+
+                        # security constraint - classification system
+                        if hSecurityCon.has_key?('classificationSystem')
+                            if hSecurityCon['classificationSystem'] != ''
+                                intSecCon[:classSystem] = hSecurityCon['classificationSystem']
+                            end
+                        end
+
+                        # security constraint - handling description
+                        if hSecurityCon.has_key?('handlingDescription')
+                            if hSecurityCon['handlingDescription'] != ''
+                                intSecCon[:handling] = hSecurityCon['handlingDescription']
+                            end
+                        end
+
+                        return intSecCon
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,57 @@
+# unpack series
+# Reader - ADIwg JSON to internal data structure
+
+# History:
+# 	Stan Smith 2016-10-12 original script
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module Series
+
+                    def self.unpack(hSeries, responseObj)
+
+                        # return nil object if input is empty
+                        if hSeries.empty?
+                            responseObj[:readerExecutionMessages] << 'Series object is empty'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intSeries = intMetadataClass.newSeries
+
+                        # series - seriesName
+                        if hSeries.has_key?('seriesName')
+                            if hSeries['seriesName'] != ''
+                                intSeries[:seriesName] = hSeries['seriesName']
+                            end
+                        end
+
+                        # series - series issue
+                        if hSeries.has_key?('seriesIssue')
+                            if hSeries['seriesIssue'] != ''
+                                intSeries[:seriesIssue] = hSeries['seriesIssue']
+                            end
+                        end
+
+                        # series - issue page
+                        if hSeries.has_key?('issuePage')
+                            if hSeries['issuePage'] != ''
+                                intSeries[:issuePage] = hSeries['issuePage']
+                            end
+                        end
+
+                        return intSeries
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,123 @@
+# unpack source
+# Reader - ADIwg JSON to internal data structure
+
+# History:
+#   Stan Smith 2016-10-17 refactored for mdJson 2.0
+#   Stan Smith 2015-07-14 refactored to remove global namespace constants
+#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
+#   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+#   Stan Smith 2014-07-03 resolve require statements using Mdtranslator.reader_module
+# 	Stan Smith 2013-11-26 original script
+
+require_relative 'module_citation'
+require_relative 'module_processStep'
+require_relative 'module_spatialReference'
+require_relative 'module_scope'
+require_relative 'module_spatialResolution'
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module Source
+
+                    def self.unpack(hSource, responseObj)
+
+                        # return nil object if input is empty
+                        if hSource.empty?
+                            responseObj[:readerExecutionMessages] << 'Source object is empty'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intSource = intMetadataClass.newDataSource
+
+                        # source - description (required)
+                        if hSource.has_key?('description')
+                            intSource[:description] = hSource['description']
+                        end
+                        if intSource[:description].nil? || intSource[:description] == ''
+                            responseObj[:readerExecutionMessages] << 'Source description is missing'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # source - source citation
+                        if hSource.has_key?('sourceCitation')
+                            hObject = hSource['sourceCitation']
+                            unless hObject.empty?
+                                hReturn = Citation.unpack(hObject, responseObj)
+                                unless hReturn.nil?
+                                    intSource[:sourceCitation] = hReturn
+                                end
+                            end
+                        end
+
+                        # source - source metadata []
+                        if hSource.has_key?('metadataCitation')
+                            aCitation = hSource['metadataCitation']
+                            aCitation.each do |item|
+                                hCitation = Citation.unpack(item, responseObj)
+                                unless hCitation.nil?
+                                    intSource[:metadataCitation] << hCitation
+                                end
+                            end
+                        end
+
+                        # source - spatial resolution
+                        if hSource.has_key?('spatialResolution')
+                            hObject = hSource['spatialResolution']
+                            unless hObject.empty?
+                                hReturn = SpatialResolution.unpack(hObject, responseObj)
+                                unless hReturn.nil?
+                                    intSource[:spatialResolution] = hReturn
+                                end
+                            end
+                        end
+
+                        # source - reference system
+                        if hSource.has_key?('referenceSystem')
+                            hObject = hSource['referenceSystem']
+                            unless hObject.empty?
+                                hReturn = SpatialReferenceSystem.unpack(hObject, responseObj)
+                                unless hReturn.nil?
+                                    intSource[:referenceSystem] = hReturn
+                                end
+                            end
+                        end
+
+                        # source - source steps []
+                        if hSource.has_key?('sourceProcessStep')
+                            aSteps = hSource['sourceProcessStep']
+                            aSteps.each do |item|
+                                hStep = ProcessStep.unpack(item, responseObj)
+                                unless hStep.nil?
+                                    intSource[:sourceSteps] << hStep
+                                end
+                            end
+                        end
+
+                        # source - scope {scope}
+                        if hSource.has_key?('scope')
+                            hObject = hSource['scope']
+                            unless hObject.empty?
+                                hReturn = Scope.unpack(hObject, responseObj)
+                                unless hReturn.nil?
+                                    intSource[:scope] = hReturn
+                                end
+                            end
+                        end
+
+                        return intSource
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,65 @@
+# unpack spatial reference system
+# Reader - ADIwg JSON to internal data structure
+
+# History:
+#   Stan Smith 2016-10-16 refactored for mdJson 2.0
+#   Stan Smith 2015-07-14 refactored to remove global namespace constants
+#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
+#   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+# 	Stan Smith 2014-09-03 original script
+
+require_relative 'module_identifier'
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module SpatialReferenceSystem
+
+                    def self.unpack(hSpatialRef, responseObj)
+
+                        # return nil object if input is empty
+                        if hSpatialRef.empty?
+                            responseObj[:readerExecutionMessages] << 'Spatial Reference System object is empty'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intSpatialRef = intMetadataClass.newSpatialReferenceSystem
+
+                        # spatial reference system - type
+                        if hSpatialRef.has_key?('referenceSystemType')
+                            if hSpatialRef['referenceSystemType'] != ''
+                                intSpatialRef[:systemType] = hSpatialRef['referenceSystemType']
+                            end
+                        end
+
+                        # spatial reference system - reference system {identifier}
+                        if hSpatialRef.has_key?('referenceSystemIdentifier')
+                            hObject = hSpatialRef['referenceSystemIdentifier']
+                            unless hObject.empty?
+                                hReturn = Identifier.unpack(hObject, responseObj)
+                                unless hReturn.nil?
+                                    intSpatialRef[:systemIdentifier] = hReturn
+                                end
+                            end
+                        end
+
+                        if intSpatialRef[:systemType].nil? && intSpatialRef[:systemIdentifier].empty?
+                            responseObj[:readerExecutionMessages] << 'Spatial Reference System must declare reference system type or reference system identifier'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        return intSpatialRef
+                    end
+
+                end
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,96 @@
+# unpack spatial representation
+# Reader - ADIwg JSON to internal data structure
+
+# History:
+#   Stan Smith 2016-10-19 original script
+
+require_relative 'module_gridRepresentation'
+require_relative 'module_vectorRepresentation'
+require_relative 'module_georectifiedRepresentation'
+require_relative 'module_georeferenceableRepresentation'
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module SpatialRepresentation
+
+                    def self.unpack(hRepresent, responseObj)
+
+                        # return nil object if input is empty
+                        if hRepresent.empty?
+                            responseObj[:readerExecutionMessages] << 'Spatial Representation object is empty'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intRepresent = intMetadataClass.newSpatialRepresentation
+                        haveOne = false
+
+                        # spatial representation - grid representation (required if not others)
+                        if hRepresent.has_key?('gridRepresentation')
+                            hRep = hRepresent['gridRepresentation']
+                            unless hRep.empty?
+                                hObject = GridRepresentation.unpack(hRep, responseObj)
+                                unless hObject.nil?
+                                    intRepresent[:gridRepresentation] = hObject
+                                    haveOne = true
+                                end
+                            end
+                        end
+
+                        # spatial representation - vector representation (required if not others)
+                        if hRepresent.has_key?('vectorRepresentation')
+                            hRep = hRepresent['vectorRepresentation']
+                            unless hRep.empty?
+                                hObject = VectorRepresentation.unpack(hRep, responseObj)
+                                unless hObject.nil?
+                                    intRepresent[:vectorRepresentation] = hObject
+                                    haveOne = true
+                                end
+                            end
+                        end
+
+                        # spatial representation - georectified representation (required if not others)
+                        if hRepresent.has_key?('georectifiedRepresentation')
+                            hRep = hRepresent['georectifiedRepresentation']
+                            unless hRep.empty?
+                                hObject = GeorectifiedRepresentation.unpack(hRep, responseObj)
+                                unless hObject.nil?
+                                    intRepresent[:georectifiedRepresentation] = hObject
+                                    haveOne = true
+                                end
+                            end
+                        end
+
+                        # spatial representation - georeferenceable representation (required if not others)
+                        if hRepresent.has_key?('georeferenceableRepresentation')
+                            hRep = hRepresent['georeferenceableRepresentation']
+                            unless hRep.empty?
+                                hObject = GeoreferenceableRepresentation.unpack(hRep, responseObj)
+                                unless hObject.nil?
+                                    intRepresent[:georeferenceableRepresentation] = hObject
+                                    haveOne = true
+                                end
+                            end
+                        end
+
+                        unless haveOne
+                            responseObj[:readerExecutionMessages] << 'Spatial Representation did not have an object of supported type'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        return intRepresent
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,77 @@
+# unpack spatial resolution
+# Reader - ADIwg JSON to internal data structure
+
+# History:
+#   Stan Smith 2016-10-17 refactored for mdJson 2.0
+#   Stan Smith 2015-07-14 refactored to remove global namespace constants
+#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
+#   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+# 	Stan Smith 2013-11-26 original script
+
+require_relative 'module_measure'
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module SpatialResolution
+
+                    def self.unpack(hResolution, responseObj)
+
+                        # return nil object if input is empty
+                        if hResolution.empty?
+                            responseObj[:readerExecutionMessages] << 'Spatial Resolution object is empty'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intResolution = intMetadataClass.newSpatialResolution
+                        haveOne = false
+
+                        # spatial resolution - scale factor (required if not others)
+                        if hResolution.has_key?('scaleFactor')
+                            if hResolution['scaleFactor'] != ''
+                                intResolution[:scaleFactor] = hResolution['scaleFactor']
+                                haveOne = true
+                            end
+                        end
+
+                        # spatial resolution - measure (required if not others)
+                        if hResolution.has_key?('measure')
+                            hMeasure = hResolution['measure']
+                            unless hMeasure.empty?
+                                hObject = Measure.unpack(hMeasure, responseObj)
+                                unless hObject.nil?
+                                    intResolution[:measure] = hObject
+                                    haveOne = true
+                                end
+                            end
+                        end
+
+                        # spatial resolution - level of detail (required if not others)
+                        if hResolution.has_key?('levelOfDetail')
+                            if hResolution['levelOfDetail'] != ''
+                                intResolution[:levelOfDetail] = hResolution['levelOfDetail']
+                                haveOne = true
+                            end
+                        end
+
+                    unless haveOne
+                        responseObj[:readerExecutionMessages] << 'Spatial Resolution did not have an object of supported type'
+                        responseObj[:readerExecutionPass] = false
+                        return nil
+                    end
+
+                    return intResolution
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end