adiwg-mdtranslator 2.10.0 → 2.12.0.pre

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

@@ -3,8 +3,10 @@
 # to define the domain of an attribute
 
 # History:
+#  Stan Smith 2018-04-04 refactored error and warning messaging
 #  Stan Smith 2017-11-02 original script
 
+require_relative '../iso19110_writer'
 require_relative 'class_listedValue'
 require_relative 'class_definitionReference'
 
@@ -18,20 +20,23 @@ module ADIWG
                def initialize(xml, responseObj)
                   @xml = xml
                   @hResponseObj = responseObj
+                  @NameSpace = ADIWG::Mdtranslator::Writers::Iso19110
                end
 
-               def writeXML(hDomain)
+               def writeXML(hDomain, inContext)
 
                   # classes used
                   listClass = FC_ListedValue.new(@xml, @hResponseObj)
                   defRefClass = FC_DefinitionReference.new(@xml, @hResponseObj)
 
+                  outContext = hDomain[:domainCode]
+
                   # if have domainItems treat as enumerated list
                   aItems = hDomain[:domainItems]
                   unless aItems.empty?
                      aItems.each do |hItem|
                         @xml.tag!('gfc:listedValue') do
-                           listClass.writeXML(hItem)
+                           listClass.writeXML(hItem, outContext)
                         end
                      end
                      return
@@ -45,7 +50,7 @@ module ADIWG
 
                            # label
                            if hDomain[:domainName].nil?
-                              @xml.tag!('gfc:label', {'gco:nilReason' => 'missing'})
+                              @NameSpace.issueWarning(100, 'gfc:label')
                            else
                               @xml.tag!('gfc:label') do
                                  @xml.tag!('gco:CharacterString', hDomain[:domainName])
@@ -73,28 +78,30 @@ module ADIWG
                   end
 
                   # if have definition only treat as unrepresentable domain
-                  @xml.tag!('gfc:listedValue') do
-                     @xml.tag!('gfc:FC_ListedValue') do
-
-                        # label
-                        if hDomain[:domainName].nil?
-                           @xml.tag!('gfc:label', {'gco:nilReason' => 'missing'})
-                        else
-                           @xml.tag!('gfc:label') do
-                              @xml.tag!('gco:CharacterString', hDomain[:domainName])
+                  unless hDomain[:domainDescription].nil?
+                     @xml.tag!('gfc:listedValue') do
+                        @xml.tag!('gfc:FC_ListedValue') do
+
+                           # label
+                           if hDomain[:domainName].nil?
+                              @NameSpace.issueWarning(101, 'gfc:label')
+                           else
+                              @xml.tag!('gfc:label') do
+                                 @xml.tag!('gco:CharacterString', hDomain[:domainName])
+                              end
                            end
-                        end
 
-                        # definition
-                        unless hDomain[:domainDescription].nil?
-                           @xml.tag!('gfc:definition') do
-                              @xml.tag!('gco:CharacterString', hDomain[:domainDescription])
+                           # definition
+                           unless hDomain[:domainDescription].nil?
+                              @xml.tag!('gfc:definition') do
+                                 @xml.tag!('gco:CharacterString', hDomain[:domainDescription])
+                              end
+                           end
+                           if hDomain[:domainDescription].empty? && @hResponseObj[:writerShowTags]
+                              @xml.tag!('gfc:definition')
                            end
-                        end
-                        if hDomain[:domainDescription].empty? && @hResponseObj[:writerShowTags]
-                           @xml.tag!('gfc:definition')
-                        end
 
+                        end
                      end
                   end
 

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

@@ -2,6 +2,7 @@
 # writer output in XML
 
 # History:
+#  Stan Smith 2018-04-03 refactored error and warning messaging
 #  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
@@ -10,6 +11,7 @@
 #  Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
 # 	Stan Smith 2013-12-01 original script
 
