adiwg-mdtranslator 0.8.0

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

@@ -0,0 +1,157 @@
+# ISO <<Class>> CI_Citation
+# writer output in XML
+
+# History:
+# 	Stan Smith 2013-08-26 original script
+# 	Stan Smith 2013-12-30 added ISBN, ISSN
+#   Stan Smith 2014-05-16 modified for JSON schema 0.4.0
+#   Stan Smith 2014-05-16 added MD_Identifier
+#   Stan Smith 2014-05-28 modified for json schema 0.5.0
+#   Stan Smith 2014-07-08 modify require statements to function in RubyGem structure
+#   Stan Smith 2014-08-18 modify identifier section for schema 0.6.0
+#   Stan Smith 2014-08-18 process isbn and issn from identifier section per 0.6.0
+
+require 'code_presentationForm'
+require 'class_responsibleParty'
+require 'class_date'
+require 'class_identifier'
+
+class CI_Citation
+
+	def initialize(xml)
+		@xml = xml
+	end
+
+	def writeXML(hCitation)
+
+		# classes used in MD_Metadata
+		presFormClass = CI_PresentationFormCode.new(@xml)
+		rPartyClass = CI_ResponsibleParty.new(@xml)
+		dateClass = CI_Date.new(@xml)
+		idClass = MD_Identifier.new(@xml)
+
+		@xml.tag!('gmd:CI_Citation') do
+
+			# citation - title - required
+			s = hCitation[:citTitle]
+			if s.nil?
+				@xml.tag!('gmd:title',{'gco:nilReason'=>'missing'})
+			else
+				@xml.tag!('gmd:title') do
+					@xml.tag!('gco:CharacterString',s)
+				end
+			end
+
+			# citation - date - required
+			aDate = hCitation[:citDate]
+			if aDate.empty?
+				@xml.tag!('gmd:date', {'gco:nilReason' => 'missing'})
+			else
+				aDate.each do |hDate|
+					@xml.tag!('gmd:date') do
+						dateClass.writeXML(hDate)
+					end
+				end
+			end
+
+			# citation - edition
+			s = hCitation[:citEdition]
+			if !s.nil?
+				@xml.tag!('gmd:edition') do
+					@xml.tag!('gco:CharacterString',s)
+				end
+			elsif $showAllTags
+				@xml.tag!('gmd:edition')
+			end
+
+			# citation - resource identifiers - MD_Identifier
+			# do not process ISBN and ISSN as MD_identifier(s)
+			# ... these are processed separately in ISO 19115-2
+			aResIDs = hCitation[:citResourceIDs]
+			if !aResIDs.empty?
+				aResIDs.each do |hResID|
+					if !hResID[:identifierType].nil?
+						next if hResID[:identifierType].downcase == 'isbn'
+						next if hResID[:identifierType].downcase == 'issn'
+					end
+					@xml.tag!('gmd:identifier') do
+						idClass.writeXML(hResID)
+					end
+				end
+			elsif $showAllTags
+				@xml.tag!('gmd:identifier')
+			end
+
+			# citation - cited responsible party
+			aResParty = hCitation[:citResponsibleParty]
+			if !aResParty.empty?
+				aResParty.each do |rParty|
+					@xml.tag!('gmd:citedResponsibleParty') do
+						rPartyClass.writeXML(rParty)
+					end
+				end
+			elsif $showAllTags
+				@xml.tag!('gmd:citedResponsibleParty')
+			end
+
+			# citation - presentation forms - CI_PresentationFormCode
+			aPresForms = hCitation[:citResourceForms]
+			if !aPresForms.empty?
+				aPresForms.each do |presForm|
+					@xml.tag!('gmd:presentationForm') do
+						presFormClass.writeXML(presForm)
+					end
+				end
+			elsif $showAllTags
+				@xml.tag!('gmd:presentationForm')
+			end
+
+			# citation - ISBN
+			needTag = true
+			aResIDs = hCitation[:citResourceIDs]
+			if !aResIDs.empty?
+				aResIDs.each do |hResID|
+					if !hResID[:identifierType].nil?
+						if hResID[:identifierType].downcase == 'isbn'
+							s = hResID[:identifier]
+							if !s.nil?
+								@xml.tag!('gmd:ISBN') do
+									@xml.tag!('gco:CharacterString',s)
+									needTag = false
+								end
+							end
+						end
+					end
+				end
+			end
+			if $showAllTags && needTag
+				@xml.tag!('gmd:ISBN')
+			end
+
+			# citation - ISSN
+			needTag = true
+			aResIDs = hCitation[:citResourceIDs]
+			if !aResIDs.empty?
+				aResIDs.each do |hResID|
+					if !hResID[:identifierType].nil?
+						if hResID[:identifierType].downcase == 'issn'
+							s = hResID[:identifier]
+							if !s.nil?
+								@xml.tag!('gmd:ISSN') do
+									@xml.tag!('gco:CharacterString',s)
+									needTag = false
+								end
+							end
+						end
+					end
+				end
+			end
+			if $showAllTags && needTag
+				@xml.tag!('gmd:ISSN')
+			end
+
+		end
+
+	end
+
+end

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

