adiwg-mdtranslator 2.14.2 → 2.15.0

data/lib/adiwg/mdtranslator/writers/iso19115_1/classes/class_usage.rb

@@ -0,0 +1,134 @@
+# ISO <<Class>> MD_Usage
+# 19115-1 writer output in XML
+
+# History:
+# 	Stan Smith 2019-03-25 original script.
+
+require_relative '../iso19115_1_writer'
+require_relative 'class_timeInstant'
+require_relative 'class_timePeriod'
+require_relative 'class_responsibility'
+require_relative 'class_citation'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Iso19115_1
+
+            class MD_Usage
+
+               def initialize(xml, hResponseObj)
+                  @xml = xml
+                  @hResponseObj = hResponseObj
+                  @NameSpace = ADIWG::Mdtranslator::Writers::Iso19115_1
+               end
+
+               def writeXML(hUsage)
+
+                  # classes used in MD_Usage
+                  instantClass = TimeInstant.new(@xml, @hResponseObj)
+                  periodClass = TimePeriod.new(@xml, @hResponseObj)
+                  responsibilityClass = CI_Responsibility.new(@xml, @hResponseObj)
+                  citationClass = CI_Citation.new(@xml, @hResponseObj)
+
+                  outContext = 'resource usage'
+
+                  @xml.tag!('mri:MD_Usage') do
+
+                     # usage - specific usage (required)
+                     unless hUsage[:specificUsage].nil?
+                        @xml.tag!('mri:specificUsage') do
+                           @xml.tag!('gco:CharacterString', hUsage[:specificUsage])
+                        end
+                     end
+                     if hUsage[:specificUsage].nil?
+                        @NameSpace.issueWarning(320, 'mri:specificUsage')
+                     end
+
+                     # usage - dateTime [0] {TimeInstant | TimePeriod}
+                     aExtents = hUsage[:temporalExtents]
+                     aExtents.each do |hExtent|
+                        unless hExtent.empty?
+                           haveTime = false
+                           unless hExtent[:timeInstant].empty?
+                              @xml.tag!('mri:usageDateTime') do
+                                 instantClass.writeXML(hExtent[:timeInstant])
+                              end
+                              haveTime = true
+                           end
+                           unless hExtent[:timePeriod].empty?
+                              @xml.tag!('mri:usageDateTime') do
+                                 periodClass.writeXML(hExtent[:timePeriod])
+                              end
+                              haveTime = true
+                           end
+                           if !haveTime
+                              @NameSpace.issueWarning(410, 'mri:usageDateTime', outContext)
+                           end
+                        end
+                     end
+                     if aExtents.empty? && @hResponseObj[:writerShowTags]
+                        @xml.tag!('mri:usageDateTime')
+                     end
+
+                     # usage - user determined limitations
+                     unless hUsage[:userLimitation].nil?
+                        @xml.tag!('mri:userDeterminedLimitations') do
+                           @xml.tag!('gco:CharacterString', hUsage[:userLimitation])
+                        end
+                     end
+                     if hUsage[:userLimitation].nil? && @hResponseObj[:writerShowTags]
+                        @xml.tag!('mri:userDeterminedLimitations')
+                     end
+
+                     # usage - user contact info [] {CI_Responsibility}
+                     aResponsibility = hUsage[:userContacts]
+                     aResponsibility.each do |hResponsibility|
+                        @xml.tag!('mri:userContactInfo') do
+                           responsibilityClass.writeXML(hResponsibility, outContext)
+                        end
+                     end
+                     if aResponsibility.empty? && @hResponseObj[:writerShowTags]
+                        @xml.tag!('mri:userContactInfo')
+                     end
+
+                     # usage - response []
+                     aResponses = hUsage[:limitationResponses]
+                     aResponses.each do |hResponse|
+                        @xml.tag!('mri:response') do
+                           @xml.tag!('gco:CharacterString', hResponse)
+                        end
+                     end
+                     if aResponses.empty? && @hResponseObj[:writerShowTags]
+                        @xml.tag!('mri:response')
+                     end
+
+                     # usage - additional documentation [] {CI_Citation}
+                     aDocuments = hUsage[:additionalDocumentation]
+                     aDocuments.each do |hDocument|
+                        @xml.tag!('mri:additionalDocumentation') do
+                           citationClass.writeXML(hDocument, outContext)
+                        end
+                     end
+                     if aDocuments.empty? && @hResponseObj[:writerShowTags]
+                        @xml.tag!('mri:additionalDocumentation')
+                     end
+
+                     # usage - identification issues {CI_Citation}
+                     unless hUsage[:identifiedIssue].empty?
+                        @xml.tag!('mri:identifiedIssues') do
+                           citationClass.writeXML(hUsage[:identifiedIssue], outContext)
+                        end
+                     end
+                     if hUsage[:identifiedIssue].empty? && @hResponseObj[:writerShowTags]
+                        @xml.tag!('mri:identifiedIssues')
+                     end
+
+                  end # mri:MD_Usage tag
+               end # writeXML
+            end # MD_Usage class
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/writers/iso19115_1/classes/class_useConstraints.rb

