adiwg-mdtranslator 1.4.0 → 2.0.0rc2

data/lib/adiwg/mdtranslator/writers/iso19110/classes/class_fcFeatureCatalogue.rb

@@ -0,0 +1,205 @@
+# ISO 19110 <<Class>> FC_FeatureCatalogue
+# writer output in XML
+
+# History:
+#   Stan Smith 2017-01-20 refactored for mdJson/mdTranslator 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 (responseObj)
+#   Stan Smith 2014-12-29 set builder object '@xml' into string 'metadata'
+#   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+# 	Stan Smith 2013-12-01 original script
+
+require_relative 'class_locale'
+require_relative 'class_responsibleParty'
+require_relative 'class_featureType'
+
+module ADIWG
+    module Mdtranslator
+        module Writers
+            module Iso19110
+
+                class FC_FeatureCatalogue
+
+                    def initialize(xml, responseObj)
+                        @xml = xml
+                        @hResponseObj = responseObj
+                    end
+
+                    def writeXML(intObj)
+
+                        # classes used
+                        localeClass = PT_Locale.new(@xml, @hResponseObj)
+                        rPartyClass = CI_ResponsibleParty.new(@xml, @hResponseObj)
+                        featureClass = FC_FeatureType.new(@xml, @hResponseObj)
+
+                        hDictionary = intObj[:dataDictionaries][0]
+                        hCitation = hDictionary[:citation]
+                        aEntities = hDictionary[:entities]
+                        version = @hResponseObj[:translatorVersion]
+
+                        # document head
+                        metadata = @xml.instruct! :xml, encoding: 'UTF-8'
+                        @xml.comment!('ISO 19110 METADATA')
+                        @xml.comment!('Metadata file was constructed using the ADIwg mdTranslator, http://mdtranslator.adiwg.org')
+                        @xml.comment!('mdTranslator software is an open-source project of the Alaska Data Integration working group (ADIwg)')
+                        @xml.comment!('mdTranslator and other metadata tools are available at https://github.com/adiwg')
+                        @xml.comment!('ADIwg is not responsible for the content of this metadata record')
+                        @xml.comment!('This metadata record was generated by mdTranslator ' + version + ' at ' + Time.now.to_s)
+
+                        # FC_FeatureCatalogue
+                        @xml.tag!('gfc:FC_FeatureCatalogue',
+                                  {'xmlns:gmi' => 'http://www.isotc211.org/2005/gmi',
+                                   'xmlns:gmd' => 'http://www.isotc211.org/2005/gmd',
+                                   'xmlns:gco' => 'http://www.isotc211.org/2005/gco',
+                                   'xmlns:gml' => 'http://www.opengis.net/gml/3.2',
+                                   'xmlns:gsr' => 'http://www.isotc211.org/2005/gsr',
+                                   'xmlns:gss' => 'http://www.isotc211.org/2005/gss',
+                                   'xmlns:gst' => 'http://www.isotc211.org/2005/gst',
+                                   'xmlns:gmx' => 'http://www.isotc211.org/2005/gmx',
+                                   'xmlns:gfc' => 'http://www.isotc211.org/2005/gfc',
+                                   'xmlns:xlink' => 'http://www.w3.org/1999/xlink',
+                                   'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance',
+                                   'xsi:schemaLocation' => 'http://www.isotc211.org/2005/gfc C:\Users\StanSmith\Projects\ISO\19115\NOAA\schema\gfc\gfc.xsd'}) do
+
+                            # local schema for development
+                            # 'xsi:schemaLocation' => 'http://www.isotc211.org/2005/gfc C:\Users\StanSmith\Projects\ISO\19115\NOAA\schema\gfc\gfc.xsd'}) do
+
+                            # remote schema for publication
+                            # 'xsi:schemaLocation' => 'http://www.isotc211.org/2005/gfc ftp://ftp.ncddc.noaa.gov/pub/Metadata/Online_ISO_Training/Intro_to_ISO/schemas/ISObio/gfc/gfc.xsd'}) do
+
+                            # feature catalogue - name, version, version date are
+                            # are taken from citation
+                            name = hCitation[:title]
+                            version = hCitation[:edition]
+                            hDate = {}
+                            aDates = hCitation[:dates]
+                            unless aDates.empty?
+                                hDate = aDates[0]
+                            end
+
+                            # feature catalogue - name (required)
+                            unless name.nil?
+                                @xml.tag!('gmx:name') do
+                                    @xml.tag!('gco:CharacterString', name)
+                                end
+                            end
+                            if name.nil?
+                                @xml.tag!('gmx:name', {'gco:nilReason' => 'missing'})
+                            end
+
+                            # feature catalogue - scope (required) []
+                            aScopes = hDictionary[:subjects]
+                            aScopes.each do |scope|
+                                @xml.tag!('gmx:scope') do
+                                    @xml.tag!('gco:CharacterString', scope)
+                                end
+                            end
+                            if aScopes.empty? && @hResponseObj[:writerShowTags]
+                                @xml.tag!('gmx:scope', {'gco:nilReason' => 'missing'})
+                            end
+
+                            # feature catalogue - field of application []
+                            aUses = hDictionary[:recommendedUses]
+                            aUses.each do |use|
+                                @xml.tag!('gmx:fieldOfApplication') do
+                                    @xml.tag!('gco:CharacterString', use)
+                                end
+                            end
+                            if aUses.empty? && @hResponseObj[:writerShowTags]
+                                @xml.tag!('gmx:fieldOfApplication')
+                            end
+
+                            # feature catalogue - version number (required)
+                            unless version.nil?
+                                @xml.tag!('gmx:versionNumber') do
+                                    @xml.tag!('gco:CharacterString', version)
+                                end
+                            end
+                            if version.nil?
+                                @xml.tag!('gmx:versionNumber', {'gco:nilReason' => 'missing'})
+                            end
+
+                            # feature catalogue - version date (required)
+                            sDate = nil
+                            unless hDate.empty?
+                                dateTime = hDate[:date]
+                                dateRes = hDate[:dateResolution]
+                                unless dateTime.nil?
+                                    sDate = AdiwgDateTimeFun.stringDateFromDateTime(dateTime, dateRes)
+                                end
+                            end
+                            unless sDate.nil?
+                                @xml.tag!('gmx:versionDate') do
+                                    @xml.tag!('gco:Date', sDate)
+                                end
+                            end
+                            if sDate.nil?
+                                @xml.tag!('gmx:versionDate', {'gco:nilReason' => 'missing'})
+                            end
+
+                            # feature catalogue - locale []
+                            aLocales = hDictionary[:locales]
+                            aLocales.each do |hLocale|
+                                unless hLocale.empty?
+                                    @xml.tag!('gmx:locale') do
+                                        localeClass.writeXML(hLocale)
+                                    end
+                                end
+                            end
+                            if aLocales.empty? && @hResponseObj[:writerShowTags]
+                                @xml.tag!('gmx:locale')
+                            end
+
+                            # feature catalogue - producer (required) {CI_ResponsibleParty}
+                            hParty = hDictionary[:responsibleParty]
+                            unless hParty.empty?
+                                role = hParty[:roleName]
+                                aParties = hParty[:parties]
+                                unless aParties.empty?
+                                    party = aParties[0]
+                                    @xml.tag!('gfc:producer') do
+                                        rPartyClass.writeXML(role, party)
+                                    end
+                                end
+                            end
+                            if hParty.empty? && @hResponseObj[:writerShowTags]
+                                @xml.tag!('gfc:producer')
+                            end
+
+                            # feature catalogue - functional language
+                            s = hDictionary[:dictionaryFormat]
+                            unless s.nil?
+                                @xml.tag!('gfc:functionalLanguage') do
+                                    @xml.tag!('gco:CharacterString', s)
+                                end
+                            end
+                            if s.nil? && @hResponseObj[:writerShowTags]
+                                @xml.tag!('gfc:functionalLanguage')
+                            end
+
+                            # feature catalogue - feature type (required)
+                            # use feature type to represent date entities
+                            unless aEntities.empty?
+                                aEntities.each do |hEntity|
+                                    @xml.tag!('gfc:featureType') do
+                                        featureClass.writeXML(hEntity)
+                                    end
+                                end
+                            end
+                            if aEntities.empty?
+                                @xml.tag!('gfc:featureType', {'gco:nilReason' => 'missing'})
+                            end
+
+                            return metadata
+                        end
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end
+

