adiwg-mdtranslator 0.8.0

data/lib/adiwg/mdtranslator/readers/adiwgJson/modules_0.8.0/module_descriptiveKeyword.rb

@@ -0,0 +1,49 @@
+# unpack descriptive keyword
+# Reader - ADIwg JSON V1 to internal data structure
+
+# History:
+# 	Stan Smith 2013-09-18 original script
+# 	Stan Smith 2013-11-27 modified to process single keyword collection
+#   Stan Smith 2014-07-03 resolve require statements using Mdtranslator.reader_module
+#   Stan Smith 2014-08-21 removed thesaurus link; replaced by onlineResource to citation
+#   Stan Smith 2014-08-21 removed extra level of encapsulation "citation" under "thesaurus"
+
+require ADIWG::Mdtranslator.reader_module('module_citation', $response[:readerVersionUsed])
+
+module Adiwg_DescriptiveKeyword
+
+	def self.unpack(hDesKeyword)
+
+		# instance classes needed in script
+		intMetadataClass = InternalMetadata.new
+		intKeyword = intMetadataClass.newKeyword
+
+		# descriptive keyword - keyword array
+		if hDesKeyword.has_key?('keyword')
+			aKeywords = hDesKeyword['keyword']
+			aKeywords.each do |keyword|
+				intKeyword[:keyword] << keyword
+			end
+		end
+
+		# descriptive keyword - keyType
+		if hDesKeyword.has_key?('keywordType')
+			s = hDesKeyword['keywordType']
+			if s != ''
+				intKeyword[:keywordType] = s
+			end
+		end
+
+		# descriptive keyword - thesaurus
+		if hDesKeyword.has_key?('thesaurus')
+			hCitation = hDesKeyword['thesaurus']
+			unless hCitation.empty?
+				intKeyword[:keyTheCitation] = Adiwg_Citation.unpack(hCitation)
+			end
+
+		end
+
+		return intKeyword
+	end
+
+end

data/lib/adiwg/mdtranslator/readers/adiwgJson/modules_0.8.0/module_distributionInfo.rb

