adiwg-mdtranslator 1.2.1 → 1.3.0

data/lib/adiwg/mdtranslator/readers/mdJson/{modules_1.0 → modules_v1}/module_entity.rb

@@ -5,10 +5,13 @@
 # 	Stan Smith 2013-12-01 original script
 #   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
 #   Stan Smith 2015-02-17 add entity aliases
+#   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
 
-require $ReaderNS.readerModule('module_entityIndex')
-require $ReaderNS.readerModule('module_entityAttribute')
-require $ReaderNS.readerModule('module_entityForeignKey')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_entityIndex')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_entityAttribute')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_entityForeignKey')
 
 module ADIWG
     module Mdtranslator
@@ -17,7 +20,11 @@ module ADIWG
 
                 module Entity
 
-                    def self.unpack(hEntity)
+                    def self.unpack(hEntity, responseObj)
+
+                        # return nil object if input is empty
+                        intEntity = nil
+                        return if hEntity.empty?
 
                         # instance classes needed in script
                         intMetadataClass = InternalMetadata.new
@@ -28,6 +35,10 @@ module ADIWG
                             s = hEntity['entityId']
                             if s != ''
                                 intEntity[:entityId] = s
+                            else
+                                responseObj[:readerExecutionMessages] << 'Data Dictionary entity ID is missing'
+                                responseObj[:readerExecutionPass] = false
+                                return nil
                             end
                         end
 
@@ -44,6 +55,10 @@ module ADIWG
                             s = hEntity['codeName']
                             if s != ''
                                 intEntity[:entityCode] = s
+                            else
+                                responseObj[:readerExecutionMessages] << 'Data Dictionary entity code name is missing'
+                                responseObj[:readerExecutionPass] = false
+                                return nil
                             end
                         end
 
@@ -60,6 +75,10 @@ module ADIWG
                             s = hEntity['definition']
                             if s != ''
                                 intEntity[:entityDefinition] = s
+                            else
+                                responseObj[:readerExecutionMessages] << 'Data Dictionary entity definition is missing'
+                                responseObj[:readerExecutionPass] = false
+                                return nil
                             end
                         end
 
@@ -76,7 +95,7 @@ module ADIWG
                             aIndexes = hEntity['index']
                             aIndexes.each do |hIndex|
                                 unless hIndex.empty?
-                                    intEntity[:indexes] << $ReaderNS::EntityIndex.unpack(hIndex)
+                                    intEntity[:indexes] << EntityIndex.unpack(hIndex, responseObj)
                                 end
                             end
                         end
@@ -86,7 +105,7 @@ module ADIWG
                             aAttributes = hEntity['attribute']
                             aAttributes.each do |hAttribute|
                                 unless hAttribute.empty?
-                                    intEntity[:attributes] << $ReaderNS::EntityAttribute.unpack(hAttribute)
+                                    intEntity[:attributes] << EntityAttribute.unpack(hAttribute, responseObj)
                                 end
                             end
                         end
@@ -96,7 +115,7 @@ module ADIWG
                             aFKeys = hEntity['foreignKey']
                             aFKeys.each do |hFKey|
                                 unless hFKey.empty?
-                                    intEntity[:foreignKeys] << $ReaderNS::EntityForeignKey.unpack(hFKey)
+                                    intEntity[:foreignKeys] << EntityForeignKey.unpack(hFKey, responseObj)
                                 end
                             end
                         end

data/lib/adiwg/mdtranslator/readers/mdJson/{modules_1.0 → modules_v1}/module_entityAttribute.rb

@@ -5,6 +5,9 @@
 # 	Stan Smith 2013-12-01 original script
 #   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
 #   Stan Smith 2015-02-17 added support for attribute aliases
+#   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
 
 module ADIWG
     module Mdtranslator
@@ -13,7 +16,11 @@ module ADIWG
 
                 module EntityAttribute
 
-                    def self.unpack(hAttribute)
+                    def self.unpack(hAttribute, responseObj)
+
+                        # return nil object if input is empty
+                        intAttribute = nil
+                        return if hAttribute.empty?
 
                         # instance classes needed in script
                         intMetadataClass = InternalMetadata.new