@@ -0,0 +1,41 @@
+# ISO <<Class>> MD_Constraints (Use Constraint)
+# 19115-1 writer output in XML
+
+# History:
+# 	Stan Smith 2019-03-18 original script
+
+require_relative 'class_constraintCommon'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Iso19115_1
+
+            class MD_Constraints
+
+               def initialize(xml, hResponseObj)
+                  @xml = xml
+                  @hResponseObj = hResponseObj
+               end
+
+               def writeXML(hConstraint, inContext = nil)
+
+                  # classes used
+                  commonClass = ConstraintCommon.new(@xml, @hResponseObj)
+
+                  outContext = 'use constraint'
+                  outContext = inContext + ' use constraint' unless inContext.nil?
+
+                  @xml.tag!('mco:MD_Constraints') do
+                     unless hConstraint.empty?
+                        commonClass.writeXML(hConstraint, outContext)
+                     end
+                  end
+
+               end # writeXML
+            end # MD_Constraints class
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/writers/iso19115_1/classes/class_vectorRepresentation.rb

@@ -0,0 +1,61 @@
+# ISO <<Class>> MD_VectorSpatialRepresentation
+# 19115-1 writer output in XML
+
+# History:
+# 	Stan Smith 2019-04-16 original script.
+
+require_relative 'class_codelist'
+require_relative 'class_geometricObjects'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Iso19115_1
+
+            class MD_VectorSpatialRepresentation
+
+               def initialize(xml, hResponseObj)
+                  @xml = xml
+                  @hResponseObj = hResponseObj
+               end
+
+               def writeXML(hVector, inContext = nil)
+
+                  # classes used
+                  codelistClass = MD_Codelist.new(@xml, @hResponseObj)
+                  geoObjClass = MD_GeometricObjects.new(@xml, @hResponseObj)
+
+                  outContext = 'vector representation'
+                  outContext = inContext + ' vector representation' unless inContext.nil?
+
+                  @xml.tag!('msr:MD_VectorSpatialRepresentation') do
+
+                     # vector representation - topology level
+                     unless hVector[:topologyLevel].nil?
+                        @xml.tag!('msr:topologyLevel') do
+                           codelistClass.writeXML('msr', 'iso_topologyLevel', hVector[:topologyLevel])
+                        end
+                     end
+                     if hVector[:topologyLevel].nil? && @hResponseObj[:writerShowTags]
+                        @xml.tag!('msr:topologyLevel')
+                     end
+
+                     # vector representation - geometric objects [{MD_GeometricObjects}]
+                     aGeoObjs = hVector[:vectorObject]
+                     aGeoObjs.each do |hGeoObj|
+                        @xml.tag!('msr:geometricObjects') do
+                           geoObjClass.writeXML(hGeoObj, outContext)
+                        end
+                     end
+                     if aGeoObjs.empty? && @hResponseObj[:writerShowTags]
+                        @xml.tag!('msr:geometricObjects')
+                     end
+
+                  end # msr:MD_VectorSpatialRepresentation tag
+               end # writeXML
+            end # MD_VectorSpatialRepresentation class
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/writers/iso19115_1/classes/class_verticalExtent.rb

