adiwg-mdtranslator 2.14.2 → 2.15.0

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

@@ -0,0 +1,205 @@
+# ISO <<Class>> CI_Citation
+# 19115-1 writer output in XML
+
+# History:
+# 	Stan Smith 2019-03-13 original script
+
+require_relative '../iso19115_1_writer'
+require_relative 'class_codelist'
+require_relative 'class_responsibility'
+require_relative 'class_date'
+require_relative 'class_identifier'
+require_relative 'class_series'
+require_relative 'class_onlineResource'
+require_relative 'class_browseGraphic'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Iso19115_1
+
+            class CI_Citation
+
+               def initialize(xml, hResponseObj)
+                  @xml = xml
+                  @hResponseObj = hResponseObj
+                  @NameSpace = ADIWG::Mdtranslator::Writers::Iso19115_1
+               end
+
+               def writeXML(hCitation, inContext = nil)
+
+                  # classes used
+                  codelistClass = MD_Codelist.new(@xml, @hResponseObj)
+                  responsibilityClass = CI_Responsibility.new(@xml, @hResponseObj)
+                  dateClass = CI_Date.new(@xml, @hResponseObj)
+                  idClass = MD_Identifier.new(@xml, @hResponseObj)
+                  seriesClass = CI_Series.new(@xml, @hResponseObj)
+                  onlineClass = CI_OnlineResource.new(@xml, @hResponseObj)
+                  graphicClass = MD_BrowseGraphic.new(@xml, @hResponseObj)
+
+                  outContext = 'citation'
+                  outContext = inContext + ' citation' unless inContext.nil?
+
+                  @xml.tag!('cit:CI_Citation') do
+
+                     # citation - title (required)
+                     if hCitation[:title].nil?
+                        @NameSpace.issueWarning(30, 'cit:title', inContext)
+                     else
+                        @xml.tag!('cit:title') do
+                           @xml.tag!('gco:CharacterString', hCitation[:title])
+                        end
+                     end
+
+                     # citation - alternate title []
+                     aTitles = hCitation[:alternateTitles]
+                     aTitles.each do |title|
+                        @xml.tag!('cit:alternateTitle') do
+                           @xml.tag!('gco:CharacterString', title)
+                        end
+                     end
+                     if aTitles.empty? && @hResponseObj[:writerShowTags]
+                        @xml.tag!('cit:alternateTitle')
+                     end
+
+                     # citation - date [] {CI_Date}
+                     aDate = hCitation[:dates]
+                     aDate.each do |hDate|
+                        @xml.tag!('cit:date') do
+                           dateClass.writeXML(hDate, outContext)
+                        end
+                     end
+                     if aDate.empty? && @hResponseObj[:writerShowTags]
+                        @xml.tag!('cit:date')
+                     end
+
+                     # citation - edition
+                     unless hCitation[:edition].nil?
+                        @xml.tag!('cit:edition') do
+                           @xml.tag!('gco:CharacterString', hCitation[:edition])
+                        end
+                     end
+                     if hCitation[:edition].nil? && @hResponseObj[:writerShowTags]
+                        @xml.tag!('cit:edition')
+                     end
+
+                     # citation - edition date {DateTime} - not implemented
+                     # would need to add dateTypeCode = 'edition'
+
+                     # citation - resource identifier [] {MD_Identifier}
+                     # process ISBN and ISSN as MD_identifier(s)
+                     # ... then also write separately in ISBN or ISSN tag
+                     isbn = ''
+                     issn = ''
+                     aIds = hCitation[:identifiers]
+                     aIds.each do |hIdentifier|
+                        unless hIdentifier[:namespace].nil?
+                           if hIdentifier[:namespace].downcase == 'isbn'
+                              isbn = hIdentifier[:identifier]
+                           elsif hIdentifier[:namespace].downcase == 'issn'
+                              issn = hIdentifier[:identifier]
+                           end
+                        end
+                        @xml.tag!('cit:identifier') do
+                           idClass.writeXML(hIdentifier, outContext)
+                        end
+                     end
+                     if aIds.empty? && @hResponseObj[:writerShowTags]
+                        @xml.tag!('cit:identifier')
+                     end
+
+                     # citation - cited responsible party [] {CI_Responsibility}
+                     aResponsibility = hCitation[:responsibleParties]
+                     aResponsibility.each do |hResponsibility|
+                        @xml.tag!('cit:citedResponsibleParty') do
+                           responsibilityClass.writeXML(hResponsibility, outContext)
+                        end
+                     end
+                     if aResponsibility.empty? && @hResponseObj[:writerShowTags]
+                        @xml.tag!('cit:citedResponsibleParty')
+                     end
+
+                     # citation - presentation forms [] {CI_PresentationFormCode}
+                     aPresForms = hCitation[:presentationForms]
+                     aPresForms.each do |presForm|
+                        @xml.tag!('cit:presentationForm') do
+                           codelistClass.writeXML('cit', 'iso_presentationForm', presForm)
+                        end
+                     end
+                     if aPresForms.empty? && @hResponseObj[:writerShowTags]
+                        @xml.tag!('cit:presentationForm')
+                     end
+
+                     # citation - series {CI_Series}
+                     hSeries = hCitation[:series]
+                     unless hSeries.empty?
+                        @xml.tag!('cit:series') do
+                           seriesClass.writeXML(hSeries)
+                        end
+                     end
+                     if hSeries.empty? && @hResponseObj[:writerShowTags]
+                        @xml.tag!('cit:series')
+                     end
+
+                     # citation - other citation details []
+                     aOther = hCitation[:otherDetails]
+                     unless aOther.empty?
+                        other = aOther[0]
+                        @xml.tag!('cit:otherCitationDetails') do
+                           @xml.tag!('gco:CharacterString', other)
+                        end
+                     end
+                     if aOther.empty? && @hResponseObj[:writerShowTags]
+                        @xml.tag!('cit:otherCitationDetails')
+                     end
+
+                     # citation - ISBN
+                     unless isbn == ''
+                        @xml.tag!('cit:ISBN') do
+                           @xml.tag!('gco:CharacterString', isbn)
+                        end
+                     end
+                     if isbn == '' && @hResponseObj[:writerShowTags]
+                        @xml.tag!('cit:ISBN')
+                     end
+
+                     # citation - ISSN
+                     unless issn == ''
+                        @xml.tag!('cit:ISSN') do
+                           @xml.tag!('gco:CharacterString', issn)
+                        end
+                     end
+                     if issn == '' && @hResponseObj[:writerShowTags]
+                        @xml.tag!('cit:ISSN')
+                     end
+
+                     # citation - online resources [] {CI_OnlineResource}
+                     aOnline = hCitation[:onlineResources]
+                     aOnline.each do |hOnline|
+                        @xml.tag!('cit:onlineResource') do
+                           onlineClass.writeXML(hOnline, outContext)
+                        end
+                     end
+                     if aOnline.empty? && @hResponseObj[:writerShowTags]
+                        @xml.tag!('cit:onlineResource')
+                     end
+
+                     # citation - graphic [] {MD_BrowseGraphic}
+                     aGraphic = hCitation[:browseGraphics]
+                     aGraphic.each do |hGraphic|
+                        @xml.tag!('cit:graphic') do
+                           graphicClass.writeXML(hGraphic, outContext)
+                        end
+                     end
+                     if aGraphic.empty? && @hResponseObj[:writerShowTags]
+                        @xml.tag!('cit:graphic')
+                     end
+
+                  end # CI_Citation tag
+               end # writeXML
+            end # CI_Citation class
+
+         end
+      end
+   end
+end

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

