adiwg-mdtranslator 0.8.0

data/lib/adiwg/mdtranslator/writers/iso19115_2/codelists/code_role.rb

@@ -0,0 +1,37 @@
+# ISO <<CodeLists>> gmd:CI_RoleCode
+
+# from http://www.isotc211.org/2005/resources/Codelist/gmxCodelists.xml
+# History:
+# 	Stan Smith 2013-08-09 original script
+
+class CI_RoleCode
+	def initialize(xml)
+		@xml = xml
+	end
+
+	def writeXML(codeName)
+
+		case(codeName)
+			when 'resourceProvider' then codeID = '001'
+			when 'custodian' then codeID = '002'
+			when 'owner' then codeID = '003'
+			when 'user' then codeID = '004'
+			when 'distributor' then codeID = '005'
+			when 'originator' then codeID = '006'
+			when 'pointOfContact' then codeID = '007'
+			when 'principalInvestigator' then codeID = '008'
+			when 'processor' then codeID = '009'
+			when 'publisher' then codeID = '010'
+			when 'author' then codeID = '011'
+			else
+				codeName = 'INVALID ROLE CODE'
+				codeID = '999'
+		end
+
+		# write xml
+		@xml.tag!('gmd:CI_RoleCode',{:codeList=>'http://www.isotc211.org/2005/resources/Codelist/gmxCodelists.xml#CI_RoleCode',
+									 :codeListValue=>"#{codeName}",
+									 :codeSpace=>"#{codeID}"})
+	end
+
+end

data/lib/adiwg/mdtranslator/writers/iso19115_2/codelists/code_scope.rb

@@ -0,0 +1,46 @@
+# ISO <<CodeLists>> gmd:MD_ScopeCode
+
+# from http://www.isotc211.org/2005/resources/Codelist/gmxCodelists.xml
+# History:
+# 	Stan Smith 2013-08-09 original script
+
+class MD_ScopeCode
+	def initialize(xml)
+		@xml = xml
+	end
+
+	def writeXML(codeName)
+		case(codeName)
+			when 'attribute' then codeID = '001'
+			when 'attributeType' then codeID = '002'
+			when 'collectionHardware' then codeID = '003'
+			when 'collectionSession' then codeID = '004'
+			when 'dataset' then codeID = '005'
+			when 'series' then codeID = '006'
+			when 'nonGeographicDataset' then codeID = '007'
+			when 'dimensionGroup' then codeID = '008'
+			when 'feature' then codeID = '009'
+			when 'featureType' then codeID = '010'
+			when 'propertyType' then codeID = '011'
+			when 'fieldSession' then codeID = '012'
+			when 'software' then codeID = '013'
+			when 'service' then codeID = '014'
+			when 'model' then codeID = '015'
+			when 'tile' then codeID = '016'
+			else
+				codeName = 'INVALID SCOPE CODE'
+				codeID = '999'
+		end
+
+		# write xml
+		@xml.tag!('gmd:MD_ScopeCode',{:codeList=>'http://www.isotc211.org/2005/resources/Codelist/gmxCodelists.xml#MD_ScopeCode',
+									  :codeListValue=>"#{codeName}",
+									  :codeSpace=>"#{codeID}"})
+	end
+
+end
+
+
+
+
+

data/lib/adiwg/mdtranslator/writers/iso19115_2/codelists/code_spatialRepresentationType.rb

@@ -0,0 +1,36 @@
+# ISO <<CodeLists>> gmd:MD_SpatialRepresentationTypeCode
+
+# from http://www.isotc211.org/2005/resources/Codelist/gmxCodelists.xml
+# History:
+# 	Stan Smith 2013-10-21 original script
+
+class MD_SpatialRepresentationTypeCode
+	def initialize(xml)
+		@xml = xml
+	end
+
+	def writeXML(codeName)
+		case(codeName)
+			when 'vector' then codeID = '001'
+			when 'grid' then codeID = '002'
+			when 'textTable' then codeID = '003'
+			when 'tin' then codeID = '004'
+			when 'stereoModel' then codeID = '005'
+			when 'video' then codeID = '006'
+			else
+				codeName = 'INVALID SPATIAL REPRESENTATION TYPE'
+				codeID = '999'
+		end
+
+		# write xml
+		@xml.tag!('gmd:MD_SpatialRepresentationTypeCode',{:codeList=>'http://www.isotc211.org/2005/resources/Codelist/gmxCodelists.xml#MD_SpatialRepresentationTypeCode',
+											 :codeListValue=>"#{codeName}",
+											 :codeSpace=>"#{codeID}"})
+	end
+
+end
+
+
+
+
+