@@ -0,0 +1,85 @@
+# ISO <<Class>> CI_Contact
+# writer output in XML
+
+# History:
+# 	Stan Smith 2013-08-12 original script
+#   Stan Smith 2014-05-14 modified for JSON schema version 0.4.0
+#   Stan Smith 2014-05-16 added method to return contact from array
+#   Stan Smith 2014-07-08 modify require statements to function in RubyGem structure
+
+require 'class_telephone'
+require 'class_address'
+require 'class_onlineResource'
+
+class CI_Contact
+
+	def initialize(xml)
+		@xml = xml
+	end
+
+	def writeXML(hContact)
+
+		# classes used in MD_Metadata
+		pBookClass = CI_Telephone.new(@xml)
+		addClass = CI_Address.new(@xml)
+		resourceClass = CI_OnlineResource.new(@xml)
+
+		@xml.tag!('gmd:CI_Contact') do
+
+			# contact - phone list - all services
+			aPhones = hContact[:phones]
+			if !aPhones.empty?
+				@xml.tag!('gmd:phone') do
+					pBookClass.writeXML(aPhones)
+				end
+			elsif $showAllTags
+				@xml.tag!('gmd:phone')
+			end
+
+			# contact - address
+			hAddress = hContact[:address]
+			if !hAddress.empty?
+				@xml.tag!('gmd:address') do
+					addClass.writeXML(hAddress)
+				end
+			elsif $showAllTags
+				@xml.tag!('gmd:address')
+			end
+
+			# contact - online resource
+			aResource = hContact[:onlineRes]
+			if !aResource.empty?
+				@xml.tag!('gmd:onlineResource') do
+					resourceClass.writeXML(aResource[0])
+				end
+			elsif $showAllTags
+				@xml.tag!('gmd:onlineResource')
+			end
+
+			# contact - contact instructions
+			s = hContact[:contactInstructions]
+			if !s.nil?
+				@xml.tag!('gmd:contactInstructions') do
+					@xml.tag!('gco:CharacterString',hContact[:contactInstructions])
+				end
+			elsif $showAllTags
+				@xml.tag!('gmd:contactInstructions')
+			end
+
+		end
+	end
+
+	def getContact(contactID)
+
+		# find contact in contact array and return the hash
+		$intContactList.each do |hContact|
+			if hContact[:contactID] == contactID
+				return hContact
+			end
+		end
+
+		return {}
+
+	end
+
+end

data/lib/adiwg/mdtranslator/writers/iso19115_2/classes/class_dataIdentification.rb

