adiwg-mdtranslator 1.4.0 → 2.0.0rc2

data/lib/adiwg/mdtranslator/writers/iso19115_2/classes/class_format.rb

@@ -1,13 +1,14 @@
 # ISO <<Class>> MD_Format
-# writer output in XML
+# 19115-2 writer output in XML
 
 # History:
-# 	Stan Smith 2013-08-26 original script
-#   Stan Smith 2014-12-12 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 make iso19110 independent of iso19115_2 classes
-#   Stan Smith 2015-07-14 refactored to eliminate namespace globals $WriterNS and $IsoNS
+#   Stan Smith 2016-12-07 refactored for mdTranslator/mdJson 2.0
 #   Stan Smith 2015-09-15 added compression method element
+#   Stan Smith 2015-07-14 refactored to eliminate namespace globals $WriterNS and $IsoNS
+#   Stan Smith 2015-07-14 refactored to make iso19110 independent of iso19115_2 classes
+#   Stan Smith 2015-06-22 replace global ($response) with passed in object (hResponseObj)
+#   Stan Smith 2014-12-12 refactored to handle namespacing readers and writers
+# 	Stan Smith 2013-08-26 original script
 
 module ADIWG
     module Mdtranslator
@@ -16,50 +17,70 @@ module ADIWG
 
                 class MD_Format
 
-                    def initialize(xml, responseObj)
+                    def initialize(xml, hResponseObj)
                         @xml = xml
-                        @responseObj = responseObj
+                        @hResponseObj = hResponseObj
                     end
 
-                    def writeXML(rFormat)
+                    def writeXML(hFormat)
 
                         @xml.tag!('gmd:MD_Format') do
 
-                            # format - name - required
-                            s = rFormat[:formatName]
-                            if s.nil?
-                                @xml.tag!('gmd:name', {'gco:nilReason' => 'missing'})
+                            # get required 19115-2 elements from citation
+                            citation = hFormat[:formatSpecification]
+                            if citation.empty?
+                                name = nil
+                                version = nil
                             else
+                                name = citation[:title]
+                                version = citation[:edition]
+                            end
+
+                            # format - name (required)
+                            unless name.nil?
                                 @xml.tag!('gmd:name') do
-                                    @xml.tag!('gco:CharacterString', s)
+                                    @xml.tag!('gco:CharacterString', name)
                                 end
                             end
+                            if name.nil?
+                                @xml.tag!('gmd:name', {'gco:nilReason' => 'missing'})
+                            end
 
-                            # format - version - required
-                            s = rFormat[:formatVersion]
-                            if s.nil?
-                                @xml.tag!('gmd:version', {'gco:nilReason' => 'unknown'})
-                            else
+                            # format - version (required)
+                            unless version.nil?
                                 @xml.tag!('gmd:version') do
+                                    @xml.tag!('gco:CharacterString', version)
+                                end
+                            end
+                            if version.nil?
+                                @xml.tag!('gmd:version', {'gco:nilReason' => 'missing'})
+                            end
+
+                            # format - amendment number
+                            s = hFormat[:amendmentNumber]
+                            unless s.nil?
+                                @xml.tag!('gmd:amendmentNumber') do
                                     @xml.tag!('gco:CharacterString', s)
                                 end
                             end
+                            if s.nil? && @hResponseObj[:writerShowTags]
+                                @xml.tag!('gmd:amendmentNumber')
+                            end
 
                             # format - compression method
-                            s = rFormat[:compressionMethod]
-                            if !s.nil?
+                            s = hFormat[:compressionMethod]
+                            unless s.nil?
                                 @xml.tag!('gmd:fileDecompressionTechnique') do
                                     @xml.tag!('gco:CharacterString', s)
                                 end
-                            elsif @responseObj[:writerShowTags]
+                            end
+                            if s.nil? && @hResponseObj[:writerShowTags]
                                 @xml.tag!('gmd:fileDecompressionTechnique')
                             end
 
-                        end
-
-                    end
-
-                end
+                        end # MD_Format tag
+                    end # writeXML
+                end # MD_Format class
 
             end
         end

