adiwg-mdtranslator 2.9.2 → 2.10.0

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

@@ -2,13 +2,14 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
-#   Stan Smith 2016-10-12 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
-#   Stan Smith 2014-12-24 added return if input hash is empty
-#   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
-#   Stan Smith 2014-04-28 modified attribute names to match json schema 0.3.0
+#  Stan Smith 2018-02-18 refactored error and warning messaging
+#  Stan Smith 2016-10-12 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
+#  Stan Smith 2014-12-24 added return if input hash is empty
+#  Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+#  Stan Smith 2014-04-28 modified attribute names to match json schema 0.3.0
 # 	Stan Smith 2013-11-27 modified to process single browse graphic rather than array
 # 	Stan Smith 2013-10-17 original script
 
@@ -16,81 +17,80 @@ require_relative 'module_onlineResource'
 require_relative 'module_constraint'
 
 module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
-
-                module Graphic
-
-                    def self.unpack(hGraphic, responseObj)
-
-                        # return nil object if input is empty
-                        if hGraphic.empty?
-                            responseObj[:readerExecutionMessages] << 'Graphic object is empty'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intGraphic = intMetadataClass.newGraphic
-
-                        # graphic - file name (required)
-                        if hGraphic.has_key?('fileName')
-                            intGraphic[:graphicName] = hGraphic['fileName']
-                        end
-                        if intGraphic[:graphicName].nil? || intGraphic[:graphicName] == ''
-                            responseObj[:readerExecutionMessages] << 'Graphic attribute fileName is missing'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        # graphic - file description
-                        if hGraphic.has_key?('fileDescription')
-                            if hGraphic['fileDescription'] != ''
-                                intGraphic[:graphicDescription] = hGraphic['fileDescription']
-                            end
-                        end
-
-                        # graphic - file  type
-                        if hGraphic.has_key?('fileType')
-                            if hGraphic['fileType'] != ''
-                                intGraphic[:graphicType] = hGraphic['fileType']
-                            end
-                        end
-
-                        # graphic - file  constraint []
-                        if hGraphic.has_key?('fileConstraint')
-                            aItems = hGraphic['fileConstraint']
-                            aItems.each do |hItem|
-                                unless hItem.empty?
-                                    hReturn = Constraint.unpack(hItem, responseObj)
-                                    unless hReturn.nil?
-                                        intGraphic[:graphicConstraints] << hReturn
-                                    end
-                                end
-                            end
+   module Mdtranslator
+      module Readers
+         module MdJson
+
+            module Graphic
+
+               def self.unpack(hGraphic, responseObj)
+
+                  # return nil object if input is empty
+                  if hGraphic.empty?
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: graphic overview object is empty'
+                     return nil
+                  end
+
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intGraphic = intMetadataClass.newGraphic
+
+                  # graphic - file name (required)
+                  if hGraphic.has_key?('fileName')
+                     intGraphic[:graphicName] = hGraphic['fileName']
+                  end
+                  if intGraphic[:graphicName].nil? || intGraphic[:graphicName] == ''
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: graphic overview file name is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
+                  # graphic - file description
+                  if hGraphic.has_key?('fileDescription')
+                     unless hGraphic['fileDescription'] == ''
+                        intGraphic[:graphicDescription] = hGraphic['fileDescription']
+                     end
+                  end
+
+                  # graphic - file  type
+                  if hGraphic.has_key?('fileType')
+                     unless hGraphic['fileType'] == ''
+                        intGraphic[:graphicType] = hGraphic['fileType']
+                     end
+                  end
+
+                  # graphic - file  constraint []
+                  if hGraphic.has_key?('fileConstraint')
+                     aItems = hGraphic['fileConstraint']
+                     aItems.each do |hItem|
+                        unless hItem.empty?
+                           hReturn = Constraint.unpack(hItem, responseObj)
+                           unless hReturn.nil?
+                              intGraphic[:graphicConstraints] << hReturn
+                           end
                         end
-
-                        # graphic - online resource []
-                        if hGraphic.has_key?('fileUri')
-                            hGraphic['fileUri'].each do |item|
-                                unless item.empty?
-                                    uri = OnlineResource.unpack(item, responseObj)
-                                    unless uri.nil?
-                                        intGraphic[:graphicURI] << uri
-                                    end
-                                end
-                            end
+                     end
+                  end
+
+                  # graphic - online resource []
+                  if hGraphic.has_key?('fileUri')
+                     hGraphic['fileUri'].each do |item|
+                        unless item.empty?
+                           uri = OnlineResource.unpack(item, responseObj)
+                           unless uri.nil?
+                              intGraphic[:graphicURI] << uri
+                           end
                         end