data/lib/adiwg/mdtranslator/writers/iso19115_2/codelists/code_topicCategory.rb

@@ -0,0 +1,50 @@
+# ISO <<CodeLists>> gmd:MD_TopicCategoryCode
+# Enumeration
+
+# from http://www.isotc211.org/2005/resources/Codelist/gmxCodelists.xml
+# History:
+# 	Stan Smith 2013-10-21 original script
+
+class MD_TopicCategoryCode
+	def initialize(xml)
+		@xml = xml
+	end
+
+	def writeXML(codeName)
+		case(codeName)
+			when 'farming',
+				'biota',
+				'boundaries',
+				'climatologyMeteorologyAtmosphere',
+				'economy',
+				'elevation',
+				'environment',
+				'geoscientificInformation',
+				'health',
+				'imageryBaseMapsEarthCover',
+				'intelligenceMilitary',
+				'inlandWaters',
+				'location',
+				'oceans',
+				'planningCadastre',
+				'society',
+				'structure',
+				'transportation',
+				'utilitiesCommunication'
+			else
+				# topics not in the standard ISO list will not pass validation
+				# the domain is validated by the XSD
+				# this codelist cannot be extended
+				return
+		end
+
+		# write xml
+		@xml.tag!('gmd:MD_TopicCategoryCode',codeName)
+	end
+
+end
+
+
+
+
+

data/lib/adiwg/mdtranslator/writers/iso19115_2/iso19115_2_writer.rb

