adiwg-mdtranslator 1.4.0 → 2.0.0rc2

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

@@ -0,0 +1,101 @@
+# unpack address
+# Reader - ADIwg JSON to internal data structure
+
+# History:
+#   Stan Smith 2016-10-03 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-30 refactored
+#   ... electronicMailAddresses into internal object
+#   Stan Smith 2014-12-19 prevented passing blank deliveryPoints and
+#   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+#   Stan Smith 2013-10-21 original script
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module Address
+
+                    def self.unpack(hAddress, responseObj)
+
+                        # return nil object if input is empty
+                        if hAddress.empty?
+                            responseObj[:readerExecutionMessages] << 'Address object is empty'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intAdd = intMetadataClass.newAddress
+
+                        # address - address type [adiwg_addressType] (required)
+                        if hAddress.has_key?('addressType')
+                            hAddress['addressType'].each do |item|
+                                if item != ''
+                                    intAdd[:addressTypes] << item
+                                end
+                            end
+                        end
+                        if intAdd[:addressTypes].empty?
+                            responseObj[:readerExecutionMessages] << 'Address Type is missing'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # address - description
+                        if hAddress.has_key?('description')
+                            if hAddress['description'] != ''
+                                intAdd[:description] = hAddress['description']
+                            end
+                        end
+
+                        # address - delivery point
+                        if hAddress.has_key?('deliveryPoint')
+                            hAddress['deliveryPoint'].each do |item|
+                                if item != ''
+                                    intAdd[:deliveryPoints] << item
+                                end
+                            end
+                        end
+
+                        # address - city
+                        if hAddress.has_key?('city')
+                            if hAddress['city'] != ''
+                                intAdd[:city] = hAddress['city']
+                            end
+                        end
+
+                        # address - admin area
+                        if hAddress.has_key?('administrativeArea')
+                            if hAddress['administrativeArea'] != ''
+                                intAdd[:adminArea] = hAddress['administrativeArea']
+                            end
+                        end
+
+                        # address - postal code
+                        if hAddress.has_key?('postalCode')
+                            if hAddress['postalCode'] != ''
+                                intAdd[:postalCode] = hAddress['postalCode']
+                            end
+                        end
+
+                        # address - country
+                        if hAddress.has_key?('country')
+                            if hAddress['country'] != ''
+                                intAdd[:country] = hAddress['country']
+                            end
+                        end
+
+                        return intAdd
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,84 @@
+# unpack allocation
+# Reader - ADIwg JSON to internal data structure
+
+# History:
+#   Stan Smith 2016-10-30 original script
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module Allocation
+
+                    def self.unpack(hAlloc, responseObj)
+
+                        # return nil object if input is empty
+                        if hAlloc.empty?
+                            responseObj[:readerExecutionMessages] << 'Allocation object is empty'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intAlloc = intMetadataClass.newAllocation
+
+                        # allocation - amount (required)
+                        if hAlloc.has_key?('amount')
+                            intAlloc[:amount] = hAlloc['amount']
+                        end
+                        if intAlloc[:amount].nil? || intAlloc[:amount] == ''
+                            responseObj[:readerExecutionMessages] << 'Allocation attribute is missing amount'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # allocation - currency (required)
+                        if hAlloc.has_key?('currency')
+                            intAlloc[:currency] = hAlloc['currency']
+                        end
+                        if intAlloc[:currency].nil? || intAlloc[:currency] == ''
+                            responseObj[:readerExecutionMessages] << 'Allocation attribute is missing currency'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # allocation - source ID {contactId}
+                        if hAlloc.has_key?('sourceId')
+                            if hAlloc['sourceId'] != ''
+                                intAlloc[:sourceId] = hAlloc['sourceId']
+                            end
+                        end
+
+                        # allocation - recipient ID {contactId}
+                        if hAlloc.has_key?('recipientId')
+                            if hAlloc['recipientId'] != ''
+                                intAlloc[:recipientId] = hAlloc['recipientId']
+                            end
+                        end
+
+                        # allocation - matching {Boolean}
+                        if hAlloc.has_key?('matching')
+                            if hAlloc['matching'] === true
+                                intAlloc[:matching] = hAlloc['matching']
+                            end
+                        end
+
+                        # allocation - comment
+                        if hAlloc.has_key?('comment')
+                            if hAlloc['comment'] != ''
+                                intAlloc[:comment] = hAlloc['comment']
+                            end
+                        end
+
+                        return intAlloc
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,111 @@
+# unpack associated resource
+# Reader - ADIwg JSON to internal data structure
+
+# History:
+#   Stan Smith 2016-10-18 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-30 added return if empty input
+#   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+#   Stan Smith 2014-11-06 added resourceType for 0.9.0
+#   Stan Smith 2014-11-06 changed resourceType to initiative type for 0.9.0
+#   Stan Smith 2014-08-18 moved resourceIdentifier to citation module schema 0.6.0
+#   Stan Smith 2014-07-08 resolve require statements using Mdtranslator.reader_module
+# 	Stan Smith 2014-06-02 added resource metadata citation section
+# 	Stan Smith 2014-05-28 added resource identifier section
+# 	Stan Smith 2014-05-02 original script
+
+require_relative 'module_citation'
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module AssociatedResource
+
+                    def self.unpack(hAssocRes, responseObj)
+
+                        # return nil object if input is empty
+                        if hAssocRes.empty?
+                            responseObj[:readerExecutionMessages] << 'Associated Resource object is empty'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intAssocRes = intMetadataClass.newAssociatedResource
+
+                        # associated resource - resource type [] (required) {resourceType}
+                        if hAssocRes.has_key?('resourceType')
+                            hAssocRes['resourceType'].each do |item|
+                                unless item.empty?
+                                    hReturn = ResourceType.unpack(item, responseObj)
+                                    unless hReturn.nil?
+                                        intAssocRes[:resourceTypes] << hReturn
+                                    end
+                                end
+                            end
+                        end
+                        if intAssocRes[:resourceTypes].empty?
+                            responseObj[:readerExecutionMessages] << 'Associated Resource is missing resourceType'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # associated resource - association type (required)
+                        if hAssocRes.has_key?('associationType')
+                            intAssocRes[:associationType] = hAssocRes['associationType']
+                        end
+                        if intAssocRes[:associationType].nil? || intAssocRes[:associationType] == ''
+                            responseObj[:readerExecutionMessages] << 'Associated Resource attribute associationType is missing'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # associated resource - initiative type
+                        if hAssocRes.has_key?('initiativeType')
+                            if hAssocRes['initiativeType'] != ''
+                                intAssocRes[:initiativeType] = hAssocRes['initiativeType']
+                            end
+                        end
+
+                         # associated resource - resource citation (required) {CI_Citation}
+                        if hAssocRes.has_key?('resourceCitation')
+                            hObject = hAssocRes['resourceCitation']
+                            unless hObject.empty?
+                                hReturn = Citation.unpack(hObject, responseObj)
+                                unless hReturn.nil?
+                                    intAssocRes[:resourceCitation] = hReturn
+                                end
+                            end
+                        end
+                        if intAssocRes[:resourceCitation].empty?
+                            responseObj[:readerExecutionMessages] << 'Associated Resource requires a resource citation'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # associated resource - metadata citation
+                        if hAssocRes.has_key?('metadataCitation')
+                            hObject = hAssocRes['metadataCitation']
+                            unless hObject.empty?
+                                hReturn = Citation.unpack(hObject, responseObj)
+                                unless hReturn.nil?
+                                    intAssocRes[:metadataCitation] = hReturn
+                                end
+                            end
+                        end
+
+
+                        return intAssocRes
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,224 @@
+# unpack attribute group
+# Reader - ADIwg JSON to internal data structure
+
+# History:
+# 	Stan Smith 2016-10-18 original script
+
+require_relative 'module_identifier'
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module Attribute
+
+                    def self.unpack(hAttribute, responseObj)
+
+                        # return nil object if input is empty
+                        if hAttribute.empty?
+                            responseObj[:readerExecutionMessages] << 'Attribute object is empty'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intAttGroup = intMetadataClass.newAttribute
+
+                        # attribute group - sequence identifier
+                        if hAttribute.has_key?('sequenceIdentifier')
+                            if hAttribute['sequenceIdentifier'] != ''
+                                intAttGroup[:sequenceIdentifier] = hAttribute['sequenceIdentifier']
+                            end
+                        end
+
+                        # attribute group - sequence identifier type (required if)
+                        unless intAttGroup[:sequenceIdentifier].nil?
+                            if hAttribute.has_key?('sequenceIdentifierType')
+                                if hAttribute['sequenceIdentifierType'] != ''
+                                    intAttGroup[:sequenceIdentifierType] = hAttribute['sequenceIdentifierType']
+                                end
+                            end
+                            if intAttGroup[:sequenceIdentifierType].nil?
+                                responseObj[:readerExecutionMessages] << 'Attribute attribute sequenceIdentifierType is missing'
+                                responseObj[:readerExecutionPass] = false
+                                return nil
+                            end
+                        end
+
+                        # attribute group - attribute description
+                        if hAttribute.has_key?('attributeDescription')
+                            if hAttribute['attributeDescription'] != ''
+                                intAttGroup[:attributeDescription] = hAttribute['attributeDescription']
+                            end
+                        end
+
+                        # attribute group - attribute identifier [identifier]
+                        if hAttribute.has_key?('attributeIdentifier')
+                            aItems = hAttribute['attributeIdentifier']
+                            aItems.each do |item|
+                                hReturn = Identifier.unpack(item, responseObj)
+                                unless hReturn.nil?
+                                    intAttGroup[:attributeIdentifiers] << hReturn
+                                end
+                            end
+                        end
+
+                        # attribute group - min value
+                        if hAttribute.has_key?('minValue')
+                            if hAttribute['minValue'] != ''
+                                intAttGroup[:minValue] = hAttribute['minValue']
+                            end
+                        end
+
+                        # attribute group - max value
+                        if hAttribute.has_key?('maxValue')
+                            if hAttribute['maxValue'] != ''
+                                intAttGroup[:maxValue] = hAttribute['maxValue']
+                            end
+                        end
+
+                        # attribute group - units (required if)
+                        unless intAttGroup[:minValue].nil? && intAttGroup[:maxValue].nil?
+                            if hAttribute.has_key?('units')
+                                if hAttribute['units'] != ''
+                                    intAttGroup[:units] = hAttribute['units']
+                                end
+                            end
+                            if intAttGroup[:units].nil?
+                                responseObj[:readerExecutionMessages] << 'Attribute attribute units is missing'
+                                responseObj[:readerExecutionPass] = false
+                                return nil
+                            end
+                        end
+
+                        # attribute group - scale factor
+                        if hAttribute.has_key?('scaleFactor')
+                            if hAttribute['scaleFactor'] != ''
+                                intAttGroup[:scaleFactor] = hAttribute['scaleFactor']
+                            end
+                        end
+
+                        # attribute group - offset
+                        if hAttribute.has_key?('offset')
+                            if hAttribute['offset'] != ''
+                                intAttGroup[:offset] = hAttribute['offset']
+                            end
+                        end
+
+                        # attribute group - mean value
+                        if hAttribute.has_key?('meanValue')
+                            if hAttribute['meanValue'] != ''
+                                intAttGroup[:meanValue] = hAttribute['meanValue']
+                            end
+                        end
+
+                        # attribute group - number of values
+                        if hAttribute.has_key?('numberOfValues')
+                            if hAttribute['numberOfValues'] != ''
+                                intAttGroup[:numberOfValues] = hAttribute['numberOfValues']
+                            end
+                        end
+
+                        # attribute group - standard deviation
+                        if hAttribute.has_key?('standardDeviation')
+                            if hAttribute['standardDeviation'] != ''
+                                intAttGroup[:standardDeviation] = hAttribute['standardDeviation']
+                            end
+                        end
+
+                        # attribute group - bits per value
+                        if hAttribute.has_key?('bitsPerValue')
+                            if hAttribute['bitsPerValue'] != ''
+                                intAttGroup[:bitsPerValue] = hAttribute['bitsPerValue']
+                            end
+                        end
+
+                        # attribute group - bound min
+                        if hAttribute.has_key?('boundMin')
+                            if hAttribute['boundMin'] != ''
+                                intAttGroup[:boundMin] = hAttribute['boundMin']
+                            end
+                        end
+
+                        # attribute group - bound max
+                        if hAttribute.has_key?('boundMax')
+                            if hAttribute['boundMax'] != ''
+                                intAttGroup[:boundMax] = hAttribute['boundMax']
+                            end
+                        end
+
+                        # attribute group - bound units (required if)
+                        unless intAttGroup[:boundMin].nil? && intAttGroup[:boundMax].nil?
+                            if hAttribute.has_key?('boundUnits')
+                                if hAttribute['boundUnits'] != ''
+                                    intAttGroup[:boundUnits] = hAttribute['boundUnits']
+                                end
+                            end
+                            if intAttGroup[:boundUnits].nil?
+                                responseObj[:readerExecutionMessages] << 'Attribute attribute boundUnits is missing'
+                                responseObj[:readerExecutionPass] = false
+                                return nil
+                            end
+                        end
+
+                        # attribute group - peak response
+                        if hAttribute.has_key?('peakResponse')
+                            if hAttribute['peakResponse'] != ''
+                                intAttGroup[:peakResponse] = hAttribute['peakResponse']
+                            end
+                        end
+
+                        # attribute group - tone gradations
+                        if hAttribute.has_key?('toneGradations')
+                            if hAttribute['toneGradations'] != ''
+                                intAttGroup[:toneGradations] = hAttribute['toneGradations']
+                            end
+                        end
+
+                        # attribute group - band boundary definition
+                        if hAttribute.has_key?('bandBoundaryDefinition')
+                            if hAttribute['bandBoundaryDefinition'] != ''
+                                intAttGroup[:bandBoundaryDefinition] = hAttribute['bandBoundaryDefinition']
+                            end
+                        end
+
+                        # attribute group - nominal spatial resolution {measure}
+                        if hAttribute.has_key?('nominalSpatialResolution')
+                            if hAttribute['nominalSpatialResolution'] != ''
+                                intAttGroup[:nominalSpatialResolution] = hAttribute['nominalSpatialResolution']
+                            end
+                        end
+
+                        # attribute group - transfer function type
+                        if hAttribute.has_key?('transferFunctionType')
+                            if hAttribute['transferFunctionType'] != ''
+                                intAttGroup[:transferFunctionType] = hAttribute['transferFunctionType']
+                            end
+                        end
+
+                        # attribute group - transmitted polarization
+                        if hAttribute.has_key?('transmittedPolarization')
+                            if hAttribute['transmittedPolarization'] != ''
+                                intAttGroup[:transmittedPolarization] = hAttribute['transmittedPolarization']
+                            end
+                        end
+
+                        # attribute group - detected polarization
+                        if hAttribute.has_key?('detectedPolarization')
+                            if hAttribute['detectedPolarization'] != ''
+                                intAttGroup[:detectedPolarization] = hAttribute['detectedPolarization']
+                            end
+                        end
+
+                        return intAttGroup
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,63 @@
+# unpack attribute group
+# Reader - ADIwg JSON to internal data structure
+
+# History:
+# 	Stan Smith 2016-10-18 original script
+
+require_relative 'module_attribute'
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module AttributeGroup
+
+                    def self.unpack(hAttGroup, responseObj)
+
+                        # return nil object if input is empty
+                        if hAttGroup.empty?
+                            responseObj[:readerExecutionMessages] << 'Attribute Group object is empty'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intAttGroup = intMetadataClass.newAttributeGroup
+
+                        # attribute group - attribute content type [] (required)
+                        if hAttGroup.has_key?('attributeContentType')
+                            hAttGroup['attributeContentType'].each do |item|
+                                if item != ''
+                                    intAttGroup[:attributeContentTypes] << item
+                                end
+                            end
+                        end
+                        if intAttGroup[:attributeContentTypes].empty?
+                            responseObj[:readerExecutionMessages] << 'Attribute Group attribute attributeContentType is missing'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # attribute group - attribute []
+                        if hAttGroup.has_key?('attribute')
+                            aItems = hAttGroup['attribute']
+                            aItems.each do |item|
+                                hReturn = Attribute.unpack(item, responseObj)
+                                unless hReturn.nil?
+                                    intAttGroup[:attributes] << hReturn
+                                end
+                            end
+                        end
+
+                        return intAttGroup
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,95 @@
+# unpack bounding box
+# Reader - ADIwg JSON to internal data structure
+
+# History:
+#   Stan Smith 2016-12-01 original script
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module BoundingBox
+
+                    def self.unpack(hBBox, responseObj)
+
+                        # return nil object if input is empty
+                        if hBBox.empty?
+                            responseObj[:readerExecutionMessages] << 'boundingBox object is empty'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intBBox = intMetadataClass.newBoundingBox
+
+                        # bounding box - west longitude (required)
+                        if hBBox.has_key?('westLongitude')
+                            intBBox[:westLongitude] = hBBox['westLongitude']
+                        end
+                        if intBBox[:westLongitude].nil? || intBBox[:westLongitude] == ''
+                            responseObj[:readerExecutionMessages] << 'boundingBox west boundary is missing'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+                        if intBBox[:westLongitude].abs > 180
+                            responseObj[:readerExecutionMessages] << 'boundingBox longitude must be between -180 and +180'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # bounding box - east longitude (required)
+                        if hBBox.has_key?('eastLongitude')
+                            intBBox[:eastLongitude] = hBBox['eastLongitude']
+                        end
+                        if intBBox[:eastLongitude].nil? || intBBox[:eastLongitude] == ''
+                            responseObj[:readerExecutionMessages] << 'boundingBox east boundary is missing'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+                        if intBBox[:eastLongitude].abs > 180
+                            responseObj[:readerExecutionMessages] << 'boundingBox longitude must be between -180 and +180'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # bounding box - south latitude (required)
+                        if hBBox.has_key?('southLatitude')
+                            intBBox[:southLatitude] = hBBox['southLatitude']
+                        end
+                        if intBBox[:southLatitude].nil? || intBBox[:southLatitude] == ''
+                            responseObj[:readerExecutionMessages] << 'boundingBox south boundary is missing'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+                        if intBBox[:southLatitude].abs > 90
+                            responseObj[:readerExecutionMessages] << 'boundingBox latitude must be between -90 and +90'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+                        # bounding box - north latitude (required)
+                        if hBBox.has_key?('northLatitude')
+                            intBBox[:northLatitude] = hBBox['northLatitude']
+                        end
+                        if intBBox[:northLatitude].nil? || intBBox[:northLatitude] == ''
+                            responseObj[:readerExecutionMessages] << 'boundingBox north boundary is missing'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+                        if intBBox[:northLatitude].abs > 90
+                            responseObj[:readerExecutionMessages] << 'boundingBox latitude must be between -90 and +90'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        return intBBox
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end