+                     end
+                  end
 
-                        return intGraphic
+                  return intGraphic
 
-                    end
-
-                end
+               end
 
             end
-        end
-    end
+
+         end
+      end
+   end
 end

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

@@ -2,78 +2,83 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
+#  Stan Smith 2018-02-18 refactored error and warning messaging
 # 	Stan Smith 2016-10-19 original script
 
 require_relative 'module_dimension'
 
 module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
+   module Mdtranslator
+      module Readers
+         module MdJson
 
-                module GridRepresentation
+            module GridRepresentation
 
-                    def self.unpack(hGrid, responseObj)
+               def self.unpack(hGrid, responseObj)
 
-                        # return nil object if input is empty
-                        if hGrid.empty?
-                            responseObj[:readerExecutionMessages] << 'Grid Representation object is empty'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intGrid = intMetadataClass.newGridInfo
+                  # return nil object if input is empty
+                  if hGrid.empty?
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: grid representation object is empty'
+                     return nil
+                  end
 
-                        # grid representation - number of dimensions (required)
-                        if hGrid.has_key?('numberOfDimensions')
-                            if hGrid['numberOfDimensions'] != ''
-                                intGrid[:numberOfDimensions] = hGrid['numberOfDimensions']
-                            end
-                        end
-                        if intGrid[:numberOfDimensions].nil?
-                            responseObj[:readerExecutionMessages] << 'Grid Representation attribute numberOfDimensions is missing'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intGrid = intMetadataClass.newGridInfo
 
-                        # grid representation - dimensions []
-                        if hGrid.has_key?('dimension')
-                            hGrid['dimension'].each do |item|
-                                hDim = Dimension.unpack(item, responseObj)
-                                unless hDim.nil?
-                                    intGrid[:dimension] << hDim
-                                end
-                            end
-                        end
+                  # grid representation - number of dimensions (required)
+                  if hGrid.has_key?('numberOfDimensions')
+                     unless hGrid['numberOfDimensions'] == ''
+                        intGrid[:numberOfDimensions] = hGrid['numberOfDimensions']
+                     end
+                  end
+                  if intGrid[:numberOfDimensions].nil?
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: grid representation number-of-dimensions is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
 
-                        # grid representation - cell geometry (required)
-                        if hGrid.has_key?('cellGeometry')
-                            if hGrid['cellGeometry'] != ''
-                                intGrid[:cellGeometry] = hGrid['cellGeometry']
-                            end
-                        end
-                        if intGrid[:cellGeometry].nil?
-                            responseObj[:readerExecutionMessages] << 'Grid Representation attribute cellGeometry is missing'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
+                  # grid representation - dimensions [] (required)
+                  if hGrid.has_key?('dimension')
+                     hGrid['dimension'].each do |item|
+                        hDim = Dimension.unpack(item, responseObj)
+                        unless hDim.nil?
+                           intGrid[:dimension] << hDim
                         end
+                     end
+                  end
+                  if intGrid[:dimension].empty?
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: grid representation dimensions are missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
 
-                        # grid representation - transformation parameter available {Boolean} (required)
-                        if hGrid.has_key?('transformationParameterAvailable')
-                            if hGrid['transformationParameterAvailable'] === true
-                                intGrid[:transformationParameterAvailable] = hGrid['transformationParameterAvailable']
-                            end
-                        end
+                  # grid representation - cell geometry (required)
+                  if hGrid.has_key?('cellGeometry')
+                     unless hGrid['cellGeometry'] == ''
+                        intGrid[:cellGeometry] = hGrid['cellGeometry']
+                     end
+                  end
+                  if intGrid[:cellGeometry].nil?
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: grid representation cell geometry is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
 
-                        return intGrid
+                  # grid representation - transformation parameter available {Boolean} (required)
+                  if hGrid.has_key?('transformationParameterAvailable')
+                     if hGrid['transformationParameterAvailable'] === true
+                        intGrid[:transformationParameterAvailable] = hGrid['transformationParameterAvailable']
+                     end
+                  end
 
-                    end
+                  return intGrid
 
-                end
+               end
 
             end