+require_relative '../iso19110_writer'
 require_relative 'class_locale'
 require_relative 'class_responsibleParty'
 require_relative 'class_featureType'
@@ -24,6 +26,7 @@ module ADIWG
                def initialize(xml, responseObj)
                   @xml = xml
                   @hResponseObj = responseObj
+                  @NameSpace = ADIWG::Mdtranslator::Writers::Iso19110
                end
 
                def writeXML(intObj)
@@ -85,7 +88,7 @@ module ADIWG
                         end
                      end
                      if name.nil?
-                        @xml.tag!('gmx:name', {'gco:nilReason' => 'missing'})
+                        @NameSpace.issueWarning(40, 'gmx:name')
                      end
 
                      # feature catalogue - scope (required) []
@@ -95,8 +98,8 @@ module ADIWG
                            @xml.tag!('gco:CharacterString', scope)
                         end
                      end
-                     if aScopes.empty? && @hResponseObj[:writerShowTags]
-                        @xml.tag!('gmx:scope', {'gco:nilReason' => 'missing'})
+                     if aScopes.empty?
+                        @NameSpace.issueWarning(41, 'gmx:scope')
                      end
 
                      # feature catalogue - field of application []
@@ -117,7 +120,7 @@ module ADIWG
                         end
                      end
                      if version.nil?
-                        @xml.tag!('gmx:versionNumber', {'gco:nilReason' => 'missing'})
+                        @NameSpace.issueWarning(42, 'gmx:versionNumber')
                      end
 
                      # feature catalogue - version date (required)
@@ -135,7 +138,7 @@ module ADIWG
                         end
                      end
                      if sDate.nil?
-                        @xml.tag!('gmx:versionDate', {'gco:nilReason' => 'missing'})
+                        @NameSpace.issueWarning(43, 'gmx:versionDate')
                      end
 
                      # feature catalogue - locale []
@@ -163,8 +166,8 @@ module ADIWG
                            end
                         end
                      end
-                     if hParty.empty? && @hResponseObj[:writerShowTags]
-                        @xml.tag!('gfc:producer')
+                     if hParty.empty?
+                        @NameSpace.issueWarning(44, 'gfc:producer')
                      end
 
                      # feature catalogue - functional language
@@ -178,7 +181,7 @@ module ADIWG
                         @xml.tag!('gfc:functionalLanguage')
                      end
 
-                     # feature catalogue - feature type (required)
+                     # feature catalogue - feature type [] (required)
                      # use feature type to represent date entities
                      unless aEntities.empty?
                         aEntities.each do |hEntity|
@@ -188,7 +191,7 @@ module ADIWG
                         end
                      end
                      if aEntities.empty?
-                        @xml.tag!('gfc:featureType', {'gco:nilReason' => 'missing'})
+                        @NameSpace.issueWarning(45, 'gfc:featureType')
                      end
 
                      return metadata

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

@@ -3,6 +3,7 @@
 # create attributes for entities
 
 # History:
+#  Stan Smith 2018-04-03 refactored error and warning messaging
 #  Stan Smith 2017-11-02 split out domain from attribute
 #  Stan Smith 2017-02-02 refactored for mdTranslator/mdJson 2.0
 #  Stan Smith 2015-07-14 refactored to eliminate namespace globals $WriterNS and $IsoNS
@@ -11,6 +12,7 @@
 #  Stan Smith 2014-12-12 refactored to handle namespacing readers and writers
 # 	Stan Smith 2014-12-02 original script
 
+require_relative '../iso19110_writer'
 require_relative 'class_multiplicity'
 require_relative 'class_unitsOfMeasure'
 require_relative 'class_definitionReference'
@@ -26,6 +28,7 @@ module ADIWG
                def initialize(xml, responseObj)
                   @xml = xml
                   @hResponseObj = responseObj
+                  @NameSpace = ADIWG::Mdtranslator::Writers::Iso19110
                end
 
                def writeXML(hAttribute)
