adiwg-mdtranslator 0.8.0

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

@@ -0,0 +1,74 @@
+# ISO <<Class>> LineString
+# writer output in XML
+
+# History:
+# 	Stan Smith 2013-11-13 original script
+#   Stan Smith 2014-05-30 modified for version 0.5.0
+#   Stan Smith 2014-07-08 modify require statements to function in RubyGem structure
+
+require ADIWG::Mdtranslator.reader_module('module_coordinates', $response[:readerVersionUsed])
+
+class LineString
+
+	def initialize(xml)
+		@xml = xml
+	end
+
+	def writeXML(hGeoElement)
+
+		# gml:LineString attributes
+		attributes = {}
+
+		# gml:LineString attributes - gml:id - required
+		lineID = hGeoElement[:elementId]
+		if lineID.nil?
+			$idCount = $idCount.succ
+			lineID = 'line' + $idCount
+		end
+		attributes['gml:id'] = lineID
+
+		# gml:LineString attributes - srsDimension
+		s = hGeoElement[:elementGeometry][:dimension]
+		if !s.nil?
+			attributes[:srsDimension] = s
+		end
+
+		# gml:LineString attributes - srsName
+		s = hGeoElement[:elementSrs][:srsName]
+		if !s.nil?
+			attributes[:srsName] = s
+		end
+
+		@xml.tag!('gml:LineString',attributes) do
+
+			# lineString - description
+			s = hGeoElement[:elementDescription]
+			if !s.nil?
+				@xml.tag!('gml:description',s)
+			elsif $showAllTags
+				@xml.tag!('gml:description')
+			end
+
+			# lineString - name
+			s = hGeoElement[:elementName]
+			if !s.nil?
+				@xml.tag!('gml:name',s)
+			elsif $showAllTags
+				@xml.tag!('gml:name')
+			end
+
+			# lineString - coordinates - required
+			# gml does not support nilReason for coordinates
+			# convert coordinate string from geoJSON to gml
+			s = hGeoElement[:elementGeometry][:geometry]
+			if !s.nil?
+				s = Adiwg_Coordinates.unpack(s)
+				@xml.tag!('gml:coordinates',s)
+			else
+				@xml.tag!('gml:coordinates')
+			end
+		end
+
+	end
+
+end

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

@@ -0,0 +1,63 @@
+# ISO <<Class>> LI_Lineage
+# 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 'class_processStep'
+require 'class_source'
+
+class LI_Lineage
+
+	def initialize(xml)
+		@xml = xml
+	end
+
+	def writeXML(hLineage)
+
+		# classes used
+		sourceClass = LI_Source.new(@xml)
+		pStepClass = LI_ProcessStep.new(@xml)
+
+		@xml.tag!('gmd:LI_Lineage') do
+
+			# lineage - statement
+			s = hLineage[:statement]
+			if !s.nil?
+				@xml.tag!('gmd:statement') do
+					@xml.tag!('gco:CharacterString',s)
+				end
+			elsif $showAllTags
+				@xml.tag!('gmd:statement')
+			end
+
+			# lineage - processing steps
+			aProcSteps = hLineage[:processSteps]
+			if !aProcSteps.empty?
+				aProcSteps.each do |pStep|
+					@xml.tag!('gmd:processStep') do
+						pStepClass.writeXML(pStep)
+					end
+				end
+			elsif $showAllTags
+				@xml.tag!('gmd:processStep')
+			end
+
+			# lineage - data sources
+			aSources = hLineage[:dataSources]
+			if !aSources.empty?
+				aSources.each do |hSource|
+					@xml.tag!('gmd:source') do
+						sourceClass.writeXML(hSource)
+					end
+				end
+			elsif $showAllTags
+				@xml.tag!('gmd:source')
+			end
+
+		end
+
+	end
+
+end

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