@@ -0,0 +1,50 @@
+# ISO <<CodeLists>>
+# 19115-1 writer output in XML
+
+# from http://mdtranslator.adiwg.org/api/codelists?format=xml
+# History:
+# 	Stan Smith 2019-03-14 original script
+
+require 'adiwg-mdcodes'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Iso19115_1
+
+            class MD_Codelist
+
+               def initialize(xml, hResponseObj)
+                  @xml = xml
+                  @hResponseObj = hResponseObj
+               end
+
+               def writeXML(codeSpace, codeList, codeName)
+
+                  # get requested codelist from the adiwg-mdcodes gem
+                  mdCodelist = ADIWG::Mdcodes.getCodelistDetail(codeList, 'hash')
+
+                  sourceName = mdCodelist['sourceName']
+                  codelist = mdCodelist['codelist']
+                  codeId = 'userCode'
+
+                  # search the codelist for a matching codeName
+                  codelist.each do |code|
+                     if code['codeName'] == codeName
+                        codeId = code['code']
+                        break
+                     end
+                  end
+
+                  # generate the iso code block
+                  @xml.tag!(codeSpace + ':' + "#{sourceName}", {:codeList => 'http://mdtranslator.adiwg.org/api/codelists?format=xml#' + "#{sourceName}",
+                                                                :codeListValue => "#{codeName}",
+                                                                :codeSpace => "#{codeId}"})
+               end
+
+            end
+
+         end
+      end
+   end
+end

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