@@ -38,6 +41,8 @@ module ADIWG
 
                   @xml.tag!('gfc:FC_FeatureAttribute') do
 
+                     outContext = hAttribute[:attributeCode]
+
                      # feature attribute - member name (required)
                      # used for attribute common name
                      s = hAttribute[:attributeName]
@@ -47,7 +52,7 @@ module ADIWG
                         end
                      end
                      if s.nil?
-                        @xml.tag!('gfc:memberName', {'gco:nilReason' => 'missing'})
+                        @NameSpace.issueWarning(50, 'gfc:memberName', outContext)
                      end
 
                      # feature attribute - definition
@@ -63,6 +68,7 @@ module ADIWG
                      end
 
                      # feature attribute - cardinality (required)
+                     # no test required, values come from Boolean values
                      @xml.tag!('gfc:cardinality') do
                         multiClass.writeXML(hAttribute)
                      end
@@ -100,7 +106,7 @@ module ADIWG
                         @xml.tag!('gfc:valueMeasurementUnit')
                      end
 
-                     # feature attribute - value type (datatype)
+                     # feature attribute - value type {datatype}
                      s = hAttribute[:dataType]
                      unless s.nil?
                         @xml.tag!('gfc:valueType') do
@@ -121,7 +127,7 @@ module ADIWG
                         # find domain in domain array
                         hDomain = ADIWG::Mdtranslator::Writers::Iso19110.getDomain(domainID)
                         unless hDomain.empty?
-                           domainClass.writeXML(hDomain)
+                           domainClass.writeXML(hDomain, outContext)
                         end
                      end
 

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

@@ -2,6 +2,7 @@
 # writer output in XML
 
 # History:
+#  Stan Smith 2018-04-03 refactored error and warning messaging
 #  Stan Smith 2017-11-02 add entity reference
 #  Stan Smith 2017-02-03 refactored for mdJson/mdTranslator 2.0
 #  Stan Smith 2015-07-14 refactored to eliminate namespace globals $WriterNS and $IsoNS
@@ -11,6 +12,7 @@
 #  Stan Smith 2014-12-12 refactored to handle namespacing readers and writers
 # 	Stan Smith 2014-12-02 original script
 
+require_relative '../iso19110_writer'
 require_relative 'class_featureConstraint'
 require_relative 'class_featureAttribute'
 require_relative 'class_definitionReference'
@@ -25,6 +27,7 @@ module ADIWG
                def initialize(xml, responseObj)
                   @xml = xml
                   @hResponseObj = responseObj
+                  @NameSpace = ADIWG::Mdtranslator::Writers::Iso19110
                end
 
                def writeXML(hEntity)
@@ -45,6 +48,8 @@ module ADIWG
 
                   @xml.tag!('gfc:FC_FeatureType', {'id' => entityId}) do
 
+                     outContext = hEntity[:entityCode]
+
                      # feature type - type name (required)
                      # used for entity common name
                      s = hEntity[:entityName]
@@ -54,7 +59,7 @@ module ADIWG
                         end
                      end
                      if s.nil?
-                        @xml.tag!('gfc:typeName', {'gco:nilReason' => 'missing'})
+                        @NameSpace.issueWarning(60, 'gfc:typeName', outContext)
                      end
 
                      # feature type - definition
@@ -96,8 +101,8 @@ module ADIWG
 
                      # feature type - feature catalogue (required)
                      # 'role that links this feature type to the feature catalogue that contains it'
-                     # confusing, allows definition of another feature catalogue here
-                     # just set to nilReason = 'inapplicable' (as recommended by NOAA)
+                     # confusing?, allows definition of another feature catalogue here
+                     # just set nilReason = 'inapplicable' (as recommended by NOAA)
                      @xml.tag!('gfc:featureCatalogue', {'gco:nilReason' => 'inapplicable'})
 
                      # feature type - constrained by

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

@@ -2,9 +2,8 @@
 # writer output in XML
 # to define the domain of an attribute
 