@@ -0,0 +1,131 @@
+# Writer - internal data structure to ISO 19115-2:2009
+
+# History:
+# 	Stan Smith 2013-08-10 original script
+#   Stan Smith 2014-06-04 add internal object pre-scan to create extents
+#   ... for geometry supplemental information
+#   Stan Smith 2014-07-08 modify require statements to function in RubyGem structure
+
+require 'builder'
+require 'date'
+require 'uuidtools'
+require 'class_metadata'
+
+$idCount = '_000'
+
+class Iso191152Writer
+
+	def initialize
+	end
+
+	def writeXML(internalObj)
+
+		# pre-scan the internal object to create a new extents for each geometry
+		# ... that has supplemental information (temporal, vertical, identity)
+		# ... new extents will be added to internalObj as needed
+		prescanGeoElements(internalObj)
+
+		# create new XML document
+		xml = Builder::XmlMarkup.new(indent: 3)
+		metadataWriter = MI_Metadata.new(xml)
+		metadata = metadataWriter.writeXML(internalObj)
+
+		return metadata
+	end
+
+	def prescanGeoElements(internalObj)
+		# supplemental information for the geographic element is carried in the
+		# ... internal structure in the temporalElements:, verticalElements:,
+		# ... and elementIdentifiers: attributes of the extGeoElements:
+		# ... of the extent.
+		# since temporal, vertical, and identify information in ISO is a property
+		# ... of EX_Extent and not of the geographicElement,
+		# ... this code creates a new extent for each geographicElement
+		# ... that has supplemental information and
+		# ... moves the supplemental information from the geometry to the new extent.
+		# In this implementation, supplemental information is only allowed for
+		# ... geometry types of Point, LineString, and Polygon
+		aExtents = internalObj[:metadata][:resourceInfo][:extents]
+		unless aExtents.empty?
+			aExtents.each do |hExtent|
+				aGeoElements = hExtent[:extGeoElements]
+				unless aGeoElements.empty?
+					aGeoElements.each do |hGeoElement|
+						hGeometry = hGeoElement[:elementGeometry]
+						unless hGeometry.empty?
+							geoType = hGeometry[:geoType]
+							case geoType
+								when 'Point', 'LineString', 'Polygon'
+									newExtent = extentFromGeoElement(hGeoElement, geoType)
+									if !newExtent.nil?
+										aExtents << newExtent
+									end
+
+								when 'MultiGeometry'
+									aGeoMembers = hGeometry[:geometry]
+									unless aGeoMembers.empty?
+										aGeoMembers.each do |hGeoMemberElement|
+											hGeometry = hGeoMemberElement[:elementGeometry]
+											unless hGeometry.empty?
+												geoType = hGeometry[:geoType]
+												case geoType
+													when 'Point', 'LineString', 'Polygon'
+														newExtent = extentFromGeoElement(hGeoMemberElement, geoType)
+														if !newExtent.nil?
+															aExtents << newExtent
+														end
+												end
+											end
+										end
+									end
+							end
+						end
+					end
+				end
+			end
+		end
+	end
+
+	def extentFromGeoElement(hGeoElement, geoType)
+		# build new extent to portray supplemental information
+		# from elementGeometry
+		if !hGeoElement[:temporalElements].empty? ||
+			!hGeoElement[:verticalElements].empty? ||
+			!hGeoElement[:elementIdentifiers].empty?
+
+			# get unique id for geometry
+			# if geometry id was missing, set it at this time so
+			# ... it will match the supplemental information extent description
+			geoID = hGeoElement[:elementId]
+			if geoID.nil?
+				$idCount = $idCount.succ
+				geoID = geoType + $idCount
+				hGeoElement[:elementId] = geoID
+			end
+
+			# build unique id for extent geometry
+			$idCount = $idCount.succ
+			extGeoID = geoType + $idCount
+
+			intMetadataClass = InternalMetadata.new
+			intExtent = intMetadataClass.newExtent
+			intGeoEle = intMetadataClass.newGeoElement
+
+			intGeoEle[:elementId] = extGeoID
+			intGeoEle[:elementGeometry] = hGeoElement[:elementGeometry]
+
+			intExtent[:extDesc] = 'Supplemental information for ' + geoID
+			intExtent[:extGeoElements] << intGeoEle
+			intExtent[:extIdElements] = hGeoElement[:elementIdentifiers]
+			intExtent[:extTempElements] = hGeoElement[:temporalElements]
+			intExtent[:extVertElements] = hGeoElement[:verticalElements]
+
+			return intExtent
+
+		else
+			return nil
+		end
+
+	end
+
+end

data/lib/adiwg/mdtranslator.rb

