adiwg-mdtranslator 2.9.2 → 2.10.0

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

@@ -2,54 +2,54 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
+#  Stan Smith 2018-02-19 refactored error and warning messaging
 # 	Stan Smith 2016-10-19 original script
 
 module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
-
-                module VectorObject
-
-                    def self.unpack(hVecObj, responseObj)
-
-                        # return nil object if input is empty
-                        if hVecObj.empty?
-                            responseObj[:readerExecutionMessages] << 'Vector Object object is empty'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intVecObj = intMetadataClass.newVectorObject
-
-                        # vector object - object type (required)
-                        if hVecObj.has_key?('objectType')
-                            if hVecObj['objectType'] != ''
-                                intVecObj[:objectType] = hVecObj['objectType']
-                            end
-                        end
-                        if intVecObj[:objectType].nil?
-                            responseObj[:readerExecutionMessages] << 'Vector Object attribute objectType is missing'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        # vector object - object count
-                        if hVecObj.has_key?('objectCount')
-                            if hVecObj['objectCount'] != ''
-                                intVecObj[:objectCount] = hVecObj['objectCount']
-                            end
-                        end
-
-                        return intVecObj
-
-                    end
-
-                end
+   module Mdtranslator
+      module Readers
+         module MdJson
+
+            module VectorObject
+
+               def self.unpack(hVecObj, responseObj)
+
+                  # return nil object if input is empty
+                  if hVecObj.empty?
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: vector object is empty'
+                     return nil
+                  end
+
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intVecObj = intMetadataClass.newVectorObject
+
+                  # vector object - object type (required)
+                  if hVecObj.has_key?('objectType')
+                     unless hVecObj['objectType'] == ''
+                        intVecObj[:objectType] = hVecObj['objectType']
+                     end
+                  end
+                  if intVecObj[:objectType].nil?
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: vector object type is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
+                  # vector object - object count
+                  if hVecObj.has_key?('objectCount')
+                     unless hVecObj['objectCount'] == ''
+                        intVecObj[:objectCount] = hVecObj['objectCount']
+                     end
+                  end
+
+                  return intVecObj
+
+               end
 
             end
-        end
-    end
+
+         end
+      end
+   end
 end

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

@@ -2,54 +2,66 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
+#  Stan Smith 2018-02-19 refactored error and warning messaging
 # 	Stan Smith 2016-10-19 original script
 
 require_relative 'module_vectorObject'
 
 module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
+   module Mdtranslator
+      module Readers
+         module MdJson
 
-                module VectorRepresentation
+            module VectorRepresentation
 
-                    def self.unpack(hVector, responseObj)
+               def self.unpack(hVector, responseObj)
 
-                        # return nil object if input is empty
-                        if hVector.empty?
-                            responseObj[:readerExecutionMessages] << 'Vector Representation object is empty'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
+                  # return nil object if input is empty
+                  if hVector.empty?
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: vector representation object is empty'
+                     return nil
+                  end
 
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intVector = intMetadataClass.newVectorInfo
+                  haveVector = false
 
-                        # vector representation - topology level
-                        if hVector.has_key?('topologyLevel')
-                            if hVector['topologyLevel'] != ''
-                                intVector[:topologyLevel] = hVector['topologyLevel']
-                            end
-                        end
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intVector = intMetadataClass.newVectorInfo
 
-                        # vector representation - vector object []
-                        if hVector.has_key?('vectorObject')
-                            hVector['vectorObject'].each do |item|
-                                hVec = VectorObject.unpack(item, responseObj)
-                                unless hVec.nil?
-                                    intVector[:vectorObject] << hVec
-                                end
-                            end
+                  # vector representation - topology level
+                  if hVector.has_key?('topologyLevel')
+                     unless hVector['topologyLevel'] == ''
+                        intVector[:topologyLevel] = hVector['topologyLevel']
+                        haveVector = true
+                     end
+                  end
+
+                  # vector representation - vector object []
+                  if hVector.has_key?('vectorObject')
+                     hVector['vectorObject'].each do |item|
+                        hVec = VectorObject.unpack(item, responseObj)
+                        unless hVec.nil?
+                           intVector[:vectorObject] << hVec
+                           haveVector = true
                         end