-require_relative 'class_definitionReference'
-
 # History:
+#  Stan Smith 2018-04-03 refactored error and warning messaging
 #  Stan Smith 2018-01-25 add support for domain itemReference
 #  Stan Smith 2017-02-03 refactored for mdJson/mdTranslator 2.0
 #  Stan Smith 2015-07-14 refactored to eliminate namespace globals $WriterNS and $IsoNS
@@ -13,6 +12,9 @@ require_relative 'class_definitionReference'
 #  Stan Smith 2014-12-12 refactored to handle namespacing readers and writers
 # 	Stan Smith 2014-12-02 original script
 
+require_relative '../iso19110_writer'
+require_relative 'class_definitionReference'
+
 module ADIWG
    module Mdtranslator
       module Writers
@@ -23,9 +25,10 @@ module ADIWG
                def initialize(xml, responseObj)
                   @xml = xml
                   @hResponseObj = responseObj
+                  @NameSpace = ADIWG::Mdtranslator::Writers::Iso19110
                end
 
-               def writeXML(hItem)
+               def writeXML(hItem, inContext)
 
                   # classes used
                   defRefClass = FC_DefinitionReference.new(@xml, @hResponseObj)
@@ -41,7 +44,7 @@ module ADIWG
                         end
                      end
                      if s.nil?
-                        @xml.tag!('gfc:label', {'gco:nilReason' => 'missing'})
+                        @NameSpace.issueWarning(70, 'gfc:label', inContext)
                      end
 
                      # listed value - code

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

@@ -2,68 +2,71 @@
 # 19115-2 writer output in XML
 
 # History:
-#   Stan Smith 2016-11-21 refactored for mdTranslator/mdJson 2.0
+#  Stan Smith 2018-04-03 refactored error and warning messaging
+#  Stan Smith 2016-11-21 refactored for mdTranslator/mdJson 2.0
 # 	Stan Smith 2015-07-28 original script.
 
+require_relative '../iso19110_writer'
 require_relative 'class_codelist'
 
 module ADIWG
-    module Mdtranslator
-        module Writers
-            module Iso19110
+   module Mdtranslator
+      module Writers
+         module Iso19110
 
-                class PT_Locale
+            class PT_Locale
 
-                    def initialize(xml, hResponseObj)
-                        @xml = xml
-                        @hResponseObj = hResponseObj
-                    end
+               def initialize(xml, hResponseObj)
+                  @xml = xml
+                  @hResponseObj = hResponseObj
+                  @NameSpace = ADIWG::Mdtranslator::Writers::Iso19110
+               end
 
-                    def writeXML(hLocale)
+               def writeXML(hLocale)
 
-                        # classes used
-                        codelistClass = MD_Codelist.new(@xml, @hResponseObj)
+                  # classes used
+                  codelistClass = MD_Codelist.new(@xml, @hResponseObj)
 
-                        @xml.tag!('gmd:PT_Locale') do
+                  @xml.tag!('gmd:PT_Locale') do
 
-                            # locale - language (required)
-                            s = hLocale[:languageCode]
-                            unless s.nil?
-                                @xml.tag!('gmd:languageCode') do
-                                    codelistClass.writeXML('gmd', 'iso_language', s)
-                                end
-                            end
-                            if s.nil?
-                                @xml.tag!('gmd:languageCode', {'gco:nilReason' => 'missing'})
-                            end
+                     # locale - language (required)
+                     s = hLocale[:languageCode]
+                     unless s.nil?
+                        @xml.tag!('gmd:languageCode') do
+                           codelistClass.writeXML('gmd', 'iso_language', s)
+                        end
+                     end
+                     if s.nil?
+                        @NameSpace.issueWarning(80, 'gmd:languageCode')
+                     end
 
