adiwg-mdtranslator 2.9.2 → 2.10.0

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

@@ -2,6 +2,7 @@
 # Reader - ADIwg JSON V1 to internal data structure
 
 # History:
+#  Stan Smith 2018-02-18 refactored error and warning messaging
 #  Stan Smith 2017-11-01 added domainReference
 #  Stan Smith 2016-10-07 refactored for mdJson 2.0
 #  Stan Smith 2015-07-23 added error reporting of missing items
@@ -24,8 +25,7 @@ module ADIWG
 
                   # return nil object if input is empty
                   if hDomain.empty?
-                     responseObj[:readerExecutionMessages] << 'Domain Member object is empty'
-                     responseObj[:readerExecutionPass] = false
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: data dictionary domain object is empty'
                      return nil
                   end
 
@@ -38,7 +38,7 @@ module ADIWG
                      intDomain[:domainId] = hDomain['domainId']
                   end
                   if intDomain[:domainId].nil? || intDomain[:domainId] == ''
-                     responseObj[:readerExecutionMessages] << 'Data Dictionary domain ID is missing'
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: data dictionary domain ID is missing'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end
@@ -55,7 +55,7 @@ module ADIWG
                      intDomain[:domainCode] = hDomain['codeName']
                   end
                   if intDomain[:domainCode].nil? || intDomain[:domainCode] == ''
-                     responseObj[:readerExecutionMessages] << 'Data Dictionary domain code name is missing'
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: data dictionary domain code is missing'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end
@@ -65,7 +65,7 @@ module ADIWG
                      intDomain[:domainDescription] = hDomain['description']
                   end
                   if intDomain[:domainDescription].nil? || intDomain[:domainDescription] == ''
-                     responseObj[:readerExecutionMessages] << 'Data Dictionary domain description is missing'
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: data dictionary domain description is missing'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end

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

@@ -2,6 +2,7 @@
 # Reader - ADIwg JSON V1 to internal data structure
 
 # History:
+#  Stan Smith 2018-02-18 refactored error and warning messaging
 #  Stan Smith 2018-01-24 add domain item reference
 #  Stan Smith 2016-10-07 refactored for mdJson 2.0
 #  Stan Smith 2015-07-23 added error reporting of missing items
@@ -23,8 +24,7 @@ module ADIWG
 
                   # return nil object if input is empty
                   if hDomItem.empty?
-                     responseObj[:readerExecutionMessages] << 'Domain Member object is empty'
-                     responseObj[:readerExecutionPass] = false
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: data dictionary domain item object is empty'
                      return nil
                   end
 
@@ -37,7 +37,7 @@ module ADIWG
                      intItem[:itemName] = hDomItem['name']
                   end
                   if intItem[:itemName].nil? || intItem[:itemName] == ''
-                     responseObj[:readerExecutionMessages] << 'Data Dictionary domain item name is missing'
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: data dictionary domain item name is missing'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end
@@ -47,7 +47,7 @@ module ADIWG
                      intItem[:itemValue] = hDomItem['value']
                   end
                   if intItem[:itemValue].nil? || intItem[:itemValue] == ''
-                     responseObj[:readerExecutionMessages] << 'Data Dictionary domain item value is missing'
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: data dictionary domain item value is missing'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end
@@ -57,7 +57,7 @@ module ADIWG
                      intItem[:itemDefinition] = hDomItem['definition']
                   end
                   if intItem[:itemDefinition].nil? || intItem[:itemDefinition] == ''
-                     responseObj[:readerExecutionMessages] << 'Data Dictionary domain item definition is missing'
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: data dictionary domain item definition is missing'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end

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

@@ -2,111 +2,112 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
+#  Stan Smith 2018-02-18 refactored error and warning messaging
 # 	Stan Smith 2016-10-03 original script
 
 module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
+   module Mdtranslator
+      module Readers
+         module MdJson
 
-                module Duration
+            module Duration
 
-                    def self.unpack(hDuration, responseObj)
+               def self.unpack(hDuration, responseObj)
 
-                        # return nil object if input is empty
-                        if hDuration.empty?
-                            responseObj[:readerExecutionMessages] << 'Duration object is empty'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
+                  # return nil object if input is empty
+                  if hDuration.empty?
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: duration object is empty'
+                     return nil
+                  end
 
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intDuration = intMetadataClass.newDuration
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intDuration = intMetadataClass.newDuration
 