@@ -0,0 +1,150 @@
+# unpack distribution info
+# Reader - ADIwg JSON V1 to internal data structure
+
+# History:
+# 	Stan Smith 2013-09-23 original script
+# 	Stan Smith 2013-11-27 changed to receive single distributor rather than array
+# 	Stan Smith 2013-12-18 changed to unpack contact using responsible party
+#   Stan Smith 2014-05-02 changed to support responsible party as hash, not array
+#   Stan Smith 2014-07-08 resolve require statements using Mdtranslator.reader_module
+
+require ADIWG::Mdtranslator.reader_module('module_onlineResource', $response[:readerVersionUsed])
+require ADIWG::Mdtranslator.reader_module('module_dateTime', $response[:readerVersionUsed])
+require ADIWG::Mdtranslator.reader_module('module_responsibleParty', $response[:readerVersionUsed])
+
+module Adiwg_DistributionInfo
+
+	def self.unpack(hDistributor)
+
+		# instance classes needed in script
+		intMetadataClass = InternalMetadata.new
+		intDistributor = intMetadataClass.newDistributor
+
+		# distributor - distribution contact
+		if hDistributor.has_key?('distributorContact')
+			hContact = hDistributor['distributorContact']
+			unless hContact.empty?
+				intDistributor[:distContact] = Adiwg_ResponsibleParty.unpack(hContact)
+			end
+		end
+
+		# distributor - distribution order process
+		if hDistributor.has_key?('distributionOrderProcess')
+			aDistOrder = hDistributor['distributionOrderProcess']
+			unless aDistOrder.empty?
+				aDistOrder.each do |distOrderProcess|
+
+					intDistOrder = intMetadataClass.newDistOrder
+
+					if distOrderProcess.has_key?('fees')
+						s = distOrderProcess['fees']
+						if s != ''
+							intDistOrder[:fees] = s
+						end
+					end
+
+					if distOrderProcess.has_key?('plannedAvailabilityDateTime')
+						s = distOrderProcess['plannedAvailabilityDateTime']
+						if s != ''
+							intDistOrder[:plannedDateTime] = Adiwg_DateTime.unpack(s)
+						end
+					end
+
+					if distOrderProcess.has_key?('orderingInstructions')
+						s = distOrderProcess['orderingInstructions']
+						if s != ''
+							intDistOrder[:orderInstructions] = s
+						end
+					end
+
+					if distOrderProcess.has_key?('turnaround')
+						s = distOrderProcess['turnaround']
+						if s != ''
+							intDistOrder[:turnaround] = s
+						end
+					end
+
+					intDistributor[:distOrderProc] << intDistOrder
+
+				end
+			end
+		end
+
+		# distributor - distribution format
+		if hDistributor.has_key?('distributorFormat')
+			aDistFormat = hDistributor['distributorFormat']
+			unless aDistFormat.empty?
+
+				aDistFormat.each do |distFormat|
+					intResFormat = intMetadataClass.newResourceFormat
+
+					if distFormat.has_key?('formatName')
+						s = distFormat['formatName']
+						if s != ''
+							intResFormat[:formatName] = s
+						end
+					end
+
+					if distFormat.has_key?('version')
+						s = distFormat['version']
+						if s != ''
+							intResFormat[:formatVersion] = s
+						end
+					end
+
+					intDistributor[:distFormat] << intResFormat
+				end
+			end
+		end
+
+		# distributor - distribution transfer options
+		if hDistributor.has_key?('distributorTransferOptions')
+			aDistTransOpt = hDistributor['distributorTransferOptions']
+			unless aDistTransOpt.empty?
+
+				aDistTransOpt.each do |distTransOpt|
+					intTransOpt = intMetadataClass.newDigitalTransOption
+
+					if distTransOpt.has_key?('online')
+						aOnlineOption = distTransOpt['online']
+						aOnlineOption.each do |hOlOption|
+							intTransOpt[:online] << Adiwg_OnlineResource.unpack(hOlOption)
+						end
+					end
+
+					if distTransOpt.has_key?('offline')
+						intOfflineOpt = intMetadataClass.newMedium
+						distOfflineOpt = distTransOpt['offline']
+						if distOfflineOpt.has_key?('name')
+							s = distOfflineOpt['name']
+							if s != ''
+								intOfflineOpt[:mediumName] = s
+							end
+						end
+
+						if distOfflineOpt.has_key?('mediumFormat')
+							s = distOfflineOpt['mediumFormat']
+							if s != ''
+								intOfflineOpt[:mediumFormat] = s
+							end
+						end
+
+						if distOfflineOpt.has_key?('mediumNote')
+							s = distOfflineOpt['mediumNote']
+							if s != ''
+								intOfflineOpt[:mediumNote] = s
+							end
+						end
+
+						intTransOpt[:offline] = intOfflineOpt
+					end
+
+					intDistributor[:distTransOption] << intTransOpt
+				end
+			end
+		end
+
+		return intDistributor
+	end
+
+end

data/lib/adiwg/mdtranslator/readers/adiwgJson/modules_0.8.0/module_extent.rb

@@ -0,0 +1,62 @@
+# unpack extent
+# Reader - ADIwg JSON V1 to internal data structure
+
+# History:
+# 	Stan Smith 2013-11-04 original script
+# 	Stan Smith 2013-11-14 add temporal elements
+# 	Stan Smith 2013-11-14 add vertical elements
+# 	Stan Smith 2013-11-27 modified to process a single extent
+# 	Stan Smith 2013-12-05 modified to for new temporalElement schema
+#   Stan Smith 2014-07-07 resolve require statements using Mdtranslator.reader_module
+
+require ADIWG::Mdtranslator.reader_module('module_geographicElement', $response[:readerVersionUsed])
+require ADIWG::Mdtranslator.reader_module('module_temporalElement', $response[:readerVersionUsed])
+require ADIWG::Mdtranslator.reader_module('module_verticalElement', $response[:readerVersionUsed])
+
+module Adiwg_Extent
+
+	def self.unpack(hExtent)
+
+		# instance classes needed in script
+		intMetadataClass = InternalMetadata.new
+		intExtent = intMetadataClass.newExtent
+
+		# extent - description
+		if hExtent.has_key?('description')
+			s = hExtent['description']
+			if s != ''
+				intExtent[:extDesc] = s
+			end
+		end
+
+		# extent - geographic elements
+		if hExtent.has_key?('geographicElement')
+			aGeoElements = hExtent['geographicElement']
+			unless aGeoElements.empty?
+				intExtent[:extGeoElements] = Adiwg_GeographicElement.unpack(aGeoElements)
+			end
+		end
+
+		# extent - temporal elements
+		if hExtent.has_key?('temporalElement')
+			hTempElement = hExtent['temporalElement']
+			unless hTempElement.empty?
+				intExtent[:extTempElements] = Adiwg_TemporalElement.unpack(hTempElement)
+			end
+		end
+
+		# extent - vertical elements
+		if hExtent.has_key?('verticalElement')
+			aVertElements = hExtent['verticalElement']
+			unless aVertElements.empty?
+				aVertElements.each do |hVertElement|
+					intExtent[:extVertElements] << Adiwg_VerticalElement.unpack(hVertElement)
+				end
+			end
+		end
+
+		return intExtent
+
+	end
+
+end

