adiwg-mdtranslator 2.3.5 → 2.4.0

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

@@ -0,0 +1,69 @@
+# unpack spatial reference system parameter set
+# Reader - ADIwg JSON to internal data structure
+
+# History:
+# 	Stan Smith 2017-10-23 original script
+
+require_relative 'module_projectionParameters'
+require_relative 'module_ellipsoid'
+require_relative 'module_verticalDatum'
+
+module ADIWG
+   module Mdtranslator
+      module Readers
+         module MdJson
+
+            module ReferenceSystemParameters
+
+               def self.unpack(hParams, responseObj)
+
+                  # return nil object if input is empty
+                  if hParams.empty?
+                     responseObj[:readerExecutionMessages] << 'Spatial Reference System Parameters object is empty'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intParamSet = intMetadataClass.newReferenceSystemParameterSet
+
+                  # 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
+                        end
+                     end
+                  end
+
+                  # reference system parameters - ellipsoid parameters
+                  if hParams.has_key?('ellipsoid')
+                     unless hParams['ellipsoid'].empty?
+                        hReturn = Ellipsoid.unpack(hParams['ellipsoid'], responseObj)
+                        unless hReturn.nil?
+                           intParamSet[:ellipsoid] = hReturn
+                        end
+                     end
+                  end
+
+                  # reference system parameters - vertical datum parameters
+                  if hParams.has_key?('verticalDatum')
+                     unless hParams['verticalDatum'].empty?
+                        hReturn = VerticalDatum.unpack(hParams['verticalDatum'], responseObj)
+                        unless hReturn.nil?
+                           intParamSet[:verticalDatum] = hReturn
+                        end
+                     end
+                  end
+
+                  return intParamSet
+               end
+
+            end
+
+         end
+      end
+   end
+end

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

@@ -2,64 +2,79 @@
 # 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 2017-10-23 added reference system parameter set
+#  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'
+require_relative 'module_referenceSystemParameters'
 
 module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
+   module Mdtranslator
+      module Readers
+         module MdJson
 
-                module SpatialReferenceSystem
+            module SpatialReferenceSystem
 
-                    def self.unpack(hSpatialRef, responseObj)
+               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
+                  # 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
+                  # 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 - 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
+                  # 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
+                  # spatial reference system - reference system parameters {referenceSystemParameterSet}
+                  if hSpatialRef.has_key?('referenceSystemParameterSet')
+                     hObject = hSpatialRef['referenceSystemParameterSet']
+                     unless hObject.empty?
+                        hReturn = ReferenceSystemParameters.unpack(hObject, responseObj)
+                        unless hReturn.nil?
+                           intSpatialRef[:systemParameterSet] = hReturn
                         end
+                     end
+                  end
 
-                        return intSpatialRef
-                    end
+                  if intSpatialRef[:systemType].nil? &&
+                     intSpatialRef[:systemIdentifier].empty? &&
+                     intSpatialRef[:systemParameterSet].empty?
+                     responseObj[:readerExecutionMessages] << 'Spatial Reference System must declare reference system type, identifier, or parameter set'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
 
-                end
+                  return intSpatialRef
+               end
 
             end
-        end
-    end
+
+         end
+      end
+   end
 end

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

@@ -2,76 +2,126 @@
 # 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 2017-10-19 add geographic resolution
+#  Stan Smith 2017-10-19 add bearingDistance resolution
+#  Stan Smith 2017-10-19 add coordinate resolution
+#  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'
+require_relative 'module_coordinateResolution'
+require_relative 'module_bearingDistanceResolution'
+require_relative 'module_geographicResolution'
 
 module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
+   module Mdtranslator
+      module Readers
+         module MdJson
 
-                module SpatialResolution
+            module SpatialResolution
 
-                    def self.unpack(hResolution, responseObj)
+               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
+                  # 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
+                  foundOne = false
+                  haveOne = false
+
+                  # spatial resolution - scale factor (required if not others)
+                  if hResolution.has_key?('scaleFactor')
+                     foundOne = true
+                     if hResolution['scaleFactor'] != ''
+                        intResolution[:scaleFactor] = hResolution['scaleFactor']
+                        haveOne = true
+                     end
+                  end
+
+                  # spatial resolution - measure (required if not others)
+                  if hResolution.has_key?('measure')
+                     foundOne = true
+                     hMeasure = hResolution['measure']
+                     unless hMeasure.empty?
+                        hObject = Measure.unpack(hMeasure, responseObj)
+                        unless hObject.nil?
+                           intResolution[:measure] = hObject
+                           haveOne = true
                         end
