adiwg-mdtranslator 2.9.2 → 2.10.0

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

@@ -2,6 +2,7 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
+#  Stan Smith 2018-02-19 refactored error and warning messaging
 # 	Stan Smith 2017-10-23 original script
 
 require_relative 'module_identifier'
@@ -18,8 +19,8 @@ module ADIWG
 
                   # return nil object if input is empty
                   if hProjection.empty?
-                     responseObj[:readerExecutionMessages] << 'Reference System Projection Parameters object is empty'
-                     responseObj[:readerExecutionPass] = false
+                     responseObj[:readerExecutionMessages] <<
+                        'WARNING: mdJson reader: reference system projection parameters object is empty'
                      return nil
                   end
 
@@ -39,14 +40,14 @@ module ADIWG
 
                   # projection parameters - grid system
                   if hProjection.has_key?('gridSystem')
-                     if hProjection['gridSystem'] != ''
+                     unless hProjection['gridSystem'] == ''
                         intProjection[:gridSystem] = hProjection['gridSystem']
                      end
                   end
 
                   # projection parameters - grid system name
                   if hProjection.has_key?('gridSystemName')
-                     if hProjection['gridSystemName'] != ''
+                     unless hProjection['gridSystemName'] == ''
                         intProjection[:gridSystemName] = hProjection['gridSystemName']
                      end
                   end
@@ -56,140 +57,140 @@ module ADIWG
                      intProjection[:projection] = hProjection['projection']
                   end
                   if intProjection[:projection].nil? || intProjection[:projection] == ''
-                     responseObj[:readerExecutionMessages] << 'Spatial Reference Projection is missing'
+                     responseObj[:readerExecutionMessages] << 'spatial reference projection is missing'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end
 
                   # projection parameters - projection name
                   if hProjection.has_key?('projectionName')
-                     if hProjection['projectionName'] != ''
+                     unless hProjection['projectionName'] == ''
                         intProjection[:projectionName] = hProjection['projectionName']
                      end
                   end
 
                   # projection parameters - zone
                   if hProjection.has_key?('gridZone')
-                     if hProjection['gridZone'] != ''
+                     unless hProjection['gridZone'] == ''
                         intProjection[:gridZone] = hProjection['gridZone']
                      end
                   end
 
                   # projection parameters - standard parallel 1
                   if hProjection.has_key?('standardParallel1')
-                     if hProjection['standardParallel1'] != ''
+                     unless hProjection['standardParallel1'] == ''
                         intProjection[:standardParallel1] = hProjection['standardParallel1']
                      end
                   end
 
                   # projection parameters - standard parallel 2
                   if hProjection.has_key?('standardParallel2')
-                     if hProjection['standardParallel2'] != ''
+                     unless hProjection['standardParallel2'] == ''
                         intProjection[:standardParallel2] = hProjection['standardParallel2']
                      end
                   end
 
                   # projection parameters - longitude of central meridian
                   if hProjection.has_key?('longitudeOfCentralMeridian')
-                     if hProjection['longitudeOfCentralMeridian'] != ''
+                     unless hProjection['longitudeOfCentralMeridian'] == ''
                         intProjection[:longitudeOfCentralMeridian] = hProjection['longitudeOfCentralMeridian']
                      end
                   end
 
                   # projection parameters - latitude of projection origin
                   if hProjection.has_key?('latitudeOfProjectionOrigin')
-                     if hProjection['latitudeOfProjectionOrigin'] != ''
+                     unless hProjection['latitudeOfProjectionOrigin'] == ''
                         intProjection[:latitudeOfProjectionOrigin] = hProjection['latitudeOfProjectionOrigin']
                      end
                   end
 
                   # projection parameters - false easting
                   if hProjection.has_key?('falseEasting')
-                     if hProjection['falseEasting'] != ''
+                     unless hProjection['falseEasting'] == ''
                         intProjection[:falseEasting] = hProjection['falseEasting']
                      end
                   end
 
                   # projection parameters - false northing
                   if hProjection.has_key?('falseNorthing')
-                     if hProjection['falseNorthing'] != ''
+                     unless hProjection['falseNorthing'] == ''
                         intProjection[:falseNorthing] = hProjection['falseNorthing']
                      end
                   end
 
                   # projection parameters - false easting northing units
                   if hProjection.has_key?('falseEastingNorthingUnits')