data/lib/adiwg/mdtranslator/readers/adiwgJson/modules_0.8.0/module_geoCoordSystem.rb

@@ -0,0 +1,46 @@
+# unpack GeoJSON properties
+# Reader - ADIwg JSON V1 to internal data structure
+
+# History:
+# 	Stan Smith 2014-04-30 original script
+
+module Adiwg_GeoCoordSystem
+
+	def self.unpack(hGeoCrs, intElement)
+
+		intMetadataClass = InternalMetadata.new
+		intSRS = intMetadataClass.newSRS
+
+		# get coordinate reference system
+		# null crs will default to CRS84 in writer
+		if hGeoCrs.has_key?('properties')
+			hCRSProp = hGeoCrs['properties']
+
+			if hCRSProp.has_key?('name')
+				s = hCRSProp['name']
+				if s != ''
+					intSRS[:srsName] = s
+				end
+			end
+
+			if hCRSProp.has_key?('href')
+				s = hCRSProp['href']
+				if s != ''
+					intSRS[:srsHref] = s
+				end
+			end
+
+			if hCRSProp.has_key?('type')
+				s = hCRSProp['type']
+				if s != ''
+					intSRS[:srsType] = s
+				end
+			end
+
+			intElement[:elementSrs] = intSRS
+
+		end
+
+	end
+
+end

data/lib/adiwg/mdtranslator/readers/adiwgJson/modules_0.8.0/module_geoProperties.rb

@@ -0,0 +1,89 @@
+# unpack GeoJSON properties
+# Reader - ADIwg JSON V1 to internal data structure
+
+# History:
+# 	Stan Smith 2014-04-29 original script
+#   Stan Smith 2014-07-07 resolve require statements using Mdtranslator.reader_module
+#   Stan Smith 2014-08-18 changed assignedId to identifier schema 0.6.0
+
+require ADIWG::Mdtranslator.reader_module('module_temporalElement', $response[:readerVersionUsed])
+require ADIWG::Mdtranslator.reader_module('module_verticalElement', $response[:readerVersionUsed])
+require ADIWG::Mdtranslator.reader_module('module_resourceIdentifier', $response[:readerVersionUsed])
+
+module Adiwg_GeoProperties
+
+	def self.unpack(hGeoProps, intElement)
+
+		# set element extent - (default true)
+		intElement[:elementIncludeData] = true
+		if hGeoProps.has_key?('includesData')
+			if !hGeoProps['includesData']
+				intElement[:elementIncludeData] = false
+			end
+		end
+
+		# set element feature name
+		if hGeoProps.has_key?('featureName')
+			s = hGeoProps['featureName']
+			if s != ''
+				intElement[:elementName] = s
+			end
+		end
+
+		# set element description
+		if hGeoProps.has_key?('description')
+			s = hGeoProps['description']
+			if s != ''
+				intElement[:elementDescription] = s
+			end
+		end
+
+		# set temporal information
+		if hGeoProps.has_key?('temporalElement')
+			hTempEle = hGeoProps['temporalElement']
+			unless hTempEle.empty?
+				intElement[:temporalElements] = Adiwg_TemporalElement.unpack(hTempEle)
+			end
+		end
+
+		# set vertical information
+		if hGeoProps.has_key?('verticalElement')
+			aVertEle = hGeoProps['verticalElement']
+			unless aVertEle.empty?
+				aVertEle.each do |hVertEle|
+					intElement[:verticalElements] << Adiwg_VerticalElement.unpack(hVertEle)
+				end
+			end
+		end
+
+		# set other assigned IDs
+		if hGeoProps.has_key?('identifier')
+			aResIds = hGeoProps['identifier']
+			unless aResIds.empty?
+				aResIds.each do |hIdentifier|
+					intElement[:elementIdentifiers] << Adiwg_ResourceIdentifier.unpack(hIdentifier)
+				end
+			end
+		end
+
+		# set feature scope
+		if hGeoProps.has_key?('featureScope')
+			s = hGeoProps['featureScope']
+			if s != ''
+				intElement[:elementScope] = s
+			end
+		end
+
+		# set feature acquisition methodology
+		if hGeoProps.has_key?('featureAcquisitionMethod')
+			s = hGeoProps['featureAcquisitionMethod']
+			if s != ''
+				intElement[:elementAcquisition] = s
+			end
+		end
+
+		return intElement
+
+	end
+
+end