+                     end
+                  end
 
-                        return intVector
+                  # error messages
+                  unless haveVector
+                     responseObj[:readerExecutionMessages] <<
+                        'ERROR: mdJson reader: vector representation must have a topology level or vector object'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
 
-                    end
+                  return intVector
 
-                end
+               end
 
             end
-        end
-    end
+
+         end
+      end
+   end
 end

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_verticalDatum.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'
@@ -17,8 +18,7 @@ module ADIWG
 
                   # return nil object if input is empty
                   if hDatum.empty?
-                     responseObj[:readerExecutionMessages] << 'Vertical Datum object is empty'
-                     responseObj[:readerExecutionPass] = false
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: vertical datum object is empty'
                      return nil
                   end
 
@@ -36,14 +36,22 @@ module ADIWG
                      end
                   end
 
+                  haveOthers  = 0
+
                   # vertical datum - datum name
                   if hDatum.has_key?('datumName')
-                     intDatum[:datumName] = hDatum['datumName']
+                     unless hDatum['datumName'] == ''
+                        intDatum[:datumName] = hDatum['datumName']
+                        haveOthers += 1
+                     end
                   end
 
                   # vertical datum - encoding method
                   if hDatum.has_key?('encodingMethod')
-                     intDatum[:encodingMethod] = hDatum['encodingMethod']
+                     unless hDatum['encodingMethod'] == ''
+                        intDatum[:encodingMethod] = hDatum['encodingMethod']
+                        haveOthers += 1
+                     end
                   end
 
                   # vertical datum - is depth system {Boolean} (required)
@@ -55,12 +63,26 @@ module ADIWG
 
                   # vertical datum - vertical resolution
                   if hDatum.has_key?('verticalResolution')
-                     intDatum[:verticalResolution] = hDatum['verticalResolution']
+                     unless hDatum['verticalResolution'] == ''
+                        intDatum[:verticalResolution] = hDatum['verticalResolution']
+                        haveOthers += 1
+                     end
                   end
 
                   # vertical datum - unit of measure
                   if hDatum.has_key?('unitOfMeasure')
-                     intDatum[:unitOfMeasure] = hDatum['unitOfMeasure']
+                     unless hDatum['unitOfMeasure'] == ''
+                        intDatum[:unitOfMeasure] = hDatum['unitOfMeasure']
+                        haveOthers += 1
+                     end
+                  end
+
+                  # error messages
+                  if intDatum[:datumIdentifier].empty? && haveOthers != 4
+                     responseObj[:readerExecutionMessages] <<
+                        'ERROR: mdJson reader: vertical datum must have an identifier or all other elements'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
                   end
 
                   return intDatum

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

@@ -2,80 +2,80 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
-#   Stan Smith 2016-10-24 original script
+#  Stan Smith 2018-02-19 refactored error and warning messaging
+#  Stan Smith 2016-10-24 original script
 
 require_relative 'module_spatialReference'
 
 module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
+   module Mdtranslator
+      module Readers
+         module MdJson
 
-                module VerticalExtent
+            module VerticalExtent
 
-                    def self.unpack(hVertical, responseObj)
+               def self.unpack(hVertical, responseObj)
 
-                        # return nil object if input is empty
-                        if hVertical.empty?
-                            responseObj[:readerExecutionMessages] << 'Vertical Extent object is empty'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
+                  # return nil object if input is empty
+                  if hVertical.empty?
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: vertical extent object is empty'
+                     return nil
+                  end
 
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intVertical = intMetadataClass.newVerticalExtent
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intVertical = intMetadataClass.newVerticalExtent
 