@@ -0,0 +1,51 @@
+# ISO <<Class>> MD_Constraint
+# 19115-1 writer output in XML
+
+# History:
+# 	Stan Smith 2019-03-15 original script
+
+require_relative '../iso19115_1_writer'
+require_relative 'class_useConstraints'
+require_relative 'class_legalConstraints'
+require_relative 'class_securityConstraints'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Iso19115_1
+
+            class Constraint
+
+               def initialize(xml, hResponseObj)
+                  @xml = xml
+                  @hResponseObj = hResponseObj
+                  @NameSpace = ADIWG::Mdtranslator::Writers::Iso19115_1
+               end
+
+               def writeXML(hConstraint, inContext = nil)
+
+                  outContext = 'constraint'
+                  outContext = inContext + ' constraint' unless inContext.nil?
+
+                  # classes used
+                  useConClass = MD_Constraints.new(@xml, @hResponseObj)
+                  legalConClass = MD_LegalConstraints.new(@xml, @hResponseObj)
+                  securityConClass = MD_SecurityConstraints.new(@xml, @hResponseObj)
+
+                  if hConstraint[:type] == 'use'
+                     useConClass.writeXML(hConstraint, outContext)
+                  elsif hConstraint[:type] == 'legal'
+                     legalConClass.writeXML(hConstraint, outContext)
+                  elsif hConstraint[:type] == 'security'
+                     securityConClass.writeXML(hConstraint, outContext)
+                  else
+                     @NameSpace.issueWarning(293, nil, outContext + " type = #{hConstraint[:type]}")
+                  end
+
+               end # writeXML
+            end # MD_Constraint class
+
+         end
+      end
+   end
+end

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

@@ -0,0 +1,104 @@
+# ISO <<Class>> MD_Constraints (Use Constraint)
+# 19115-1 writer output in XML
+
+# History:
+# 	Stan Smith 2019-04-15 original script
+
+require_relative 'class_scope'
+require_relative 'class_browseGraphic'
+require_relative 'class_citation'
+require_relative 'class_releasability'
+require_relative 'class_responsibility'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Iso19115_1
+
+            class ConstraintCommon
+
+               def initialize(xml, hResponseObj)
+                  @xml = xml
+                  @hResponseObj = hResponseObj
+               end
+
+               def writeXML(hConstraint, inContext = nil)
+
+                  # classes used
+                  scopeClass = MD_Scope.new(@xml, @hResponseObj)
+                  graphClass = MD_BrowseGraphic.new(@xml, @hResponseObj)
+                  citationClass = CI_Citation.new(@xml, @hResponseObj)
+                  releaseClass = MD_Releasability.new(@xml, @hResponseObj)
+                  responsibleClass = CI_Responsibility.new(@xml, @hResponseObj)
+
+                  # use constraints - use limitation []
+                  aCons = hConstraint[:useLimitation]
+                  aCons.each do |useCon|
+                     @xml.tag!('mco:useLimitation') do
+                        @xml.tag!('gco:CharacterString', useCon)
+                     end
+                  end
+                  if aCons.empty? && @hResponseObj[:writerShowTags]
+                     @xml.tag!('mco:useLimitation')
+                  end
+
+                  # use constraints - constraint application scope {MD_Scope}
+                  unless hConstraint[:scope].empty?
+                     @xml.tag!('mco:constraintApplicationScope') do
+                        scopeClass.writeXML(hConstraint[:scope], inContext)
+                     end
+                  end
+                  if hConstraint[:scope].empty? && @hResponseObj[:writerShowTags]
+                     @xml.tag!('mco:constraintApplicationScope')
+                  end
+
+                  # use constraints - graphic [] {MD_BrowseGraphic}
+                  aGraphics = hConstraint[:graphic]
+                  aGraphics.each do |hGraphic|
+                     @xml.tag!('mco:graphic') do
+                        graphClass.writeXML(hGraphic, inContext)
+                     end
+                  end
+                  if aGraphics.empty? && @hResponseObj[:writerShowTags]
+                     @xml.tag!('mco:graphic')
+                  end
+
+                  # use constraints - reference [] {CI_Citation}
+                  aReferences = hConstraint[:reference]
+                  aReferences.each do |hCitation|
+                     @xml.tag!('mco:reference') do
+                        citationClass.writeXML(hCitation, inContext)
+                     end
+                  end
+                  if aReferences.empty? && @hResponseObj[:writerShowTags]
+                     @xml.tag!('mco:reference')
+                  end
+
+                  # use constraints - releasability {MD_Releasability}
+                  unless hConstraint[:releasability].empty?
+                     @xml.tag!('mco:releasability') do
+                        releaseClass.writeXML(hConstraint[:releasability], inContext)
+                     end
+                  end
+                  if hConstraint[:releasability].empty? && @hResponseObj[:writerShowTags]
+                     @xml.tag!('mco:releasability')
+                  end
+
+                  # use constraints - responsible party [] {CI_Responsibility}
+                  aParties = hConstraint[:responsibleParty]
+                  aParties.each do |hRParty|
+                     @xml.tag!('mco:responsibleParty') do
+                        responsibleClass.writeXML(hRParty, inContext)
+                     end
+                  end
+                  if aParties.empty? && @hResponseObj[:writerShowTags]
+                     @xml.tag!('mco:responsibleParty')
+                  end
+
+               end # writeXML
+            end # MD_Constraints class
+
+         end
+      end
+   end
+end

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