data/lib/adiwg/mdtranslator/writers/iso19110/classes/class_featureAttribute.rb

@@ -1,13 +1,14 @@
 # ISO <<Class>> FC_FeatureAttribute
 # writer output in XML
-# create create attributes for entities
+# create attributes for entities
 
 # History:
-# 	Stan Smith 2014-12-02 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 2017-02-02 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 (responseObj)
+#   Stan Smith 2014-12-12 refactored to handle namespacing readers and writers
+# 	Stan Smith 2014-12-02 original script
 
 require_relative 'class_multiplicity'
 require_relative 'class_listedValue'
@@ -22,70 +23,72 @@ module ADIWG
 
                     def initialize(xml, responseObj)
                         @xml = xml
-                        @responseObj = responseObj
+                        @hResponseObj = responseObj
                     end
 
                     def writeXML(hAttribute)
 
                         # classes used
-                        multiClass = Multiplicity.new(@xml, @responseObj)
-                        listClass = FC_ListedValue.new(@xml, @responseObj)
-                        uomClass = UnitsOfMeasure.new(@xml, @responseObj)
+                        multiClass = Multiplicity.new(@xml, @hResponseObj)
+                        listClass = FC_ListedValue.new(@xml, @hResponseObj)
+                        uomClass = UnitsOfMeasure.new(@xml, @hResponseObj)
 
                         @xml.tag!('gfc:FC_FeatureAttribute') do
 