data/lib/adiwg/mdtranslator/writers/iso19115_2/classes/class_fraction.rb

@@ -0,0 +1,40 @@
+# ISO <<Class>> MD_RepresentativeFraction
+# 19115-2 writer output in XML
+
+# History:
+#   Stan Smith 2016-12-13 original script
+
+module ADIWG
+    module Mdtranslator
+        module Writers
+            module Iso19115_2
+
+                class MD_RepresentativeFraction
+
+                    def initialize(xml, hResponseObj)
+                        @xml = xml
+                        @hResponseObj = hResponseObj
+                    end
+
+                    def writeXML(denominator)
+
+                        @xml.tag!('gmd:MD_RepresentativeFraction') do
+
+                            # representative fraction - denominator
+                            unless denominator.nil?
+                                @xml.tag!('gmd:denominator') do
+                                    @xml.tag!('gco:Integer', denominator)
+                                end
+                            end
+                            if denominator.nil?
+                                @xml.tag!('gmd:denominator', {'gco:nilReason' => 'missing'})
+                            end
+
+                        end # gmd:MD_RepresentativeFraction tag
+                    end # writeXML
+                end # MD_RepresentativeFraction class
+
+            end
+        end
+    end
+end

data/lib/adiwg/mdtranslator/writers/iso19115_2/classes/class_gcoDateTime.rb

@@ -0,0 +1,48 @@
+# ISO <<Class>> Date, DateTime
+# 19115-2 writer output in XML
+
+# History:
+# 	Stan Smith 2017-02-10 original script
+
+module ADIWG
+    module Mdtranslator
+        module Writers
+            module Iso19115_2
+
+                class GcoDateTime
+
+                    def initialize(xml, hResponseObj)
+                        @xml = xml
+                        @hResponseObj = hResponseObj
+                    end
+
+                    def writeXML(hDate)
+
+                        date = hDate[:date]
+                        dateRes = hDate[:dateResolution]
+
+                        # date - date (required)
+                        unless date.nil?
+                            case dateRes
+                                when 'Y', 'YM', 'YMD'
+                                    dateStr = AdiwgDateTimeFun.stringDateFromDateTime(date, dateRes)
+                                    @xml.tag!('gco:Date', dateStr)
+                                when 'YMDh', 'YMDhm', 'YMDhms'
+                                    dateStr = AdiwgDateTimeFun.stringDateTimeFromDateTime(date, 'YMDhms')
+                                    @xml.tag!('gco:DateTime', dateStr)
+                                when 'YMDhZ', 'YMDhmZ', 'YMDhmsZ'
+                                    dateStr = AdiwgDateTimeFun.stringDateTimeFromDateTime(date, 'YMDhmsZ')
+                                    @xml.tag!('gco:DateTime', dateStr)
+                                else
+                                    dateStr = AdiwgDateTimeFun.stringDateTimeFromDateTime(date, dateRes)
+                                    @xml.tag!('gco:DateTime', dateStr)
+                            end
+                        end
+
+                    end # write XML
+                end # Date class
+
+            end
+        end
+    end
+end

data/lib/adiwg/mdtranslator/writers/iso19115_2/classes/class_geographicElement.rb

@@ -1,17 +1,25 @@
 # ISO <<Class>> geographicElement {abstract}
-# writer output in XML
+# 19115-2 writer output in XML
 
 # History:
-# 	Stan Smith 2014-05-29 original script
-#   Stan Smith 2014-05-30 added multi-point, multi-linestring, multi-polygon support
-#   Stan Smith 2014-07-08 modify require statements to function in RubyGem structure
-#   Stan Smith 2014-12-12 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 make iso19110 independent of iso19115_2 classes
+#   Stan Smith 2016-12-05 refactored for mdTranslator/mdJson 2.0
 #   Stan Smith 2015-07-14 refactored to eliminate namespace globals $WriterNS and $IsoNS