@@ -0,0 +1,119 @@
+# ISO <<Class>> CI_Contact
+# 19115-1 writer output in XML
+
+# History:
+# 	Stan Smith 2019-03-14 original script
+
+require_relative 'class_phone'
+require_relative 'class_address'
+require_relative 'class_email'
+require_relative 'class_onlineResource'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Iso19115_1
+
+            class CI_Contact
+
+               def initialize(xml, hResponseObj)
+                  @xml = xml
+                  @hResponseObj = hResponseObj
+               end
+
+               def writeXML(hContact)
+
+                  # classes used
+                  phoneClass = CI_Telephone.new(@xml, @hResponseObj)
+                  addressClass = CI_Address.new(@xml, @hResponseObj)
+                  emailClass = Email.new(@xml, @hResponseObj)
+                  resourceClass = CI_OnlineResource.new(@xml, @hResponseObj)
+
+                  # outContext
+                  outContext = 'contact information'
+                  outContext +=  ' ' + hContact[:name] unless hContact[:name].nil?
+                  outContext += ' (' + hContact[:contactId] + ')' unless hContact[:contactId].nil?
+
+                  @xml.tag!('cit:CI_Contact') do
+
+                     # contact - phones [] {CI_Telephone}
+                     # pass phone array to phoneClass
+                     # ... need to output separate phone tags for each service
+                     unless hContact[:phones].empty?
+                        phoneClass.writeXML(hContact[:phones], outContext)
+                     end
+                     if hContact[:phones].empty? && @hResponseObj[:writerShowTags]
+                        @xml.tag!('cit:phone')
+                     end
+
+                     # contact - address [] {CI_Address}
+                     aAddress = hContact[:addresses]
+                     aAddress.each do |hAddress|
+                        @xml.tag!('cit:address') do
+                           addressClass.writeXML(hAddress)
+                        end
+                     end
+                     if aAddress.empty? && @hResponseObj[:writerShowTags]
+                        @xml.tag!('cit:address')
+                     end
+
+                     # contact - email address [] {CI_Address}
+                     # in 19115-1 email addresses are associated with mailing addresses
+                     # in mdJson email addresses are associated with the contact
+                     # so email addresses are written into a separate address block for the contact
+                     unless hContact[:eMailList].empty?
+                        @xml.tag!('cit:address') do
+                           emailClass.writeXML(hContact[:eMailList])
+                        end
+                     end
+
+                     # contact - online resource [] {CI_OnlineResource}
+                     aOlResources = hContact[:onlineResources]
+                     aOlResources.each do |hOnline|
+                        @xml.tag!('cit:onlineResource') do
+                           resourceClass.writeXML(hOnline, outContext)
+                        end
+                     end
+                     if aOlResources.empty? && @hResponseObj[:writerShowTags]
+                        @xml.tag!('cit:onlineResource')
+                     end
+
+                     # contact - hours of service []
+                     aHours = hContact[:hoursOfService]
+                     aHours.each do |hours|
+                        @xml.tag!('cit:hoursOfService') do
+                           @xml.tag!('gco:CharacterString', hours)
+                        end
+                     end
+                     if aHours.empty? && @hResponseObj[:writerShowTags]
+                        @xml.tag!('cit:hoursOfService')
+                     end
+
+                     # contact - contact instructions
+                     unless hContact[:contactInstructions].nil?
+                        @xml.tag!('cit:contactInstructions') do
+                           @xml.tag!('gco:CharacterString', hContact[:contactInstructions])
+                        end
+                     end
+                     if hContact[:contactInstructions].nil? && @hResponseObj[:writerShowTags]
+                        @xml.tag!('cit:contactInstructions')
+                     end
+
+                     # contact - contact type
+                     unless hContact[:contactType].nil?
+                        @xml.tag!('cit:contactType') do
+                           @xml.tag!('gco:CharacterString', hContact[:contactType])
+                        end
+                     end
+                     if hContact[:contactType].nil? && @hResponseObj[:writerShowTags]
+                        @xml.tag!('cit:contactType')
+                     end
+
+                  end # CI_Contact tag
+               end # write XML
+            end # CI_Contact class
+
+         end
+      end
+   end
+end