-                            # feature attribute - member name - required
-                            # used to define attribute common name
+                            # feature attribute - member name (required)
+                            # used for attribute common name
                             s = hAttribute[:attributeName]
-                            if !s.nil?
+                            unless s.nil?
                                 @xml.tag!('gfc:memberName') do
                                     @xml.tag!('gco:LocalName', s)
                                 end
-                            else
+                            end
+                            if s.nil?
                                 @xml.tag!('gfc:memberName', {'gco:nilReason' => 'missing'})
                             end
 
                             # feature attribute - definition
+                            # not required by ISO, but important enough to indicate if missing
                             s = hAttribute[:attributeDefinition]
-                            if !s.nil?
+                            unless s.nil?
                                 @xml.tag!('gfc:definition') do
                                     @xml.tag!('gco:CharacterString', s)
                                 end
-                            elsif @responseObj[:writerShowTags]
-                                @xml.tag!('gfc:definition')
+                            end
+                            if s.nil?
+                                @xml.tag!('gfc:definition', {'gco:nilReason' => 'missing'})
                             end
 
-                            # feature attribute - cardinality - required
-                            b = hAttribute[:allowNull]
-                            if !b.nil?
-                                @xml.tag!('gfc:cardinality') do
-                                    multiClass.writeXML(b)
-                                end
-                            else
-                                @xml.tag!('gfc:cardinality', {'gco:nilReason' => 'missing'})
+                            # feature attribute - cardinality (required)
+                            @xml.tag!('gfc:cardinality') do
+                                multiClass.writeXML(hAttribute)
                             end
 
                             # feature attribute - code
                             s = hAttribute[:attributeCode]
-                            if !s.nil?
+                            unless s.nil?
                                 @xml.tag!('gfc:code') do
                                     @xml.tag!('gco:CharacterString', s)
                                 end
-                            elsif @responseObj[:writerShowTags]
+                            end
+                            if s.nil? && @hResponseObj[:writerShowTags]
                                 @xml.tag!('gfc:code')
                             end
 
                             # feature attribute - value measurement unit (units of measure)
                             s = hAttribute[:unitOfMeasure]
-                            if !s.nil?
+                            unless s.nil?
                                 @xml.tag!('gfc:valueMeasurementUnit') do
                                     uomClass.writeUnits(s)
                                 end
                             end
+                            if s.nil? && @hResponseObj[:writerShowTags]
+                                @xml.tag!('gfc:valueMeasurementUnit')
+                            end
 
                             # feature attribute - value type (datatype)
                             s = hAttribute[:dataType]
-                            if !s.nil?
+                            unless s.nil?
                                 @xml.tag!('gfc:valueType') do
                                     @xml.tag!('gco:TypeName') do
                                         @xml.tag!('gco:aName') do
@@ -93,34 +96,32 @@ module ADIWG
                                         end
                                     end
                                 end
-                            elsif @responseObj[:writerShowTags]
+                            end
+                            if s.nil? && @hResponseObj[:writerShowTags]
                                 @xml.tag!('gfc:valueType')
                             end
 
                             # feature attribute - listed value (domain)
                             domainID = hAttribute[:domainId]