data/lib/adiwg/mdtranslator/readers/adiwgJson/modules_0.8.0/module_geographicElement.rb

@@ -0,0 +1,168 @@
+# unpack geographic element
+# Reader - ADIwg JSON V1 to internal data structure
+# determine element type
+
+# History:
+# 	Stan Smith 2013-11-04 original script
+# 	Stan Smith 2013-11-13 added line string
+# 	Stan Smith 2013-11-13 added multi line string
+# 	Stan Smith 2013-11-18 added polygon
+#   Stan Smith 2014-04-30 complete redesign for json schema 0.3.0
+#   Stan Smith 2014-05-22 added multi polygon
+#   Stan Smith 2014-05-23 cleaned up hash copy problem by using Marshal
+#   Stan Smith 2014-05-23 added direct geometry support for Point, Line, Polygon
+#   Stan Smith 2014-05-23 added direct geometry support for MultiPoint, MultiLine, MultiPolygon
+#   Stan Smith 2014-05-23 added direct support for geometryCollection
+#   Stan Smith 2014-07-07 resolve require statements using Mdtranslator.reader_module
+
+require ADIWG::Mdtranslator.reader_module('module_geoCoordSystem', $response[:readerVersionUsed])
+require ADIWG::Mdtranslator.reader_module('module_geoProperties', $response[:readerVersionUsed])
+require ADIWG::Mdtranslator.reader_module('module_boundingBox', $response[:readerVersionUsed])
+require ADIWG::Mdtranslator.reader_module('module_point', $response[:readerVersionUsed])
+require ADIWG::Mdtranslator.reader_module('module_lineString', $response[:readerVersionUsed])
+require ADIWG::Mdtranslator.reader_module('module_polygon', $response[:readerVersionUsed])
+
+module Adiwg_GeographicElement
+
+	def self.unpack(aGeoElements)
+
+		# only one geometry is allowed per geographic element.
+		# ... in GeoJSON each geometry is allowed a bounding box;
+		# ... This code splits bounding boxes to separate elements
+
+		# instance classes needed in script
+		aIntGeoEle = Array.new
+
+		aGeoElements.each do |hGeoJsonElement|
+
+			# instance classes needed in script
+			intMetadataClass = InternalMetadata.new
+			hGeoElement = intMetadataClass.newGeoElement
+
+			# find geographic element type
+			if hGeoJsonElement.has_key?('type')
+				elementType = hGeoJsonElement['type']
+			else
+				# invalid geographic element
+				return nil
+			end
+
+			# set geographic element id
+			if hGeoJsonElement.has_key?('id')
+				s = hGeoJsonElement['id']
+				if s != ''
+					hGeoElement[:elementId] = s
+				end
+			end
+
+			# set geographic element coordinate reference system - CRS
+			if hGeoJsonElement.has_key?('crs')
+				hGeoCrs = hGeoJsonElement['crs']
+				Adiwg_GeoCoordSystem.unpack(hGeoCrs, hGeoElement)
+			end
+
+			# set geographic element properties
+			if hGeoJsonElement.has_key?('properties')
+				hGeoProps = hGeoJsonElement['properties']
+				Adiwg_GeoProperties.unpack(hGeoProps, hGeoElement)
+			end
+
+			# process geographic element bounding box
+			# the bounding box must be represented as a separate geographic element for ISO
+			# need to make a deep copy of current state of geographic element for bounding box
+			if hGeoJsonElement.has_key?('bbox')
+				if hGeoJsonElement['bbox'].length == 4
+					aBBox = hGeoJsonElement['bbox']
+
+					boxElement = Marshal.load(Marshal.dump(hGeoElement))
+					boxElement[:elementGeometry] = Adiwg_BoundingBox.unpack(aBBox)
+
+					aIntGeoEle << boxElement
+				end
+			end
+
+			# unpack geographic element
+			case elementType
+
+				# GeoJSON Features
+				when 'Feature'
+					if hGeoJsonElement.has_key?('geometry')
+						hGeometry = hGeoJsonElement['geometry']
+
+						# geoJSON requires geometry to be 'null' when geometry is bounding box only
+						# JSON null converts in parsing to ruby nil
+						unless hGeometry.nil?
+							unless hGeometry.empty?
+								if hGeometry.has_key?('type')
+									geometryType = hGeometry['type']
+									aCoordinates = hGeometry['coordinates']
+									unless aCoordinates.empty?
+										case geometryType
+											when 'Point', 'MultiPoint'
+												hGeoElement[:elementGeometry] = Adiwg_Point.unpack(aCoordinates, geometryType)
+											when 'LineString', 'MultiLineString'
+												hGeoElement[:elementGeometry] = Adiwg_LineString.unpack(aCoordinates, geometryType)
+											when 'Polygon', 'MultiPolygon'
+												hGeoElement[:elementGeometry] = Adiwg_Polygon.unpack(aCoordinates, geometryType)
+											else
+												# log - the GeoJSON geometry type is not supported
+										end
+										aIntGeoEle << hGeoElement
+									end
+								end
+							end
+						end
+
+					end
+
+				# GeoJSON Feature Collection
+				when 'FeatureCollection'
+					if hGeoJsonElement.has_key?('features')
+						aFeatures = hGeoJsonElement['features']
+						unless aFeatures.empty?
+							intGeometry = intMetadataClass.newGeometry
+							intGeometry[:geoType] = 'MultiGeometry'
+							intGeometry[:geometry] = Adiwg_GeographicElement.unpack(aFeatures)
+							hGeoElement[:elementGeometry] = intGeometry
+							aIntGeoEle << hGeoElement
+						end
+					end
+
+				# GeoJSON Geometries
+				when 'Point', 'MultiPoint'
+					aCoordinates = hGeoJsonElement['coordinates']
+					hGeoElement[:elementGeometry] = Adiwg_Point.unpack(aCoordinates, elementType)
+					aIntGeoEle << hGeoElement
+
+				when 'LineString', 'MultiLineString'
+					aCoordinates = hGeoJsonElement['coordinates']
+					hGeoElement[:elementGeometry] = Adiwg_LineString.unpack(aCoordinates, elementType)
+					aIntGeoEle << hGeoElement
+
+				when 'Polygon', 'MultiPolygon'
+					aCoordinates = hGeoJsonElement['coordinates']
+					hGeoElement[:elementGeometry] = Adiwg_Polygon.unpack(aCoordinates, elementType)
+					aIntGeoEle << hGeoElement
+
+				# GeoJSON Geometry Collection
+				when 'GeometryCollection'
+					if hGeoJsonElement.has_key?('geometries')
+						aGeometries = hGeoJsonElement['geometries']
+						unless aGeometries.empty?
+							intGeometry = intMetadataClass.newGeometry
+							intGeometry[:geoType] = 'MultiGeometry'
+							intGeometry[:geometry] = Adiwg_GeographicElement.unpack(aGeometries)
+							hGeoElement[:elementGeometry] = intGeometry
+							aIntGeoEle << hGeoElement
+						end
+					end
+
+			end
+
+		end
+
+		return aIntGeoEle
+
+	end
+
+end