-                        # duration - years
-                        if hDuration.has_key?('years')
-                            if hDuration['years'].nil?
-                                intDuration[:years] = 0
-                            else
-                                intDuration[:years] = hDuration['years']
-                            end
-                        else
-                            intDuration[:years] = 0
-                        end
+                  # duration - years
+                  if hDuration.has_key?('years')
+                     if hDuration['years'].nil?
+                        intDuration[:years] = 0
+                     else
+                        intDuration[:years] = hDuration['years']
+                     end
+                  else
+                     intDuration[:years] = 0
+                  end
 
-                        # duration - months
-                        if hDuration.has_key?('months')
-                            if hDuration['months'].nil?
-                                intDuration[:months] = 0
-                            else
-                                intDuration[:months] = hDuration['months']
-                            end
-                        else
-                            intDuration[:months] = 0
-                        end
+                  # duration - months
+                  if hDuration.has_key?('months')
+                     if hDuration['months'].nil?
+                        intDuration[:months] = 0
+                     else
+                        intDuration[:months] = hDuration['months']
+                     end
+                  else
+                     intDuration[:months] = 0
+                  end
 
-                        # duration - days
-                        if hDuration.has_key?('days')
-                            if hDuration['days'].nil?
-                                intDuration[:days] = 0
-                            else
-                                intDuration[:days] = hDuration['days']
-                            end
-                        else
-                            intDuration[:days] = 0
-                        end
+                  # duration - days
+                  if hDuration.has_key?('days')
+                     if hDuration['days'].nil?
+                        intDuration[:days] = 0
+                     else
+                        intDuration[:days] = hDuration['days']
+                     end
+                  else
+                     intDuration[:days] = 0
+                  end
 
-                        # duration - hours
-                        if hDuration.has_key?('hours')
-                            if hDuration['hours'].nil?
-                                intDuration[:hours] = 0
-                            else
-                                intDuration[:hours] = hDuration['hours']
-                            end
-                        else
-                            intDuration[:hours] = 0
-                        end
+                  # duration - hours
+                  if hDuration.has_key?('hours')
+                     if hDuration['hours'].nil?
+                        intDuration[:hours] = 0
+                     else
+                        intDuration[:hours] = hDuration['hours']
+                     end
+                  else
+                     intDuration[:hours] = 0
+                  end
 
-                        # duration - minutes
-                        if hDuration.has_key?('minutes')
-                            if hDuration['minutes'].nil?
-                                intDuration[:minutes] = 0
-                            else
-                                intDuration[:minutes] = hDuration['minutes']
-                            end
-                        else
-                            intDuration[:minutes] = 0
-                        end
+                  # duration - minutes
+                  if hDuration.has_key?('minutes')
+                     if hDuration['minutes'].nil?
+                        intDuration[:minutes] = 0
+                     else
+                        intDuration[:minutes] = hDuration['minutes']
+                     end
+                  else
+                     intDuration[:minutes] = 0
+                  end
 
-                        # duration - seconds
-                        if hDuration.has_key?('seconds')
-                            if hDuration['seconds'].nil?
-                                intDuration[:seconds] = 0
-                            else
-                                intDuration[:seconds] = hDuration['seconds']
-                            end
-                        else
-                            intDuration[:seconds] = 0
-                        end
+                  # duration - seconds
+                  if hDuration.has_key?('seconds')
+                     if hDuration['seconds'].nil?
+                        intDuration[:seconds] = 0
+                     else
+                        intDuration[:seconds] = hDuration['seconds']
+                     end
+                  else
+                     intDuration[:seconds] = 0
+                  end
 
-                        totalDuration = intDuration[:years] +
-                            intDuration[:months] +
-                            intDuration[:days] +
-                            intDuration[:hours] +
-                            intDuration[:minutes] +
-                            intDuration[:seconds]
-                        unless totalDuration > 0
-                            responseObj[:readerExecutionMessages] << 'Duration is zero'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        return intDuration
-                    end
-                end
+                  # error messages
+                  totalDuration = intDuration[:years] +
+                     intDuration[:months] +
+                     intDuration[:days] +
+                     intDuration[:hours] +
+                     intDuration[:minutes] +
+                     intDuration[:seconds]
+                  unless totalDuration > 0
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: duration not specified'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
 
+                  return intDuration
+               end
             end
-        end
-    end
+
+         end
+      end
+   end
 end

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

@@ -2,6 +2,7 @@
 # Reader - mdJson to internal data structure
 
 # History:
+#  Stan Smith 2018-02-18 refactored error and warning messaging
 #  Stan Smith 2017-11-01 added entityReference, fieldSeparator, headerLines, quoteCharacter
 #  Stan Smith 2016-10-07 refactored for mdJson 2.0
 #  Stan Smith 2015-07-24 added error reporting of missing items