@@ -0,0 +1,64 @@
+# ISO <<Class>> MD_MaintenanceInformation
+# writer output in XML
+
+# History:
+# 	Stan Smith 2013-10-31 original script
+# 	Stan Smith 2013-12-18 added contact
+#   Stan Smith 2014-07-08 modify require statements to function in RubyGem structure
+
+require 'code_maintenanceFrequency'
+require 'class_responsibleParty'
+
+class MD_MaintenanceInformation
+
+	def initialize(xml)
+		@xml = xml
+	end
+
+	def writeXML(hMaintInfo)
+
+		# classes used
+		maintFreqCode = MD_MaintenanceFrequencyCode.new(@xml)
+		rPartyClass = CI_ResponsibleParty.new(@xml)
+
+		@xml.tag! 'gmd:MD_MaintenanceInformation' do
+
+			# maintenance information - frequency code - required
+			s = hMaintInfo[:maintFreq]
+			if s.nil?
+				@xml.tag!('gmd:maintenanceAndUpdateFrequency', {'gco:nilReason'=>'unknown'})
+			else
+				@xml.tag!('gmd:maintenanceAndUpdateFrequency') do
+					maintFreqCode.writeXML(s)
+				end
+			end
+
+			# maintenance information - note
+			aNotes = hMaintInfo[:maintNotes]
+			if !aNotes.empty?
+				aNotes.each do |note|
+					@xml.tag!('gmd:maintenanceNote') do
+						@xml.tag!('gco:CharacterString',note)
+					end
+				end
+			elsif $showAllTags
+				@xml.tag!('gmd:maintenanceNote')
+			end
+
+			# maintenance information - contact - CI_ResponsibleParty
+			aContacts = hMaintInfo[:maintContacts]
+			if aContacts.empty? && $shoeEmpty
+				@xml.tag!('gmd:contact')
+			else
+				aContacts.each do |hContact|
+					@xml.tag!('gmd:contact') do
+						rPartyClass.writeXML(hContact)
+					end
+				end
+			end
+
+		end
+
+	end
+
+end

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

@@ -0,0 +1,59 @@
+# ISO <<Class>> MD_Medium
+# writer output in XML
+
+# History:
+# 	Stan Smith 2013-09-26 original script
+#   Stan Smith 2014-07-08 modify require statements to function in RubyGem structure
+
+require 'code_mediumName'
+require 'code_mediumFormat'
+
+class MD_Medium
+
+	def initialize(xml)
+		@xml = xml
+	end
+
+	def writeXML(medium)
+
+		# classes used
+		medFormatCode = MD_MediumFormatCode.new(@xml)
+		medNameCode = MD_MediumNameCode.new(@xml)
+
+		@xml.tag!('gmd:MD_Medium') do
+
+			# medium - name - MD_MediumNameCode
+			s = medium[:mediumName]
+			if !s.nil?
+				@xml.tag!('gmd:name') do
+					medNameCode.writeXML(s)
+				end
+			elsif $showAllTags
+				@xml.tag!('gmd:name')
+			end
+
+			# medium - medium format - MD_MediumFormatCode
+			s = medium[:mediumFormat]
+			if !s.nil?
+				@xml.tag!('gmd:mediumFormat') do
+					medFormatCode.writeXML(s)
+				end
+			elsif $showAllTags
+				@xml.tag!('gmd:mediumFormat')
+			end
+
+			# medium - medium note
+			s = medium[:mediumNote]
+			if !s.nil?
+				@xml.tag!('gmd:mediumNote') do
+					@xml.tag!('gco:CharacterString',s)
+				end
+			elsif $showAllTags
+				@xml.tag!('gmd:mediumNote')
+			end
+
+		end
+
+	end
+
+end

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