@@ -0,0 +1,70 @@
+# ISO <<Class>> EX_VerticalExtent
+# 19115-1 writer output in XML
+
+# History:
+# 	Stan Smith 2019-03-19 original script
+
+require_relative '../iso19115_1_writer'
+require_relative 'class_referenceSystem'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Iso19115_1
+
+            class EX_VerticalExtent
+
+               def initialize(xml, hResponseObj)
+                  @xml = xml
+                  @hResponseObj = hResponseObj
+                  @NameSpace = ADIWG::Mdtranslator::Writers::Iso19115_1
+               end
+
+               def writeXML(hVertEle)
+
+                  # classes used
+                  referenceClass = MD_ReferenceSystem.new(@xml, @hResponseObj)
+
+                  @xml.tag!('gex:EX_VerticalExtent') do
+
+                     # vertical extent - minimum value (required)
+                     unless hVertEle[:minValue].nil?
+                        @xml.tag!('gex:minimumValue') do
+                           @xml.tag!('gco:Real', hVertEle[:minValue])
+                        end
+                     end
+                     if hVertEle[:minValue].nil?
+                        @NameSpace.issueWarning(330, 'gex:minimumValue')
+                     end
+
+                     # vertical extent - maximum value (required)
+                     unless hVertEle[:maxValue].nil?
+                        @xml.tag!('gex:maximumValue') do
+                           @xml.tag!('gco:Real', hVertEle[:maxValue])
+                        end
+                     end
+                     if hVertEle[:maxValue].nil?
+                        @NameSpace.issueWarning(331, 'gex:maximumValue')
+                     end
+
+                     # vertical extent - vertical crs ID {MD_ReferenceSystem}
+                     unless hVertEle[:crsId].empty?
+                        @xml.tag!('gex:verticalCRSId') do
+                           referenceClass.writeXML(hVertEle[:crsId])
+                        end
+                     end
+                     if hVertEle[:crsId].empty? && @hResponseObj[:writerShowTags]
+                        @xml.tag!('gex:verticalCRSId')
+                     end
+
+                     # vertical extent - vertical crs {many possible classes}
+                     # not implemented
+
+                  end # EX_VerticalExtent tag
+               end # writeXML
+            end # EX_VerticalExtent class
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/writers/iso19115_1/iso19115_1_writer.rb