@@ -32,6 +39,10 @@ module ADIWG
                             s = hAttribute['codeName']
                             if s != ''
                                 intAttribute[:attributeCode] = s
+                            else
+                                responseObj[:readerExecutionMessages] << 'Data Dictionary attribute code name is missing'
+                                responseObj[:readerExecutionPass] = false
+                                return nil
                             end
                         end
 
@@ -48,6 +59,10 @@ module ADIWG
                             s = hAttribute['definition']
                             if s != ''
                                 intAttribute[:attributeDefinition] = s
+                            else
+                                responseObj[:readerExecutionMessages] << 'Data Dictionary attribute definition is missing'
+                                responseObj[:readerExecutionPass] = false
+                                return nil
                             end
                         end
 
@@ -56,6 +71,10 @@ module ADIWG
                             s = hAttribute['dataType']
                             if s != ''
                                 intAttribute[:dataType] = s
+                            else
+                                responseObj[:readerExecutionMessages] << 'Data Dictionary attribute data type is missing'
+                                responseObj[:readerExecutionPass] = false
+                                return nil
                             end
                         end
 
@@ -64,6 +83,10 @@ module ADIWG
                             s = hAttribute['allowNull']
                             if s != ''
                                 intAttribute[:allowNull] = s
+                            else
+                                responseObj[:readerExecutionMessages] << 'Data Dictionary attribute allow null flag is missing'
+                                responseObj[:readerExecutionPass] = false
+                                return nil
                             end
                         end
 

data/lib/adiwg/mdtranslator/readers/mdJson/{modules_1.0 → modules_v1}/module_entityForeignKey.rb

@@ -4,6 +4,9 @@
 # History:
 # 	Stan Smith 2013-12-01 original script
 #   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
 
 module ADIWG
     module Mdtranslator
@@ -12,7 +15,11 @@ module ADIWG
 
                 module EntityForeignKey
 
-                    def self.unpack(hFKey)
+                    def self.unpack(hFKey, responseObj)
+
+                        # return nil object if input is empty
+                        intFKey = nil
+                        return if hFKey.empty?
 
                         # instance classes needed in script
                         intMetadataClass = InternalMetadata.new
@@ -23,6 +30,10 @@ module ADIWG
                             aLocalAttributes = hFKey['localAttributeCodeName']
                             unless aLocalAttributes.empty?
                                 intFKey[:fkLocalAttributes] = aLocalAttributes
+                            else
+                                responseObj[:readerExecutionMessages] << 'Data Dictionary foreign key local attribute code name is missing'
+                                responseObj[:readerExecutionPass] = false
+                                return nil
                             end
                         end
 
@@ -31,6 +42,10 @@ module ADIWG
                             s = hFKey['referencedEntityCodeName']
                             if s != ''
                                 intFKey[:fkReferencedEntity] = s
+                            else
+                                responseObj[:readerExecutionMessages] << 'Data Dictionary foreign key referenced entity name is missing'
+                                responseObj[:readerExecutionPass] = false
+                                return nil
                             end
                         end
 
@@ -39,6 +54,10 @@ module ADIWG
                             aRefAttributes = hFKey['referencedAttributeCodeName']
                             unless aRefAttributes.empty?
                                 intFKey[:fkReferencedAttributes] = aRefAttributes
+                            else
+                                responseObj[:readerExecutionMessages] << 'Data Dictionary foreign key referenced attribute name is missing'
+                                responseObj[:readerExecutionPass] = false
+                                return nil
                             end
                         end
 

data/lib/adiwg/mdtranslator/readers/mdJson/{modules_1.0 → modules_v1}/module_entityIndex.rb

@@ -4,6 +4,9 @@
 # History:
 # 	Stan Smith 2013-12-01 original script
 #   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
 
 module ADIWG
     module Mdtranslator
@@ -12,7 +15,11 @@ module ADIWG
 
                 module EntityIndex
 
-                    def self.unpack(hIndex)
+                    def self.unpack(hIndex, responseObj)
+
+                        # return nil object if input is empty
+                        intIndex = nil
+                        return if hIndex.empty?
 
                         # instance classes needed in script
                         intMetadataClass = InternalMetadata.new