@@ -0,0 +1,277 @@
+# ISO <<Class>> MI_Metadata
+# writer output in XML
+
+# History:
+# 	Stan Smith 2013-08-09 original script
+# 	Stan Smith 2013-09-25 added distribution
+# 	Stan Smith 2013-09-25 added data quality
+# 	Stan Smith 2013-09-25 added metadata maintenance
+# 	Stan Smith 2013-09-25 added reference system info
+# 	Stan Smith 2013-12-27 added parent identifier
+#   Stan Smith 2014-05-14 modify for JSON schema 0.4.0
+#   Stan Smith 2014-05-14 refactored method calls to be consistent w/ other classes
+#   Stan Smith 2014-05-28 added resource URI
+#   Stan Smith 2014-07-08 modify require statements to function in RubyGem structure
+#   Stan Smith 2014-08-18 add dataSetURI
+#   Stan Smith 2014-09-03 replaced spatial reference system code with named, epsg, and
+#   ... wkt reference system descriptions using RS_Identifier for 0.7.0
+#   Stan Smith 2014-09-19 changed file identifier to read from internal storage as
+#   ... an MD_Identifier class.  To support version 0.8.0 json.
+
+require 'code_characterSet'
+require 'code_scope'
+require 'class_responsibleParty'
+require 'class_metadataExtension'
+require 'class_dataIdentification'
+require 'class_distribution'
+require 'class_dataQuality'
+require 'class_maintenanceInformation'
+require 'class_referenceSystem'
+require 'module_dateTimeFun'
+
+class MI_Metadata
+
+	def initialize(xml)
+		@xml = xml
+	end
+
+	def writeXML(internalObj)
+
+		# # classes used in MD_Metadata
+		charCode = MD_CharacterSetCode.new(@xml)
+		scopeCode = MD_ScopeCode.new(@xml)
+		rPartyClass = CI_ResponsibleParty.new(@xml)
+		mdExtClass = MD_MetadataExtensionInformation.new(@xml)
+		dataIdClass = MD_DataIdentification.new(@xml)
+		distClass = MD_Distribution.new(@xml)
+		dqClass = DQ_DataQuality.new(@xml)
+		metaMaintClass = MD_MaintenanceInformation.new(@xml)
+		refSysClass = MD_ReferenceSystem.new(@xml)
+
+		intMetadata = internalObj[:metadata]
+		hMetaInfo = intMetadata[:metadataInfo]
+		hResInfo = intMetadata[:resourceInfo]
+		aAssocRes = intMetadata[:associatedResources]
+		$intContactList = internalObj[:contacts]
+
+		# document head
+		@xml.instruct! :xml, encoding: 'UTF-8'
+		@xml.comment!('core gmi based instance document ISO 19115-2')
+		@xml.tag!('gmi:MI_Metadata',{'xmlns:gmi' => 'http://www.isotc211.org/2005/gmi',
+									'xmlns:gmd' => 'http://www.isotc211.org/2005/gmd',
+									'xmlns:gco' => 'http://www.isotc211.org/2005/gco',
+									'xmlns:gml' => 'http://www.opengis.net/gml/3.2',
+									'xmlns:gsr' => 'http://www.isotc211.org/2005/gsr',
+									'xmlns:gss' => 'http://www.isotc211.org/2005/gss',
+									'xmlns:gst' => 'http://www.isotc211.org/2005/gst',
+									'xmlns:gmx' => 'http://www.isotc211.org/2005/gmx',
+									'xmlns:gfc' => 'http://www.isotc211.org/2005/gfc',
+									'xmlns:srv' => 'http://www.isotc211.org/2005/srv',
+									'xmlns:xlink' => 'http://www.w3.org/1999/xlink',
+									'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance',
+									'xsi:schemaLocation' => 'http://www.isotc211.org/2005/gmi ftp://ftp.ncddc.noaa.gov/pub/Metadata/Online_ISO_Training/Intro_to_ISO/schemas/ISObio/schema.xsd'}) do
+
+			# metadata information - file identifier - default
+			# the internal object stores the file identifier as a MD_Identifier to support 19115-1
+			# ISO 19115-2 only support the file identifier as a character string
+			@xml.tag!('gmd:fileIdentifier') do
+				hMetadataId = hMetaInfo[:metadataId]
+				if hMetadataId[:identifier].nil?
+					# generate fileIdentifier if one not provided
+					@xml.tag!('gco:CharacterString',UUIDTools::UUID.random_create.to_s)
+				else
+					@xml.tag!('gco:CharacterString',hMetadataId[:identifier])
+				end
+			end
+
+			# metadata information - file language - default
+			@xml.tag!('gmd:language') do
+				# all xml is written in US English
+				@xml.tag!('gco:CharacterString','eng; USA')
+			end
+
+			# metadata information - character set - default
+			@xml.tag!('gmd:characterSet') do
+				# all out put is in utf8
+				charCode.writeXML('utf8')
+			end
+
+			# metadata information - parent identifier
+			# the internal object stores the parent identifier as a CI_Citation to support 19115-1
+			# ISO 19115-2 only support the parent identifier as a character string
+			hParent = hMetaInfo[:parentMetadata]
+			if !hParent.empty?
+				@xml.tag!('gmd:parentIdentifier') do
+					s = hParent[:citTitle]
+					aResIds = hParent[:citResourceIDs]
+					if aResIds.length > 0
+						s += ' ids: | '
+						aResIds.each do |resource|
+							s += resource[:identifierType] + ': ' + resource[:identifier] + ' | '
+						end
+					end
+					@xml.tag!('gco:CharacterString',s)
+				end
+			elsif $showAllTags
+				@xml.tag!('gmd:parentIdentifier')
+			end
+
+			# metadata information - file hierarchy - default dataset
+			aHierarchy = hMetaInfo[:metadataScope]
+			if aHierarchy.empty?
+				@xml.tag!('gmd:hierarchyLevel') do
+					scopeCode.writeXML('dataset')
+				end
+			else
+				aHierarchy.each do |hierarchy|
+					@xml.tag!('gmd:hierarchyLevel') do
+						scopeCode.writeXML(hierarchy)
+					end
+				end
+			end
+
+			# metadata information - metadata custodian - required
+			aCustodians = hMetaInfo[:metadataCustodians]
+			if aCustodians.empty?
+				@xml.tag!('gmd:contact', {'gco:nilReason' => 'missing'})
+			else
+				aCustodians.each do |hCustodian|
+					@xml.tag!('gmd:contact') do
+						rPartyClass.writeXML(hCustodian)
+					end
+				end
+			end
+
+			# metadata information - date stamp - required - default to now()
+			@xml.tag!('gmd:dateStamp') do
+
+				# if date not supplied, fill with today's date
+				hDate = hMetaInfo[:metadataCreateDate]
+				if hDate.empty?
+					mDate = AdiwgDateTimeFun.stringDateFromDateTime(DateTime.now, 'YMD')
+				else
+					mDateTime = hDate[:dateTime]
+					mDateRes = hDate[:dateResolution]
+					if mDateTime.nil?
+						mDate = AdiwgDateTimeFun.stringDateFromDateTime(DateTime.now, 'YMD')
+					else
+						mDate = AdiwgDateTimeFun.stringDateFromDateTime(mDateTime, mDateRes)
+					end
+				end
+
+				@xml.tag!('gco:Date',mDate)
+			end
+
+			# metadata information - metadata standard name - default
+			@xml.tag!('gmd:metadataStandardName') do
+				@xml.tag!('gco:CharacterString','ISO 19115-2')
+			end
+
+			# metadata information - metadata standard version - default
+			@xml.tag!('gmd:metadataStandardVersion') do
+				@xml.tag!('gco:CharacterString','ISO 19115-2:2009(E)')
+			end
+
+			# metadata information - dataset URI
+			s = hMetaInfo[:metadataURI]
+			if !s.nil?
+				@xml.tag!('gmd:dataSetURI') do
+					@xml.tag!('gco:CharacterString',s)
+				end
+			elsif $showAllTags
+				@xml.tag!('gmd:dataSetURI')
+			end
+
+			# metadata information - reference system
+			hRefSystems = hResInfo[:spatialReferenceSystem]
+			if !hRefSystems.empty?
+
+				# named reference systems
+				aRefNames = hRefSystems[:sRNames]
+				aRefNames.each do |refName|
+					@xml.tag!('gmd:referenceSystemInfo') do
+						refSysClass.writeXML(refName, 'name')
+					end
+				end
+
+				# epsg reference systems
+				aRefNames = hRefSystems[:sREPSGs]
+				aRefNames.each do |refName|
+					@xml.tag!('gmd:referenceSystemInfo') do
+						refSysClass.writeXML(refName, 'epsg')
+					end
+				end
+
+				# wkt reference systems
+				aRefNames = hRefSystems[:sRWKTs]
+				aRefNames.each do |refName|
+					@xml.tag!('gmd:referenceSystemInfo') do
+						refSysClass.writeXML(refName, 'wkt')
+					end
+				end
+
+			elsif $showAllTags
+				@xml.tag!('gmd:referenceSystemInfo')
+			end
+
+			# metadata information - metadata extension info
+			aExtensions = hMetaInfo[:extensions]
+			if !aExtensions.empty?
+				aExtensions.each do |hExtension|
+					@xml.tag!('gmd:metadataExtensionInfo') do
+						mdExtClass.writeXML(hExtension)
+					end
+				end
+			elsif $showAllTags
+				@xml.tag!('gmd:metadataExtensionInfo')
+			end
+
+			# metadata information - identification info - required
+			if hResInfo.empty?
+				@xml.tag!('gmd:identificationInfo', {'gco:nilReason' => 'missing'})
+			else
+				@xml.tag!('gmd:identificationInfo') do
+					dataIdClass.writeXML(hResInfo, aAssocRes)
+				end
+			end
+
+			# metadata information - content info
+			# ... information about data and link to 19110
+			# ... on hold until 19115-1 release
+
+			# metadata information - distribution info []
+			aDistInfo = intMetadata[:distributorInfo]
+			if !aDistInfo.empty?
+				@xml.tag!('gmd:distributionInfo') do
+					distClass.writeXML(aDistInfo)
+				end
+			elsif $showAllTags
+				@xml.tag!('gmd:distributionInfo')
+			end
+
+			# metadata information - data quality info
+			aDQInfo = hResInfo[:dataQualityInfo]
+			if !aDQInfo.empty?
+				aDQInfo.each do |hDQInfo|
+					@xml.tag!('gmd:dataQualityInfo') do
+						dqClass.writeXML(hDQInfo)
+					end
+				end
+			elsif $showAllTags
+				xml.tag!('gmd:dataQualityInfo')
+			end
+
+			# metadata information - metadata maintenance
+			hMetaMaint = hMetaInfo[:maintInfo]
+			if !hMetaMaint.empty?
+				@xml.tag!('gmd:metadataMaintenance') do
+					metaMaintClass.writeXML(hMetaMaint)
+				end
+			elsif $showAllTags
+				xml.tag!('gmd:metadataMaintenance')
+			end
+
+		end
+	end
+
+end

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