@@ -27,8 +28,7 @@ module ADIWG
 
                   # return nil object if input is empty
                   if hEntity.empty?
-                     responseObj[:readerExecutionMessages] << 'Entity object is empty'
-                     responseObj[:readerExecutionPass] = false
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: data dictionary entity object is empty'
                      return nil
                   end
 
@@ -46,7 +46,7 @@ module ADIWG
 
                   # entity - name
                   if hEntity.has_key?('commonName')
-                     if hEntity['commonName'] != ''
+                     unless hEntity['commonName'] == ''
                         intEntity[:entityName] = hEntity['commonName']
                      end
                   end
@@ -56,7 +56,7 @@ module ADIWG
                      intEntity[:entityCode] = hEntity['codeName']
                   end
                   if intEntity[:entityCode].nil? || intEntity[:entityCode] == ''
-                     responseObj[:readerExecutionMessages] << 'Data Dictionary entity code name is missing'
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: data dictionary entity code name is missing'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end
@@ -64,7 +64,7 @@ module ADIWG
                   # entity - alias []
                   if hEntity.has_key?('alias')
                      hEntity['alias'].each do |item|
-                        if item != ''
+                        unless item == ''
                            intEntity[:entityAlias] << item
                         end
                      end
@@ -75,7 +75,7 @@ module ADIWG
                      intEntity[:entityDefinition] = hEntity['definition']
                   end
                   if intEntity[:entityDefinition].nil? || intEntity[:entityDefinition] == ''
-                     responseObj[:readerExecutionMessages] << 'Data Dictionary entity definition is missing'
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: data dictionary entity definition is missing'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end
@@ -95,7 +95,7 @@ module ADIWG
                   # data entity - primary key (NOT required)
                   if hEntity.has_key?('primaryKeyAttributeCodeName')
                      hEntity['primaryKeyAttributeCodeName'].each do |item|
-                        if item != ''
+                        unless item == ''
                            intEntity[:primaryKey] << item
                         end
                      end
@@ -139,21 +139,21 @@ module ADIWG
 
                   # entity - field separator
                   if hEntity.has_key?('fieldSeparatorCharacter')
-                     if hEntity['fieldSeparatorCharacter'] != ''
+                     unless hEntity['fieldSeparatorCharacter'] == ''
                         intEntity[:fieldSeparatorCharacter] = hEntity['fieldSeparatorCharacter']
                      end
                   end
 
                   # entity - number of header lines
                   if hEntity.has_key?('numberOfHeaderLines')
-                     if hEntity['numberOfHeaderLines'] != ''
+                     unless hEntity['numberOfHeaderLines'] == ''
                         intEntity[:numberOfHeaderLines] = hEntity['numberOfHeaderLines'].to_i
                      end
                   end
 
                   # entity - quote character
                   if hEntity.has_key?('quoteCharacter')
-                     if hEntity['quoteCharacter'] != ''
+                     unless hEntity['quoteCharacter'] == ''
                         intEntity[:quoteCharacter] = hEntity['quoteCharacter']
                      end
                   end

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

@@ -2,6 +2,8 @@
 # Reader - ADIwg JSON V1 to internal data structure
 
 # History:
+#  Stan Smith 2018-02-18 refactored error and warning messaging
+#  Stan Smith 2018-02-14 rename allowMany to mustBeUnique
 #  Stan Smith 2017-11-01 added new elements to support fgdc and flat files
 #  Stan Smith 2016-10-05 refactored for mdJson 2.0
 #  Stan Smith 2015-07-24 added error reporting of missing items
@@ -27,8 +29,7 @@ module ADIWG
 
                   # return nil object if input is empty
                   if hAttribute.empty?
-                     responseObj[:readerExecutionMessages] << 'Entity Attribute object is empty'
-                     responseObj[:readerExecutionPass] = false
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: data dictionary entity attribute object is empty'
                      return nil
                   end
 
@@ -38,7 +39,7 @@ module ADIWG
 
                   # attribute - common name
                   if hAttribute.has_key?('commonName')
-                     if hAttribute['commonName'] != ''
+                     unless hAttribute['commonName'] == ''
                         intAttribute[:attributeName] = hAttribute['commonName']
                      end
                   end
@@ -48,7 +49,7 @@ module ADIWG
                      intAttribute[:attributeCode] = hAttribute['codeName']
                   end
                   if intAttribute[:attributeCode].nil? || intAttribute[:attributeCode] == ''