@@ -0,0 +1,338 @@
+# ISO <<Class>> MD_DataIdentification
+# writer output in XML
+
+# History:
+# 	Stan Smith 2013-08-26 original script
+# 	Stan Smith 2013-09-18 add descriptive keywords
+# 	Stan Smith 2013-11-01 add constraints
+# 	Stan Smith 2013-11-08 add extents
+# 	Stan Smith 2013-11-21 add taxonomy
+# 	Stan Smith 2013-11-22 add metadata extension
+# 	Stan Smith 2013-11-25 add resource usage
+# 	Stan Smith 2013-11-25 add spatial resolution
+#   Stan Smith 2014-05-15 modify to support JSON schema version 0.4.0
+#   Stan Smith 2014-05-21 added aggregate information section
+#   Stan Smith 2014-07-08 modify require statements to function in RubyGem structure
+
+require 'code_progress'
+require 'code_topicCategory'
+require 'code_spatialRepresentationType'
+require 'class_citation'
+require 'class_responsibleParty'
+require 'class_maintenanceInformation'
+require 'class_browseGraphic'
+require 'class_format'
+require 'class_keyword'
+require 'class_usage'
+require 'class_useConstraints'
+require 'class_legalConstraints'
+require 'class_securityConstraints'
+require 'class_aggregateInformation'
+require 'class_taxonSystem'
+require 'class_resolution'
+require 'class_extent'
+
+class MD_DataIdentification
+
+	def initialize(xml)
+		@xml = xml
+	end
+
+	def writeXML(hDataId, aAssocRes)
+
+		# codes used by MD_Metadata
+		progressCode = MD_ProgressCode.new(@xml)
+		spatialCode = MD_SpatialRepresentationTypeCode.new(@xml)
+		topicCode = MD_TopicCategoryCode.new(@xml)
+
+		# classes used by MD_Metadata
+		citationClass = CI_Citation.new(@xml)
+		rPartyClass = CI_ResponsibleParty.new(@xml)
+		mInfoClass = MD_MaintenanceInformation.new(@xml)
+		bGraphicClass = MD_BrowseGraphic.new(@xml)
+		rFormatClass = MD_Format.new(@xml)
+		keywordClass = MD_Keywords.new(@xml)
+		useClass = MD_Usage.new(@xml)
+		uConClass = MD_Constraints.new(@xml)
+		lConClass = MD_LegalConstraints.new(@xml)
+		sConClass = MD_SecurityConstraints.new(@xml)
+		aggInfoClass = MD_AggregateInformation.new(@xml)
+		taxClass = MD_TaxonSys.new(@xml)
+		resolutionClass = MD_Resolution.new(@xml)
+		extentClass = EX_Extent.new(@xml)
+
+		# data identification
+		@xml.tag!('gmd:MD_DataIdentification') do
+
+			# data identification - citation - required
+			hCitation = hDataId[:citation]
+			if hCitation.empty?
+				@xml.tag!('gmd:citation', {'gco:nilReason' => 'missing'})
+			else
+				@xml.tag!('gmd:citation') do
+					citationClass.writeXML(hCitation)
+				end
+			end
+
+			# data identification - abstract - required
+			s = hDataId[:abstract]
+			if s.nil?
+				@xml.tag!('gmd:abstract', {'gco:nilReason' => 'missing'})
+			else
+				@xml.tag!('gmd:abstract') do
+					@xml.tag!('gco:CharacterString', s)
+				end
+			end
+
+			# data identification - purpose
+			s = hDataId[:purpose]
+			if !s.nil?
+				@xml.tag!('gmd:purpose') do
+					@xml.tag!('gco:CharacterString', s)
+				end
+			elsif $showAllTags
+				@xml.tag!('gmd:purpose')
+			end
+
+			# data identification - credit
+			aCredits = hDataId[:credits]
+			if !aCredits.empty?
+				aCredits.each do |credit|
+					@xml.tag!('gmd:credit') do
+						@xml.tag!('gco:CharacterString', credit)
+					end
+				end
+			elsif $showAllTags
+				@xml.tag!('gmd:credit')
+			end
+
+			# data identification - status - required
+			s = hDataId[:status]
+			if s.nil?
+				@xml.tag!('gmd:status', {'gco:nilReason' => 'missing'})
+			else
+				@xml.tag!('gmd:status') do
+					progressCode.writeXML(s)
+				end
+			end
+
+			# data identification - point of contact
+			aPOCs = hDataId[:pointsOfContact]
+			if !aPOCs.empty?
+				aPOCs.each do |hPContact|
+					@xml.tag!('gmd:pointOfContact') do
+						rPartyClass.writeXML(hPContact)
+					end
+				end
+			elsif $showAllTags
+				@xml.tag!('gmd:pointOfContact')
+			end
+
+			# data identification - resource maintenance
+			aMaintInfo = hDataId[:resourceMaint]
+			if !aMaintInfo.empty?
+				aMaintInfo.each do |hResMaintInfo|
+					@xml.tag!('gmd:resourceMaintenance') do
+						mInfoClass.writeXML(hResMaintInfo)
+					end
+				end
+			elsif $showAllTags
+				@xml.tag!('gmd:resourceMaintenance')
+			end
+
+			# data identification - graphic overview
+			aGOverview = hDataId[:graphicOverview]
+			if !aGOverview.empty?
+				aGOverview.each do |graphic|
+					gLink = graphic[:bGURI]
+					attributes = {}
+					attributes['xlink:href'] = gLink if gLink
+					@xml.tag!('gmd:graphicOverview', attributes) do
+						bGraphicClass.writeXML(graphic)
+					end
+				end
+			elsif $showAllTags
+				@xml.tag!('gmd:graphicOverview')
+			end
+
+			# data identification - resource format
+			aResFormats = hDataId[:resourceFormats]
+			if !aResFormats.empty?
+				aResFormats.each do |hResFormat|
+					@xml.tag!('gmd:resourceFormat') do
+						rFormatClass.writeXML(hResFormat)
+					end
+				end
+			elsif $showAllTags
+				@xml.tag!('gmd:resourceFormat')
+			end
+
+			# data identification - descriptive keywords
+			aDesKeywords = hDataId[:descriptiveKeywords]
+			if !aDesKeywords.empty?
+				aDesKeywords.each do |hDKeyword|
+					@xml.tag!('gmd:descriptiveKeywords') do
+						keywordClass.writeXML(hDKeyword)
+					end
+				end
+			elsif $showAllTags
+				@xml.tag!('gmd:descriptiveKeywords')
+			end
+
+			# data identification - resource specific usage
+			aResUses = hDataId[:resourceUses]
+			if !aResUses.empty?
+				aResUses.each do |hResUse|
+					@xml.tag!('gmd:resourceSpecificUsage') do
+						useClass.writeXML(hResUse)
+					end
+				end
+			elsif $showAllTags
+				@xml.tag!('gmd:resourceSpecificUsage')
+			end
+
+			# data identification - resource constraints - use constraints
+			aUseLimits = hDataId[:useConstraints]
+			if !aUseLimits.empty?
+				@xml.tag!('gmd:resourceConstraints') do
+					uConClass.writeXML(aUseLimits)
+				end
+			elsif $showAllTags
+				@xml.tag!('gmd:resourceConstraints') do
+					@xml.tag!('gmd:MD_Constraints')
+				end
+			end
+
+			# data identification - resource constraints - legal constraints
+			aLegalCons = hDataId[:legalConstraints]
+			if !aLegalCons.empty?
+				aLegalCons.each do |hLegalCon|
+					@xml.tag!('gmd:resourceConstraints') do
+						lConClass.writeXML(hLegalCon)
+					end
+				end
+			elsif $showAllTags
+				@xml.tag!('gmd:resourceConstraints') do
+					@xml.tag!('gmd:MD_LegalConstraints')
+				end
+			end
+
+			# data identification - resource constraints - security constraints
+			# empty tag cannot be shown for security constraints - XSD issue
+			aSecurityCons = hDataId[:securityConstraints]
+			unless aSecurityCons.empty?
+				aSecurityCons.each do |hSecCon|
+					@xml.tag!('gmd:resourceConstraints') do
+						sConClass.writeXML(hSecCon)
+					end
+				end
+			end
+
+			# data identification - aggregate information
+			if !aAssocRes.empty?
+				aAssocRes.each do |hAssocRes|
+					@xml.tag!('gmd:aggregationInfo') do
+						aggInfoClass.writeXML(hAssocRes)
+					end
+				end
+			elsif $showAllTags
+				@xml.tag!('gmd:aggregationInfo')
+			end
+
+			# data identification - taxonomy
+			hTaxonomy = hDataId[:taxonomy]
+			if !hTaxonomy.empty?
+				@xml.tag!('gmd:taxonomy') do
+					taxClass.writeXML(hTaxonomy)
+				end
+			elsif $showAllTags
+				@xml.tag!('gmd:taxonomy')
+			end
+
+			# data identification - spatial representation type
+			aSpatialType = hDataId[:spatialRepresentationTypes]
+			if !aSpatialType.empty?
+				aSpatialType.each do |spType|
+					@xml.tag!('gmd:spatialRepresentationType') do
+						spatialCode.writeXML(spType)
+					end
+				end
+			elsif $showAllTags
+				@xml.tag!('gmd:spatialRepresentationType')
+			end
+
+			# data identification - spatial resolution
+			aSpatialRes = hDataId[:spatialResolutions]
+			if !aSpatialRes.empty?
+				aSpatialRes.each do |hSpRes|
+					@xml.tag!('gmd:spatialResolution') do
+						resolutionClass.writeXML(hSpRes)
+					end
+				end
+			elsif $showAllTags
+				@xml.tag!('gmd:spatialResolution')
+			end
+
+			# data identification - language - required - default of english applied
+			aLanguages = hDataId[:resourceLanguages]
+			if !aLanguages.empty?
+				aLanguages.each do |language|
+					@xml.tag!('gmd:language') do
+						@xml.tag!('gco:CharacterString', language)
+					end
+				end
+			else
+				@xml.tag!('gmd:language') do
+					@xml.tag!('gco:CharacterString', 'eng; USA')
+				end
+			end
+
+			# data identification - topic category
+			aTopics = hDataId[:topicCategories]
+			if !aTopics.empty?
+				aTopics.each do |spType|
+					@xml.tag!('gmd:topicCategory') do
+						topicCode.writeXML(spType)
+					end
+				end
+			elsif $showAllTags
+				@xml.tag!('gmd:topicCategory')
+			end
+
+			# data identification - environment description
+			s = hDataId[:environmentDescription]
+			if !s.nil?
+				@xml.tag!('gmd:environmentDescription') do
+					@xml.tag!('gco:CharacterString', s)
+				end
+			elsif $showAllTags
+				@xml.tag!('gmd:environmentDescription')
+			end
+
+			# data identification - extent
+			aExtents = hDataId[:extents]
+			if !aExtents.empty?
+				aExtents.each do |hExtent|
+					@xml.tag!('gmd:extent') do
+						extentClass.writeXML(hExtent)
+					end
+				end
+			elsif $showAllTags
+				@xml.tag!('gmd:extent')
+			end
+
+			# data identification - supplemental info
+			s = hDataId[:supplementalInfo]
+			if !s.nil?
+				@xml.tag!('gmd:supplementalInformation') do
+					@xml.tag!('gco:CharacterString', s)
+				end
+			elsif $showAllTags
+				@xml.tag!('gmd:supplementalInformation')
+			end
+
+		end
+
+	end
+
+end