-                     if hProjection['falseEastingNorthingUnits'] != ''
+                     unless hProjection['falseEastingNorthingUnits'] == ''
                         intProjection[:falseEastingNorthingUnits] = hProjection['falseEastingNorthingUnits']
                      end
                   end
 
                   # projection parameters - scale factor at equator
                   if hProjection.has_key?('scaleFactorAtEquator')
-                     if hProjection['scaleFactorAtEquator'] != ''
+                     unless hProjection['scaleFactorAtEquator'] == ''
                         intProjection[:scaleFactorAtEquator] = hProjection['scaleFactorAtEquator']
                      end
                   end
 
                   # projection parameters - height of prospective point above surface
                   if hProjection.has_key?('heightOfProspectivePointAboveSurface')
-                     if hProjection['heightOfProspectivePointAboveSurface'] != ''
+                     unless hProjection['heightOfProspectivePointAboveSurface'] == ''
                         intProjection[:heightOfProspectivePointAboveSurface] = hProjection['heightOfProspectivePointAboveSurface'].to_f
                      end
                   end
 
                   # projection parameters - longitude of projection center
                   if hProjection.has_key?('longitudeOfProjectionCenter')
-                     if hProjection['longitudeOfProjectionCenter'] != ''
+                     unless hProjection['longitudeOfProjectionCenter'] == ''
                         intProjection[:longitudeOfProjectionCenter] = hProjection['longitudeOfProjectionCenter']
                      end
                   end
 
                   # projection parameters - latitude of projection center
                   if hProjection.has_key?('latitudeOfProjectionCenter')
-                     if hProjection['latitudeOfProjectionCenter'] != ''
+                     unless hProjection['latitudeOfProjectionCenter'] == ''
                         intProjection[:latitudeOfProjectionCenter] = hProjection['latitudeOfProjectionCenter']
                      end
                   end
 
                   # projection parameters - scale factor at center line
                   if hProjection.has_key?('scaleFactorAtCenterLine')
-                     if hProjection['scaleFactorAtCenterLine'] != ''
+                     unless hProjection['scaleFactorAtCenterLine'] == ''
                         intProjection[:scaleFactorAtCenterLine] = hProjection['scaleFactorAtCenterLine']
                      end
                   end
 
                   # projection parameters - scale factor at meridian
                   if hProjection.has_key?('scaleFactorAtCentralMeridian')
-                     if hProjection['scaleFactorAtCentralMeridian'] != ''
+                     unless hProjection['scaleFactorAtCentralMeridian'] == ''
                         intProjection[:scaleFactorAtCentralMeridian] = hProjection['scaleFactorAtCentralMeridian']
                      end
                   end
 
                   # projection parameters - straight vertical longitude from pole
                   if hProjection.has_key?('straightVerticalLongitudeFromPole')
-                     if hProjection['straightVerticalLongitudeFromPole'] != ''
+                     unless hProjection['straightVerticalLongitudeFromPole'] == ''
                         intProjection[:straightVerticalLongitudeFromPole] = hProjection['straightVerticalLongitudeFromPole']
                      end
                   end
 
                   # projection parameters - scale factor at projection origin
                   if hProjection.has_key?('scaleFactorAtProjectionOrigin')
-                     if hProjection['scaleFactorAtProjectionOrigin'] != ''
+                     unless hProjection['scaleFactorAtProjectionOrigin'] == ''
                         intProjection[:scaleFactorAtProjectionOrigin] = hProjection['scaleFactorAtProjectionOrigin']
                      end
                   end
 
                   # projection parameters - azimuth angle
                   if hProjection.has_key?('azimuthAngle')
-                     if hProjection['azimuthAngle'] != ''
+                     unless hProjection['azimuthAngle'] == ''
                         intProjection[:azimuthAngle] = hProjection['azimuthAngle']
                      end
                   end
 
                   # projection parameters - azimuth measure point longitude
                   if hProjection.has_key?('azimuthMeasurePointLongitude')
-                     if hProjection['azimuthMeasurePointLongitude'] != ''
+                     unless hProjection['azimuthMeasurePointLongitude'] == ''
                         intProjection[:azimuthMeasurePointLongitude] = hProjection['azimuthMeasurePointLongitude']
                      end
                   end
@@ -207,42 +208,42 @@ module ADIWG
 
                   # projection parameters - landsat number
                   if hProjection.has_key?('landsatNumber')