-                            if !domainID.nil?
+                            unless domainID.nil?
                                 # find domain in domain array
                                 hDomain = ADIWG::Mdtranslator::Writers::Iso19110.getDomain(domainID)
                                 unless hDomain.empty?
-
-                                    # only the domain items are represented in iso
                                     aItems = hDomain[:domainItems]
                                     aItems.each do |hItem|
                                         @xml.tag!('gfc:listedValue') do
                                             listClass.writeXML(hItem)
                                         end
                                     end
-
                                 end
-                            elsif @responseObj[:writerShowTags]
+                            end
+                            if domainID.nil? && @hResponseObj[:writerShowTags]
                                 @xml.tag!('gfc:listedValue')
                             end
 
-                        end
-                    end
-
-                end
+                        end # gfc:FC_FeatureAttribute tag
+                    end # writeXML
+                end # gfc:FC_FeatureAttribute class
 
             end
         end

data/lib/adiwg/mdtranslator/writers/iso19110/classes/class_featureConstraint.rb

@@ -5,11 +5,12 @@
 # ... all constraints need to be expressed as character strings
 
 # History:
-# 	Stan Smith 2014-12-02 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 2017-02-03 refactored for mdJson/mdTranslator 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 (responseObj)
+#   Stan Smith 2014-12-12 refactored to handle namespacing readers and writers
+# 	Stan Smith 2014-12-02 original script
 
 module ADIWG
     module Mdtranslator
@@ -20,7 +21,7 @@ module ADIWG
 
                     def initialize(xml, responseObj)
                         @xml = xml
-                        @responseObj = responseObj
+                        @hResponseObj = responseObj
                     end
 
                     def writeXML(conType, hConstraint)
@@ -58,11 +59,9 @@ module ADIWG
                                 @xml.tag!('gco:CharacterString', s)
 
                             end
-                        end
-
-                    end
-
-                end
+                        end # gfc:FC_Constraint tag
+                    end # writeXML
+                end # FC_Constraint class
 
             end
         end

data/lib/adiwg/mdtranslator/writers/iso19110/classes/class_featureType.rb

@@ -2,12 +2,13 @@
 # writer output in XML
 
 # History:
-# 	Stan Smith 2014-12-02 original script
-#   Stan Smith 2014-12-12 refactored to handle namespacing readers and writers
-#   Stan Smith 2015-02-18 added aliases for entities
-#   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 2017-02-03 refactored for mdJson/mdTranslator 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 (responseObj)
+#   Stan Smith 2015-02-18 added aliases for entities
+#   Stan Smith 2014-12-12 refactored to handle namespacing readers and writers
+# 	Stan Smith 2014-12-02 original script
 
 require_relative 'class_featureConstraint'
 require_relative 'class_featureAttribute'
@@ -21,54 +22,61 @@ module ADIWG
 
                     def initialize(xml, responseObj)
                         @xml = xml
-                        @responseObj = responseObj
+                        @hResponseObj = responseObj
                     end
 
                     def writeXML(hEntity)
 
                         # classes used
-                        fConClass = FC_Constraint.new(@xml, @responseObj)
-                        fAttClass = FC_FeatureAttribute.new(@xml, @responseObj)
+                        fConClass = FC_Constraint.new(@xml, @hResponseObj)
+                        fAttClass = FC_FeatureAttribute.new(@xml, @hResponseObj)
+
+                        # create an identity for the entity
+                        entityId = hEntity[:entityId]
+                        if entityId.nil?
+                            @hResponseObj[:writerMissingIdCount] = @hResponseObj[:writerMissingIdCount].succ
+                            entityId = 'entity' + @hResponseObj[:writerMissingIdCount]
+                        end
 
-                        # create and identity for the entity
-                        @responseObj[:writerMissingIdCount] = @responseObj[:writerMissingIdCount].succ
-                        entityID = 'entity' + @responseObj[:writerMissingIdCount]
-                        @xml.tag!('gfc:FC_FeatureType', {'id' => entityID}) do
+                        @xml.tag!('gfc:FC_FeatureType', {'id' => entityId}) do
 
-                            # feature type - type name - required
-                            # use entity common name
+                            # feature type - type name (required)
+                            # used for entity common name
                             s = hEntity[:entityName]