+#   Stan Smith 2015-07-14 refactored to make iso19110 independent of iso19115_2 classes
+#   Stan Smith 2015-06-22 replace global ($response) with passed in object (hResponseObj)
+#   Stan Smith 2014-12-12 refactored to handle namespacing readers and writers
+#   Stan Smith 2014-07-08 modify require statements to function in RubyGem structure
+#   Stan Smith 2014-05-30 added multi-point, multi-linestring, multi-polygon support
+# 	Stan Smith 2014-05-29 original script
 
-require_relative 'class_geographicBoundingBox'
-require_relative 'class_boundingPolygon'
+require_relative 'class_point'
+require_relative 'class_lineString'
+require_relative 'class_polygon'
+require_relative 'class_multiPoint'
+require_relative 'class_multiLine'
+require_relative 'class_multiPolygon'
+require_relative 'class_geometryCollection'
+require_relative 'class_feature'
+require_relative 'class_featureCollection'
 
 module ADIWG
     module Mdtranslator
@@ -20,30 +28,51 @@ module ADIWG
 
                 class GeographicElement
 
-                    def initialize(xml, responseObj)
+                    def initialize(xml, hResponseObj)
                         @xml = xml
-                        @responseObj = responseObj
+                        @hResponseObj = hResponseObj
                     end
 
-                    def writeXML(hGeoElement)
+                    def writeXML(aGeoElement)
 
                         # classes used
-                        geoBBoxClass =  EX_GeographicBoundingBox.new(@xml, @responseObj)
-                        geoBPolyClass =  EX_BoundingPolygon.new(@xml, @responseObj)
-
-                        geoType = hGeoElement[:elementGeometry][:geoType]
-                        case geoType
-                            when 'BoundingBox'
-                                geoBBoxClass.writeXML(hGeoElement)
-                            when 'Point', 'LineString', 'Polygon', 'MultiPoint', 'MultiLineString', 'MultiPolygon'
-                                geoBPolyClass.writeXML(hGeoElement)
-                            when 'MultiGeometry'
-                                geoBPolyClass.writeXML(hGeoElement)
-                        end
+                        pointClass =  Point.new(@xml, @hResponseObj)
+                        lineClass =  LineString.new(@xml, @hResponseObj)
+                        polyClass =  Polygon.new(@xml, @hResponseObj)
+                        multiPointClass =  MultiPoint.new(@xml, @hResponseObj)
+                        multiLineClass =  MultiLineString.new(@xml, @hResponseObj)
+                        multiPolyClass =  MultiPolygon.new(@xml, @hResponseObj)
+                        geoCollectClass =  GeometryCollection.new(@xml, @hResponseObj)
+                        featureClass =  Feature.new(@xml, @hResponseObj)
+                        featureCollectClass =  FeatureCollection.new(@xml, @hResponseObj)
 
-                    end
+                        aGeoElement.each do |hGeoElement|
+                            @xml.tag!('gmd:polygon') do
+                                case hGeoElement[:type]
+                                    when 'Point'
+                                        pointClass.writeXML(hGeoElement, {}, nil)
+                                    when 'LineString'
+                                        lineClass.writeXML(hGeoElement, {}, nil)
+                                    when 'Polygon'
+                                        polyClass.writeXML(hGeoElement, {}, nil)
+                                    when 'MultiPoint'
+                                        multiPointClass.writeXML(hGeoElement, {}, nil)
+                                    when 'MultiLineString'
+                                        multiLineClass.writeXML(hGeoElement, {}, nil)
+                                    when 'MultiPolygon'
+                                        multiPolyClass.writeXML(hGeoElement, {}, nil)
+                                    when 'GeometryCollection'
+                                        geoCollectClass.writeXML(hGeoElement, {}, nil)
+                                    when 'Feature'
+                                        featureClass.writeXML(hGeoElement)
+                                    when 'FeatureCollection'
+                                        featureCollectClass.writeXML(hGeoElement)
+                                end
+                            end
+                        end
 
-                end
+                    end # writeXML
+                end # GeographicElement class
 
             end
         end

data/lib/adiwg/mdtranslator/writers/iso19115_2/classes/class_geographicExtent.rb