data/lib/adiwg/mdtranslator/readers/adiwgJson/modules_0.8.0/module_legalConstraint.rb

@@ -0,0 +1,45 @@
+# unpack legal constraint
+# Reader - ADIwg JSON V1 to internal data structure
+
+# History:
+# 	Stan Smith 2013-11-14 original script
+# 	Stan Smith 2013-11-27 modified to process a single legal constraint
+#   Stan Smith 2014-04-28 modified attribute names to match json schema 0.3.0
+
+module Adiwg_LegalConstraints
+
+	def self.unpack(hLegalCon)
+
+		# instance classes needed in script
+		intMetadataClass = InternalMetadata.new
+		hIntCon = intMetadataClass.newLegalConstraint
+
+		# legal constraint - access code
+		if hLegalCon.has_key?('accessConstraint')
+			aAccCodes = hLegalCon['accessConstraint']
+			unless aAccCodes.empty?
+				hIntCon[:accessCodes] = aAccCodes
+			end
+		end
+
+		# legal constraint - use code
+		if hLegalCon.has_key?('useConstraint')
+			aUseCodes = hLegalCon['useConstraint']
+			unless aUseCodes.empty?
+				hIntCon[:useCodes] = aUseCodes
+			end
+		end
+
+		# legal constraint - other constraints
+		if hLegalCon.has_key?('otherConstraint')
+			aOtherCons = hLegalCon['otherConstraint']
+			unless aOtherCons.empty?
+				hIntCon[:otherCons] = aOtherCons
+			end
+		end
+
+		return hIntCon
+
+	end
+
+end