@@ -0,0 +1,105 @@
+# Writer - internal data structure to ISO 19115-1:2014
+
+# History:
+# 	Stan Smith 2019-03-12 original script
+
+# items not implemented in mdJson
+# online resource - applicationProfile (string)
+# online resource - protocol request (string)
+# party - multiple contactInfo{}
+
+require 'builder'
+require 'adiwg/mdtranslator/writers/iso19115_1/version'
+require 'adiwg/mdtranslator/internal/module_dateTimeFun'
+require_relative 'classes/class_mdMetadata'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Iso19115_1
+
+            def self.startWriter(intObj, hResponseObj)
+
+               # make contact available to the instance
+               @contacts = intObj[:contacts]
+               @hResponseObj = hResponseObj
+
+               # load error message array
+               file = File.join(File.dirname(__FILE__), 'iso19115_1_writer_messages_eng') + '.yml'
+               hMessageList = YAML.load_file(file)
+               @aMessagesList = hMessageList['messageList']
+
+               # set the format of the output file based on the writer specified
+               hResponseObj[:writerOutputFormat] = 'xml'
+               hResponseObj[:writerVersion] = ADIWG::Mdtranslator::Writers::Iso19115_1::VERSION
+
+               # create new XML document
+               @xml = Builder::XmlMarkup.new(indent: 3)
+
+               # start writing the ISO 19115-1 XML record
+               metadataWriter = MD_Metadata.new(@xml, hResponseObj)
+               metadata = metadataWriter.writeXML(intObj)
+
+               return metadata
+
+            end
+
+            # find contact in contact array and return the contact hash
+            def self.getContact(contactId)
+
+               @contacts.each do |hContact|
+                  if hContact[:contactId] == contactId
+                     return hContact
+                  end
+               end
+               return {}
+
+            end
+
+            def self.findMessage(messageId)
+               @aMessagesList.each do |hMessage|
+                  if hMessage['id'] == messageId
+                     return hMessage['message']
+                  end
+               end
+               return nil
+            end
+
+            def self.issueError(messageId, context = nil)
+               message = findMessage(messageId)
+               unless message.nil?
+                  message += ': CONTEXT is ' + context unless context.nil?
+                  @hResponseObj[:writerMessages] << 'ERROR: ISO-19115-1 writer: ' + message
+                  @hResponseObj[:writerPass] = false
+               end
+            end
+
+            def self.issueWarning(messageId, tag = nil, context = nil)
+               message = findMessage(messageId)
+               unless message.nil?
+                  message += ': CONTEXT is ' + context unless context.nil?
+                  if @hResponseObj[:writerForceValid]
+                     if tag.nil?
+                        issueError(messageId, context)
+                     else
+                        @xml.tag!(tag, {'gco:nilReason' => 'missing'})
+                        @hResponseObj[:writerMessages] << 'WARNING: ISO-19115-1 writer: ' + message
+                     end
+                  else
+                     @hResponseObj[:writerMessages] << 'WARNING: ISO-19115-1 writer: ' + message
+                  end
+               end
+            end
+
+            def self.issueNotice(messageId, context = nil)
+               message = findMessage(messageId)
+               unless message.nil?
+                  message += ': CONTEXT is ' + context unless context.nil?
+                  @hResponseObj[:writerMessages] << 'NOTICE: ISO-19115-1 writer: ' + message
+               end
+            end
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/writers/iso19115_1/iso19115_1_writer_messages_eng.yml