-                     if hProjection['landsatNumber'] != ''
+                     unless hProjection['landsatNumber'] == ''
                         intProjection[:landsatNumber] = hProjection['landsatNumber']
                      end
                   end
 
                   # projection parameters - landsat path
                   if hProjection.has_key?('landsatPath')
-                     if hProjection['landsatPath'] != ''
+                     unless hProjection['landsatPath'] == ''
                         intProjection[:landsatPath] = hProjection['landsatPath']
                      end
                   end
 
                   # projection parameters - local planar description
                   if hProjection.has_key?('localPlanarDescription')
-                     if hProjection['localPlanarDescription'] != ''
+                     unless hProjection['localPlanarDescription'] == ''
                         intProjection[:localPlanarDescription] = hProjection['localPlanarDescription']
                      end
                   end
 
                   # projection parameters - local planar georeference
                   if hProjection.has_key?('localPlanarGeoreference')
-                     if hProjection['localPlanarGeoreference'] != ''
+                     unless hProjection['localPlanarGeoreference'] == ''
                         intProjection[:localPlanarGeoreference] = hProjection['localPlanarGeoreference']
                      end
                   end
 
                   # projection parameters - other projection description
                   if hProjection.has_key?('otherProjectionDescription')
-                     if hProjection['otherProjectionDescription'] != ''
+                     unless hProjection['otherProjectionDescription'] == ''
                         intProjection[:otherProjectionDescription] = hProjection['otherProjectionDescription']
                      end
                   end
 
                   # projection parameters - other grid description
                   if hProjection.has_key?('otherGridDescription')
-                     if hProjection['otherGridDescription'] != ''
+                     unless hProjection['otherGridDescription'] == ''
                         intProjection[:otherGridDescription] = hProjection['otherGridDescription']
                      end
                   end

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

@@ -2,6 +2,7 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
+#  Stan Smith 2018-02-19 refactored error and warning messaging
 # 	Stan Smith 2017-10-23 original script
 
 require_relative 'module_projectionParameters'
@@ -19,8 +20,8 @@ module ADIWG
 
                   # return nil object if input is empty
                   if hParams.empty?
-                     responseObj[:readerExecutionMessages] << 'Spatial Reference System Parameters object is empty'
-                     responseObj[:readerExecutionPass] = false
+                     responseObj[:readerExecutionMessages] <<
+                        'WARNING: mdJson reader: spatial reference system parameters object is empty'
                      return nil
                   end
 
@@ -28,12 +29,15 @@ module ADIWG
                   intMetadataClass = InternalMetadata.new
                   intParamSet = intMetadataClass.newReferenceSystemParameterSet
 
+                  haveParams = false
+
                   # reference system parameters - projection parameters
                   if hParams.has_key?('projection')
                      unless hParams['projection'].empty?
                         hReturn = ProjectionParameters.unpack(hParams['projection'], responseObj)
                         unless hReturn.nil?
                            intParamSet[:projection] = hReturn
+                           haveParams = true
                         end
                      end
                   end
@@ -44,6 +48,7 @@ module ADIWG
                         hReturn = Geodetic.unpack(hParams['geodetic'], responseObj)
                         unless hReturn.nil?
                            intParamSet[:geodetic] = hReturn
+                           haveParams = true
                         end
                      end
                   end
@@ -54,10 +59,19 @@ module ADIWG
                         hReturn = VerticalDatum.unpack(hParams['verticalDatum'], responseObj)
                         unless hReturn.nil?
                            intParamSet[:verticalDatum] = hReturn
+                           haveParams = true
                         end
                      end
                   end
 
+                  # error messages
+                  unless haveParams
+                     responseObj[:readerExecutionMessages] <<
+                        'WARNING: mdJson reader: spatial reference system parameters must have at least one projection, geodetic, or vertical datum'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
                   return intParamSet
                end
 

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

@@ -2,70 +2,76 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
+#  Stan Smith 2018-02-19 refactored error and warning messaging
 # 	Stan Smith 2016-10-15 original script
 
 require_relative 'module_responsibleParty'
 
 module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
+   module Mdtranslator
+      module Readers
+         module MdJson
 
-                module Releasability
+            module Releasability
 
-                    def self.unpack(hRelease, responseObj)
+               def self.unpack(hRelease, responseObj)
 