-                            if !s.nil?
+                            unless s.nil?
                                 @xml.tag!('gfc:typeName') do
                                     @xml.tag!('gco:LocalName', s)
                                 end
-                            else
+                            end
+                            if s.nil?
                                 @xml.tag!('gfc:typeName', {'gco:nilReason' => 'missing'})
                             end
 
                             # feature type - definition
                             s = hEntity[:entityDefinition]
-                            if !s.nil?
+                            unless s.nil?
                                 @xml.tag!('gfc:definition') do
                                     @xml.tag!('gco:CharacterString', s)
                                 end
-                            elsif @responseObj[:writerShowTags]
+                            end
+                            if s.nil? && @hResponseObj[:writerShowTags]
                                 @xml.tag!('gfc:definition')
                             end
 
                             # feature type - code
-                            # use entity code name
+                            # used for entity code name
                             s = hEntity[:entityCode]
-                            if !s.nil?
+                            unless s.nil?
                                 @xml.tag!('gfc:code') do
                                     @xml.tag!('gco:CharacterString', s)
                                 end
-                            elsif @responseObj[:writerShowTags]
+                            end
+                            if s.nil? && @hResponseObj[:writerShowTags]
                                 @xml.tag!('gfc:code')
                             end
 
-                            # feature type - isAbstract - required
-                            # defaulted to false, value not available in internal object
+                            # feature type - isAbstract (required)
+                            # always defaulted to false
                             @xml.tag!('gfc:isAbstract') do
                                 @xml.tag!('gco:Boolean', 'false')
                             end
@@ -81,27 +89,28 @@ module ADIWG
                                 end
                             end
 
-                            # feature type - feature catalogue - required
+                            # feature type - feature catalogue (required)
                             # 'role that links this feature type to the feature catalogue that contains it'
-                            # confusing, allow definition of another feature catalogue here
-                            # just set to nilReason = 'inapplicable' (recommended by NOAA)
+                            # confusing, allows definition of another feature catalogue here
+                            # just set to nilReason = 'inapplicable' (as recommended by NOAA)
                             @xml.tag!('gfc:featureCatalogue', {'gco:nilReason' => 'inapplicable'})
 
                             # feature type - constrained by
                             # use to define primary key, foreign keys, and indexes
-                            # pass primary key
+                            # constraint - primary key
                             aPKs = hEntity[:primaryKey]
-                            if !aPKs.empty?
+                            unless aPKs.empty?
                                 @xml.tag!('gfc:constrainedBy') do
                                     fConClass.writeXML('pk', aPKs)
                                 end
-                            elsif @responseObj[:writerShowTags]
+                            end
+                            if aPKs.empty? && @hResponseObj[:writerShowTags]
                                 @xml.tag!('gfc:constrainedBy')
                             end
 
-                            # pass indexes
+                            # constraint - indexes
                             aIndexes = hEntity[:indexes]
-                            if !aIndexes.empty?
+                            unless aIndexes.empty?
                                 aIndexes.each do |hIndex|
                                     @xml.tag!('gfc:constrainedBy') do
                                         fConClass.writeXML('index', hIndex)
@@ -109,9 +118,9 @@ module ADIWG
                                 end
                             end
 
-                            # pass foreign keys
+                            # constraint - foreign keys
                             aFKs = hEntity[:foreignKeys]
-                            if !aFKs.empty?
+                            unless aFKs.empty?
                                 aFKs.each do |hFK|
                                     @xml.tag!('gfc:constrainedBy') do
                                         fConClass.writeXML('fk', hFK)
@@ -122,21 +131,20 @@ module ADIWG
                             # feature type - character of characteristics
                             # used to define entity attributes
                             aAttributes = hEntity[:attributes]
-                            if !aAttributes.empty?
+                            unless aAttributes.empty?
                                 aAttributes.each do |hAttribute|
                                     @xml.tag!('gfc:carrierOfCharacteristics') do
                                         fAttClass.writeXML(hAttribute)
                                     end
                                 end
-                            elsif @responseObj[:writerShowTags]
+                            end
+                            if aAttributes.empty? && @hResponseObj[:writerShowTags]
                                 @xml.tag!('gfc:carrierOfCharacteristics')
                             end
 
-                        end
-
-                    end
-
-                end
+                        end # gfc:FC_FeatureType tag
+                    end # writeXML
+                end # FC_FeatureType class
 
             end
         end