-                     responseObj[:readerExecutionMessages] << 'Data Dictionary attribute code name is missing'
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: data dictionary entity attribute code name is missing'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end
@@ -56,7 +57,7 @@ module ADIWG
                   # attribute - alias []
                   if hAttribute.has_key?('alias')
                      hAttribute['alias'].each do |item|
-                        if item != ''
+                        unless item == ''
                            intAttribute[:attributeAlias] << item
                         end
                      end
@@ -67,7 +68,7 @@ module ADIWG
                      intAttribute[:attributeDefinition] = hAttribute['definition']
                   end
                   if intAttribute[:attributeDefinition].nil? || intAttribute[:attributeDefinition] == ''
-                     responseObj[:readerExecutionMessages] << 'Data Dictionary attribute definition is missing'
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: data dictionary entity attribute definition is missing'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end
@@ -88,77 +89,86 @@ module ADIWG
                      intAttribute[:dataType] = hAttribute['dataType']
                   end
                   if intAttribute[:dataType].nil? || intAttribute[:dataType] == ''
-                     responseObj[:readerExecutionMessages] << 'Data Dictionary attribute data type is missing'
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: data dictionary entity attribute data type is missing'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end
 
-                  # attribute - minimum cardinality (required)
+                  # attribute - allow nulls (required)
                   if hAttribute.has_key?('allowNull')
                      if hAttribute['allowNull'] === true
                         intAttribute[:allowNull] = hAttribute['allowNull']
                      end
                   end
 
-                  # attribute - maximum cardinality
+                  # attribute - require value to be unique (required)
+                  # ... allowMany deprecated
                   if hAttribute.has_key?('allowMany')
                      if hAttribute['allowMany'] === true
-                        intAttribute[:allowMany] = hAttribute['allowMany']
+                        intAttribute[:mustBeUnique] = hAttribute['allowMany']
+                        responseObj[:readerExecutionMessages] <<
+                           'WARNING: mdJson reader: data dictionary entity attribute "allowMany" is deprecated, use "mustBeUnique"'
+                        return nil
+                     end
+                  end
+                  if hAttribute.has_key?('mustBeUnique')
+                     if hAttribute['mustBeUnique'] === true
+                        intAttribute[:mustBeUnique] = hAttribute['mustBeUnique']
                      end
                   end
 
                   # attribute - units of measure
                   if hAttribute.has_key?('units')
-                     if hAttribute['units'] != ''
+                     unless hAttribute['units'] == ''
                         intAttribute[:unitOfMeasure] = hAttribute['units']
                      end
                   end
 
                   # attribute - units of measure resolution
                   if hAttribute.has_key?('unitsResolution')
-                     if hAttribute['unitsResolution'] != ''
+                     unless hAttribute['unitsResolution'] == ''
                         intAttribute[:measureResolution] = hAttribute['unitsResolution']
                      end
                   end
 
                   # attribute - case sensitive {Boolean} (default = false)
                   if hAttribute.has_key?('isCaseSensitive')
-                     if hAttribute['unitsResolution'] != ''
+                     unless hAttribute['unitsResolution'] == ''
                         intAttribute[:isCaseSensitive] = hAttribute['isCaseSensitive']
                      end
                   end
 
                   # attribute - field width
                   if hAttribute.has_key?('fieldWidth')
-                     if hAttribute['fieldWidth'] != ''
+                     unless hAttribute['fieldWidth'] == ''
                         intAttribute[:fieldWidth] = hAttribute['fieldWidth']
                      end
                   end
 
                   # attribute - missing value
                   if hAttribute.has_key?('missingValue')
-                     if hAttribute['missingValue'] != ''
+                     unless hAttribute['missingValue'] == ''
                         intAttribute[:missingValue] = hAttribute['missingValue']
                      end
                   end
 
                   # attribute - domain ID
                   if hAttribute.has_key?('domainId')
-                     if hAttribute['domainId'] != ''
+                     unless hAttribute['domainId'] == ''
                         intAttribute[:domainId] = hAttribute['domainId']
                      end
                   end
 
                   # attribute - minimum value
                   if hAttribute.has_key?('minValue')
-                     if hAttribute['minValue'] != ''
+                     unless hAttribute['minValue'] == ''
                         intAttribute[:minValue] = hAttribute['minValue']
                      end
                   end
 
                   # attribute - maximum value
                   if hAttribute.has_key?('maxValue')
-                     if hAttribute['maxValue'] != ''
+                     unless hAttribute['maxValue'] == ''
                         intAttribute[:maxValue] = hAttribute['maxValue']
                      end
                   end