-                            # locale - country
-                            s = hLocale[:countryCode]
-                            unless s.nil?
-                                @xml.tag!('gmd:country') do
-                                    codelistClass.writeXML('gmd', 'iso_countries', s)
-                                end
-                            end
-                            if s.nil? && @hResponseObj[:writerShowTags]
-                                @xml.tag!('gmd:country')
-                            end
+                     # locale - country
+                     s = hLocale[:countryCode]
+                     unless s.nil?
+                        @xml.tag!('gmd:country') do
+                           codelistClass.writeXML('gmd', 'iso_countries', s)
+                        end
+                     end
+                     if s.nil? && @hResponseObj[:writerShowTags]
+                        @xml.tag!('gmd:country')
+                     end
 
-                            # locale - character encoding (required)
-                            s = hLocale[:characterEncoding]
-                            unless s.nil?
-                                @xml.tag!('gmd:characterEncoding') do
-                                    codelistClass.writeXML('gmd', 'iso_characterSet', s)
-                                end
-                            end
-                            if s.nil?
-                                @xml.tag!('gmd:characterEncoding', {'gco:nilReason' => 'missing'})
-                            end
+                     # locale - character encoding (required)
+                     s = hLocale[:characterEncoding]
+                     unless s.nil?
+                        @xml.tag!('gmd:characterEncoding') do
+                           codelistClass.writeXML('gmd', 'iso_characterSet', s)
+                        end
+                     end
+                     if s.nil?
+                        @NameSpace.issueWarning(81, 'gmd:characterEncoding')
+                     end
 
-                        end # gmd:PT_Locale
-                    end # writeXML
-                end # gmd:PT_Locale class
+                  end # gmd:PT_Locale
+               end # writeXML
+            end # gmd:PT_Locale class
 
-            end
-        end
-    end
+         end
+      end
+   end
 end

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

@@ -2,8 +2,10 @@
 # 19115-2 output for ISO 19115-2 XML
 
 # History:
+#  Stan Smith 2018-04-03 refactored error and warning messaging
 # 	Stan Smith 2017-11-02 original script
 
+require_relative '../iso19110_writer'
 require_relative 'class_citation'
 
 module ADIWG
@@ -16,6 +18,7 @@ module ADIWG
                def initialize(xml, hResponseObj)
                   @xml = xml
                   @hResponseObj = hResponseObj
+                  @NameSpace = ADIWG::Mdtranslator::Writers::Iso19110
                end
 
                def writeXML(hIdentifier)
@@ -39,7 +42,7 @@ module ADIWG
                      # identifier - code (required)
                      s = hIdentifier[:identifier]
                      if s.nil?
-                        @xml.tag!('gmd:code', {'gco:nilReason' => 'missing'})
+                        @NameSpace.issueWarning(90, 'gmd:code')
                      else
                         @xml.tag!('gmd:code') do
                            @xml.tag!('gco:CharacterString', s)

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

@@ -37,8 +37,23 @@ module ADIWG
                def writeXML(hAttribute)
 
                   # xml for iso classes Multiplicity and MultiplicityRange
+                  # in 19110 cardinality is expressed as multiplicity, a min/max range
+                  # Multiplicity is not defined in the documentation, only inferred from the XSD
+                  # max cardinality -----------------
                   # ISO 19110-2 rule
                   # ... "If this is an attribute or operation, the default cardinality is 1"
+                  # there is no hint if this refers to min or max of the range, I chose max
+                  # I assume this means the attribute can occur only once in the entity
+                  # I set the internal object mustBeUnique = true as default
+                  # I assume false would describe something like a repeating tag in an XML file
+                  # min cardinality -----------------
+                  # mdJson allows setting flag to allow nulls as attribute values
+                  # I set this into minimum cardinality
+                  # issue ---------------------------
+                  # min cardinality refers to the attribute values
+                  # max cardinality refers to the attribute instantiation
+                  # perhaps one of these should not be carried in ISO19110
+
                   minCard = 1
                   maxCard = 9
                   if hAttribute[:allowNull]