adiwg-mdtranslator 2.9.2 → 2.10.0

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

@@ -5,65 +5,69 @@
 # ... all constraints need to be expressed as character strings
 
 # History:
-#   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 2018-02-14 enhance constraint formatting
+#  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
-        module Writers
-            module Iso19110
+   module Mdtranslator
+      module Writers
+         module Iso19110
 
-                class FC_Constraint
+            class FC_Constraint
 
-                    def initialize(xml, responseObj)
-                        @xml = xml
-                        @hResponseObj = responseObj
-                    end
+               def initialize(xml, responseObj)
+                  @xml = xml
+                  @hResponseObj = responseObj
+               end
 
-                    def writeXML(conType, hConstraint)
+               def writeXML(conType, hConstraint)
 
-                        @xml.tag!('gfc:FC_Constraint') do
-                            @xml.tag!('gfc:description') do
+                  @xml.tag!('gfc:FC_Constraint') do
+                     @xml.tag!('gfc:description') do
 
-                                # find type of constraint (primary key or index)
-                                case conType
+                        # find type of constraint (primary key or index)
+                        case conType
 
-                                    # primary keys
-                                    when 'pk'
-                                        s = 'primary key: '
-                                        s += hConstraint.to_s
+                           # primary keys
+                           when 'pk'
+                              s = 'PRIMARY KEY ' + hConstraint.to_s
 
-                                    # indexes
-                                    when 'index'
-                                        if hConstraint[:duplicate]
-                                            indexType = 'duplicate'
-                                        else
-                                            indexType = 'unique'
-                                        end
-                                        s = indexType + ' index ' + hConstraint[:indexCode]
-                                        s += ' on ' + hConstraint[:attributeNames].to_s
+                           # indexes
+                           when 'index'
+                              if hConstraint[:duplicate]
+                                 indexType = 'DUPLICATE'
+                              else
+                                 indexType = 'UNIQUE'
+                              end
+                              s = indexType + ' INDEX ' + hConstraint[:indexCode]
+                              s += ' ON ' + hConstraint[:attributeNames].to_s
 
-                                    # foreign keys
-                                    when 'fk'
-                                        s = 'foreign key '
-                                        s += hConstraint[:fkLocalAttributes].to_s
-                                        s += ' references ' + hConstraint[:fkReferencedEntity] + '.'
-                                        s += hConstraint[:fkReferencedAttributes].to_s
+                           # foreign keys
+                           when 'fk'
+                              s = 'FK'
+                              hConstraint[:fkLocalAttributes].each do |attribute|
+                                 s += '_' + attribute
+                              end
+                              s += ' FOREIGN KEY '
+                              s += hConstraint[:fkLocalAttributes].to_s
+                              s += ' REFERENCES ' + hConstraint[:fkReferencedEntity]
+                              s += hConstraint[:fkReferencedAttributes].to_s
 
-                                end
+                        end
 
-                                @xml.tag!('gco:CharacterString', s)
+                        @xml.tag!('gco:CharacterString', s)
 
-                            end
-                        end # gfc:FC_Constraint tag
-                    end # writeXML
-                end # FC_Constraint class
+                     end
+                  end # gfc:FC_Constraint tag
+               end # writeXML
+            end # FC_Constraint class
 
-            end
-        end
-    end
+         end
+      end
+   end
 end

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

@@ -5,62 +5,72 @@
 # ... cardinality is defined between tables, not for attributes.
 # ... documentation by NOAA and modelManager suggest best practice for
 # ... propertyType is to default to 1.
+# ... upper not provided a value in examples but XSD required it to be present
 # ... I assume this is using cardinality like optionality.
 # ... therefore ...
-# ... lower = 0 => Null
-# ... lower = 1 => NotNull
-# ... upper not provided a value, but is required to be present.
+# ... lower = 0 if allowNull = false
+# ... lower = 1 if allowNull = true
+# ... upper = 1 if mustBeUnique = true
+# ... upper = 9 if mustBeUnique = false with isInfinite="true"
 
 # History:
-#   Stan Smith 2017-02-02 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 2018-02-14 add isInfinite="true" to upper multiplicity
+#  Stan Smith 2017-02-02 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
-        module Writers
-            module Iso19110
+   module Mdtranslator
+      module Writers
+         module Iso19110
 