@@ -0,0 +1,82 @@
+# ISO <<Class>> geographicElement {abstract}
+# writer output in XML
+
+# History:
+#   Stan Smith 2016-12-02 original script
+
+require_relative 'class_boundingBox'
+require_relative 'class_mdIdentifier'
+require_relative 'class_geographicElement'
+
+module ADIWG
+    module Mdtranslator
+        module Writers
+            module Iso19115_2
+
+                class GeographicExtent
+
+                    def initialize(xml, hResponseObj)
+                        @xml = xml
+                        @hResponseObj = hResponseObj
+                    end
+
+                    def writeXML(hGeoExtent)
+
+                        # classes used
+                        bBoxClass =  EX_GeographicBoundingBox.new(@xml, @hResponseObj)
+                        idClass =  MD_Identifier.new(@xml, @hResponseObj)
+                        geoEleClass =  GeographicElement.new(@xml, @hResponseObj)
+
+                        extType = hGeoExtent[:containsData]
+
+                        # geographic element - geographic bounding box
+                        # test for user provided bounding box
+                        # if empty, take computedBbox
+                        hBbox = hGeoExtent[:boundingBox]
+                        if hBbox.empty?
+                            hBbox = hGeoExtent[:computedBbox]
+                        end
+                        unless hBbox.empty?
+                            @xml.tag!('gmd:geographicElement') do
+                                @xml.tag!('gmd:EX_GeographicBoundingBox') do
+                                    @xml.tag!('gmd:extentTypeCode') do
+                                        @xml.tag!('gco:Boolean', extType)
+                                    end
+                                    bBoxClass.writeXML(hBbox)
+                                end
+                            end
+                        end
+
+                        # geographic element - geographic description
+                        unless hGeoExtent[:identifier].empty?
+                            @xml.tag!('gmd:geographicElement') do
+                                @xml.tag!('gmd:EX_GeographicDescription') do
+                                    @xml.tag!('gmd:extentTypeCode') do
+                                        @xml.tag!('gco:Boolean', extType)
+                                    end
+                                    @xml.tag!('gmd:geographicIdentifier') do
+                                        idClass.writeXML(hGeoExtent[:identifier])
+                                    end
+                                end
+                            end
+                        end
+
+                        # geographic element - geographic bounding polygon
+                        unless hGeoExtent[:geographicElements].empty?
+                            @xml.tag!('gmd:geographicElement') do
+                                @xml.tag!('gmd:EX_BoundingPolygon') do
+                                    @xml.tag!('gmd:extentTypeCode') do
+                                        @xml.tag!('gco:Boolean', extType)
+                                    end
+                                    geoEleClass.writeXML(hGeoExtent[:geographicElements])
+                                end
+                            end
+                        end
+
+                    end # writeXML
+                end # GeographicExtent class
+
+            end
+        end
+    end
+end

data/lib/adiwg/mdtranslator/writers/iso19115_2/classes/class_geometricObjects.rb

@@ -0,0 +1,56 @@
+# ISO <<Class>> MD_GeometricObjects
+# 19115-2 writer output in XML
+
+# History:
+# 	Stan Smith 2016-12-08 original script.
+
+require_relative 'class_codelist'
+
+module ADIWG
+    module Mdtranslator
+        module Writers
+            module Iso19115_2
+
+                class MD_GeometricObjects
+
+                    def initialize(xml, hResponseObj)
+                        @xml = xml
+                        @hResponseObj = hResponseObj
+                    end
+
+                    def writeXML(hGeoObj)
+
+                        # classes used
+                        codelistClass = MD_Codelist.new(@xml, @hResponseObj)
+
+                        @xml.tag!('gmd:MD_GeometricObjects') do
+
+                            # geometric object - object type (required)
+                            s = hGeoObj[:objectType]
+                            if s.nil?
+                                @xml.tag!('gmd:geometricObjectType', {'gco:nilReason'=>'missing'})
+                            else
+                                @xml.tag!('gmd:geometricObjectType') do
+                                    codelistClass.writeXML('gmd', 'iso_geometricObjectType', s)
+                                end
+                            end
+
+                            # geometric object - object count
+                            s = hGeoObj[:objectCount]
+                            unless s.nil?
+                                @xml.tag!('gmd:geometricObjectCount') do
+                                    @xml.tag!('gco:Integer', s.to_s)
+                                end
+                            end
+                            if s.nil? && @hResponseObj[:writerShowTags]
+                                @xml.tag!('gmd:geometricObjectCount')
+                            end
+
+                        end # gmd:MD_GeometricObjects tag
+                    end # writeXML
+                end # MD_GeometricObjects class
+
+            end
+        end
+    end
+end