-                        # vertical extent - description
-                        if hVertical.has_key?('description')
-                            if hVertical['description'] != ''
-                                intVertical[:description] = hVertical['description']
-                            end
-                        end
+                  # vertical extent - description
+                  if hVertical.has_key?('description')
+                     unless hVertical['description'] == ''
+                        intVertical[:description] = hVertical['description']
+                     end
+                  end
 
-                        # vertical extent - min value (required)
-                        if hVertical.has_key?('minValue')
-                            intVertical[:minValue] = hVertical['minValue']
-                        end
-                        if intVertical[:minValue].nil? || intVertical[:minValue] == ''
-                            responseObj[:readerExecutionMessages] << 'Vertical Extent is missing minValue'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
+                  # vertical extent - min value (required)
+                  if hVertical.has_key?('minValue')
+                     intVertical[:minValue] = hVertical['minValue']
+                  end
+                  if intVertical[:minValue].nil? || intVertical[:minValue] == ''
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: vertical extent minimum value is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
 
-                        # vertical extent - max value (required)
-                        if hVertical.has_key?('maxValue')
-                            intVertical[:maxValue] = hVertical['maxValue']
-                        end
-                        if intVertical[:maxValue].nil? || intVertical[:maxValue] == ''
-                            responseObj[:readerExecutionMessages] << 'Vertical Extent is missing maxValue'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
+                  # vertical extent - max value (required)
+                  if hVertical.has_key?('maxValue')
+                     intVertical[:maxValue] = hVertical['maxValue']
+                  end
+                  if intVertical[:maxValue].nil? || intVertical[:maxValue] == ''
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: vertical extent maximum value is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
 
-                        # vertical extent - crs ID {spatialReference} (required)
-                        if hVertical.has_key?('crsId')
-                            hObject = hVertical['crsId']
-                            unless hObject.empty?
-                                hReturn = SpatialReferenceSystem.unpack(hObject, responseObj)
-                                unless hReturn.nil?
-                                    intVertical[:crsId] = hReturn
-                                end
-                            end
-                        end
-                        if intVertical[:crsId].empty?
-                            responseObj[:readerExecutionMessages] << 'Vertical Extent is missing crsId'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
+                  # vertical extent - crs ID {spatialReference} (required)
+                  if hVertical.has_key?('crsId')
+                     hObject = hVertical['crsId']
+                     unless hObject.empty?
+                        hReturn = SpatialReferenceSystem.unpack(hObject, responseObj)
+                        unless hReturn.nil?
+                           intVertical[:crsId] = hReturn
                         end
+                     end
+                  end
+                  if intVertical[:crsId].empty?
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: vertical extent CRS identifier is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
 
-                        return intVertical
+                  return intVertical
 
-                    end
-
-                end
+               end
 
             end
-        end
-    end
+
+         end
+      end
+   end
 end

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

@@ -2,63 +2,63 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
+#  Stan Smith 2018-02-19 refactored error and warning messaging
 #   Stan Smith 2016-10-21 original script
 
 require_relative 'module_responsibleParty'
 
 module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
+   module Mdtranslator
+      module Readers
+         module MdJson
 
-                module Voucher
+            module Voucher
 
-                    def self.unpack(hVoucher, responseObj)
+               def self.unpack(hVoucher, responseObj)
 
-                        # return nil object if input is empty
-                        if hVoucher.empty?
-                            responseObj[:readerExecutionMessages] << 'Voucher object is empty'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
+                  # return nil object if input is empty
+                  if hVoucher.empty?
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: voucher object is empty'
+                     return nil
+                  end
 
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intVoucher = intMetadataClass.newTaxonVoucher
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intVoucher = intMetadataClass.newTaxonVoucher
 
-                        # voucher - specimen
-                        if hVoucher.has_key?('specimen')
-                            intVoucher[:specimen] = hVoucher['specimen']
-                        end
-                        if intVoucher[:specimen].nil? || intVoucher[:specimen] == ''
-                            responseObj[:readerExecutionMessages] << 'Voucher object is missing specimen'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
+                  # voucher - specimen (required)
+                  if hVoucher.has_key?('specimen')
+                     intVoucher[:specimen] = hVoucher['specimen']
+                  end
+                  if intVoucher[:specimen].nil? || intVoucher[:specimen] == ''
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: voucher specimen is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
 