@@ -23,6 +30,10 @@ module ADIWG
                             s = hIndex['codeName']
                             if s != ''
                                 intIndex[:indexCode] = s
+                            else
+                                responseObj[:readerExecutionMessages] << 'Data Dictionary entity index name is missing'
+                                responseObj[:readerExecutionPass] = false
+                                return nil
                             end
                         end
 
@@ -31,6 +42,10 @@ module ADIWG
                             s = hIndex['allowDuplicates']
                             if s != ''
                                 intIndex[:duplicate] = s
+                            else
+                                responseObj[:readerExecutionMessages] << 'Data Dictionary entity index unique/duplicate flag is missing'
+                                responseObj[:readerExecutionPass] = false
+                                return nil
                             end
                         end
 
@@ -39,6 +54,10 @@ module ADIWG
                             aKeyAttributes = hIndex['attributeCodeName']
                             unless aKeyAttributes.empty?
                                 intIndex[:attributeNames] = aKeyAttributes
+                            else
+                                responseObj[:readerExecutionMessages] << 'Data Dictionary entity index attribute list is missing'
+                                responseObj[:readerExecutionPass] = false
+                                return nil
                             end
                         end
 

data/lib/adiwg/mdtranslator/readers/mdJson/{modules_1.0 → modules_v1}/module_extent.rb

@@ -9,10 +9,12 @@
 # 	Stan Smith 2013-12-05 modified to for new temporalElement schema
 #   Stan Smith 2014-07-07 resolve require statements using Mdtranslator.reader_module
 #   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
 
-require $ReaderNS.readerModule('module_geographicElement')
-require $ReaderNS.readerModule('module_temporalElement')
-require $ReaderNS.readerModule('module_verticalElement')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_geographicElement')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_temporalElement')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_verticalElement')
 
 module ADIWG
     module Mdtranslator
@@ -21,7 +23,7 @@ module ADIWG
 
                 module Extent
 
-                    def self.unpack(hExtent)
+                    def self.unpack(hExtent, responseObj)
 
                         # instance classes needed in script
                         intMetadataClass = InternalMetadata.new
@@ -39,7 +41,7 @@ module ADIWG
                         if hExtent.has_key?('geographicElement')
                             aGeoElements = hExtent['geographicElement']
                             unless aGeoElements.empty?
-                                intExtent[:extGeoElements] = $ReaderNS::GeographicElement.unpack(aGeoElements)
+                                intExtent[:extGeoElements] = GeographicElement.unpack(aGeoElements, responseObj)
                             end
                         end
 
@@ -47,7 +49,7 @@ module ADIWG
                         if hExtent.has_key?('temporalElement')
                             hTempElement = hExtent['temporalElement']
                             unless hTempElement.empty?
-                                intExtent[:extTempElements] = $ReaderNS::TemporalElement.unpack(hTempElement)
+                                intExtent[:extTempElements] = TemporalElement.unpack(hTempElement, responseObj)
                             end
                         end
 
@@ -56,7 +58,7 @@ module ADIWG
                             aVertElements = hExtent['verticalElement']
                             unless aVertElements.empty?
                                 aVertElements.each do |hVertElement|
-                                    intExtent[:extVertElements] << $ReaderNS::VerticalElement.unpack(hVertElement)
+                                    intExtent[:extVertElements] << VerticalElement.unpack(hVertElement, responseObj)
                                 end
                             end
                         end

data/lib/adiwg/mdtranslator/readers/mdJson/{modules_1.0 → modules_v1}/module_geoCoordSystem.rb

@@ -4,6 +4,8 @@
 # History:
 # 	Stan Smith 2014-04-30 original script
 #   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
 
 module ADIWG
     module Mdtranslator
@@ -12,7 +14,7 @@ module ADIWG
 
                 module GeoCoordSystem
 
-                    def self.unpack(hGeoCrs, intElement)
+                    def self.unpack(hGeoCrs, intElement, responseObj)
 
                         intMetadataClass = InternalMetadata.new
                         intSRS = intMetadataClass.newSRS