@@ -0,0 +1,156 @@
+# ISO <<Class>> MD_MetadataExtensionInformation
+# writer output in XML
+
+# History:
+# 	Stan Smith 2013-11-22 original script
+#   Stan Smith 2014-07-08 modify require statements to function in RubyGem structure
+
+require 'code_obligation'
+require 'code_datatype'
+require 'class_onlineResource'
+require 'class_responsibleParty'
+
+class MD_MetadataExtensionInformation
+
+	def initialize(xml)
+		@xml = xml
+	end
+
+	def writeXML(hExtension)
+
+		# classes used
+		olResClass = CI_OnlineResource.new(@xml)
+		rPartyClass = CI_ResponsibleParty.new(@xml)
+		obCode = MD_ObligationCode.new(@xml)
+		dataTCode = MD_DatatypeCode.new(@xml)
+
+		@xml.tag!('gmd:MD_MetadataExtensionInformation') do
+
+			# metadata extension - online resource - CI_OnLineResource
+			hOLResource = hExtension[:onLineResource]
+			if !hOLResource.empty?
+				@xml.tag!('gmd:extensionOnLineResource') do
+					olResClass.writeXML(hOLResource)
+				end
+			elsif $showAllTags
+				@xml.tag!('gmd:extensionOnLineResource')
+			end
+
+			# metadata extension = extended element information
+			@xml.tag!('gmd:extendedElementInformation') do
+				@xml.tag!('gmd:MD_ExtendedElementInformation') do
+
+					# extended element info - name - required
+					s = hExtension[:extName]
+					if s.nil?
+						@xml.tag!('gmd:name',{'gco:nilReason'=>'missing'})
+					else
+						@xml.tag!('gmd:name') do
+							@xml.tag!('gco:CharacterString',s)
+						end
+					end
+
+					# extended element info - short name
+					s = hExtension[:extShortName]
+					if !s.nil?
+						@xml.tag!('gmd:shortName') do
+							@xml.tag!('gco:CharacterString',s)
+						end
+					elsif $showAllTags
+						@xml.tag!('gmd:shortName')
+					end
+
+					# extended element info - definition - required
+					s = hExtension[:extDefinition]
+					if s.nil?
+						@xml.tag!('gmd:definition',{'gco:nilReason'=>'missing'})
+					else
+						@xml.tag!('gmd:definition') do
+							@xml.tag!('gco:CharacterString',s)
+						end
+					end
+
+					# extended element info - obligation
+					s = hExtension[:obligation]
+					if !s.nil?
+						@xml.tag!('gmd:obligation') do
+							obCode.writeXML(s)
+						end
+					elsif $showAllTags
+						@xml.tag!('gmd:obligation')
+					end
+
+					# extended element info - data type - required
+					s = hExtension[:dataType]
+					if s.nil?
+						@xml.tag!('gmd:dataType',{'gco:nilReason'=>'missing'})
+					else
+						@xml.tag!('gmd:dataType') do
+							dataTCode.writeXML(s)
+						end
+					end
+
+					# extended element info - maximum occurrence
+					s = hExtension[:maxOccurrence]
+					if !s.nil?
+						@xml.tag!('gmd:maximumOccurrence') do
+							@xml.tag!('gco:CharacterString',s)
+						end
+					elsif $showAllTags
+						@xml.tag!('gmd:maximumOccurrence')
+					end
+
+					# extended element info - parent entity - required
+					aParents = hExtension[:parentEntities]
+					if aParents.empty?
+						@xml.tag!('gmd:parentEntity',{'gco:nilReason'=>'missing'})
+					else
+						aParents.each do |parent|
+							@xml.tag!('gmd:parentEntity') do
+								@xml.tag!('gco:CharacterString',parent)
+							end
+						end
+					end
+
+					# extended element info - rule
+					s = hExtension[:rule]
+					if s.nil?
+						@xml.tag!('gmd:rule',{'gco:nilReason'=>'missing'})
+					else
+						@xml.tag!('gmd:rule') do
+							@xml.tag!('gco:CharacterString',s)
+						end
+					end
+
+					# extended element info - rationale
+					aRations = hExtension[:rationales]
+					if aRations.empty?
+						@xml.tag!('gmd:rationale')
+					else
+						aRations.each do |ration|
+							@xml.tag!('gmd:rationale') do
+								@xml.tag!('gco:CharacterString', ration)
+							end
+						end
+					end
+
+					# extended element info - source - CI_ResponsibleParty
+					aSources = hExtension[:extSources]
+					if aSources.empty?
+						@xml.tag!('gmd:source',{'gco:nilReason'=>'missing'})
+					else
+						aSources.each do |hSource|
+							@xml.tag!('gmd:source') do
+								rPartyClass.writeXML(hSource)
+							end
+						end
+					end
+
+				end
+			end
+
+		end
+
+	end
+
+end