-                        # return nil object if input is empty
-                        if hRelease.empty?
-                            responseObj[:readerExecutionMessages] << 'Releasability object is empty'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
+                  # return nil object if input is empty
+                  if hRelease.empty?
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: releasability object is empty'
+                     return nil
+                  end
 
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intRelease = intMetadataClass.newRelease
-
-                        # releasability - addressee [responsibleParty]
-                        if hRelease.has_key?('addressee')
-                            aRParty = hRelease['addressee']
-                            aRParty.each do |item|
-                                hParty = ResponsibleParty.unpack(item, responseObj)
-                                unless hParty.nil?
-                                    intRelease[:addressee] << hParty
-                                end
-                            end
-                        end
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intRelease = intMetadataClass.newRelease
 
-                        # releasability - statement
-                        if hRelease.has_key?('statement')
-                            if hRelease['statement'] != ''
-                                intRelease[:statement] = hRelease['statement']
-                            end
-                        end
+                  haveRelease = false
 
-                        # releasability - dissemination constraint []
-                        if hRelease.has_key?('disseminationConstraint')
-                            hRelease['disseminationConstraint'].each do |item|
-                                if item != ''
-                                    intRelease[:disseminationConstraint] << item
-                                end
-                            end
+                  # releasability - addressee [responsibleParty]
+                  if hRelease.has_key?('addressee')
+                     aRParty = hRelease['addressee']
+                     aRParty.each do |item|
+                        hParty = ResponsibleParty.unpack(item, responseObj)
+                        unless hParty.nil?
+                           intRelease[:addressee] << hParty
+                           haveRelease = true
                         end
+                     end
+                  end
 
-                        if intRelease[:addressee].empty? && intRelease[:statement].nil?
-                            responseObj[:readerExecutionMessages] << 'Releasability must have at least one addressee or statement'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
+                  # releasability - statement
+                  if hRelease.has_key?('statement')
+                     unless hRelease['statement'] == ''
+                        intRelease[:statement] = hRelease['statement']
+                        haveRelease = true
+                     end
+                  end
+
+                  # releasability - dissemination constraint []
+                  if hRelease.has_key?('disseminationConstraint')
+                     hRelease['disseminationConstraint'].each do |item|
+                        if item != ''
+                           intRelease[:disseminationConstraint] << item
                         end
+                     end
+                  end
 
-                        return intRelease
+                  # error messages
+                  unless haveRelease
+                     responseObj[:readerExecutionMessages] <<
+                        'ERROR: mdJson reader: releasability must have at least one addressee or statement'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
 
-                    end
+                  return intRelease
 
-                end
+               end
 
             end
-        end
-    end
+
+         end
+      end
+   end
 end

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

@@ -2,6 +2,7 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
+#  Stan Smith 2018-02-19 refactored error and warning messaging
 #  Stan Smith 2017-05-16 deprecated topic category
 #   ... topic category is now handled as keyword list
 #  Stan Smith 2016-11-01 original script
@@ -37,7 +38,7 @@ module ADIWG
 
                   # return nil object if input is empty
                   if hResInfo.empty?
-                     responseObj[:readerExecutionMessages] << 'ResourceInfo object is empty'
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: resource info object is empty'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end
@@ -58,7 +59,7 @@ module ADIWG
                      end
                   end
                   if intResInfo[:resourceTypes].empty?
-                     responseObj[:readerExecutionMessages] << 'ResourceInfo is missing resourceType'
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: resource info resource type is missing'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end
@@ -74,7 +75,7 @@ module ADIWG
                      end
                   end
                   if intResInfo[:citation].empty?
-                     responseObj[:readerExecutionMessages] << 'ResourceInfo is missing citation'
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: resource info citation is missing'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end
@@ -84,21 +85,21 @@ module ADIWG
                      intResInfo[:abstract] = hResInfo['abstract']
                   end
                   if intResInfo[:abstract].nil? || intResInfo[:abstract] == ''
-                     responseObj[:readerExecutionMessages] << 'ResourceInfo is missing abstract'
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: resource info abstract is missing'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end
 
                   # resource information - short abstract
                   if hResInfo.has_key?('shortAbstract')
-                     if hResInfo['shortAbstract'] != ''
+                     unless hResInfo['shortAbstract'] == ''
                         intResInfo[:shortAbstract] = hResInfo['shortAbstract']
                      end
                   end
 
                   # resource information - purpose
                   if hResInfo.has_key?('purpose')