-                class Multiplicity
+            class Multiplicity
 
-                    def initialize(xml, responseObj)
-                        @xml = xml
-                        @hResponseObj = responseObj
-                    end
+               def initialize(xml, responseObj)
+                  @xml = xml
+                  @hResponseObj = responseObj
+               end
 
-                    def writeXML(hAttribute)
+               def writeXML(hAttribute)
 
-                        minCard = 1
-                        if hAttribute[:allowNull]
-                            minCard = 0
-                        end
-                        maxCard = 1
-                        if hAttribute[:allowMany]
-                            maxCard = 99999
-                        end
+                  # xml for iso classes Multiplicity and MultiplicityRange
+                  # ISO 19110-2 rule
+                  # ... "If this is an attribute or operation, the default cardinality is 1"
+                  minCard = 1
+                  maxCard = 9
+                  if hAttribute[:allowNull]
+                     minCard = 0
+                  end
+                  if hAttribute[:mustBeUnique]
+                     maxCard = 1
+                  end
 
-                        # xml for iso classes Multiplicity and MultiplicityRange
-                        @xml.tag!('gco:Multiplicity') do
+                  # xml for iso classes Multiplicity and MultiplicityRange
+                  @xml.tag!('gco:Multiplicity') do
 
-                            @xml.tag!('gco:range') do
-                                @xml.tag!('gco:MultiplicityRange') do
-                                    @xml.tag!('gco:lower') do
-                                        @xml.tag!('gco:Integer', minCard)
-                                    end
-                                    @xml.tag!('gco:upper') do
-                                        @xml.tag!('gco:UnlimitedInteger', maxCard)
-                                    end
-                                end
-                            end
+                     @xml.tag!('gco:range') do
+                        @xml.tag!('gco:MultiplicityRange') do
+                           @xml.tag!('gco:lower') do
+                              @xml.tag!('gco:Integer', minCard)
+                           end
+                           @xml.tag!('gco:upper') do
+                              if maxCard == 1
+                                 @xml.tag!('gco:UnlimitedInteger', 1)
+                              else
+                                 @xml.tag!('gco:UnlimitedInteger', {'isInfinite'=>'true'}, 9)
+                              end
+                           end
+                        end
+                     end
 
-                        end # gco:Multiplicity tag
-                    end # writeXML
-                end # Multiplicity class
+                  end # gco:Multiplicity tag
+               end # writeXML
+            end # Multiplicity class
 
-            end
-        end
-    end
+         end
+      end
+   end
 end

data/lib/adiwg/mdtranslator/writers/iso19110/version.rb

@@ -1,4 +1,6 @@
 # History
+#  Stan Smith 2018-02-14 refactored cardinality
+#  Stan Smith 2018-02-14 refactored constraints
 #  Stan Smith 2017-03-10 refactored for mdJson/mdTranslator 2.0
 #  Josh Bradley
 
@@ -7,7 +9,7 @@ module ADIWG
       module Writers
          module Iso19110
 
-            VERSION = '1.1.0'
+            VERSION = '1.1.1'
 
          end
       end

data/lib/adiwg/mdtranslator/writers/mdJson/sections/mdJson_entityAttribute.rb

@@ -31,7 +31,7 @@ module ADIWG
                      end
                      json.dataType hAttribute[:dataType]
                      json.allowNull hAttribute[:allowNull]
-                     json.allowMany hAttribute[:allowMany]
+                     json.mustBeUnique hAttribute[:mustBeUnique]
                      json.units hAttribute[:unitOfMeasure]
                      json.unitsResolution hAttribute[:measureResolution]
                      json.isCaseSensitive hAttribute[:isCaseSensitive]

data/lib/adiwg/mdtranslator/writers/mdWriters.rb

@@ -1,72 +1,72 @@
 # MdTranslator - controller for evaluating and directing writers
 
 # History:
-#   Stan Smith 2016-11-14 refactored for mdTranslator 2.0.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 2015-03-04 changed method of setting $WriterNS
-#   Stan Smith 2012-12-16 generalized handleWriter to use :writerName
-#   Stan Smith 2014-12-11 original script
+#  Stan Smith 2016-11-14 refactored for mdTranslator 2.0.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 2015-03-04 changed method of setting $WriterNS
+#  Stan Smith 2012-12-16 generalized handleWriter to use :writerName
+#  Stan Smith 2014-12-11 original script
 
 module ADIWG