@@ -0,0 +1,132 @@
+# Writer - messages for ISO 19115-1:2014
+
+# History:
+#  Stan Smith 20189-03-12 original script
+
+messageList:
+   - {id: 1, message: "associated resource association type is missing"}
+
+   - {id: 10, message: "bounding box west longitude is missing"}
+   - {id: 11, message: "bounding box east longitude is missing"}
+   - {id: 12, message: "bounding box south latitude is missing"}
+   - {id: 13, message: "bounding box north latitude is missing"}
+
+   - {id: 20, message: "browse graphic file name is missing"}
+
+   - {id: 30, message: "citation title is missing"}
+
+   - {id: 40, message: "coverage attribute description is missing"}
+   - {id: 41, message: "coverage content type is missing"}
+
+   - {id: 50, message: "resource citation is missing"}
+   - {id: 51, message: "resource abstract is missing"}
+   - {id: 52, message: "resource point of contact is missing"}
+   - {id: 53, message: "multiple taxonomies were provided, ISO 19115-2 allows only one"}
+   - {id: 54, message: "the first taxonomy was written to the metadata record"}
+
+   - {id: 60, message: "data quality scope is missing"}
+
+   - {id: 70, message: "date is missing"}
+   - {id: 71, message: "date type is missing"}
+
+   - {id: 80, message: "dimension type is missing"}
+   - {id: 81, message: "dimension size is missing"}
+
+   - {id: 90, message: "distributor contact is missing"}
+
+   - {id: 100, message: "extension extended element name is missing"}
+   - {id: 101, message: "extension extended element definition is missing"}
+   - {id: 102, message: "extension extended element entity type is missing"}
+   - {id: 103, message: "extension extended element parent entity is missing"}
+   - {id: 104, message: "extension extended element rule is missing"}
+   - {id: 105, message: "extension extended element source is missing"}
+
+   - {id: 110, message: "GeoJSON geometry object type is not recognized"}
+
+   - {id: 120, message: "format specification citation is missing"}
+   - {id: 121, message: "format version is missing"}
+
+   - {id: 130, message: "spatial resolution representative fraction denominator is missing"}
+
+   - {id: 140, message: "GeoJSON geometry is not supported by feature"}
+
+   - {id: 150, message: "vector object type is missing"}
+
+   - {id: 160, message: "GeoJSON geometry is not supported by geometry collection"}
+   - {id: 161, message: "Geometry collection has no geometries"}
+
+   - {id: 170, message: "georectified corner points are missing"}
+   - {id: 171, message: "georectified point in pixel is missing"}
+   - {id: 172, message: "georectified must have either 2 or 4 corner points"}
+
+   - {id: 180, message: "georeferenced parameter is missing"}
+
+   - {id: 190, message: "grid representation number of dimensions is missing"}
+   - {id: 191, message: "grid representation dimensions are missing"}
+   - {id: 192, message: "grid representation cell geometry is missing"}
+
+   - {id: 200, message: "keyword section keywords are missing"}
+
+   - {id: 210, message: "locale language code is missing"}
+   - {id: 211, message: "locale character encoding is missing"}
+
+   - {id: 220, message: "maintenance update frequency is missing"}
+
+   - {id: 230, message: "identifier code is missing"}
+
+   - {id: 240, message: "metadata contacts are missing"}
+   - {id: 241, message: "data identification section (resourceInfo) is missing"}
+
+   - {id: 250, message: "online resource URL is missing"}
+
+   - {id: 260, message: "process step description is missing"}
+
+   - {id: 270, message: "responsible party role is missing"}
+   - {id: 271, message: "responsible party is missing"}
+   - {id: 272, message: "responsible party not found"}
+   - {id: 273, message: "responsible party logo is missing"}
+   - {id: 274, message: "responsible party organization member not found"}
+
+   - {id: 280, message: "scope level (code) is missing"}
+
+   - {id: 290, message: "security constraint classification is missing"}
+   - {id: 291, message: "legal constraint is missing when constraint type is 'legal'"}
+   - {id: 292, message: "security constraint is missing when constraint type is 'security'"}
+   - {id: 293, message: "constraint type must be 'use', 'legal' or 'security'"}
+
+   - {id: 300, message: "taxonomic level is missing"}
+   - {id: 301, message: "taxonomic name is missing"}
+
+   - {id: 310, message: "taxonomic classification system is missing"}
+   - {id: 311, message: "taxonomic identification reference is missing"}
+   - {id: 312, message: "taxonomic observer is missing"}
+   - {id: 313, message: "taxonomic procedures are missing"}
+   - {id: 314, message: "taxonomic classification is missing"}
+   - {id: 315, message: "multiple taxonomic classifications were specified, ISO 19115-2 supports only one"}
+   - {id: 316, message: "the first taxonomic classification was written to the metadata record"}
+
+   - {id: 320, message: "resource specific usage is missing"}
+   - {id: 321, message: "resource specific usage contact is missing"}
+
+   - {id: 330, message: "vertical extent minimum is missing"}
+   - {id: 331, message: "vertical extent maximum is missing"}
+   - {id: 332, message: "vertical extent coordinate reference system is missing"}
+
+   - {id: 340, message: "taxonomic voucher specimen is missing"}
+   - {id: 341, message: "taxonomic voucher repository is missing"}
+
+   - {id: 350, message: "attribute sequence identifier is missing"}
+   - {id: 351, message: "attribute sequence identifier type is missing"}
+
+   - {id: 360, message: "measure type is invalid; must be one of [distance, length, angle, measure, scale]"}
+
+   - {id: 370, message: "phone number is missing"}
+
+   - {id: 380, message: "spatial reference system identifier is missing"}
+   - {id: 381, message: "spatial reference system type is missing"}
+
+   - {id: 390, message: "resource type 'type' is missing"}
+
+   - {id: 400, message: "invalid topic category"}
+
+   - {id: 410, message: "temporal extent must have a TimeInstant or TimePeriod"}