@@ -0,0 +1,97 @@
+# MdTranslator - ADIwg MdTranslator RubyGem entry point
+# ... pass input file to appropriate reader and writer;
+# ... assign module path names for require statements
+
+# History:
+# 	Stan Smith 2014-07-02 original script
+#   Stan Smith 2014-07-21 added ADIWG namespace
+#   Stan Smith 2014-07-21 added validation of json structure
+#   Stan Smith 2014-07-23 moved all validations to readers/adiwg/adiwg_validator.rb
+#   ... each reader will have it's own validator
+#   Stan Smith 2014-09-26 added processing of minor release numbers
+
+# add main directories to load_path
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__),'mdtranslator'))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__),'mdtranslator/internal'))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__),'mdtranslator/readers'))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__),'mdtranslator/writers'))
+
+require 'version'
+require 'internal_metadata_obj'
+
+module ADIWG
+
+	module Mdtranslator
+
+		def self.translate(file, reader, writer, validate, showAllTags)
+
+			$showAllTags = showAllTags
+			$response = {
+				readerFormat: nil,
+				readerStructurePass: nil,
+				readerStructureMessages: [],
+				readerName: reader,
+				readerNameFound: nil,
+				readerVersionFound: nil,
+				readerVersionUsed: nil,
+				readerValidationLevel: validate,
+				readerValidationPass: nil,
+				readerValidationMessages: [],
+				writerName: writer,
+				writerFormat: nil,
+				writerPass: nil,
+				writerMessages: [],
+				writerOutput: nil
+			}
+
+			# the mdtranslator gem loads and returns the above hash
+
+			case reader
+				when 'adiwgJson'
+					require 'adiwgJson/adiwgJson_validator'
+
+					# validate adiwgJson file
+					AdiwgJsonValidation.validate(file)
+					if $response[:readerStructurePass] && $response[:readerValidationPass]
+						# initiate the reader
+						require 'adiwgJson/adiwgJson_reader'
+						readerClass = AdiwgJsonReader.new
+						internalObj = readerClass.unpack(file)
+					else
+						return $response
+					end
+			end
+
+			case writer
+				when 'iso19115_2'
+					$LOAD_PATH.unshift(File.join(File.dirname(__FILE__),'mdtranslator/writers/iso19115_2/codelists'))
+					$LOAD_PATH.unshift(File.join(File.dirname(__FILE__),'mdtranslator/writers/iso19115_2/classes'))
+					require 'iso19115_2/iso19115_2_writer'
+
+					# set the format of the output file based on the writer specified
+					$response[:writerFormat] = 'xml'
+
+					writerClass = Iso191152Writer.new
+
+					# initiate the writer
+					$response[:writerOutput] = writerClass.writeXML(internalObj)
+					if $response[:writerMessages].length > 0
+						$response[:writerPass] = false
+					else
+						$response[:writerPass] = true
+					end
+			end
+
+			return $response
+
+		end
+
+		def self.reader_module(moduleName, version)
+			dir = File.join($response[:readerName], 'modules_' + version)
+			file = File.join(dir, moduleName)
+			return file
+		end
+
+	end
+
+end

data/lib/adiwg-mdtranslator.rb

@@ -0,0 +1 @@
+require 'adiwg/mdtranslator'

data/mdtranslator.rb