data/lib/adiwg/mdtranslator/writers/iso19115_2/classes/class_dataQuality.rb

@@ -0,0 +1,55 @@
+# ISO <<Class>> DQ_DataQuality
+# writer output in XML
+
+# History:
+# 	Stan Smith 2013-11-20 original script
+#   Stan Smith 2014-07-09 modify require statements to function in RubyGem structure
+
+require 'code_scope'
+require 'class_lineage'
+
+class DQ_DataQuality
+
+	def initialize(xml)
+		@xml = xml
+	end
+
+	def writeXML(hDataQ)
+
+		# classes used
+		scopeCode = MD_ScopeCode.new(@xml)
+		lineClass = LI_Lineage.new(@xml)
+
+		@xml.tag!('gmd:DQ_DataQuality') do
+
+			# data quality - scope - required
+			s = hDataQ[:dataScope]
+			if s.nil?
+				@xml.tag!('gmd:scope',{'gco:nilReason'=>'missing'})
+			else
+				@xml.tag!('gmd:scope') do
+					@xml.tag!('gmd:DQ_Scope') do
+						@xml.tag!('gmd:level') do
+							scopeCode.writeXML(s)
+						end
+					end
+				end
+			end
+
+			# date quality - report
+
+			# data quality - lineage
+			hLineage = hDataQ[:dataLineage]
+			if !hLineage.empty?
+				@xml.tag!('gmd:lineage') do
+					lineClass.writeXML(hLineage)
+				end
+			elsif $showAllTags
+				@xml.tag!('gmd:lineage')
+			end
+
+		end
+
+	end
+
+end