data/lib/adiwg/mdtranslator/readers/adiwgJson/modules_0.8.0/module_lineString.rb

@@ -0,0 +1,25 @@
+# unpack line string
+# line string is coded in GeoJSON
+# Reader - ADIwg JSON V1 to internal data structure
+
+# History:
+# 	Stan Smith 2013-11-13 original script
+#   Stan Smith 2014-04-30 reorganized for json schema 0.3.0
+#   Stan Smith 2014-07-07 resolve require statements using Mdtranslator.reader_module
+
+require ADIWG::Mdtranslator.reader_module('module_coordinates', $response[:readerVersionUsed])
+
+module Adiwg_LineString
+
+	def self.unpack(aCoords, geoType)
+		intMetadataClass = InternalMetadata.new
+		intLine = intMetadataClass.newGeometry
+
+		intLine[:geoType] = geoType
+		intLine[:geometry] = aCoords
+		intLine[:dimension] = Adiwg_Coordinates.getDimension(aCoords)
+
+		return intLine
+	end
+
+end

data/lib/adiwg/mdtranslator/readers/adiwgJson/modules_0.8.0/module_lineage.rb

@@ -0,0 +1,50 @@
+# unpack lineage
+# Reader - ADIwg JSON V1 to internal data structure
+
+# History:
+# 	Stan Smith 2013-11-26 original script
+#   Stan Smith 2014-07-03 resolve require statements using Mdtranslator.reader_module
+
+require ADIWG::Mdtranslator.reader_module('module_processStep', $response[:readerVersionUsed])
+require ADIWG::Mdtranslator.reader_module('module_source', $response[:readerVersionUsed])
+
+module Adiwg_Lineage
+
+	def self.unpack(hLineage)
+
+		# instance classes needed in script
+		intMetadataClass = InternalMetadata.new
+		intDataLine = intMetadataClass.newLineage
+
+		# lineage - statement
+		if hLineage.has_key?('statement')
+			s = hLineage['statement']
+			if s != ''
+				intDataLine[:statement] = s
+			end
+		end
+
+		# lineage - process steps
+		if hLineage.has_key?('processStep')
+			aProcSteps = hLineage['processStep']
+			unless aProcSteps.empty?
+				aProcSteps.each do |hProcStep|
+					intDataLine[:processSteps] << Adiwg_ProcessStep.unpack(hProcStep)
+				end
+			end
+		end
+
+		# lineage - data sources
+		if hLineage.has_key?('source')
+			aSources = hLineage['source']
+			unless aSources.empty?
+				aSources.each do |hSource|
+					intDataLine[:dataSources] << Adiwg_Source.unpack(hSource)
+				end
+			end
+		end
+
+		return intDataLine
+	end
+
+end