data/lib/adiwg/mdtranslator/writers/iso19115_2/classes/class_geometryCollection.rb

@@ -0,0 +1,88 @@
+# GeoJSON GeometryCollection
+# 19115-2 writer output in XML
+
+# History:
+#   Stan Smith 2016-12-06 original script
+
+require_relative 'class_point'
+require_relative 'class_lineString'
+require_relative 'class_polygon'
+require_relative 'class_multiPoint'
+require_relative 'class_multiLine'
+require_relative 'class_multiPolygon'
+require_relative 'class_featureProperties'
+
+module ADIWG
+    module Mdtranslator
+        module Writers
+            module Iso19115_2
+
+                class GeometryCollection
+
+                    def initialize(xml, hResponseObj)
+                        @xml = xml
+                        @hResponseObj = hResponseObj
+                    end
+
+                    def writeXML(hGeoObject, hProperties, objId)
+
+                        # classes used
+                        pointClass =  Point.new(@xml, @hResponseObj)
+                        lineClass =  LineString.new(@xml, @hResponseObj)
+                        polyClass =  Polygon.new(@xml, @hResponseObj)
+                        multiPointClass =  MultiPoint.new(@xml, @hResponseObj)
+                        multiLineClass =  MultiLineString.new(@xml, @hResponseObj)
+                        multiPolyClass =  MultiPolygon.new(@xml, @hResponseObj)
+                        geoPropClass = FeatureProperties.new(@xml, @hResponseObj)
+
+                        # geometry collection attributes
+                        attributes = {}
+
+                        # geometry collection attributes - gml:id (required)
+                        if objId.nil?
+                            @hResponseObj[:writerMissingIdCount] = @hResponseObj[:writerMissingIdCount].succ
+                            objId = 'geometryCollection' + @hResponseObj[:writerMissingIdCount]
+                        end
+                        attributes['gml:id'] = objId
+
+                        # geometry collection attributes - srsName (GeoJSON is WGS84)
+                        attributes[:srsName] = 'WGS84'
+
+                        @xml.tag!('gml:MultiGeometry', attributes) do
+
+                            # geometry collection - properties for Feature
+                            unless hProperties.empty?
+                                geoPropClass.writeXML(hProperties)
+                            end
+
+                            # geometry collection - geometry objects (required)
+                            @xml.tag!('gml:geometryMembers') do
+                                unless hGeoObject[:geometryObjects].empty?
+                                    aObjects = hGeoObject[:geometryObjects]
+                                    aObjects.each do |hGeoObj|
+                                        case hGeoObj[:type]
+                                            when 'Point'
+                                                pointClass.writeXML(hGeoObj, {}, nil)
+                                            when 'LineString'
+                                                lineClass.writeXML(hGeoObj, {}, nil)
+                                            when 'Polygon'
+                                                polyClass.writeXML(hGeoObj, {}, nil)
+                                            when 'MultiPoint'
+                                                multiPointClass.writeXML(hGeoObj, {}, nil)
+                                            when 'MultiLineString'
+                                                multiLineClass.writeXML(hGeoObj, {}, nil)
+                                            when 'MultiPolygon'
+                                                multiPolyClass.writeXML(hGeoObj, {}, nil)
+                                        end
+                                    end
+                                end
+                            end
+
+                        end # gml:MultiGeometry tag
+                    end # writeXML
+                end # GeometryCollection class
+
+            end
+        end
+    end
+end

data/lib/adiwg/mdtranslator/writers/iso19115_2/classes/class_georectified.rb