data/lib/adiwg/mdtranslator/readers/mdJson/{modules_1.0 → modules_v1}/module_geoProperties.rb

@@ -6,10 +6,12 @@
 #   Stan Smith 2014-07-07 resolve require statements using Mdtranslator.reader_module
 #   Stan Smith 2014-08-18 changed assignedId to identifier schema 0.6.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
 
-require $ReaderNS.readerModule('module_temporalElement')
-require $ReaderNS.readerModule('module_verticalElement')
-require $ReaderNS.readerModule('module_resourceIdentifier')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_temporalElement')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_verticalElement')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_resourceIdentifier')
 
 module ADIWG
     module Mdtranslator
@@ -18,7 +20,7 @@ module ADIWG
 
                 module GeoProperties
 
-                    def self.unpack(hGeoProps, intElement)
+                    def self.unpack(hGeoProps, intElement, responseObj)
 
                         # set element extent - (default true)
                         intElement[:elementIncludeData] = true
@@ -48,7 +50,7 @@ module ADIWG
                         if hGeoProps.has_key?('temporalElement')
                             hTempEle = hGeoProps['temporalElement']
                             unless hTempEle.empty?
-                                intElement[:temporalElements] = $ReaderNS::TemporalElement.unpack(hTempEle)
+                                intElement[:temporalElements] = TemporalElement.unpack(hTempEle, responseObj)
                             end
                         end
 
@@ -57,7 +59,7 @@ module ADIWG
                             aVertEle = hGeoProps['verticalElement']
                             unless aVertEle.empty?
                                 aVertEle.each do |hVertEle|
-                                    intElement[:verticalElements] << $ReaderNS::VerticalElement.unpack(hVertEle)
+                                    intElement[:verticalElements] << VerticalElement.unpack(hVertEle, responseObj)
                                 end
                             end
                         end
@@ -67,7 +69,7 @@ module ADIWG
                             aResIds = hGeoProps['identifier']
                             unless aResIds.empty?
                                 aResIds.each do |hIdentifier|
-                                    intElement[:elementIdentifiers] << $ReaderNS::ResourceIdentifier.unpack(hIdentifier)
+                                    intElement[:elementIdentifiers] << ResourceIdentifier.unpack(hIdentifier, responseObj)
                                 end
                             end
                         end

data/lib/adiwg/mdtranslator/readers/mdJson/{modules_1.0 → modules_v1}/module_geographicElement.rb

@@ -15,13 +15,15 @@
 #   Stan Smith 2014-05-23 added direct support for geometryCollection
 #   Stan Smith 2014-07-07 resolve require statements using Mdtranslator.reader_module
 #   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
 
-require $ReaderNS.readerModule('module_geoCoordSystem')
-require $ReaderNS.readerModule('module_geoProperties')
-require $ReaderNS.readerModule('module_boundingBox')
-require $ReaderNS.readerModule('module_point')
-require $ReaderNS.readerModule('module_lineString')
-require $ReaderNS.readerModule('module_polygon')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_geoCoordSystem')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_geoProperties')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_boundingBox')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_point')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_lineString')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_polygon')
 
 module ADIWG
     module Mdtranslator
@@ -30,7 +32,7 @@ module ADIWG
 
                 module GeographicElement
 
-                    def self.unpack(aGeoElements)
+                    def self.unpack(aGeoElements, responseObj)
 
                         # only one geometry is allowed per geographic element.
                         # ... in GeoJSON each geometry is allowed a bounding box;
@@ -64,13 +66,13 @@ module ADIWG
                             # set geographic element coordinate reference system - CRS
                             if hGeoJsonElement.has_key?('crs')
                                 hGeoCrs = hGeoJsonElement['crs']
-                                $ReaderNS::GeoCoordSystem.unpack(hGeoCrs, hGeoElement)
+                                GeoCoordSystem.unpack(hGeoCrs, hGeoElement, responseObj)
                             end
 
                             # set geographic element properties
                             if hGeoJsonElement.has_key?('properties')
                                 hGeoProps = hGeoJsonElement['properties']
-                                $ReaderNS::GeoProperties.unpack(hGeoProps, hGeoElement)
+                                GeoProperties.unpack(hGeoProps, hGeoElement, responseObj)
                             end
 
                             # process geographic element bounding box