@@ -0,0 +1,178 @@
+#!/usr/bin/env ruby
+# ADIwg mdTranslator - Thor CLI for mdtranslator
+
+# History:
+# 	Stan Smith 2014-07-15 original script
+#   Stan Smith 2014-09-02 changed name to mdtranslator
+#   Stan Smith 2014-09-21 coded cli to 0.8.0 api
+
+# uncomment next 2 lines during development to run from code (not gem) ....
+lib = File.expand_path('lib')
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'thor'
+require 'adiwg-mdtranslator'
+
+class Mdtranslator < Thor
+
+	# exit_on_failure added to exit with code 1 if thor cannot complete task
+	# such as if required parameters are missing
+	def self.exit_on_failure?
+		true
+	end
+
+	# basic cli description
+	desc 'translate [FILE]', %q{Pass JSON string or filename plus parameters to mdtranslator translate}
+	long_desc <<-LONGDESC
+	    'mdtranslator translate' provides command line access to the ADIWG metadata translator
+ with options to select the input file reader, select writer output format, show empty tags
+ in XML outputs, and choose level of validation for JSON inputs.
+	LONGDESC
+	# define cli options
+	method_option :reader, :aliases => '-r', :desc => 'Name of reader to read your input', :default => 'adiwgJson'
+	method_option :writer, :aliases => '-w', :desc => 'Name of writer to create your metadata, or leave blank to validate input only'
+	method_option :validate, :aliases => '-v', :desc => 'Specify level of validation to be performed', :enum => %w{none normal strict}, :default => 'normal'
+	method_option :showAllTags, :aliases => '-s', :desc => 'Include tags for unused attributes', :type => :boolean, :default => false
+	method_option :messages, :aliases => '-m', :desc => 'On error return messages as formatted text or json object', :enum => %w{json text}, :default => 'text'
+	method_option :returnObject, :aliases => '-o', :desc => 'Return full JSON object generated by translator', :type => :boolean, :default => false
+
+	# accept command and options
+	def translate(file)
+
+		# test to see if file parameter is a local file
+		# if not ... it is assumed to be a json string
+		if File.exist?(file)
+			# read file
+			my_file = File.open(file, 'r')
+			fileObj = my_file.read
+			my_file.close
+		else
+			fileObj = file
+		end
+
+		# for testing parameters
+		# puts 'reader: ' + options[:reader]
+		# puts 'writer: ' + options[:writer]
+		# puts 'validation level: ' + options[:validate]
+		# puts 'showAllTags: ' + options[:showAllTags].to_s
+		# puts 'message format: ' + options[:messages]
+		# puts 'return object format: ' + options[:returnObject]
+		# require 'pp'
+		# pp fileObj
+
+		# call mdtranslator
+		mdReturn = ADIWG::Mdtranslator.translate(fileObj, options[:reader], options[:writer],
+												 options[:validate], options[:showAllTags])
+
+		# determine return content and type of return ...
+		if mdReturn[:readerStructurePass] && mdReturn[:readerValidationPass]
+
+			# no problem was found with the input file
+			if options[:writer].nil?
+				# if no writer was specified the input was being validated only,
+				# ...no writer output will have been generated,
+				# ...and the return will be a string unless json was requested
+				if options[:messages] == 'json'
+					$stdout.write mdReturn.to_json
+					return
+				else
+					$stdout.write 'Success'
+					return
+				end
+			else
+				# a writer was specified,
+				# output is expected from the translator's writer
+				if mdReturn[:writerPass]
+				    # writer output was generated
+					# ...return the writer output in its native format unless json was requested
+					if options[:returnObject]
+						$stdout.write mdReturn.to_json
+						return
+					else
+						$stdout.write mdReturn[:writerOutput].to_s
+						return
+					end
+				else
+					# the writer failed or generated warnings to be reported
+					# ...return the messages as a string unless json was requested
+					if options[:messages] == 'json'
+						$stdout.write mdReturn.to_json
+						return
+					else
+						# build a string with messages issues from parser and validator
+						s = ''
+						s += "Failed\n"
+						s += "Writer failed to generate output or issued significant warnings\n"
+						s += "See following messages for further information\n"
+
+						# post structure messages
+						i = 0
+						mdReturn[:writerMessages].each do |message|
+							i += 1
+							s += "\nMessage: #{i}\n"
+							s += message + "\n"
+						end
+
+						$stdout.write s
+						return
+
+					end
+				end
+			end
+
+		else
+
+			# problems were found with the input file
+
+			# if no writer was specified the input was being validated only,
+			# ...no writer output will have been generated,
+			# ...and return is always expected to be a string
+			if options[:messages] == 'json'
+				$stdout.write mdReturn.to_json
+				return
+			else
+				# build a string with messages issues from parser and validator
+				s = ''
+				s += "Failed\n"
+				s += "Input failed to pass either file structure validation or content does not match schema\n"
+				s += "See following messages for further information\n"
+
+				# post structure messages
+				if mdReturn[:readerStructurePass]
+					s += "Success - Input structure is valid\n"
+				else
+					s += "Fail - Structure of input file is invalid - see following message(s):\n"
+					i = 0
+					mdReturn[:readerStructureMessages].each do |message|
+						i += 1
+						s += "\nMessage: #{i}\n"
+						s += message.to_s + "\n"
+					end
+				end
+
+				# post validator messages
+				unless mdReturn[:readerValidationPass].nil?
+					if mdReturn[:readerValidationPass]
+						s += "Success - Input content passes schema definition\n"
+					else
+						s += "Fail - Input content did not pass schema validation - see following message(s):\n"
+						i = 0
+						mdReturn[:readerValidationMessages].each do |message|
+							i += 1
+							s += "\nMessage: #{i}\n"
+							s += message.to_s + "\n"
+						end
+					end
+				end
+
+				$stdout.write s
+				return
+
+			end
+		end
+
+	end
+
+	Mdtranslator.start(ARGV)
+
+end