@@ -0,0 +1,121 @@
+# ISO <<Class>> MD_Georectified
+# 19115-2 writer output in XML
+
+# History:
+# 	Stan Smith 2016-12-08 original script.
+
+require_relative 'class_grid'
+require_relative 'class_point'
+
+module ADIWG
+    module Mdtranslator
+        module Writers
+            module Iso19115_2
+
+                class MD_Georectified
+
+                    def initialize(xml, hResponseObj)
+                        @xml = xml
+                        @hResponseObj = hResponseObj
+                    end
+
+                    def writeXML(hGeoRec)
+
+                        # classes used
+                        gridClass = Grid.new(@xml, @hResponseObj)
+                        pointClass = Point.new(@xml, @hResponseObj)
+
+                        @xml.tag!('gmd:MD_Georectified') do
+
+                            # georectified - add grid info
+                            hGrid = hGeoRec[:gridRepresentation]
+                            gridClass.writeXML(hGrid)
+
+                            # georectified - checkpoint availability
+                            s = hGeoRec[:checkPointAvailable]
+                            @xml.tag!('gmd:checkPointAvailability') do
+                                @xml.tag!('gco:Boolean', s)
+                            end
+
+                            # georectified - checkpoint description
+                            s = hGeoRec[:checkPointDescription]
+                            unless s.nil?
+                                @xml.tag!('gmd:checkPointDescription') do
+                                    @xml.tag!('gco:CharacterString', s)
+                                end
+                            end
+                            if s.nil? && @hResponseObj[:writerShowTags]
+                                @xml.tag!('gmd:checkPointDescription')
+                            end
+
+                            # georectified - corner points (required)
+                            # note: 2 - 4 points are required, but XSD only allows 1
+                            # ... coordinates are flattened into one multi-dimensional point
+                            aCoords = hGeoRec[:cornerPoints]
+                            unless aCoords.empty?
+                                aCoords = aCoords.flatten
+                                hPoint = {}
+                                hPoint[:type] = 'Point'
+                                hPoint[:coordinates] = aCoords
+                                @xml.tag!('gmd:cornerPoints') do
+                                    pointClass.writeXML(hPoint, {}, nil)
+                                end
+                            end
+                            if aCoords.empty?
+                                @xml.tag!('gmd:cornerPoints', {'gco:nilReason'=>'missing'})
+                            end
+
+                            # georectified - center point
+                            aCoords = hGeoRec[:centerPoint]
+                            unless aCoords.empty?
+                                hPoint = {}
+                                hPoint[:type] = 'Point'
+                                hPoint[:coordinates] = aCoords
+                                @xml.tag!('gmd:centerPoint') do
+                                    pointClass.writeXML(hPoint, {}, nil)
+                                end
+                            end
+                            if aCoords.empty? && @hResponseObj[:writerShowTags]
+                                @xml.tag!('gmd:centerPoint')
+                            end
+
+                            # georectified - point in pixel (required)
+                            s = hGeoRec[:pointInPixel]
+                            if s.nil?
+                                @xml.tag!('gmd:pointInPixel', {'gco:nilReason'=>'missing'})
+                            else
+                                @xml.tag!('gmd:pointInPixel') do
+                                    @xml.tag!('gmd:MD_PixelOrientationCode', s)
+                                end
+                            end
+
+                            # georectified - transformation dimension description
+                            s = hGeoRec[:transformationDimensionDescription]
+                            unless s.nil?
+                                @xml.tag!('gmd:transformationDimensionDescription') do
+                                    @xml.tag!('gco:CharacterString', s)
+                                end
+                            end
+                            if s.nil? && @hResponseObj[:writerShowTags]
+                                @xml.tag!('gmd:transformationDimensionDescription')
+                            end
+
+                            # georectified - transformation dimension mapping
+                            s = hGeoRec[:transformationDimensionMapping]
+                            unless s.nil?
+                                @xml.tag!('gmd:transformationDimensionMapping') do
+                                    @xml.tag!('gco:CharacterString', s)
+                                end
+                            end
+                            if s.nil? && @hResponseObj[:writerShowTags]
+                                @xml.tag!('gmd:transformationDimensionMapping')
+                            end
+
+                        end # gmd:MD_Georectified tag
+                    end # writeXML
+                end # MD_Georectified class
+
+            end
+        end
+    end
+end