@@ -81,7 +83,7 @@ module ADIWG
                                     aBBox = hGeoJsonElement['bbox']
 
                                     boxElement = Marshal.load(Marshal.dump(hGeoElement))
-                                    boxElement[:elementGeometry] = $ReaderNS::BoundingBox.unpack(aBBox)
+                                    boxElement[:elementGeometry] = BoundingBox.unpack(aBBox, responseObj)
 
                                     aIntGeoEle << boxElement
                                 end
@@ -105,11 +107,11 @@ module ADIWG
                                                     unless aCoordinates.empty?
                                                         case geometryType
                                                             when 'Point', 'MultiPoint'
-                                                                hGeoElement[:elementGeometry] = $ReaderNS::Point.unpack(aCoordinates, geometryType)
+                                                                hGeoElement[:elementGeometry] = Point.unpack(aCoordinates, geometryType, responseObj)
                                                             when 'LineString', 'MultiLineString'
-                                                                hGeoElement[:elementGeometry] = $ReaderNS::LineString.unpack(aCoordinates, geometryType)
+                                                                hGeoElement[:elementGeometry] = LineString.unpack(aCoordinates, geometryType, responseObj)
                                                             when 'Polygon', 'MultiPolygon'
-                                                                hGeoElement[:elementGeometry] = $ReaderNS::Polygon.unpack(aCoordinates, geometryType)
+                                                                hGeoElement[:elementGeometry] = Polygon.unpack(aCoordinates, geometryType, responseObj)
                                                             else
                                                                 # log - the GeoJSON geometry type is not supported
                                                         end
@@ -128,7 +130,7 @@ module ADIWG
                                         unless aFeatures.empty?
                                             intGeometry = intMetadataClass.newGeometry
                                             intGeometry[:geoType] = 'MultiGeometry'
-                                            intGeometry[:geometry] = $ReaderNS::GeographicElement.unpack(aFeatures)
+                                            intGeometry[:geometry] = GeographicElement.unpack(aFeatures, responseObj)
                                             hGeoElement[:elementGeometry] = intGeometry
                                             aIntGeoEle << hGeoElement
                                         end
@@ -137,17 +139,17 @@ module ADIWG
                                 # GeoJSON Geometries
                                 when 'Point', 'MultiPoint'
                                     aCoordinates = hGeoJsonElement['coordinates']
-                                    hGeoElement[:elementGeometry] = $ReaderNS::Point.unpack(aCoordinates, elementType)
+                                    hGeoElement[:elementGeometry] = Point.unpack(aCoordinates, elementType, responseObj)
                                     aIntGeoEle << hGeoElement
 
                                 when 'LineString', 'MultiLineString'
                                     aCoordinates = hGeoJsonElement['coordinates']
-                                    hGeoElement[:elementGeometry] = $ReaderNS::LineString.unpack(aCoordinates, elementType)
+                                    hGeoElement[:elementGeometry] = LineString.unpack(aCoordinates, elementType, responseObj)
                                     aIntGeoEle << hGeoElement
 
                                 when 'Polygon', 'MultiPolygon'
                                     aCoordinates = hGeoJsonElement['coordinates']
-                                    hGeoElement[:elementGeometry] = $ReaderNS::Polygon.unpack(aCoordinates, elementType)
+                                    hGeoElement[:elementGeometry] = Polygon.unpack(aCoordinates, elementType, responseObj)
                                     aIntGeoEle << hGeoElement
 
                                 # GeoJSON Geometry Collection
@@ -157,7 +159,7 @@ module ADIWG
                                         unless aGeometries.empty?
                                             intGeometry = intMetadataClass.newGeometry
                                             intGeometry[:geoType] = 'MultiGeometry'
-                                            intGeometry[:geometry] = $ReaderNS::GeographicElement.unpack(aGeometries)
+                                            intGeometry[:geometry] = GeographicElement.unpack(aGeometries, responseObj)
                                             hGeoElement[:elementGeometry] = intGeometry
                                             aIntGeoEle << hGeoElement
                                         end