-                     if hResInfo['purpose'] != ''
+                     unless hResInfo['purpose'] == ''
                         intResInfo[:purpose] = hResInfo['purpose']
                      end
                   end
@@ -106,7 +107,7 @@ module ADIWG
                   # resource information - credits []
                   if hResInfo.has_key?('credit')
                      hResInfo['credit'].each do |item|
-                        if item != ''
+                        unless item == ''
                            intResInfo[:credits] << item
                         end
                      end
@@ -126,13 +127,13 @@ module ADIWG
                   # resource information - status [] (required)
                   if hResInfo.has_key?('status')
                      hResInfo['status'].each do |item|
-                        if item != ''
+                        unless item == ''
                            intResInfo[:status] << item
                         end
                      end
                   end
                   if intResInfo[:status].empty?
-                     responseObj[:readerExecutionMessages] << 'ResourceInfo is missing status'
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: resource info status is missing'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end
@@ -153,7 +154,8 @@ module ADIWG
                         unless hReturn.nil?
                            intResInfo[:keywords] << hReturn[0]
                         end
-                        responseObj[:readerExecutionMessages] << 'TopicCategory is deprecated, use keyword type isoTopicCategory instead'
+                        responseObj[:readerExecutionMessages] <<
+                           'WARNING: mdJson reader: TopicCategory is deprecated, items were moved to keywords "isoTopicCategory"'
                      end
                   end
 
@@ -168,7 +170,7 @@ module ADIWG
                      end
                   end
                   if intResInfo[:pointOfContacts].empty?
-                     responseObj[:readerExecutionMessages] << 'ResourceInfo object is missing pointOfContact'
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: resource info point-of-contact is missing'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end
@@ -187,7 +189,7 @@ module ADIWG
                   # resource information - spatial representation type []
                   if hResInfo.has_key?('spatialRepresentationType')
                      hResInfo['spatialRepresentationType'].each do |item|
-                        if item != ''
+                        unless item == ''
                            intResInfo[:spatialRepresentationTypes] << item
                         end
                      end
@@ -325,7 +327,7 @@ module ADIWG
                      end
                   end
                   if intResInfo[:defaultResourceLocale].empty?
-                     responseObj[:readerExecutionMessages] << 'ResourceInfo object is missing defaultResourceLocale'
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: resource info default locale is missing'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end

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

@@ -2,54 +2,54 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
-#   Stan Smith 2017-02-15 original script
+#  Stan Smith 2018-02-19 refactored error and warning messaging
+#  Stan Smith 2017-02-15 original script
 
 module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
-
-                module ResourceType
-
-                    def self.unpack(hType, responseObj)
-
-                        # return nil object if input is empty
-                        if hType.empty?
-                            responseObj[:readerExecutionMessages] << 'Resource Type object is empty'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intType = intMetadataClass.newResourceType
-
-                        # resource type - type (required) {MD_ScopeCode}
-                        if hType.has_key?('type')
-                            if hType['type'] != ''
-                                intType[:type] = hType['type']
-                            end
-                        end
-                        if intType[:type].nil?
-                            responseObj[:readerExecutionMessages] << 'Resource Type object is missing type'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        # resource type - name
-                        if hType.has_key?('name')
-                            if hType['name'] != ''
-                                intType[:name] = hType['name']
-                            end
-                        end
-
-                        return intType
-
-                    end
-
-                end
+   module Mdtranslator
+      module Readers
+         module MdJson
+
+            module ResourceType
+
+               def self.unpack(hType, responseObj)
+
+                  # return nil object if input is empty
+                  if hType.empty?
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: resource type object is empty'
+                     return nil
+                  end
+
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intType = intMetadataClass.newResourceType
+
+                  # resource type - type (required) {MD_ScopeCode}
+                  if hType.has_key?('type')
+                     unless hType['type'] == ''
+                        intType[:type] = hType['type']
+                     end
+                  end
+                  if intType[:type].nil?
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: resource type is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
+                  # resource type - name
+                  if hType.has_key?('name')
+                     unless hType['name'] == ''
+                        intType[:name] = hType['name']
+                     end
+                  end
+
+                  return intType
+
+               end
 
             end
-        end
-    end
+
+         end
+      end
+   end
 end