-    module Mdtranslator
-        module Writers
-
-            def self.handleWriter(intObj, hResponseObj)
-
-                # use ':writerRequested' from hResponseObj to build directory path to writer
-                # writer's high-level folder must be placed in 'lib/adiwg/mdtranslator/writers/'
-                # writer's code must must be in folder named '{writer}'
-                # '{writer}' must contain a module named '{writer}_writer.rb'
-                # '{writer}_writer.rb' must have a method named 'startWriter()'
-                # 'startWriter()' must pass two parameters (intObj, hResponseObj)
-                # all writer modules and classes must remain in their private namespace
-                # writer namespace is 'ADIWG::Mdtranslator::Writers::{writer}'
-
-                # the writer's high-level
-                thisDir = File.dirname(File.expand_path(__FILE__))
-                writerDir = File.join(thisDir, hResponseObj[:writerRequested])
-                if File.directory?(writerDir)
-
-                    # writer folder
-                    writerModule = File.join(writerDir, hResponseObj[:writerRequested] + '_writer')
-                    require writerModule
-
-                    # writer namespace
-                    writerNS = hResponseObj[:writerRequested].dup
-                    writerNS[0] = writerNS[0].upcase
+   module Mdtranslator
+      module Writers
+
+         def self.handleWriter(intObj, hResponseObj)
+
+            # use ':writerRequested' from hResponseObj to build directory path to writer
+            # writer's high-level folder must be placed in 'lib/adiwg/mdtranslator/writers/'
+            # writer's code must must be in folder named '{writer}'
+            # '{writer}' must contain a module named '{writer}_writer.rb'
+            # '{writer}_writer.rb' must have a method named 'startWriter()'
+            # 'startWriter()' must pass two parameters (intObj, hResponseObj)
+            # all writer modules and classes must remain in their private namespace
+            # writer namespace is 'ADIWG::Mdtranslator::Writers::{writer}'
+
+            # the writer's high-level
+            thisDir = File.dirname(File.expand_path(__FILE__))
+            writerDir = File.join(thisDir, hResponseObj[:writerRequested])
+            if File.directory?(writerDir)
+
+               # writer folder
+               writerModule = File.join(writerDir, hResponseObj[:writerRequested] + '_writer')
+               require writerModule
+
+               # writer namespace
+               writerNS = hResponseObj[:writerRequested].dup
+               writerNS[0] = writerNS[0].upcase
+
+               # pass internal object and hResponseObj to the writer
+               hResponseObj[:writerOutput] = ADIWG::Mdtranslator::Writers.const_get(writerNS).startWriter(intObj, hResponseObj)
+
+            else
+               hResponseObj[:writerMessages] << "ERROR: Requested writer '#{hResponseObj[:writerRequested]}' cannot be found."
+               hResponseObj[:writerPass] = false
+            end
 
-                    # pass internal object and hResponseObj to the writer
-                    hResponseObj[:writerOutput] = ADIWG::Mdtranslator::Writers.const_get(writerNS).startWriter(intObj, hResponseObj)
+            return hResponseObj
 
-                else
-                    hResponseObj[:writerMessages] << "Requested writer '#{hResponseObj[:writerRequested]}' cannot be found."
-                    hResponseObj[:writerPass] = false
-                end
+         end
 
-                return hResponseObj
+         # return writer readme text
+         # this is called from the Rails API
+         def self.get_writer_readme(writer)
 
+            thisDir = File.dirname(File.expand_path(__FILE__))
+            path = File.join(thisDir, writer, 'readme.md')
+            if File.exist?(path)
+               file = File.open(path, 'r')
+               readmeText = file.read
+               file.close
+               return readmeText
+            else
+               return 'Readme file not found'
             end
 
-            # return writer readme text
-            # this is called from the Rails API
-            def self.get_writer_readme(writer)
-
-                thisDir = File.dirname(File.expand_path(__FILE__))
-                path = File.join(thisDir, writer, 'readme.md')
-                if File.exist?(path)
-                    file = File.open(path, 'r')
-                    readmeText = file.read
-                    file.close
-                    return readmeText
-                else
-                    return 'Readme file not found'
-                end
-
-            end
+         end
 
-        end
-    end
+      end
+   end
 end