+                     end
+                  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
+                  # spatial resolution - coordinate resolution (required if not others)
+                  if hResolution.has_key?('coordinateResolution')
+                     foundOne = true
+                     hCoordRes = hResolution['coordinateResolution']
+                     unless hCoordRes.empty?
+                        hReturn = CoordinateResolution.unpack(hCoordRes, responseObj)
+                        unless hReturn.nil?
+                           intResolution[:coordinateResolution] = hReturn
+                           haveOne = true
                         end
+                     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
+                  # spatial resolution - bearing distance resolution (required if not others)
+                  if hResolution.has_key?('bearingDistanceResolution')
+                     foundOne = true
+                     hBearRes = hResolution['bearingDistanceResolution']
+                     unless hBearRes.empty?
+                        hReturn = BearingDistanceResolution.unpack(hBearRes, responseObj)
+                        unless hReturn.nil?
+                           intResolution[:bearingDistanceResolution] = hReturn
+                           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
+                  # spatial resolution - geographic resolution (required if not others)
+                  if hResolution.has_key?('geographicResolution')
+                     foundOne = true
+                     hGeoRes = hResolution['geographicResolution']
+                     unless hGeoRes.empty?
+                        hReturn = GeographicResolution.unpack(hGeoRes, responseObj)
+                        unless hReturn.nil?
+                           intResolution[:geographicResolution] = hReturn
+                           haveOne = true
                         end
+                     end
+                  end
 
-                    unless haveOne
-                        responseObj[:readerExecutionMessages] << 'Spatial Resolution did not have an object of supported type'
-                        responseObj[:readerExecutionPass] = false
-                        return nil
-                    end
+                  # spatial resolution - level of detail (required if not others)
+                  if hResolution.has_key?('levelOfDetail')
+                     foundOne = true
+                     if hResolution['levelOfDetail'] != ''
+                        intResolution[:levelOfDetail] = hResolution['levelOfDetail']
+                        haveOne = true
+                     end
+                  end
 
-                    return intResolution
+                  unless foundOne
+                     responseObj[:readerExecutionMessages] << 'Spatial Resolution did not have an object of supported type'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
 
-                    end
+                  return nil unless haveOne
+                  return intResolution
 
-                end
+               end
 
             end
-        end
-    end
+
+         end
+      end
+   end
 end

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

@@ -0,0 +1,89 @@
+# unpack spatial reference system vertical datum
+# Reader - ADIwg JSON to internal data structure
+
+# History:
+# 	Stan Smith 2017-10-23 original script
+
+require_relative 'module_identifier'
+
+module ADIWG
+   module Mdtranslator
+      module Readers
+         module MdJson
+
+            module VerticalDatum
+
+               def self.unpack(hDatum, responseObj)
+
+                  # return nil object if input is empty
+                  if hDatum.empty?
+                     responseObj[:readerExecutionMessages] << 'Vertical Datum object is empty'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intDatum = intMetadataClass.newVerticalDatum
+
+                  # vertical datum - identifier {identifier} (required)
+                  if hDatum.has_key?('datumIdentifier')
+                     unless hDatum['datumIdentifier'].empty?
+                        hReturn = Identifier.unpack(hDatum['datumIdentifier'], responseObj)
+                        unless hReturn.nil?
+                           intDatum[:datumIdentifier] = hReturn
+                        end
+                     end
+                  end
+                  if intDatum[:datumIdentifier].empty?
+                     responseObj[:readerExecutionMessages] << 'Vertical Datum Identifier  is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
+                  # vertical datum - encoding method (required)
+                  if hDatum.has_key?('encodingMethod')
+                     intDatum[:encodingMethod] = hDatum['encodingMethod']
+                  end
+                  if intDatum[:encodingMethod].nil? || intDatum[:encodingMethod] == ''
+                     responseObj[:readerExecutionMessages] << 'Vertical Datum Encoding Method is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
+                  # vertical datum - is depth system {Boolean} (required)
+                  if hDatum.has_key?('isDepthSystem')
+                     if hDatum['isDepthSystem'] === true
+                        intDatum[:isDepthSystem] = true
+                     end
+                  end
+
+                  # vertical datum - vertical resolution (required)
+                  if hDatum.has_key?('verticalResolution')
+                     intDatum[:verticalResolution] = hDatum['verticalResolution']
+                  end
+                  if intDatum[:verticalResolution].nil? || intDatum[:verticalResolution] == ''
+                     responseObj[:readerExecutionMessages] << 'Vertical Resolution is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
+                  # vertical datum - unit of measure (required)
+                  if hDatum.has_key?('unitOfMeasure')
+                     intDatum[:unitOfMeasure] = hDatum['unitOfMeasure']
+                  end
+                  if intDatum[:unitOfMeasure].nil? || intDatum[:unitOfMeasure] == ''
+                     responseObj[:readerExecutionMessages] << 'Unit of Measure is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
+                  return intDatum
+               end
+
+            end
+
+         end
+      end
+   end
+end