-                        # voucher - repository
-                        if hVoucher.has_key?('repository')
-                            hObject = hVoucher['repository']
-                            unless hObject.empty?
-                                hReturn = ResponsibleParty.unpack(hObject, responseObj)
-                                unless hReturn.nil?
-                                    intVoucher[:repository] = hReturn
-                                end
-                            end
+                  # voucher - repository (required)
+                  if hVoucher.has_key?('repository')
+                     hObject = hVoucher['repository']
+                     unless hObject.empty?
+                        hReturn = ResponsibleParty.unpack(hObject, responseObj)
+                        unless hReturn.nil?
+                           intVoucher[:repository] = hReturn
                         end
-                        if intVoucher[:repository].empty?
-                            responseObj[:readerExecutionMessages] << 'Voucher object is missing repository'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        return intVoucher
+                     end
+                  end
+                  if intVoucher[:repository].empty?
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: voucher repository is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
 
-                    end
+                  return intVoucher
 
-                end
+               end
 
             end
-        end
-    end
+
+         end
+      end
+   end
 end

data/lib/adiwg/mdtranslator/readers/mdReaders.rb

@@ -36,13 +36,17 @@ module ADIWG
                readerNS = hResponseObj[:readerRequested].dup
                readerNS[0] = readerNS[0].upcase
 
-               # reader will return intObj and updated hResponseObj
+               # reader will create and return the intObj
                return ADIWG::Mdtranslator::Readers.const_get(readerNS).readFile(file, hResponseObj)
 
             else
-               hResponseObj[:readerValidationMessages] << "Requested reader '#{hResponseObj[:readerRequested]}' cannot be found."
+
+               hResponseObj[:readerValidationMessages] << "ERROR: Requested reader '#{hResponseObj[:readerRequested]}' cannot be found."
                hResponseObj[:readerValidationPass] = false
+
+               # return empty intObj
                return {}
+
             end
 
          end

data/lib/adiwg/mdtranslator/version.rb

@@ -1,6 +1,14 @@
 # adiwg mdTranslator
 
 # version 2 history
+# 2.10.0 2018-02-26 add 'forceValid' parameter to mdTranslator.translate
+# 2.9.3 2018-02-24 add messaging to mdJson reader
+# 2.9.3 2018-02-20 add data and time format validation to module_dateTomeFun
+# 2.9.3 2018-02-17 add messaging to fgdc reader
+# 2.9.3 2018-02-14 refactored 19110 add isInfinite="true" to upper multiplicity
+# 2.9.3 2018-02-14 refactored 19110 constraints
+# 2.9.3 2018-02-14 deprecated and renamed allowMany to mustBeUnique
+# 2.9.2 2018-02-22 call base maps with https:
 # 2.9.1 2018-02-05 move 'technicalPrerequisite' to 'resourceFormat'
 # 2.9.1 2018-02-05 fix variable name in fgdc spatial domain writer
 # 2.9.0 2018-02-01 added fgdc writer distribution information section
@@ -63,7 +71,7 @@
 module ADIWG
    module Mdtranslator
       # current mdtranslator version
-      VERSION = "2.9.2"
+      VERSION = "2.10.0"
    end
 end
 

data/lib/adiwg/mdtranslator/writers/html/sections/html_entityAttribute.rb

@@ -67,9 +67,9 @@ module ADIWG
                   @html.text!(hAttribute[:allowNull].to_s)
                   @html.br
 
-                  # entity attribute - allow many {Boolean}
-                  @html.em('Allow Many Values: ')
-                  @html.text!(hAttribute[:allowMany].to_s)
+                  # entity attribute - must be unique {Boolean}
+                  @html.em('Attribute Values Must Be Unique: ')
+                  @html.text!(hAttribute[:mustBeUnique].to_s)
                   @html.br
 
                   # entity attribute - unit of measure