-        end
-    end
+
+         end
+      end
+   end
 end

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

@@ -2,86 +2,86 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
-#   Stan Smith 2016-10-13 refactored for mdJson 2.0
-#   Stan Smith 2015-07-31 added support for fields added by ISO 19115-1 (RS_Identifier)
-#   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-08-18 added type to identifier schema 0.6.0
-#   Stan Smith 2014-07-03 resolve require statements using Mdtranslator.reader_module
+#  Stan Smith 2018-02-18 refactored error and warning messaging
+#  Stan Smith 2016-10-13 refactored for mdJson 2.0
+#  Stan Smith 2015-07-31 added support for fields added by ISO 19115-1 (RS_Identifier)
+#  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-08-18 added type to identifier schema 0.6.0
+#  Stan Smith 2014-07-03 resolve require statements using Mdtranslator.reader_module
 # 	Stan Smith 2014-05-28 original script
 
 require_relative 'module_citation'
 
 module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
-
-                module Identifier
-
-                    def self.unpack(hIdentifier, responseObj)
-
-                        # return nil object if input is empty
-                        if hIdentifier.empty?
-                            responseObj[:readerExecutionMessages] << 'Identifier object is empty'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
+   module Mdtranslator
+      module Readers
+         module MdJson
+
+            module Identifier
+
+               def self.unpack(hIdentifier, responseObj)
+
+                  # return nil object if input is empty
+                  if hIdentifier.empty?
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: identifier object is empty'
+                     return nil
+                  end
+
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intIdent = intMetadataClass.newIdentifier
+
+                  # identifier - identifier (required)
+                  if hIdentifier.has_key?('identifier')
+                     intIdent[:identifier] = hIdentifier['identifier']
+                  end
+                  if intIdent[:identifier].nil? || intIdent[:identifier] == ''
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: identifier object identifier is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
+                  # identifier - namespace
+                  if hIdentifier.has_key?('namespace')
+                     unless hIdentifier['namespace'] == ''
+                        intIdent[:namespace] = hIdentifier['namespace']
+                     end
+                  end
+
+                  # identifier - version
+                  if hIdentifier.has_key?('version')
+                     unless hIdentifier['version'] == ''
+                        intIdent[:version] = hIdentifier['version']
+                     end
+                  end
+
+                  # identifier - description
+                  if hIdentifier.has_key?('description')
+                     unless hIdentifier['description'] == ''
+                        intIdent[:description] = hIdentifier['description']
+                     end
+                  end
+
+                  # identifier - authority (citation)
+                  if hIdentifier.has_key?('authority')
+                     hObject = hIdentifier['authority']
+                     unless hObject.empty?
+                        hReturn = Citation.unpack(hObject, responseObj)
+                        unless hReturn.nil?
+                           intIdent[:citation] = hReturn
                         end
+                     end
+                  end
 
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intIdent= intMetadataClass.newIdentifier
+                  return intIdent
 
-                        # identifier - identifier (required)
-                        if hIdentifier.has_key?('identifier')
-                            intIdent[:identifier] = hIdentifier['identifier']
-                        end
-                        if intIdent[:identifier].nil? || intIdent[:identifier] == ''
-                            responseObj[:readerExecutionMessages] << 'Identifier attribute identifier is missing'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        # identifier - namespace
-                        if hIdentifier.has_key?('namespace')
-                            if hIdentifier['namespace'] != ''
-                                intIdent[:namespace] = hIdentifier['namespace']
-                            end
-                        end
-
-                        # identifier - version
-                        if hIdentifier.has_key?('version')
-                            if hIdentifier['version'] != ''
-                                intIdent[:version] = hIdentifier['version']
-                            end
-                        end
-
-                        # identifier - description
-                        if hIdentifier.has_key?('description')
-                            if hIdentifier['description'] != ''
-                                intIdent[:description] = hIdentifier['description']
-                            end
-                        end
-
-                        # identifier - authority (citation)
-                        if hIdentifier.has_key?('authority')
-                            hObject = hIdentifier['authority']
-                            unless hObject.empty?
-                                hReturn = Citation.unpack(hObject, responseObj)
-                                unless hReturn.nil?
-                                    intIdent[:citation] = hReturn
-                                end
-                            end
-                        end
-
-                        return intIdent
-
-                    end
-
-                end
+               end
 
             end
-        end
-    end
+
+         end
+      end
+   end
 end