adiwg-mdtranslator 1.4.0 → 2.0.0rc2

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

@@ -0,0 +1,112 @@
+# unpack duration
+# Reader - ADIwg JSON to internal data structure
+
+# History:
+# 	Stan Smith 2016-10-03 original script
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module Duration
+
+                    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
+
+                        # 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 - 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 - 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 - 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
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,135 @@
+# unpack a data dictionary entity
+# Reader - mdJson to internal data structure
+
+# History:
+#   Stan Smith 2016-10-07 refactored for mdJson 2.0
+#   Stan Smith 2015-07-24 added error reporting of missing items
+#   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 2015-02-17 add entity aliases
+#   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+# 	Stan Smith 2013-12-01 original script
+
+require_relative 'module_entityIndex'
+require_relative 'module_entityAttribute'
+require_relative 'module_entityForeignKey'
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module Entity
+
+                    def self.unpack(hEntity, responseObj)
+
+                        # return nil object if input is empty
+                        if hEntity.empty?
+                            responseObj[:readerExecutionMessages] << 'Entity object is empty'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intEntity = intMetadataClass.newEntity
+
+                        # entity - id
+                        if hEntity.has_key?('entityId')
+                            s = hEntity['entityId']
+                            unless s == ''
+                                intEntity[:entityId] = s
+                            end
+                        end
+
+                        # entity - name
+                        if hEntity.has_key?('commonName')
+                            if  hEntity['commonName'] != ''
+                                intEntity[:entityName] =  hEntity['commonName']
+                            end
+                        end
+
+                        # entity - code (required)
+                        if hEntity.has_key?('codeName')
+                            intEntity[:entityCode] = hEntity['codeName']
+                        end
+                        if intEntity[:entityCode].nil? || intEntity[:entityCode] == ''
+                            responseObj[:readerExecutionMessages] << 'Data Dictionary entity code name is missing'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # entity - alias []
+                        if hEntity.has_key?('alias')
+                            hEntity['alias'].each do |item|
+                                if item != ''
+                                    intEntity[:entityAlias] << item
+                                end
+                            end
+                        end
+
+                        # entity - definition (required)
+                        if hEntity.has_key?('definition')
+                            intEntity[:entityDefinition] = hEntity['definition']
+                        end
+                        if intEntity[:entityDefinition].nil? || intEntity[:entityDefinition] == ''
+                            responseObj[:readerExecutionMessages] << 'Data Dictionary entity definition is missing'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # data entity - primary key (NOT required)
+                        if hEntity.has_key?('primaryKeyAttributeCodeName')
+                            hEntity['primaryKeyAttributeCodeName'].each do |item|
+                                if item != ''
+                                    intEntity[:primaryKey] << item
+                                end
+                            end
+                        end
+
+                        # entity - indexes []
+                        if hEntity.has_key?('index')
+                            hEntity['index'].each do |hIndex|
+                                unless hIndex.empty?
+                                    index = EntityIndex.unpack(hIndex, responseObj)
+                                    unless index.nil?
+                                        intEntity[:indexes] << index
+                                    end
+                                end
+                            end
+                        end
+
+                        # entity - attributes []
+                        if hEntity.has_key?('attribute')
+                            hEntity['attribute'].each do |hAttribute|
+                                unless hAttribute.empty?
+                                    attribute = EntityAttribute.unpack(hAttribute, responseObj)
+                                    unless attribute.nil?
+                                        intEntity[:attributes] << attribute
+                                    end
+                                end
+                            end
+                        end
+
+                        # entity - foreign keys []
+                        if hEntity.has_key?('foreignKey')
+                            hEntity['foreignKey'].each do |hFKey|
+                                unless hFKey.empty?
+                                    fKey = EntityForeignKey.unpack(hFKey, responseObj)
+                                    unless fKey.nil?
+                                        intEntity[:foreignKeys] << fKey
+                                    end
+                                end
+                            end
+                        end
+
+                        return intEntity
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,130 @@
+# unpack an data entity attribute
+# Reader - ADIwg JSON V1 to internal data structure
+
+# History:
+#   Stan Smith 2016-10-05 refactored for mdJson 2.0
+#   Stan Smith 2015-07-24 added error reporting of missing items
+#   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 2015-02-17 added support for attribute aliases
+#   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+# 	Stan Smith 2013-12-01 original script
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module EntityAttribute
+
+                    def self.unpack(hAttribute, responseObj)
+
+                        # return nil object if input is empty
+                        if hAttribute.empty?
+                            responseObj[:readerExecutionMessages] << 'Entity Attribute object is empty'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intAttribute = intMetadataClass.newEntityAttribute
+
+                        # attribute - common name
+                        if hAttribute.has_key?('commonName')
+                            if hAttribute['commonName'] != ''
+                                intAttribute[:attributeName] = hAttribute['commonName']
+                            end
+                        end
+
+                        # attribute - code name (required)
+                        if hAttribute.has_key?('codeName')
+                            intAttribute[:attributeCode] = hAttribute['codeName']
+                        end
+                        if intAttribute[:attributeCode].nil? || intAttribute[:attributeCode] == ''
+                            responseObj[:readerExecutionMessages] << 'Data Dictionary attribute code name is missing'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # attribute - alias []
+                        if hAttribute.has_key?('alias')
+                            hAttribute['alias'].each do |item|
+                                if item != ''
+                                    intAttribute[:attributeAlias] << item
+                                end
+                            end
+                        end
+
+                        # attribute - definition (required)
+                        if hAttribute.has_key?('definition')
+                            intAttribute[:attributeDefinition] = hAttribute['definition']
+                        end
+                        if intAttribute[:attributeDefinition].nil? || intAttribute[:attributeDefinition] == ''
+                            responseObj[:readerExecutionMessages] << 'Data Dictionary attribute definition is missing'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # attribute - data type (required)
+                        if hAttribute.has_key?('dataType')
+                            intAttribute[:dataType] = hAttribute['dataType']
+                        end
+                        if intAttribute[:dataType].nil? || intAttribute[:dataType] == ''
+                            responseObj[:readerExecutionMessages] << 'Data Dictionary attribute data type is missing'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # attribute - minimum cardinality (required)
+                        if hAttribute.has_key?('allowNull')
+                            if hAttribute['allowNull'] === true
+                                intAttribute[:allowNull] = hAttribute['allowNull']
+                            end
+                        end
+
+                        # attribute - maximum cardinality
+                        if hAttribute.has_key?('allowMany')
+                            if hAttribute['allowMany'] === true
+                                intAttribute[:allowMany] = hAttribute['allowMany']
+                            end
+                        end
+
+                        # attribute - units of measure
+                        if hAttribute.has_key?('units')
+                            if hAttribute['units'] != ''
+                                intAttribute[:unitOfMeasure] = hAttribute['units']
+                            end
+                        end
+
+                        # attribute - domain ID
+                        if hAttribute.has_key?('domainId')
+                            if hAttribute['domainId'] != ''
+                                intAttribute[:domainId] = hAttribute['domainId']
+                            end
+                        end
+
+                        # attribute - minimum value
+                        if hAttribute.has_key?('minValue')
+                            if hAttribute['minValue'] != ''
+                                intAttribute[:minValue] = hAttribute['minValue']
+                            end
+                        end
+
+                        # attribute - maximum value
+                        if hAttribute.has_key?('maxValue')
+                            if hAttribute['maxValue'] != ''
+                                intAttribute[:maxValue] = hAttribute['maxValue']
+                            end
+                        end
+
+                        return intAttribute
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,78 @@
+# unpack an data entity foreign key
+# Reader - ADIwg JSON V1 to internal data structure
+
+# History:
+#   Stan Smith 2016-10-06 refactored for mdJson 2.0
+#   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
+#   Stan Smith 2015-07-14 refactored to remove global namespace constants
+#   Stan Smith 2015-07-24 added error reporting of missing items
+# 	Stan Smith 2013-12-01 original script
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module EntityForeignKey
+
+                    def self.unpack(hFKey, responseObj)
+
+                        # return nil object if input is empty
+                        if hFKey.empty?
+                            responseObj[:readerExecutionMessages] << 'Foreign Key object is empty'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intFKey = intMetadataClass.newEntityForeignKey
+
+                        # entity foreign key - local attribute code name [] (required)
+                        # return nil if no local attribute is provided
+                        if hFKey.has_key?('localAttributeCodeName')
+                            intFKey[:fkLocalAttributes] = hFKey['localAttributeCodeName']
+                        else
+                            intFKey[:fkLocalAttributes] = []
+                        end
+                        if intFKey[:fkLocalAttributes].empty?
+                            responseObj[:readerExecutionMessages] << 'Data Dictionary foreign key local attribute code name is missing'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # entity foreign key - referenced entity code name (required)
+                        # return nil if no referenced entity is provided
+                        if hFKey.has_key?('referencedEntityCodeName')
+                            intFKey[:fkReferencedEntity] = hFKey['referencedEntityCodeName']
+                        end
+                        if intFKey[:fkReferencedEntity].nil? || intFKey[:fkReferencedEntity] == ''
+                            responseObj[:readerExecutionMessages] << 'Data Dictionary foreign key referenced entity name is missing'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # entity foreign key - referenced attribute code name [] (required)
+                        # return nil if no referenced attribute is provided
+                        if hFKey.has_key?('referencedAttributeCodeName')
+                            intFKey[:fkReferencedAttributes] = hFKey['referencedAttributeCodeName']
+                        else
+                            intFKey[:fkReferencedAttributes] = []
+                        end
+                        if intFKey[:fkReferencedAttributes].empty?
+                            responseObj[:readerExecutionMessages] << 'Data Dictionary foreign key referenced attribute name is missing'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        return intFKey
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,72 @@
+# unpack an data entity index
+# Reader - ADIwg JSON V1 to internal data structure
+
+# History:
+#   Stan Smith 2016-10-07 refactored for mdJson 2.0
+#   Stan Smith 2015-07-24 added error reporting of missing items
+#   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-12-01 original script
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module EntityIndex
+
+                    def self.unpack(hIndex, responseObj)
+
+                        # return nil object if input is empty
+                        if hIndex.empty?
+                            responseObj[:readerExecutionMessages] << 'Entity Index object is empty'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intIndex = intMetadataClass.newEntityIndex
+
+                        # entity index - code name (required)
+                        # return nil if no entity index is provided
+                        if hIndex.has_key?('codeName')
+                            intIndex[:indexCode] = hIndex['codeName']
+                        end
+                        if intIndex[:indexCode].nil? || intIndex[:indexCode] == ''
+                            responseObj[:readerExecutionMessages] << 'Data Dictionary entity index name is missing'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # entity index - allow duplicates (required)
+                        if hIndex.has_key?('allowDuplicates')
+                            if hIndex['allowDuplicates'] === true
+                                intIndex[:duplicate] = true
+                            end
+                        end
+
+                        # entity index - attribute list [] (required)
+                        # return nil if no attribute list is provided
+                        if hIndex.has_key?('attributeCodeName')
+                            intIndex[:attributeNames] = hIndex['attributeCodeName']
+                        else
+                            intIndex[:attributeNames] = []
+                        end
+                        if intIndex[:attributeNames].empty?
+                            responseObj[:readerExecutionMessages] << 'Data Dictionary entity index attribute list is missing'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        return intIndex
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,83 @@
+# unpack a extent
+# Reader - mdJson to internal data structure
+
+# History:
+#   Stan Smith 2016-10-30 original script
+
+require_relative 'module_geographicExtent'
+require_relative 'module_temporalExtent'
+require_relative 'module_verticalExtent'
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module Extent
+
+                    def self.unpack(hExtent, responseObj)
+
+                        # return nil object if input is empty
+                        if hExtent.empty?
+                            responseObj[:readerExecutionMessages] << 'Extent object is empty'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intExtent = intMetadataClass.newExtent
+
+                        # extent - description
+                        if hExtent.has_key?('description')
+                            if  hExtent['description'] != ''
+                                intExtent[:description] =  hExtent['description']
+                            end
+                        end
+
+                        # extent - geographicExtent
+                        if hExtent.has_key?('geographicExtent')
+                            hExtent['geographicExtent'].each do |item|
+                                unless item.empty?
+                                    hReturn = GeographicExtent.unpack(item, responseObj)
+                                    unless hReturn.nil?
+                                        intExtent[:geographicExtents] << hReturn
+                                    end
+                                end
+                            end
+                        end
+
+                        # extent - temporalExtent
+                        if hExtent.has_key?('temporalExtent')
+                            hExtent['temporalExtent'].each do |item|
+                                unless item.empty?
+                                    hReturn = TemporalExtent.unpack(item, responseObj)
+                                    unless hReturn.nil?
+                                        intExtent[:temporalExtents] << hReturn
+                                    end
+                                end
+                            end
+                        end
+
+                        # extent - verticalExtent
+                        if hExtent.has_key?('verticalExtent')
+                            hExtent['verticalExtent'].each do |item|
+                                unless item.empty?
+                                    hReturn = VerticalExtent.unpack(item, responseObj)
+                                    unless hReturn.nil?
+                                        intExtent[:verticalExtents] << hReturn
+                                    end
+                                end
+                            end
+                        end
+
+                        return intExtent
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end