data/lib/adiwg/mdtranslator/writers/iso19115_2/classes/class_date.rb

@@ -0,0 +1,60 @@
+# ISO <<Class>> CI_Date
+# writer output in XML
+
+# History:
+# 	Stan Smith 2013-08-26 original script
+# 	Stan Smith 2013-11-21 support for date or datetime
+#   Stan Smith 2014-07-08 modify require statements to function in RubyGem structure
+
+require 'module_dateTimeFun'
+require 'code_dateType'
+
+class CI_Date
+
+	def initialize(xml)
+		@xml = xml
+	end
+
+	def writeXML(hDate)
+
+		# classes used
+		dateTypeCode = CI_DateTypeCode.new(@xml)
+
+		citDateTime = hDate[:dateTime]
+		citDateRes = hDate[:dateResolution]
+		citDateType = hDate[:dateType]
+
+		@xml.tag!('gmd:CI_Date') do
+
+			# date - date - required
+			if citDateTime.nil?
+				@xml.tag!('gmd:date',{'gco:nilReason'=>'missing'})
+			else
+				@xml.tag!('gmd:date') do
+
+					if citDateRes.length > 3
+						# if time, requires all time fields
+						dateStr = AdiwgDateTimeFun.stringDateTimeFromDateTime(citDateTime,'YMDhmsZ')
+						@xml.tag!('gco:DateTime',dateStr)
+					else
+						dateStr = AdiwgDateTimeFun.stringDateFromDateTime(citDateTime,citDateRes)
+						@xml.tag!('gco:Date',dateStr)
+					end
+
+				end
+
+			end
+
+			# date - date type - required
+			if citDateType.nil?
+				@xml.tag!('gmd:dateType',{'gco:nilReason'=>'missing'})
+			else
+				@xml.tag!('gmd:dateType') do
+					dateTypeCode.writeXML(citDateType)
+				end
+			end
+		end
+
+	end
+
+end